Managed Hsms - Check Mhsm Name Availability

Ссылка

Служба:: Key Vault

Версия API:: 2022-07-01

Проверяет, является ли имя управляемого модуля HSM допустимым и еще не используется.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.

Текст запроса

Имя	Обязательно	Тип	Описание
name	True	string	Имя управляемого модуля HSM.

Ответы

Имя	Тип	Описание
200 OK	CheckMhsmNameAvailabilityResult	ОК . Операция проверка доступности имени mhsm выполнена успешно.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Пример ответа

Код состояния:: 200

{
  "nameAvailable": true
}

Определения

Имя	Описание
CheckMhsmNameAvailabilityParameters	Параметры, используемые для проверка доступности имени управляемого модуля HSM.
CheckMhsmNameAvailabilityResult	Ответ операции CheckMhsmNameAvailability.
CloudError	Ответ об ошибке от поставщика ресурсов Key Vault
CloudErrorBody	Ответ об ошибке от поставщика ресурсов Key Vault
Reason	Причина, по которой не удалось использовать имя управляемого модуля HSM. Элемент reason возвращается, только если nameAvailable имеет значение false.

CheckMhsmNameAvailabilityParameters

Параметры, используемые для проверка доступности имени управляемого модуля HSM.

Имя	Тип	Описание
name	string	Имя управляемого модуля HSM.

CheckMhsmNameAvailabilityResult

Ответ операции CheckMhsmNameAvailability.

Имя	Тип	Описание
message	string	Сообщение об ошибке, в которой более подробно объясняется значение Причины.
nameAvailable	boolean	Логическое значение, указывающее, доступно ли имя для использования. Если значение равно true, имя доступно. Если значение равно false, имя уже принято или является недопустимым и не может быть использовано.
reason	Reason	Причина, по которой не удалось использовать имя управляемого модуля HSM. Элемент reason возвращается, только если nameAvailable имеет значение false.

CloudError

Ответ об ошибке от поставщика ресурсов Key Vault

Имя	Тип	Описание
error	CloudErrorBody	Ответ об ошибке от поставщика ресурсов Key Vault

CloudErrorBody