Skip to content

Commit 5e3efd2

Browse files
authored
Merge pull request #234976 from jackrichins/patch-67
Clarify that URLs are case-insensitive
2 parents 981a2d9 + 4b3ecd4 commit 5e3efd2

File tree

1 file changed

+32
-32
lines changed

1 file changed

+32
-32
lines changed

articles/key-vault/general/about-keys-secrets-certificates.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,41 @@ tags: azure-resource-manager
88
ms.service: key-vault
99
ms.subservice: general
1010
ms.topic: overview
11-
ms.date: 12/12/2022
11+
ms.date: 04/18/2023
1212
ms.author: mbaldwin
1313
---
1414

1515
# Azure Key Vault keys, secrets and certificates overview
1616

17-
Azure Key Vault enables Microsoft Azure applications and users to store and use several types of secret/key data. Key Vault resource provider supports two resource types: vaults and managed HSMs.
17+
Azure Key Vault enables Microsoft Azure applications and users to store and use several types of secret/key data: keys, secrets, and certificates. Keys, secrets, and certificates are collectively referred to as "objects".
1818

19-
## DNS suffixes for base URL
20-
This table shows the base URL DNS suffix used by the data-plane endpoint for vaults and managed HSM pools in various cloud environments.
19+
## Object identifiers
20+
Objects are uniquely identified within Key Vault using a case-insensitive identifier called the object identifier. No two objects in the system have the same identifier, regardless of geo-location. The identifier consists of a prefix that identifies the key vault, object type, user provided object name, and an object version. Identifiers that don't include the object version are referred to as "base identifiers". Key Vault object identifiers are also valid URLs, but should always be compared as case-insensitive strings.
21+
22+
For more information, see [Authentication, requests, and responses](authentication-requests-and-responses.md)
23+
24+
An object identifier has the following general format (depending on container type):
25+
26+
- **For Vaults**:
27+
`https://{vault-name}.vault.azure.net/{object-type}/{object-name}/{object-version}`
28+
29+
- **For Managed HSM pools**:
30+
`https://{hsm-name}.managedhsm.azure.net/{object-type}/{object-name}/{object-version}`
31+
32+
> [!NOTE]
33+
> See [Object type support](#object-types) for types of objects supported by each container type.
34+
35+
Where:
36+
37+
| Element | Description |
38+
|-|-|
39+
| `vault-name` or `hsm-name` | The name for a key vault or a Managed HSM pool in the Microsoft Azure Key Vault service.<br /><br />Vault names and Managed HSM pool names are selected by the user and are globally unique.<br /><br />Vault name and Managed HSM pool name must be a 3-24 character string, containing only 0-9, a-z, A-Z, and not consecutive -.|
40+
| `object-type` | The type of the object, "keys", "secrets", or "certificates".|
41+
| `object-name` | An `object-name` is a user provided name for and must be unique within a key vault. The name must be a 1-127 character string, starting with a letter and containing only 0-9, a-z, A-Z, and -.|
42+
| `object-version `| An `object-version` is a system-generated, 32 character string identifier that is optionally used to address a unique version of an object. |
43+
44+
## DNS suffixes for object identifiers
45+
The Azure Key Vault resource provider supports two resource types: vaults and managed HSMs. This table shows the DNS suffix used by the data-plane endpoint for vaults and managed HSM pools in various cloud environments.
2146

2247
Cloud environment | DNS suffix for vaults | DNS suffix for managed HSMs
2348
---|---|---
@@ -27,9 +52,9 @@ Azure US Government | .vault.usgovcloudapi.net | Not supported
2752
Azure German Cloud | .vault.microsoftazure.de | Not supported
2853

2954
## Object types
30-
This table shows object types and their suffixes in the base URL.
55+
This table shows object types and their suffixes in the object identifier.
3156

32-
Object type|URL Suffix|Vaults|Managed HSM Pools
57+
Object type|Identifier Suffix|Vaults|Managed HSM Pools
3358
--|--|--|--
3459
**Cryptographic keys**||
3560
HSM-protected keys|/keys|Supported|Supported
@@ -63,38 +88,13 @@ Refer to the JOSE specifications for relevant data types for keys, encryption, a
6388

6489
## Objects, identifiers, and versioning
6590

66-
Objects stored in Key Vault are versioned whenever a new instance of an object is created. Each version is assigned a unique identifier and URL. When an object is first created, it's given a unique version identifier and marked as the current version of the object. Creation of a new instance with the same object name gives the new object a unique version identifier, causing it to become the current version.
91+
Objects stored in Key Vault are versioned whenever a new instance of an object is created. Each version is assigned a unique object identifier. When an object is first created, it's given a unique version identifier and marked as the current version of the object. Creation of a new instance with the same object name gives the new object a unique version identifier, causing it to become the current version.
6792

6893
Objects in Key Vault can be retrieved by specifying a version or by omitting version to get latest version of the object. Performing operations on objects requires providing version to use specific version of the object.
6994

7095
> [!NOTE]
7196
> The values you provide for Azure resources or object IDs may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information.
7297
73-
### Vault-name and Object-name
74-
Objects are uniquely identified within Key Vault using a URL. No two objects in the system have the same URL, regardless of geo-location. The complete URL to an object is called the Object Identifier. The URL consists of a prefix that identifies the Key Vault, object type, user provided Object Name, and an Object Version. The Object Name is case-insensitive and immutable. Identifiers that don't include the Object Version are referred to as Base Identifiers.
75-
76-
For more information, see [Authentication, requests, and responses](authentication-requests-and-responses.md)
77-
78-
An object identifier has the following general format (depending on container type):
79-
80-
- **For Vaults**:
81-
`https://{vault-name}.vault.azure.net/{object-type}/{object-name}/{object-version}`
82-
83-
- **For Managed HSM pools**:
84-
`https://{hsm-name}.managedhsm.azure.net/{object-type}/{object-name}/{object-version}`
85-
86-
> [!NOTE]
87-
> See [Object type support](#object-types) for types of objects supported by each container type.
88-
89-
Where:
90-
91-
| Element | Description |
92-
|-|-|
93-
|`vault-name` or `hsm-name`|The name for a vault or a Managed HSM pool in the Microsoft Azure Key Vault service.<br /><br />Vault names and Managed HSM pool names are selected by the user and are globally unique.<br /><br />Vault name and Managed HSM pool name must be a 3-24 character string, containing only 0-9, a-z, A-Z, and not consecutive -.|
94-
|`object-type`|The type of the object, "keys", "secrets", or 'certificates'.|
95-
|`object-name`|An `object-name` is a user provided name for and must be unique within a Key Vault. The name must be a 1-127 character string, starting with a letter and containing only 0-9, a-z, A-Z, and -.|
96-
|`object-version`|An `object-version` is a system-generated, 32 character string identifier that is optionally used to address a unique version of an object.|
97-
9898
## Next steps
9999

100100
- [About keys](../keys/about-keys.md)

0 commit comments

Comments
 (0)