Skip to content

Commit 45eaffc

Browse files
authored
Merge pull request #370 from JeffreyRichter/patch-1
Updated URL Guidelines for DNS Done Right
2 parents 31a1a1a + a12ce5d commit 45eaffc

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
@@ -6,7 +6,7 @@
66

77
| Date | Notes |
88
| ----------- | -------------------------------------------------------------- |
9-
| 2022-Aug-20 | Add "azure-deprecating" response header |
9+
| 2022-Sep-07 | Updated URL guidelines for DNS Done Right | |
1010
| 2022-Jul-15 | Update guidance on long-running operations |
1111
| 2022-May-11 | Drop guidance on version discovery |
1212
| 2022-Mar-29 | Add guidelines about using durations |
@@ -65,18 +65,20 @@ A Uniform Resource Locator (URL) is how developers access the resources of your
6565

6666
:white_check_mark: **DO** use this URL pattern:
6767
```text
68-
https://<service>.<cloud>/<tenant>/<service-root>/<resource-collection>/<resource-id>/
68+
https://<tenant>.<region>.<service>.<cloud>/<service-root>/<resource-collection>/<resource-id>
6969
```
7070

7171
Where:
7272
| Field | Description
7373
| - | - |
74+
| tenant | Regionally-unique ID representing a tenant (used for isolation, billing, quota enforcement, lifetime of resources, etc.)
75+
| region | Identifies the tenant's selected region. This region string MUST match one of the strings in the "Name" column returned from running this Azure CLI's "az account list-locations -o table"
7476
| service | Name of the service (ex: blobstore, servicebus, directory, or management)
7577
| cloud | Cloud domain name, e.g. `azure.net` (see Azure CLI's "az cloud list")
76-
| tenant | Globally-unique ID of container representing tenant isolation, billing, enforced quotas, lifetime of containers (ex: subscription UUID)
7778
| service&#x2011;root | Service-specific path (ex: blobcontainer, myqueue)
7879
| resource&#x2011;collection | Name of the collection, unabbreviated, pluralized
79-
| resource&#x2011;id | Value of the unique id property. This MUST be the raw string/number/guid value with no quoting but properly escaped to fit in a URL segment.
80+
| resource&#x2011;id | Id of resource within the resource-collection. This MUST be the raw string/number/guid value with no quoting but properly escaped to fit in a URL segment.
81+
8082

8183
:white_check_mark: **DO** use kebab-casing (preferred) or camel-casing for URL path segments. If the segment refers to a JSON field, use camel casing.
8284

0 commit comments

Comments
 (0)