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 매개 변수

Name	In(다음 안에)	필수	형식	Description
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
api-version	query	True	string	클라이언트 API 버전.

요청 본문

Name	필수	형식	Description
name	True	string	관리되는 hsm 이름입니다.

응답

Name	형식	Description
200 OK	CheckMhsmNameAvailabilityResult	확인 -- mhsm 이름 가용성을 검사 작업이 성공했습니다.
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
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
}

정의

Name	Description
CheckMhsmNameAvailabilityParameters	관리되는 hsm 이름의 가용성을 검사 데 사용되는 매개 변수입니다.
CheckMhsmNameAvailabilityResult	CheckMhsmNameAvailability 작업 응답입니다.
CloudError	Key Vault 리소스 공급자의 오류 응답
CloudErrorBody	Key Vault 리소스 공급자의 오류 응답
Reason	관리되는 hsm 이름을 사용할 수 없는 이유입니다. Reason 요소는 NameAvailable이 false인 경우에만 반환됩니다.

CheckMhsmNameAvailabilityParameters

관리되는 hsm 이름의 가용성을 검사 데 사용되는 매개 변수입니다.

Name	형식	Description
name	string	관리되는 hsm 이름입니다.

CheckMhsmNameAvailabilityResult

CheckMhsmNameAvailability 작업 응답입니다.

Name	형식	Description
message	string	이유 값을 자세히 설명하는 오류 메시지입니다.
nameAvailable	boolean	이름을 사용할 수 있는지 여부를 나타내는 부울 값입니다. true이면 이름을 사용할 수 있습니다. false이면 이름이 이미 사용되었거나 유효하지 않으며 사용할 수 없습니다.
reason	Reason	관리되는 hsm 이름을 사용할 수 없는 이유입니다. Reason 요소는 NameAvailable이 false인 경우에만 반환됩니다.

CloudError

Key Vault 리소스 공급자의 오류 응답

Name	형식	Description
error	CloudErrorBody	Key Vault 리소스 공급자의 오류 응답

CloudErrorBody