Vaults - Check Name Availability
Ellenőrzi, hogy a tárolónév érvényes-e, és még nincs-e használatban.
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/checkNameAvailability?api-version=2022-07-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz. |
api-version
|
query | True |
string |
Client API-verzió. |
Kérelem törzse
Name | Kötelező | Típus | Description |
---|---|---|---|
name | True |
string |
A tároló neve. |
type | True |
Az erőforrás típusa, Microsoft.KeyVault/vaults |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
OK – A tárolónév rendelkezésre állásának ellenőrzésére irányuló művelet sikeres volt. |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. |
Példák
Validate a vault name
Sample Request
Sample Response
{
"nameAvailable": true
}
Definíciók
Name | Description |
---|---|
Check |
A CheckNameAvailability művelet válasza. |
Cloud |
Hibaválasz Key Vault erőforrás-szolgáltatótól |
Cloud |
Hibaválasz Key Vault erőforrás-szolgáltatótól |
Reason |
A tárolónév nem használható. Az Ok elem csak akkor lesz visszaadva, ha a NameAvailable értéke hamis. |
Type |
Az erőforrás típusa, Microsoft.KeyVault/vaults |
Vault |
A tároló nevének rendelkezésre állásának ellenőrzéséhez használt paraméterek. |
CheckNameAvailabilityResult
A CheckNameAvailability művelet válasza.
Name | Típus | Description |
---|---|---|
message |
string |
Hibaüzenet, amely részletesebben ismerteti az Ok értéket. |
nameAvailable |
boolean |
Logikai érték, amely azt jelzi, hogy a név használható-e. Ha igaz, a név elérhető. Ha hamis, a név már foglalt vagy érvénytelen, és nem használható. |
reason |
A tárolónév nem használható. Az Ok elem csak akkor lesz visszaadva, ha a NameAvailable értéke hamis. |
CloudError
Hibaválasz Key Vault erőforrás-szolgáltatótól
Name | Típus | Description |
---|---|---|
error |
Hibaválasz Key Vault erőforrás-szolgáltatótól |
CloudErrorBody
Hibaválasz Key Vault erőforrás-szolgáltatótól
Name | Típus | Description |
---|---|---|
code |
string |
Hibakód. Ez egy mnemonikus, amely programozott módon fogyasztható. |
message |
string |
Felhasználóbarát hibaüzenet. Az üzenet általában honosított, és a szolgáltatás verziójától függően változhat. |
Reason
A tárolónév nem használható. Az Ok elem csak akkor lesz visszaadva, ha a NameAvailable értéke hamis.
Name | Típus | Description |
---|---|---|
AccountNameInvalid |
string |
|
AlreadyExists |
string |
Type
Az erőforrás típusa, Microsoft.KeyVault/vaults
Name | Típus | Description |
---|---|---|
Microsoft.KeyVault/vaults |
string |
VaultCheckNameAvailabilityParameters
A tároló nevének rendelkezésre állásának ellenőrzéséhez használt paraméterek.
Name | Típus | Description |
---|---|---|
name |
string |
A tároló neve. |
type |
Az erőforrás típusa, Microsoft.KeyVault/vaults |