Vaults - Check Name Availability

Servizio:: Key Vault

Versione API:: 2024-11-01

Verifica che il nome dell'insieme di credenziali sia valido e non sia già in uso.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/checkNameAvailability?api-version=2024-11-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata al servizio.
api-version	query	True	string	Versione dell'API client.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
name	True	string	Nome dell'insieme di credenziali.
type	True	Type	Tipo di risorsa, Microsoft.KeyVault/vaults

Risposte

Nome	Tipo	Descrizione
200 OK	CheckNameAvailabilityResult	OK - L'operazione per verificare la disponibilità del nome dell'insieme di credenziali è stata eseguita correttamente.
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Esempio

Validate a vault name

Esempio di richiesta

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/checkNameAvailability?api-version=2024-11-01

{
  "name": "sample-vault",
  "type": "Microsoft.KeyVault/vaults"
}

Risposta di esempio

Codice di stato:: 200

{
  "nameAvailable": true
}

Definizioni

Nome	Descrizione
CheckNameAvailabilityResult	Risposta dell'operazione CheckNameAvailability.
CloudError	Risposta di errore dal provider di risorse Key Vault
CloudErrorBody	Risposta di errore dal provider di risorse Key Vault
Reason	Il motivo per cui non è stato possibile utilizzare un nome dell'insieme di credenziali. L'elemento Reason viene restituito solo se NameAvailable è false.
Type	Tipo di risorsa, Microsoft.KeyVault/vaults
VaultCheckNameAvailabilityParameters	Parametri utilizzati per verificare la disponibilità del nome dell'insieme di credenziali.

CheckNameAvailabilityResult

Oggetto

Risposta dell'operazione CheckNameAvailability.

Nome	Tipo	Descrizione
message	string	Un messaggio di errore che spiega il valore Reason in modo più dettagliato.
nameAvailable	boolean	Valore booleano che indica se il nome è disponibile per l'uso. Se true, il nome è disponibile. Se false, il nome è già stato utilizzato o non è valido e non può essere utilizzato.
reason	Reason	Il motivo per cui non è stato possibile utilizzare un nome dell'insieme di credenziali. L'elemento Reason viene restituito solo se NameAvailable è false.

CloudError

Oggetto

Risposta di errore dal provider di risorse Key Vault

Nome	Tipo	Descrizione
error	CloudErrorBody	Risposta di errore dal provider di risorse Key Vault

CloudErrorBody

Oggetto

Risposta di errore dal provider di risorse Key Vault

Nome	Tipo	Descrizione
code	string	Codice di errore. Si tratta di un tasto mnemonico che può essere utilizzato a livello di codice.
message	string	Messaggio di errore di facile utilizzo. Il messaggio è in genere localizzato e può variare in base alla versione del servizio.

Reason

Enumerazione

Il motivo per cui non è stato possibile utilizzare un nome dell'insieme di credenziali. L'elemento Reason viene restituito solo se NameAvailable è false.

Valore	Descrizione
AccountNameInvalid
AlreadyExists

Type

Enumerazione

Tipo di risorsa, Microsoft.KeyVault/vaults

Valore	Descrizione
Microsoft.KeyVault/vaults

VaultCheckNameAvailabilityParameters

Oggetto

Parametri utilizzati per verificare la disponibilità del nome dell'insieme di credenziali.

Nome	Tipo	Descrizione
name	string	Nome dell'insieme di credenziali.
type	Type	Tipo di risorsa, Microsoft.KeyVault/vaults