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 サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	必須	型	説明
name	True	string	マネージド HSM 名。

応答

名前	型	説明
200 OK	CheckMhsmNameAvailabilityResult	OK -- mhsm 名の可用性をチェックする操作が成功しました。
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 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