Skip to content

Commit 99f99bc

Browse files
authored
Merge pull request #421 from mikekistler/deprecating-examples
Add examples of azure-deprecating header
2 parents e02baff + 11df3d9 commit 99f99bc

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

azure/Guidelines.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -917,18 +917,20 @@ The purpose is to inform customers (when debugging/logging responses) that they
917917

918918
Deprecations should use the following pattern:
919919
```text
920-
<description> will retire on <date> (`url`);
920+
<description> will retire on <date> (<url>)
921921
```
922922

923+
Multiple deprecations are allowed, semicolon delimited.
924+
923925
Where the following placeholders should be provided:
924926
- `description`: a human-readable description of what is being deprecated
925927
- `date`: the target date that this will be deprecated. This should be expressed following the format in [ISO 8601](https://datatracker.ietf.org/doc/html/rfc7231#section-7.1.1.1), e.g. "2022-10-31".
926928
- `url`: a fully qualified url that the user can follow to learn more about what is being deprecated, preferably to Azure Updates.
927929

928930
For example:
929-
```text
930-
azure-deprecating: API version 2009-27-07 will retire on 2022-12-01 (https://azure.microsoft.com/updates/video-analyzer-retirement);TLS 1.0 & 1.1 will retire on 2020-10-30 (https://azure.microsoft.com/updates/azure-active-directory-registration-service-is-ending-support-for-tls-10-and-11/)
931-
```
931+
- `azure-deprecating: API version 2009-27-07 will retire on 2022-12-01 (https://azure.microsoft.com/updates/video-analyzer-retirement);TLS 1.0 & 1.1 will retire on 2020-10-30 (https://azure.microsoft.com/updates/azure-active-directory-registration-service-is-ending-support-for-tls-10-and-11/)`
932+
- `azure-deprecating: Model version 2021-01-15 used in Sentiment analysis will retire on 2022-12-01 (https://aka.ms/ta-modelversions?sentimentAnalysis)`
933+
- `azure-deprecating: TLS 1.0 & 1.1 support will retire on 2022-10-01 (https://devblogs.microsoft.com/devops/deprecating-weak-cryptographic-standards-tls-1-0-and-1-1-in-azure-devops-services/)`
932934

933935
<a name="deprecation-header-review"></a>
934936
:no_entry: **DO NOT** introduce this header without approval from [Azure Breaking Change Reviewers](mailto:[email protected]) and an official deprecation notice on [Azure Updates](https://azure.microsoft.com/updates/).

0 commit comments

Comments
 (0)