Managed Hsms - Check Mhsm Name Availability

Reference

Služba:: Key Vault

Verze rozhraní API:: 2022-07-01

Zkontroluje, jestli je název spravovaného hsm platný a že se ještě nepoužívá.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/checkMhsmNameAvailability?api-version=2022-07-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Vyžadováno	Typ	Description
name	True	string	Název spravovaného hsm.

Odpovědi

Name	Typ	Description
200 OK	CheckMhsmNameAvailabilityResult	OK – Operace pro kontrolu dostupnosti názvu mhsm byla úspěšná.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Validate a managed hsm name

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/checkMhsmNameAvailability?api-version=2022-07-01

{
  "name": "sample-mhsm"
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python managed_hsm_check_mhsm_name_availability.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = KeyVaultManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.managed_hsms.check_mhsm_name_availability(
        mhsm_name={"name": "sample-mhsm"},
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_checkMhsmNameAvailability.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Ukázková odpověď

Stavový kód:: 200

{
  "nameAvailable": true
}

Definice

Name	Description
CheckMhsmNameAvailabilityParameters	Parametry použité ke kontrole dostupnosti názvu spravovaného hsm.
CheckMhsmNameAvailabilityResult	Odpověď operace CheckMhsmNameAvailability
CloudError	Chybová odpověď od poskytovatele prostředků Key Vault
CloudErrorBody	Chybová odpověď od poskytovatele prostředků Key Vault
Reason	Důvod, proč nebylo možné použít název spravovaného hsm. Element reason je vrácen pouze v případě, že NameAvailable je false.

CheckMhsmNameAvailabilityParameters

Parametry použité ke kontrole dostupnosti názvu spravovaného hsm.

Name	Typ	Description
name	string	Název spravovaného hsm.

CheckMhsmNameAvailabilityResult

Odpověď operace CheckMhsmNameAvailability

Name	Typ	Description
message	string	Chybová zpráva s podrobnějším vysvětlením hodnoty Reason
nameAvailable	boolean	Logická hodnota, která určuje, jestli je název k dispozici k použití. Pokud je hodnota true, název je k dispozici. Pokud je false, název již byl převzat nebo je neplatný a nelze ho použít.
reason	Reason	Důvod, proč nebylo možné použít název spravovaného hsm. Element reason je vrácen pouze v případě, že NameAvailable je false.

CloudError

Chybová odpověď od poskytovatele prostředků Key Vault

Name	Typ	Description
error	CloudErrorBody	Chybová odpověď od poskytovatele prostředků Key Vault

CloudErrorBody