Skip to content

Commit 11df3d9

Browse files
committed
Add examples of azure-deprecating header
1 parent faa9220 commit 11df3d9

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
@@ -914,18 +914,20 @@ The purpose is to inform customers (when debugging/logging responses) that they
914914

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

920+
Multiple deprecations are allowed, semicolon delimited.
921+
920922
Where the following placeholders should be provided:
921923
- `description`: a human-readable description of what is being deprecated
922924
- `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".
923925
- `url`: a fully qualified url that the user can follow to learn more about what is being deprecated, preferably to Azure Updates.
924926

925927
For example:
926-
```text
927-
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/)
928-
```
928+
- `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/)`
929+
- `azure-deprecating: Model version 2021-01-15 used in Sentiment analysis will retire on 2022-12-01 (https://aka.ms/ta-modelversions?sentimentAnalysis)`
930+
- `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/)`
929931

930932
<a name="deprecation-header-review"></a>
931933
: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)