Vaults - List By Resource Group

Ссылка

Service:: Key Vault

API Version:: 2021-10-01

Операция list получает сведения о хранилищах, связанных с подпиской, и в указанной группе ресурсов.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults?$top={$top}&api-version=2021-10-01

Параметры URI

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

Ответы

Name	Type	Description
200 OK	VaultListResult	Получение сведений обо всех хранилищах ключей в указанной группе ресурсов.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Примеры

List vaults in the specified resource group

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults?$top=1&api-version=2021-10-01

package armkeyvault_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/listVaultByResourceGroup.json
func ExampleVaultsClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armkeyvault.NewVaultsClient("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourceGroupPager("sample-group",
		&armkeyvault.VaultsClientListByResourceGroupOptions{Top: to.Ptr[int32](1)})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-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": "premium"
        },
        "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,
        "enableSoftDelete": true,
        "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000",
        "vaultUri": "https://sample-vault.vault.azure.net/",
        "provisioningState": "Succeeded"
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults?api-version=2021-10-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}

Определения

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

AccessPolicyEntry

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

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

ActionsRequired

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

Name	Type	Description
None	string

CloudError

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

Name	Type	Description
error	CloudErrorBody	Ответ об ошибке от поставщика ресурсов Key Vault

CloudErrorBody

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

Name	Type	Description
code	string	Код ошибки. Это mnemonic, который можно использовать программным способом.
message	string	Понятное сообщение об ошибке. Сообщение обычно локализовано и может отличаться от версии службы.

CreateMode

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

Name	Type	Description
default	string
recover	string

identityType

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

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

IPRule

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

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

NetworkRuleAction

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

Name	Type	Description
Allow	string
Deny	string

NetworkRuleBypassOptions

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

Name	Type	Description
AzureServices	string
None	string

NetworkRuleSet

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

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

Permissions

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

Name	Type	Description
certificates	string[]	Разрешения на сертификаты
keys	string[]	Разрешения на ключи
secrets	string[]	Разрешения на доступ к секретам
storage	string[]	Разрешения для учетных записей хранения

PrivateEndpoint

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

Name	Type	Description
id	string	Полный идентификатор ресурса частной конечной точки.

PrivateEndpointConnectionItem

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

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

PrivateEndpointConnectionProvisioningState

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

Name	Type	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

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

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

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

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

Sku

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

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

SkuFamily

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

Name	Type	Description
A	string

SkuName

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

Name	Type	Description
premium	string
standard	string

SystemData

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

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

Vault

Сведения о ресурсе с расширенными сведениями.

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

VaultListResult

Список хранилищ

Name	Type	Description
nextLink	string	URL-адрес для получения следующего набора хранилищ.
value	Vault[]	Список хранилищ.

VaultProperties

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

Name	Type	Default Value	Description
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 (true или false), по умолчанию оно будет иметь значение true. Если задано значение true, его нельзя вернуть к false.
enabledForDeployment	boolean		Свойство, определяющее, разрешено ли azure Виртуальные машины получать сертификаты, хранящиеся в виде секретов из хранилища ключей.
enabledForDiskEncryption	boolean		Свойство, указываемое, разрешено ли Шифрование дисков Azure извлекать секреты из хранилища и распаковывать ключи.
enabledForTemplateDeployment	boolean		Свойство, указываемое, разрешено ли azure Resource Manager получать секреты из хранилища ключей.
hsmPoolResourceId	string		Идентификатор ресурса пула HSM.
networkAcls	NetworkRuleSet		Правила, определяющие доступность хранилища ключей из определенных сетевых расположений.
privateEndpointConnections	PrivateEndpointConnectionItem[]		Список подключений к частной конечной точке, связанных с хранилищем ключей.
provisioningState	VaultProvisioningState		Состояние подготовки хранилища.
publicNetworkAccess	string	enabled	Свойство, указываемое, будет ли хранилище принимать трафик из общедоступного Интернета. Если задано значение "отключено", весь трафик, кроме трафика частной конечной точки, и это происходит из доверенных служб, будет заблокировано. При этом будут переопределяться заданные правила брандмауэра, что означает, что даже если правила брандмауэра присутствуют, мы не будем соблюдать правила.
sku	Sku		Сведения о номере SKU
softDeleteRetentionInDays	integer	90	Дни хранения данных softDelete. Он принимает >=7 и <=90.
tenantId	string		Идентификатор клиента Azure Active Directory, который следует использовать для проверки подлинности запросов к хранилищу ключей.
vaultUri	string		Универсальный код ресурса (URI) хранилища для выполнения операций с ключами и секретами.

VaultProvisioningState

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

Name	Type	Description
RegisteringDns	string
Succeeded	string

VirtualNetworkRule

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

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