Managed Hsms - Check Mhsm Name Availability

Referencia

Servicio:: Key Vault

Versión de la API:: 2022-07-01

Comprueba que el nombre de hsm administrado es válido y que aún no está en uso.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de api de cliente.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
name	True	string	Nombre de hsm administrado.

Respuestas

Nombre	Tipo	Description
200 OK	CheckMhsmNameAvailabilityResult	Aceptar: operación para comprobar que la disponibilidad del nombre de mhsm se realizó correctamente.
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

Respuesta de muestra

status code:: 200

{
  "nameAvailable": true
}

Definiciones

Nombre	Description
CheckMhsmNameAvailabilityParameters	Parámetros usados para comprobar la disponibilidad del nombre hsm administrado.
CheckMhsmNameAvailabilityResult	Respuesta de la operación CheckMhsmNameAvailability.
CloudError	Respuesta de error del proveedor de recursos de Key Vault
CloudErrorBody	Respuesta de error del proveedor de recursos de Key Vault
Reason	Motivo por el que no se pudo usar un nombre hsm administrado. El elemento reason solo se devuelve si NameAvailable es false.

CheckMhsmNameAvailabilityParameters

Parámetros usados para comprobar la disponibilidad del nombre hsm administrado.

Nombre	Tipo	Description
name	string	Nombre de hsm administrado.

CheckMhsmNameAvailabilityResult

Respuesta de la operación CheckMhsmNameAvailability.

Nombre	Tipo	Description
message	string	Mensaje de error que explica el valor reason con más detalle.
nameAvailable	boolean	Valor booleano que indica si el nombre está disponible para su uso. Si es true, el nombre está disponible. Si es false, el nombre ya se ha tomado o no es válido y no se puede usar.
reason	Reason	Motivo por el que no se pudo usar un nombre hsm administrado. El elemento reason solo se devuelve si NameAvailable es false.

CloudError

Respuesta de error del proveedor de recursos de Key Vault

Nombre	Tipo	Description
error	CloudErrorBody	Respuesta de error del proveedor de recursos de Key Vault

CloudErrorBody