Vaults - Get

Служба:

Key Vault

Версия API:

2024-11-01

Получает указанное хранилище ключей Azure.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}?api-version=2024-11-01

Параметры URI

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

Ответы

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

Примеры

Retrieve a vault

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault?api-version=2024-11-01

Java

/**
 * Samples for Vaults GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/getVault.json
     */
    /**
     * Sample code: Retrieve a vault.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void retrieveAVault(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.vaults().manager().serviceClient().getVaults().getByResourceGroupWithResponse("sample-resource-group",
            "sample-vault", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python get_vault.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.vaults.get(
        resource_group_name="sample-resource-group",
        vault_name="sample-vault",
    )
    print(response)


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

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/blob/ee1eec42dcc710ff88db2d1bf574b2f9afe3d654/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/getVault.json
func ExampleVaultsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armkeyvault.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVaultsClient().Get(ctx, "sample-resource-group", "sample-vault", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Vault = armkeyvault.Vault{
	// 	Name: to.Ptr("sample-vault"),
	// 	Type: to.Ptr("Microsoft.KeyVault/vaults"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault"),
	// 	Location: to.Ptr("westus"),
	// 	Properties: &armkeyvault.VaultProperties{
	// 		AccessPolicies: []*armkeyvault.AccessPolicyEntry{
	// 			{
	// 				ObjectID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 				Permissions: &armkeyvault.Permissions{
	// 					Certificates: []*armkeyvault.CertificatePermissions{
	// 						to.Ptr(armkeyvault.CertificatePermissionsGet),
	// 						to.Ptr(armkeyvault.CertificatePermissionsList),
	// 						to.Ptr(armkeyvault.CertificatePermissionsDelete),
	// 						to.Ptr(armkeyvault.CertificatePermissionsCreate),
	// 						to.Ptr(armkeyvault.CertificatePermissionsImport),
	// 						to.Ptr(armkeyvault.CertificatePermissionsUpdate),
	// 						to.Ptr(armkeyvault.CertificatePermissionsManagecontacts),
	// 						to.Ptr(armkeyvault.CertificatePermissionsGetissuers),
	// 						to.Ptr(armkeyvault.CertificatePermissionsListissuers),
	// 						to.Ptr(armkeyvault.CertificatePermissionsSetissuers),
	// 						to.Ptr(armkeyvault.CertificatePermissionsDeleteissuers),
	// 						to.Ptr(armkeyvault.CertificatePermissionsManageissuers),
	// 						to.Ptr(armkeyvault.CertificatePermissionsRecover),
	// 						to.Ptr(armkeyvault.CertificatePermissionsPurge)},
	// 						Keys: []*armkeyvault.KeyPermissions{
	// 							to.Ptr(armkeyvault.KeyPermissionsEncrypt),
	// 							to.Ptr(armkeyvault.KeyPermissionsDecrypt),
	// 							to.Ptr(armkeyvault.KeyPermissionsWrapKey),
	// 							to.Ptr(armkeyvault.KeyPermissionsUnwrapKey),
	// 							to.Ptr(armkeyvault.KeyPermissionsSign),
	// 							to.Ptr(armkeyvault.KeyPermissionsVerify),
	// 							to.Ptr(armkeyvault.KeyPermissionsGet),
	// 							to.Ptr(armkeyvault.KeyPermissionsList),
	// 							to.Ptr(armkeyvault.KeyPermissionsCreate),
	// 							to.Ptr(armkeyvault.KeyPermissionsUpdate),
	// 							to.Ptr(armkeyvault.KeyPermissionsImport),
	// 							to.Ptr(armkeyvault.KeyPermissionsDelete),
	// 							to.Ptr(armkeyvault.KeyPermissionsBackup),
	// 							to.Ptr(armkeyvault.KeyPermissionsRestore),
	// 							to.Ptr(armkeyvault.KeyPermissionsRecover),
	// 							to.Ptr(armkeyvault.KeyPermissionsPurge)},
	// 							Secrets: []*armkeyvault.SecretPermissions{
	// 								to.Ptr(armkeyvault.SecretPermissionsGet),
	// 								to.Ptr(armkeyvault.SecretPermissionsList),
	// 								to.Ptr(armkeyvault.SecretPermissionsSet),
	// 								to.Ptr(armkeyvault.SecretPermissionsDelete),
	// 								to.Ptr(armkeyvault.SecretPermissionsBackup),
	// 								to.Ptr(armkeyvault.SecretPermissionsRestore),
	// 								to.Ptr(armkeyvault.SecretPermissionsRecover),
	// 								to.Ptr(armkeyvault.SecretPermissionsPurge)},
	// 							},
	// 							TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 					}},
	// 					EnabledForDeployment: to.Ptr(true),
	// 					EnabledForDiskEncryption: to.Ptr(true),
	// 					EnabledForTemplateDeployment: to.Ptr(true),
	// 					HsmPoolResourceID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 					ProvisioningState: to.Ptr(armkeyvault.VaultProvisioningStateSucceeded),
	// 					PublicNetworkAccess: to.Ptr("Enabled"),
	// 					SKU: &armkeyvault.SKU{
	// 						Name: to.Ptr(armkeyvault.SKUNameStandard),
	// 						Family: to.Ptr(armkeyvault.SKUFamilyA),
	// 					},
	// 					TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 					VaultURI: to.Ptr("https://sample-vault.vault.azure.net"),
	// 				},
	// 				SystemData: &armkeyvault.SystemData{
	// 					CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
	// 					CreatedBy: to.Ptr("keyVaultUser1"),
	// 					CreatedByType: to.Ptr(armkeyvault.IdentityTypeUser),
	// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
	// 					LastModifiedBy: to.Ptr("keyVaultUser2"),
	// 					LastModifiedByType: to.Ptr(armkeyvault.IdentityTypeUser),
	// 				},
	// 				Tags: map[string]*string{
	// 				},
	// 			}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { KeyVaultManagementClient } = require("@azure/arm-keyvault");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets the specified Azure key vault.
 *
 * @summary Gets the specified Azure key vault.
 * x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/getVault.json
 */
async function retrieveAVault() {
  const subscriptionId =
    process.env["KEYVAULT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["KEYVAULT_RESOURCE_GROUP"] || "sample-resource-group";
  const vaultName = "sample-vault";
  const credential = new DefaultAzureCredential();
  const client = new KeyVaultManagementClient(credential, subscriptionId);
  const result = await client.vaults.get(resourceGroupName, vaultName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.KeyVault.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.KeyVault;

// Generated from example definition: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/getVault.json
// this example is just showing the usage of "Vaults_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "sample-resource-group";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this KeyVaultResource
KeyVaultCollection collection = resourceGroupResource.GetKeyVaults();

// invoke the operation
string vaultName = "sample-vault";
NullableResponse<KeyVaultResource> response = await collection.GetIfExistsAsync(vaultName);
KeyVaultResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    KeyVaultData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

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

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault",
  "name": "sample-vault",
  "type": "Microsoft.KeyVault/vaults",
  "location": "westus",
  "tags": {},
  "systemData": {
    "createdBy": "keyVaultUser1",
    "createdByType": "User",
    "createdAt": "2020-01-01T12:00:00.0000000Z",
    "lastModifiedBy": "keyVaultUser2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-01T12:00:00.0000000Z"
  },
  "properties": {
    "sku": {
      "family": "A",
      "name": "standard"
    },
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "accessPolicies": [
      {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "permissions": {
          "keys": [
            "encrypt",
            "decrypt",
            "wrapKey",
            "unwrapKey",
            "sign",
            "verify",
            "get",
            "list",
            "create",
            "update",
            "import",
            "delete",
            "backup",
            "restore",
            "recover",
            "purge"
          ],
          "secrets": [
            "get",
            "list",
            "set",
            "delete",
            "backup",
            "restore",
            "recover",
            "purge"
          ],
          "certificates": [
            "get",
            "list",
            "delete",
            "create",
            "import",
            "update",
            "managecontacts",
            "getissuers",
            "listissuers",
            "setissuers",
            "deleteissuers",
            "manageissuers",
            "recover",
            "purge"
          ]
        }
      }
    ],
    "enabledForDeployment": true,
    "enabledForDiskEncryption": true,
    "enabledForTemplateDeployment": true,
    "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000",
    "vaultUri": "https://sample-vault.vault.azure.net",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Enabled"
  }
}

Определения

Имя	Описание
AccessPolicyEntry	Удостоверение, имеющее доступ к хранилищу ключей. Все удостоверения в массиве должны использовать тот же идентификатор клиента, что и идентификатор клиента хранилища ключей.
ActionsRequired	Сообщение, указывающее, требуются ли изменения в поставщике услуг, требуются какие-либо обновления для потребителя.
CertificatePermissions	Разрешения на сертификаты
CloudError	Ответ об ошибке от поставщика ресурсов Key Vault
CloudErrorBody	Ответ об ошибке от поставщика ресурсов Key Vault
CreateMode	Режим создания хранилища, указывающий, требуется ли восстановить хранилище.
identityType	Тип удостоверения, создавшего ресурс хранилища ключей.
IPRule	Правило, регулирующее доступность хранилища с определенного IP-адреса или диапазона IP-адресов.
KeyPermissions	Разрешения на ключи
NetworkRuleAction	Действие по умолчанию, если правило из ipRules и из virtualNetworkRules не совпадает. Это используется только после оценки свойства обхода.
NetworkRuleBypassOptions	Указывает, какой трафик может обойти правила сети. Это может быть "AzureServices" или "Нет". Если значение по умолчанию не задано, — AzureServices.
NetworkRuleSet	Набор правил, регулирующих сетевой доступ хранилища.
Permissions	Разрешения, которые удостоверение имеет для ключей, секретов, сертификатов и хранилища.
PrivateEndpoint	Свойства объекта частной конечной точки.
PrivateEndpointConnectionItem	Элемент подключения к частной конечной точке.
PrivateEndpointConnectionProvisioningState	Текущее состояние подготовки.
PrivateEndpointServiceConnectionStatus	Состояние подключения к частной конечной точке.
PrivateLinkServiceConnectionState	Объект, представляющий состояние утверждения подключения к приватному каналу.
SecretPermissions	Разрешения на секреты
Sku	Сведения о номере SKU
SkuFamily	Имя семейства SKU
SkuName	Имя SKU, указывающее, является ли хранилище ключей стандартным хранилищем или хранилищем класса Premium.
StoragePermissions	Разрешения для учетных записей хранения
SystemData	Метаданные, относящиеся к созданию и последнему изменению ресурса хранилища ключей.
Vault	Информация о ресурсах с расширенными сведениями.
VaultProperties	Свойства хранилища
VaultProvisioningState	Состояние подготовки хранилища.
VirtualNetworkRule	Правило, регулирующее доступность хранилища из определенной виртуальной сети.

AccessPolicyEntry

Object

Удостоверение, имеющее доступ к хранилищу ключей. Все удостоверения в массиве должны использовать тот же идентификатор клиента, что и идентификатор клиента хранилища ключей.

Имя	Тип	Описание
applicationId	string (uuid)	Идентификатор приложения клиента, выполняющего запрос от имени субъекта
objectId	string	Идентификатор объекта пользователя, субъекта-службы или группы безопасности в клиенте Azure Active Directory для хранилища. Идентификатор объекта должен быть уникальным для списка политик доступа.
permissions	Permissions	Разрешения удостоверения имеются для ключей, секретов и сертификатов.
tenantId	string (uuid)	Идентификатор клиента Azure Active Directory, который следует использовать для проверки подлинности запросов к хранилищу ключей.

ActionsRequired

Перечисление

Сообщение, указывающее, требуются ли изменения в поставщике услуг, требуются какие-либо обновления для потребителя.

Значение	Описание
None

CertificatePermissions

Перечисление

Разрешения на сертификаты

Значение	Описание
all
get
list
delete
create
import
update
managecontacts
getissuers
listissuers
setissuers
deleteissuers
manageissuers
recover
purge
backup
restore

CloudError

Object

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

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

CloudErrorBody

Object

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

Имя	Тип	Описание
code	string	Код ошибки. Это мнемосхема, которую можно использовать программно.
message	string	Понятное сообщение об ошибке. Сообщение обычно локализовано и может различаться в зависимости от версии службы.

CreateMode

Перечисление

Режим создания хранилища, указывающий, требуется ли восстановить хранилище.

Значение	Описание
recover
default

identityType

Перечисление

Тип удостоверения, создавшего ресурс хранилища ключей.

Значение	Описание
User
Application
ManagedIdentity
Key

IPRule

Object

Правило, регулирующее доступность хранилища с определенного IP-адреса или диапазона IP-адресов.

Имя	Тип	Описание
value	string	Диапазон адресов IPv4 в нотации CIDR, например "124.56.78.91" (простой IP-адрес) или "124.56.78.0/24" (все адреса, начинающиеся с 124.56.78).

KeyPermissions

Перечисление

Разрешения на ключи

Значение	Описание
all
encrypt
decrypt
wrapKey
unwrapKey
sign
verify
get
list
create
update
import
delete
backup
restore
recover
purge
release
rotate
getrotationpolicy
setrotationpolicy

NetworkRuleAction

Перечисление

Действие по умолчанию, если правило из ipRules и из virtualNetworkRules не совпадает. Это используется только после оценки свойства обхода.

Значение	Описание
Allow
Deny

NetworkRuleBypassOptions

Перечисление

Указывает, какой трафик может обойти правила сети. Это может быть "AzureServices" или "Нет". Если значение по умолчанию не задано, — AzureServices.

Значение	Описание
AzureServices
None

NetworkRuleSet

Object

Набор правил, регулирующих сетевой доступ хранилища.

Имя	Тип	Описание
bypass	NetworkRuleBypassOptions	Указывает, какой трафик может обойти правила сети. Это может быть "AzureServices" или "Нет". Если значение по умолчанию не задано, — AzureServices.
defaultAction	NetworkRuleAction	Действие по умолчанию, если правило из ipRules и из virtualNetworkRules не совпадает. Это используется только после оценки свойства обхода.
ipRules	IPRule[]	Список правил IP-адресов.
virtualNetworkRules	VirtualNetworkRule[]	Список правил виртуальной сети.

Permissions

Object

Разрешения, которые удостоверение имеет для ключей, секретов, сертификатов и хранилища.

Имя	Тип	Описание
certificates	CertificatePermissions[]	Разрешения на сертификаты
keys	KeyPermissions[]	Разрешения на ключи
secrets	SecretPermissions[]	Разрешения на секреты
storage	StoragePermissions[]	Разрешения для учетных записей хранения

PrivateEndpoint

Object

Свойства объекта частной конечной точки.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса частной конечной точки.

PrivateEndpointConnectionItem

Object

Элемент подключения к частной конечной точке.

Имя	Тип	Описание
etag	string	Изменяется всякий раз при изменении состояния подключения к частной конечной точке.
id	string	Идентификатор подключения к частной конечной точке.
properties.privateEndpoint	PrivateEndpoint	Свойства объекта частной конечной точки.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Состояние утверждения подключения приватного канала.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Состояние подготовки подключения к частной конечной точке.

PrivateEndpointConnectionProvisioningState

Перечисление

Текущее состояние подготовки.

Значение	Описание
Succeeded
Creating
Updating
Deleting
Failed
Disconnected

PrivateEndpointServiceConnectionStatus

Перечисление

Состояние подключения к частной конечной точке.

Значение	Описание
Pending
Approved
Rejected
Disconnected

PrivateLinkServiceConnectionState

Object

Объект, представляющий состояние утверждения подключения к приватному каналу.

Имя	Тип	Описание
actionsRequired	ActionsRequired	Сообщение, указывающее, требуются ли изменения в поставщике услуг, требуются какие-либо обновления для потребителя.
description	string	Причина утверждения или отклонения.
status	PrivateEndpointServiceConnectionStatus	Указывает, утверждено ли подключение, отклонено или удалено владельцем хранилища ключей.

SecretPermissions

Перечисление

Разрешения на секреты

Значение	Описание
all
get
list
set
delete
backup
restore
recover
purge

Sku

Object

Сведения о номере SKU

Имя	Тип	Описание
family	SkuFamily	Имя семейства SKU
name	SkuName	Имя SKU, указывающее, является ли хранилище ключей стандартным хранилищем или хранилищем класса Premium.

SkuFamily

Перечисление

Имя семейства SKU

Значение	Описание
A

SkuName

Перечисление

Имя SKU, указывающее, является ли хранилище ключей стандартным хранилищем или хранилищем класса Premium.

Значение	Описание
standard
premium

StoragePermissions

Перечисление

Разрешения для учетных записей хранения

Значение	Описание
all
get
list
delete
set
update
regeneratekey
recover
purge
backup
restore
setsas
listsas
getsas
deletesas

SystemData

Object

Метаданные, относящиеся к созданию и последнему изменению ресурса хранилища ключей.

Имя	Тип	Описание
createdAt	string (date-time)	Временная метка создания ресурса хранилища ключей (UTC).
createdBy	string	Удостоверение, создавшее ресурс хранилища ключей.
createdByType	identityType	Тип удостоверения, создавшего ресурс хранилища ключей.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса хранилища ключей (UTC).
lastModifiedBy	string	Удостоверение, которое последним изменило ресурс хранилища ключей.
lastModifiedByType	identityType	Тип удостоверения, которое последним изменило ресурс хранилища ключей.

Vault

Object

Информация о ресурсах с расширенными сведениями.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса хранилища ключей.
location	string	Расположение ресурса хранилища ключей в Azure.
name	string	Имя ресурса хранилища ключей.
properties	VaultProperties	Свойства хранилища
systemData	SystemData	Системные метаданные для хранилища ключей.
tags	object	Теги, назначенные ресурсу хранилища ключей.
type	string	Тип ресурса хранилища ключей.

VaultProperties

Object

Свойства хранилища

Имя	Тип	Default value	Описание
accessPolicies	AccessPolicyEntry[]		Массив 0–1024 удостоверений, имеющих доступ к хранилищу ключей. Все удостоверения в массиве должны использовать тот же идентификатор клиента, что и идентификатор клиента хранилища ключей. Если createMode задано значение recover, политики доступа не требуются. В противном случае требуются политики доступа.
createMode	CreateMode		Режим создания хранилища, указывающий, требуется ли восстановить хранилище.
enablePurgeProtection	boolean		Свойство, указывающее, включена ли защита от очистки для этого хранилища. Установка этого свойства на значение true активирует защиту от очистки для этого хранилища и его содержимого. Только служба Key Vault может инициировать жесткое, безвозвратное удаление. Параметр действует только в том случае, если обратимое удаление также включено. Включение этой функции необратимо. Т. е. свойство не принимает значение false в качестве значения.
enableRbacAuthorization	boolean	False	Свойство, определяющее, как разрешены действия с данными. Если значение true, хранилище ключей будет использовать управление доступом на основе ролей (RBAC) для авторизации действий с данными, а политики доступа, указанные в свойствах хранилища, будут игнорироваться. Если значение false, хранилище ключей будет использовать политики доступа, указанные в свойствах хранилища, и любые политики, хранящиеся в Azure Resource Manager, будут игнорироваться. Если значение NULL или не указано, хранилище создается со значением false по умолчанию. Обратите внимание, что действия управления всегда авторизованы с помощью RBAC.
enableSoftDelete	boolean	True	Свойство, указываемое, включена ли функция обратимого удаления для этого хранилища ключей. Если при создании нового хранилища ключей не задано значение (true или false), по умолчанию оно будет иметь значение true. Если задано значение true, его нельзя вернуть к false.
enabledForDeployment	boolean	False	Свойство, указываемое, разрешены ли виртуальные машины Azure получать сертификаты, хранящиеся в виде секретов из хранилища ключей.
enabledForDiskEncryption	boolean	False	Свойство, указываемое, разрешено ли шифрование дисков Azure извлекать секреты из хранилища и распаковывать ключи.
enabledForTemplateDeployment	boolean	False	Свойство, указываемое, разрешено ли Azure Resource Manager получать секреты из хранилища ключей.
hsmPoolResourceId	string		Идентификатор ресурса пула HSM.
networkAcls	NetworkRuleSet		Правила, управляющие специальными возможностями хранилища ключей из определенных сетевых расположений.
privateEndpointConnections	PrivateEndpointConnectionItem[]		Список подключений к частным конечным точкам, связанных с хранилищем ключей.
provisioningState	VaultProvisioningState		Состояние подготовки хранилища.
publicNetworkAccess	string	enabled	Свойство, указываемое, будет ли хранилище принимать трафик из общедоступного Интернета. Если задано значение "отключено" весь трафик, кроме трафика частной конечной точки, и то, что происходит из доверенных служб, будет заблокировано. Это переопределит установленные правила брандмауэра, что означает, что даже если правила брандмауэра присутствуют, мы не будем учитывать правила.
sku	Sku		Сведения о номере SKU
softDeleteRetentionInDays	integer (int32)	90	Дни хранения данных softDelete. Он принимает >=7 и <=90.
tenantId	string (uuid)		Идентификатор клиента Azure Active Directory, который следует использовать для проверки подлинности запросов к хранилищу ключей.
vaultUri	string		Универсальный код ресурса (URI) хранилища для выполнения операций с ключами и секретами.

VaultProvisioningState

Перечисление

Состояние подготовки хранилища.

Значение	Описание
Succeeded
RegisteringDns

VirtualNetworkRule

Object

Правило, регулирующее доступность хранилища из определенной виртуальной сети.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса подсети виртуальной сети, например "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".
ignoreMissingVnetServiceEndpoint	boolean	Свойство, указываемое, будет ли NRP игнорировать проверку, настроена ли родительская подсеть serviceEndpoints.