Managed Hsms - Get Deleted

リファレンス

Service:: Key Vault

API Version:: 2022-07-01

指定した削除されたマネージド HSM を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/locations/{location}/deletedManagedHSMs/{name}?api-version=2022-07-01

URI パラメーター

名前	/	必須	型	説明
location	path	True	string	削除されたマネージド HSM の場所。
name	path	True	string	削除されたマネージド HSM の名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API のバージョン。

応答

名前	型	説明
200 OK	DeletedManagedHsm	指定した削除されたマネージド HSM に関する情報を取得しました。
Other Status Codes	ManagedHsmError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Retrieve a deleted managed HSM

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedManagedHSMs/hsm1?api-version=2022-07-01

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python deleted_managed_hsm_get.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.get_deleted(
        name="hsm1",
        location="westus",
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/DeletedManagedHsm_Get.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

Sample Response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedManagedHSMs/hsm1",
  "name": "vault-agile-drawer-6404",
  "type": "Microsoft.KeyVault/deletedManagedHSMs",
  "properties": {
    "mhsmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
    "location": "westus",
    "deletionDate": "2021-04-01T00:00:59Z",
    "scheduledPurgeDate": "2021-04-01T00:00:59Z",
    "purgeProtectionEnabled": true,
    "tags": {
      "Dept": "hsm",
      "Environment": "production"
    }
  }
}

定義

名前	説明
DeletedManagedHsm
DeletedManagedHsmProperties	削除されたマネージド HSM のプロパティ。
Error	サーバーエラー。
ManagedHsmError	エラー例外。

DeletedManagedHsm

名前	型	説明
id	string	削除されたマネージド HSM プールの Azure Resource Manager リソース ID。
name	string	マネージド HSM プールの名前。
properties	DeletedManagedHsmProperties	削除されたマネージド HSM のプロパティ
type	string	マネージド HSM プールのリソースの種類。

DeletedManagedHsmProperties

削除されたマネージド HSM のプロパティ。

名前	型	説明
deletionDate	string	削除された日付。
location	string	元のマネージド HSM の場所。
mhsmId	string	元のマネージド HSM のリソース ID。
purgeProtectionEnabled	boolean	元のマネージド HSM の保護状態を消去します。
scheduledPurgeDate	string	スケジュールされた消去日。
tags	object	元のマネージド HSM のタグ。

Error

サーバーエラー。

名前	型	説明
code	string	エラーコード。
innererror	Error	内部エラーには、より具体的なエラーコードが含まれています。
message	string	エラーメッセージ。

ManagedHsmError

エラー例外。

名前	型	説明
error	Error	サーバーエラー。