Managed Hsms - Check Mhsm Name Availability

Referência

Serviço:: Key Vault

Versão da API:: 2022-07-01

Verifica se o nome hsm gerido é válido e ainda não está a ser utilizado.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do Cliente.

Corpo do Pedido

Name	Necessário	Tipo	Description
name	True	string	O nome hsm gerido.

Respostas

Name	Tipo	Description
200 OK	CheckMhsmNameAvailabilityResult	OK - Operação para verificar se a disponibilidade do nome mhsm foi efetuada com êxito.
Other Status Codes	CloudError	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

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

Resposta da amostra

Código de estado:: 200

{
  "nameAvailable": true
}

Definições

Name	Description
CheckMhsmNameAvailabilityParameters	Os parâmetros utilizados para verificar a disponibilidade do nome hsm gerido.
CheckMhsmNameAvailabilityResult	A resposta da operação CheckMhsmNameAvailability.
CloudError	Uma resposta de erro do fornecedor de recursos Key Vault
CloudErrorBody	Uma resposta de erro do fornecedor de recursos Key Vault
Reason	O motivo pelo qual não foi possível utilizar um nome hsm gerido. O elemento de motivo só é devolvido se Nome Disponível for falso.

CheckMhsmNameAvailabilityParameters

Os parâmetros utilizados para verificar a disponibilidade do nome hsm gerido.

Name	Tipo	Description
name	string	O nome hsm gerido.

CheckMhsmNameAvailabilityResult

A resposta da operação CheckMhsmNameAvailability.

Name	Tipo	Description
message	string	Uma mensagem de erro a explicar o valor motivo mais detalhadamente.
nameAvailable	boolean	Um valor booleano que indica se o nome está disponível para utilização. Se for verdadeiro, o nome está disponível. Se for falso, o nome já foi utilizado ou é inválido e não pode ser utilizado.
reason	Reason	O motivo pelo qual não foi possível utilizar um nome hsm gerido. O elemento de motivo só é devolvido se Nome Disponível for falso.

CloudError

Uma resposta de erro do fornecedor de recursos Key Vault

Name	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do fornecedor de recursos Key Vault

CloudErrorBody