Vaults - Check Name Availability
Controleert of de kluisnaam geldig is en nog niet in gebruik is.
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/checkNameAvailability?api-version=2022-07-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep. |
api-version
|
query | True |
string |
Client-API-versie. |
Aanvraagbody
Name | Vereist | Type | Description |
---|---|---|---|
name | True |
string |
De naam van de kluis. |
type | True |
Het type resource, Microsoft.KeyVault/kluizen |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
OK: bewerking om te controleren of de kluisnaam beschikbaar is. |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Voorbeelden
Validate a vault name
Sample Request
Sample Response
{
"nameAvailable": true
}
Definities
Name | Description |
---|---|
Check |
Het antwoord van de bewerking CheckNameAvailability. |
Cloud |
Een foutreactie van Key Vault resourceprovider |
Cloud |
Een foutreactie van Key Vault resourceprovider |
Reason |
De reden dat een kluisnaam niet kan worden gebruikt. Het element Reason wordt alleen geretourneerd als NameAvailable onwaar is. |
Type |
Het type resource, Microsoft.KeyVault/kluizen |
Vault |
De parameters die worden gebruikt om de beschikbaarheid van de kluisnaam te controleren. |
CheckNameAvailabilityResult
Het antwoord van de bewerking CheckNameAvailability.
Name | Type | Description |
---|---|---|
message |
string |
Een foutbericht waarin de redenwaarde gedetailleerder wordt uitgelegd. |
nameAvailable |
boolean |
Een booleaanse waarde die aangeeft of de naam beschikbaar is voor gebruik. Als waar is, is de naam beschikbaar. Als de naam onwaar is, is de naam al in gebruik of is deze ongeldig en kan deze niet worden gebruikt. |
reason |
De reden dat een kluisnaam niet kan worden gebruikt. Het element Reason wordt alleen geretourneerd als NameAvailable onwaar is. |
CloudError
Een foutreactie van Key Vault resourceprovider
Name | Type | Description |
---|---|---|
error |
Een foutreactie van Key Vault resourceprovider |
CloudErrorBody
Een foutreactie van Key Vault resourceprovider
Name | Type | Description |
---|---|---|
code |
string |
Foutcode. Dit is een ezelsbruggetje dat programmatisch kan worden gebruikt. |
message |
string |
Gebruiksvriendelijk foutbericht. Het bericht is doorgaans gelokaliseerd en kan per serviceversie verschillen. |
Reason
De reden dat een kluisnaam niet kan worden gebruikt. Het element Reason wordt alleen geretourneerd als NameAvailable onwaar is.
Name | Type | Description |
---|---|---|
AccountNameInvalid |
string |
|
AlreadyExists |
string |
Type
Het type resource, Microsoft.KeyVault/kluizen
Name | Type | Description |
---|---|---|
Microsoft.KeyVault/vaults |
string |
VaultCheckNameAvailabilityParameters
De parameters die worden gebruikt om de beschikbaarheid van de kluisnaam te controleren.
Name | Type | Description |
---|---|---|
name |
string |
De naam van de kluis. |
type |
Het type resource, Microsoft.KeyVault/kluizen |