Vaults - Update

Обновление хранилища ключей в указанной подписке.

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

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

Имя группы ресурсов, к которой принадлежит сервер.

subscriptionId
path True

string

Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.

vaultName
path True

string

Имя хранилища

Regex pattern: ^[a-zA-Z0-9-]{3,24}$

api-version
query True

string

Версия API клиента.

Текст запроса

Имя Тип Описание
properties

VaultPatchProperties

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

tags

object

Теги, которые будут назначены хранилищу ключей.

Ответы

Имя Тип Описание
200 OK

Vault

Хранилище с исправлениями

201 Created

Vault

Хранилище с исправлениями

Other Status Codes

CloudError

Ответ об ошибке, описывающий причину сбоя операции.

Примеры

Update an existing vault

Sample Request

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

{
  "properties": {
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "sku": {
      "family": "A",
      "name": "standard"
    },
    "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,
    "publicNetworkAccess": "Enabled"
  }
}

Sample Response

{
  "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",
    "networkAcls": {
      "bypass": "AzureServices",
      "defaultAction": "Deny",
      "ipRules": [
        {
          "value": ""
        }
      ],
      "virtualNetworkRules": [
        {
          "id": "",
          "ignoreMissingVnetServiceEndpoint": false
        }
      ]
    },
    "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"
          ]
        }
      }
    ],
    "privateEndpointConnections": [
      {
        "id": "",
        "properties": {
          "provisioningState": "Succeeded",
          "privateEndpoint": {
            "id": ""
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "actionsRequired": "None"
          }
        }
      }
    ],
    "enabledForDeployment": true,
    "enabledForDiskEncryption": true,
    "enabledForTemplateDeployment": true,
    "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000",
    "vaultUri": "https://sample-vault.vault.azure.net",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Enabled"
  }
}
{
  "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 или None. Если значение не указано, по умолчанию используется значение AzureServices.

NetworkRuleSet

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

Permissions

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

PrivateEndpoint

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

PrivateEndpointConnectionItem

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

PrivateEndpointConnectionProvisioningState

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

PrivateEndpointServiceConnectionStatus

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

PrivateLinkServiceConnectionState

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

SecretPermissions

Разрешения на доступ к секретам

Sku

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

SkuFamily

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

SkuName

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

StoragePermissions

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

SystemData

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

Vault

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

VaultPatchParameters

Параметры для создания или обновления хранилища

VaultPatchProperties

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

VaultProperties

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

VaultProvisioningState

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

VirtualNetworkRule

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

AccessPolicyEntry

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

Имя Тип Описание
applicationId

string

Идентификатор приложения клиента, выполняющего запрос от имени участника

objectId

string

Идентификатор объекта пользователя, субъекта-службы или группы безопасности в клиенте Azure Active Directory для хранилища. Идентификатор объекта должен быть уникальным для списка политик доступа.

permissions

Permissions

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

tenantId

string

Идентификатор клиента Azure Active Directory, который следует использовать для проверки подлинности запросов к хранилищу ключей.

ActionsRequired

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

Имя Тип Описание
None

string

CertificatePermissions

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

Имя Тип Описание
all

string

backup

string

create

string

delete

string

deleteissuers

string

get

string

getissuers

string

import

string

list

string

listissuers

string

managecontacts

string

manageissuers

string

purge

string

recover

string

restore

string

setissuers

string

update

string

CloudError

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

Имя Тип Описание
error

CloudErrorBody

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

CloudErrorBody

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

Имя Тип Описание
code

string

Код ошибки. Это мнемоник, который можно использовать программным способом.

message

string

Понятное сообщение об ошибке. Сообщение обычно локализовано и может отличаться в зависимости от версии службы.

CreateMode

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

Имя Тип Описание
default

string

recover

string

identityType

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

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

IPRule

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

Имя Тип Описание
value

string

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

KeyPermissions

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

Имя Тип Описание
all

string

backup

string

create

string

decrypt

string

delete

string

encrypt

string

get

string

getrotationpolicy

string

import

string

list

string

purge

string

recover

string

release

string

restore

string

rotate

string

setrotationpolicy

string

sign

string

unwrapKey

string

update

string

verify

string

wrapKey

string

NetworkRuleAction

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

Имя Тип Описание
Allow

string

Deny

string

NetworkRuleBypassOptions

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

Имя Тип Описание
AzureServices

string

None

string

NetworkRuleSet

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

Имя Тип Описание
bypass

NetworkRuleBypassOptions

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

defaultAction

NetworkRuleAction

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

ipRules

IPRule[]

Список правил IP-адресов.

virtualNetworkRules

VirtualNetworkRule[]

Список правил виртуальной сети.

Permissions

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

Имя Тип Описание
certificates

CertificatePermissions[]

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

keys

KeyPermissions[]

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

secrets

SecretPermissions[]

Разрешения на доступ к секретам

storage

StoragePermissions[]

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

PrivateEndpoint

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

Имя Тип Описание
id

string

Полный идентификатор ресурса частной конечной точки.

PrivateEndpointConnectionItem

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

Имя Тип Описание
etag

string

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

id

string

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

properties.privateEndpoint

PrivateEndpoint

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

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Состояние утверждения подключения к приватному каналу.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

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

PrivateEndpointConnectionProvisioningState

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

Имя Тип Описание
Creating

string

Deleting

string

Disconnected

string

Failed

string

Succeeded

string

Updating

string

PrivateEndpointServiceConnectionStatus

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

Имя Тип Описание
Approved

string

Disconnected

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

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

Имя Тип Описание
actionsRequired

ActionsRequired

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

description

string

Причина утверждения или отклонения.

status

PrivateEndpointServiceConnectionStatus

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

SecretPermissions

Разрешения на доступ к секретам

Имя Тип Описание
all

string

backup

string

delete

string

get

string

list

string

purge

string

recover

string

restore

string

set

string

Sku

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

Имя Тип Описание
family

SkuFamily

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

name

SkuName

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

SkuFamily

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

Имя Тип Описание
A

string

SkuName

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

Имя Тип Описание
premium

string

standard

string

StoragePermissions

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

Имя Тип Описание
all

string

backup

string

delete

string

deletesas

string

get

string

getsas

string

list

string

listsas

string

purge

string

recover

string

regeneratekey

string

restore

string

set

string

setsas

string

update

string

SystemData

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

Имя Тип Описание
createdAt

string

Метка времени создания ресурса хранилища ключей (UTC).

createdBy

string

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

createdByType

identityType

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

lastModifiedAt

string

Метка времени последнего изменения ресурса хранилища ключей (UTC).

lastModifiedBy

string

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

lastModifiedByType

identityType

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

Vault

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

Имя Тип Описание
id

string

Полный идентификатор ресурса хранилища ключей.

location

string

Расположение ресурса хранилища ключей в Azure.

name

string

Имя ресурса хранилища ключей.

properties

VaultProperties

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

systemData

SystemData

Системные метаданные для хранилища ключей.

tags

object

Теги, назначенные ресурсу хранилища ключей.

type

string

Тип ресурса хранилища ключей.

VaultPatchParameters

Параметры для создания или обновления хранилища

Имя Тип Описание
properties

VaultPatchProperties

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

tags

object

Теги, которые будут назначены хранилищу ключей.

VaultPatchProperties

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

Имя Тип Описание
accessPolicies

AccessPolicyEntry[]

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

createMode

CreateMode

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

enablePurgeProtection

boolean

Свойство, указывающее, включена ли защита от очистки для этого хранилища. Если задать для этого свойства значение true, активируется защита от очистки для этого хранилища и его содержимого. Только служба Key Vault может инициировать жесткое, неустранимое удаление. Параметр действует только в том случае, если также включено обратимое удаление. Включение этой функции необратимо, то есть свойство не принимает значение false.

enableRbacAuthorization

boolean

Свойство, которое управляет авторизацией действий с данными. Если значение равно true, хранилище ключей будет использовать контроль доступа на основе ролей (RBAC) для авторизации действий с данными, а политики доступа, указанные в свойствах хранилища, будут игнорироваться. Если задано значение false, хранилище ключей будет использовать политики доступа, указанные в свойствах хранилища, а все политики, хранящиеся в Azure Resource Manager, будут игнорироваться. Если значение null или не указано, значение этого свойства не изменится.

enableSoftDelete

boolean

Свойство , указываемое, включена ли функция обратимого удаления для этого хранилища ключей. Если задано значение true, его нельзя вернуть к false.

enabledForDeployment

boolean

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

enabledForDiskEncryption

boolean

Свойство , которое указывает, разрешено ли шифрованию дисков Azure извлекать секреты из хранилища и распаковывать ключи.

enabledForTemplateDeployment

boolean

Свойство, указываемое, разрешено ли Resource Manager Azure получать секреты из хранилища ключей.

networkAcls

NetworkRuleSet

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

publicNetworkAccess

string

Свойство, указываемое, будет ли хранилище принимать трафик из общедоступного Интернета. Если задано значение "отключено", весь трафик, кроме трафика частной конечной точки, и тот, который поступает из доверенных служб, будет заблокирован. Это переопределит заданные правила брандмауэра. Это означает, что даже при наличии правил брандмауэра мы не будем соблюдать правила.

sku

Sku

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

softDeleteRetentionInDays

integer

softDelete data retention days. Он принимает >значения =7 и <=90.

tenantId

string

Идентификатор клиента Azure Active Directory, который следует использовать для проверки подлинности запросов к хранилищу ключей.

VaultProperties

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

Имя Тип Значение по умолчанию Описание
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

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

enabledForDiskEncryption

boolean

Свойство , которое указывает, разрешено ли шифрованию дисков Azure извлекать секреты из хранилища и распаковывать ключи.

enabledForTemplateDeployment

boolean

Свойство, указываемое, разрешено ли Resource Manager Azure получать секреты из хранилища ключей.

hsmPoolResourceId

string

Идентификатор ресурса пула HSM.

networkAcls

NetworkRuleSet

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

privateEndpointConnections

PrivateEndpointConnectionItem[]

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

provisioningState

VaultProvisioningState

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

publicNetworkAccess

string

enabled

Свойство, указываемое, будет ли хранилище принимать трафик из общедоступного Интернета. Если задано значение "отключено", весь трафик, кроме трафика частной конечной точки, и тот, который поступает из доверенных служб, будет заблокирован. Это переопределит заданные правила брандмауэра. Это означает, что даже при наличии правил брандмауэра мы не будем соблюдать правила.

sku

Sku

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

softDeleteRetentionInDays

integer

90

softDelete data retention days. Он принимает >значения =7 и <=90.

tenantId

string

Идентификатор клиента Azure Active Directory, который следует использовать для проверки подлинности запросов к хранилищу ключей.

vaultUri

string

Универсальный код ресурса (URI) хранилища для выполнения операций с ключами и секретами.

VaultProvisioningState

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

Имя Тип Описание
RegisteringDns

string

Succeeded

string

VirtualNetworkRule

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

Имя Тип Описание
id

string

Полный идентификатор ресурса подсети виртуальной сети, например "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".

ignoreMissingVnetServiceEndpoint

boolean

Свойство , указывающая, будет ли NRP игнорировать проверка, если в родительской подсети настроены точки serviceEndpoints.