Managed Hsms - Get Deleted

Service:

Key Vault

API Version:

2021-10-01

Возвращает указанный удаленный управляемый модуль HSM.

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

Параметры URI

Name	In	Required	Type	Description
location	path	True	string	Расположение удаленного управляемого устройства HSM.
name	path	True	string	Имя удаленного управляемого устройства HSM.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют Microsoft Azure подписке. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия клиентского API.

Ответы

Name	Type	Description
200 OK	DeletedManagedHsm	Извлекаются сведения об указанном удаленном управляемом устройстве HSM.
Other Status Codes	ManagedHsmError	Ответ об ошибке, описывающий причину сбоя операции.

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

azure_auth

Flow OAuth2 Azure Active Directory

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

Scopes

Name	Description
user_impersonation	олицетворения учетной записи пользователя

Примеры

Retrieve a deleted managed HSM

Sample Request

HTTP

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

Go

package armkeyvault_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2021-10-01/examples/DeletedManagedHsm_Get.json
func ExampleManagedHsmsClient_GetDeleted() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armkeyvault.NewManagedHsmsClient("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.GetDeleted(ctx,
		"hsm1",
		"westus",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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

Name	Type	Description
id	string	Идентификатор ресурса Azure Resource Manager для удаленного управляемого пула HSM.
name	string	Имя управляемого пула HSM.
properties	DeletedManagedHsmProperties	Свойства удаленного управляемого модуля HSM
type	string	Тип ресурса управляемого пула HSM.

DeletedManagedHsmProperties

Свойства удаленного управляемого модуля HSM.

Name	Type	Description
deletionDate	string	Дата удаления.
location	string	Расположение исходного управляемого устройства HSM.
mhsmId	string	Идентификатор ресурса исходного управляемого устройства HSM.
purgeProtectionEnabled	boolean	Состояние защиты от очистки исходного управляемого устройства HSM.
scheduledPurgeDate	string	Запланированная дата очистки.
tags	object	Теги исходного управляемого модуля HSM.

Error

Ошибка сервера.

Name	Type	Description
code	string	Код ошибки.
innererror	Error	Внутренняя ошибка содержит более конкретный код ошибки.
message	string	Сообщение об ошибке.

ManagedHsmError

Исключение в результате ошибки.

Name	Type	Description
error	Error	Ошибка сервера.