Vaults - Update Access Policy

Ссылка

Service:: Key Vault

API Version:: 2022-07-01

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
operationKind	path	True	AccessPolicyUpdateKind	Имя операции.
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	True	VaultAccessPolicyProperties	Свойства политики доступа

Ответы

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

Примеры

Add an access policy, or update an access policy with new permissions

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

{
  "properties": {
    "accessPolicies": [
      {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "permissions": {
          "keys": [
            "encrypt"
          ],
          "secrets": [
            "get"
          ],
          "certificates": [
            "get"
          ]
        }
      }
    ]
  }
}

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python update_access_policies_add.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.update_access_policy(
        resource_group_name="sample-group",
        vault_name="sample-vault",
        operation_kind="add",
        parameters={
            "properties": {
                "accessPolicies": [
                    {
                        "objectId": "00000000-0000-0000-0000-000000000000",
                        "permissions": {"certificates": ["get"], "keys": ["encrypt"], "secrets": ["get"]},
                        "tenantId": "00000000-0000-0000-0000-000000000000",
                    }
                ]
            }
        },
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/updateAccessPoliciesAdd.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/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/accessPolicies/",
  "type": "Microsoft.KeyVault/vaults/accessPolicies",
  "properties": {
    "accessPolicies": [
      {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "permissions": {
          "keys": [
            "encrypt"
          ],
          "secrets": [
            "get"
          ],
          "certificates": [
            "get"
          ]
        }
      }
    ]
  }
}

Status code:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/accessPolicies/",
  "type": "Microsoft.KeyVault/vaults/accessPolicies",
  "properties": {
    "accessPolicies": [
      {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "permissions": {
          "keys": [
            "encrypt"
          ],
          "secrets": [
            "get"
          ],
          "certificates": [
            "get"
          ]
        }
      }
    ]
  }
}

Определения

Имя	Описание
AccessPolicyEntry	Удостоверение, которое имеет доступ к хранилищу ключей. Все удостоверения в массиве должны использовать тот же идентификатор клиента, что и идентификатор клиента хранилища ключей.
AccessPolicyUpdateKind	Имя операции.
CertificatePermissions	Разрешения для сертификатов
CloudError	Ответ об ошибке от поставщика ресурсов Key Vault
CloudErrorBody	Ответ об ошибке от поставщика ресурсов Key Vault
KeyPermissions	Разрешения для ключей
Permissions	Разрешения, которые удостоверение имеет для ключей, секретов, сертификатов и хранилища.
SecretPermissions	Разрешения на доступ к секретам
StoragePermissions	Разрешения для учетных записей хранения
VaultAccessPolicyParameters	Параметры для обновления политики доступа в хранилище
VaultAccessPolicyProperties	Свойства политики доступа к хранилищу

AccessPolicyEntry

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

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

AccessPolicyUpdateKind

Имя операции.

Имя	Тип	Описание
add	string
remove	string
replace	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	Понятное сообщение об ошибке. Сообщение обычно локализовано и может отличаться в зависимости от версии службы.

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

Permissions

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

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

SecretPermissions

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

Имя	Тип	Описание
all	string
backup	string
delete	string
get	string
list	string
purge	string
recover	string
restore	string
set	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

VaultAccessPolicyParameters

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

Имя	Тип	Описание
id	string	Идентификатор ресурса политики доступа.
location	string	Тип ресурса политики доступа.
name	string	Имя ресурса политики доступа.
properties	VaultAccessPolicyProperties	Свойства политики доступа
type	string	Имя ресурса политики доступа.

VaultAccessPolicyProperties

Свойства политики доступа к хранилищу

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