Managed Hsms - Check Mhsm Name Availability

Referenz

Dienst:: Key Vault

API-Version:: 2022-07-01

Überprüft, ob der verwaltete hsm-Name gültig ist und noch nicht verwendet wird.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
name	True	string	Der verwaltete hsm-Name.

Antworten

Name	Typ	Beschreibung
200 OK	CheckMhsmNameAvailabilityResult	OK : Der Vorgang zum Überprüfen der Verfügbarkeit von mhsm-Namen war erfolgreich.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "nameAvailable": true
}

Definitionen

Name	Beschreibung
CheckMhsmNameAvailabilityParameters	Die Parameter, die verwendet werden, um die Verfügbarkeit des verwalteten hsm-Namens zu überprüfen.
CheckMhsmNameAvailabilityResult	Die Antwort des CheckMhsmNameAvailability-Vorgangs.
CloudError	Eine Fehlerantwort von Key Vault Ressourcenanbieter
CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter
Reason	Der Grund dafür, dass ein verwalteter hsm-Name nicht verwendet werden konnte. Das Reason-Element wird nur zurückgegeben, wenn NameAvailable false ist.

CheckMhsmNameAvailabilityParameters

Die Parameter, die verwendet werden, um die Verfügbarkeit des verwalteten hsm-Namens zu überprüfen.

Name	Typ	Beschreibung
name	string	Der verwaltete hsm-Name.

CheckMhsmNameAvailabilityResult

Die Antwort des CheckMhsmNameAvailability-Vorgangs.

Name	Typ	Beschreibung
message	string	Eine Fehlermeldung, die den Wert "Reason" ausführlicher erläutert.
nameAvailable	boolean	Ein boolescher Wert, der angibt, ob der Name für Sie verfügbar ist. Wenn true, ist der Name verfügbar. Wenn false, wurde der Name bereits verwendet oder ist ungültig und kann nicht verwendet werden.
reason	Reason	Der Grund dafür, dass ein verwalteter hsm-Name nicht verwendet werden konnte. Das Reason-Element wird nur zurückgegeben, wenn NameAvailable false ist.

CloudError

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter

CloudErrorBody