Managed Hsms - Check Mhsm Name Availability

Odwołanie

Usługa:: Key Vault

Wersja interfejsu API:: 2022-07-01

Sprawdza, czy zarządzana nazwa modułu hsm jest prawidłowa i nie jest jeszcze używana.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Wymagane	Typ	Opis
name	True	string	Nazwa zarządzanego modułu hsm.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CheckMhsmNameAvailabilityResult	OK — operacja sprawdzania dostępności nazwy mhsm zakończyła się pomyślnie.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "nameAvailable": true
}

Definicje

Nazwa	Opis
CheckMhsmNameAvailabilityParameters	Parametry używane do sprawdzania dostępności zarządzanego modułu hsm.
CheckMhsmNameAvailabilityResult	Odpowiedź operacji CheckMhsmNameAvailability.
CloudError	Odpowiedź na błąd dostawcy zasobów Key Vault
CloudErrorBody	Odpowiedź na błąd dostawcy zasobów Key Vault
Reason	Przyczyna, dla którego nie można użyć nazwy zarządzanego modułu hsm. Element przyczyny jest zwracany tylko wtedy, gdy wartość NameAvailable ma wartość false.

CheckMhsmNameAvailabilityParameters

Parametry używane do sprawdzania dostępności zarządzanego modułu hsm.

Nazwa	Typ	Opis
name	string	Nazwa zarządzanego modułu hsm.

CheckMhsmNameAvailabilityResult

Odpowiedź operacji CheckMhsmNameAvailability.

Nazwa	Typ	Opis
message	string	Komunikat o błędzie wyjaśniający wartość Przyczyna bardziej szczegółowo.
nameAvailable	boolean	Wartość logiczna wskazująca, czy nazwa jest dostępna do użycia. Jeśli wartość true, nazwa jest dostępna. Jeśli wartość false, nazwa została już podjęta lub jest nieprawidłowa i nie można jej użyć.
reason	Reason	Przyczyna, dla którego nie można użyć nazwy zarządzanego modułu hsm. Element przyczyny jest zwracany tylko wtedy, gdy wartość NameAvailable ma wartość false.

CloudError

Odpowiedź na błąd dostawcy zasobów Key Vault

Nazwa	Typ	Opis
error	CloudErrorBody	Odpowiedź na błąd dostawcy zasobów Key Vault

CloudErrorBody