Vaults - Update Access Policy

Referência

Service:: Key Vault

API Version:: 2022-07-01

Atualize as políticas de acesso num cofre de chaves na subscrição especificada.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
operationKind	path	True	AccessPolicyUpdateKind	Nome da operação
resourceGroupName	path	True	string	O nome do Grupo de Recursos ao qual o cofre pertence.
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
vaultName	path	True	string	Nome do cofre Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Versão da API do Cliente.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties	True	VaultAccessPolicyProperties	Propriedades da política de acesso

Respostas

Name	Tipo	Description
200 OK	VaultAccessPolicyParameters	As políticas de acesso atualizadas
201 Created	VaultAccessPolicyParameters	As políticas de acesso atualizadas
Other Status Codes	CloudError	Resposta de erro que descreve o motivo pela qual a operação falhou.

Exemplos

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"
          ]
        }
      }
    ]
  }
}

Definições

Name	Description
AccessPolicyEntry	Uma identidade que tem acesso ao cofre de chaves. Todas as identidades na matriz têm de utilizar o mesmo ID de inquilino que o ID de inquilino do cofre de chaves.
AccessPolicyUpdateKind	Nome da operação
CertificatePermissions	Permissões para certificados
CloudError	Uma resposta de erro do fornecedor de recursos Key Vault
CloudErrorBody	Uma resposta de erro do fornecedor de recursos Key Vault
KeyPermissions	Permissões para chaves
Permissions	Permissões que a identidade tem para chaves, segredos, certificados e armazenamento.
SecretPermissions	Permissões para segredos
StoragePermissions	Permissões para contas de armazenamento
VaultAccessPolicyParameters	Parâmetros para atualizar a política de acesso num cofre
VaultAccessPolicyProperties	Propriedades da política de acesso do cofre

AccessPolicyEntry

Uma identidade que tem acesso ao cofre de chaves. Todas as identidades na matriz têm de utilizar o mesmo ID de inquilino que o ID de inquilino do cofre de chaves.

Name	Tipo	Description
applicationId	string	ID da Aplicação do cliente que faz o pedido em nome de um principal
objectId	string	O ID de objeto de um utilizador, principal de serviço ou grupo de segurança no inquilino do Azure Active Directory do cofre. O ID do objeto tem de ser exclusivo para a lista de políticas de acesso.
permissions	Permissions	Permissões que a identidade tem para chaves, segredos e certificados.
tenantId	string	O ID de inquilino do Azure Active Directory que deve ser utilizado para autenticar pedidos no cofre de chaves.

AccessPolicyUpdateKind

Nome da operação

Name	Tipo	Description
add	string
remove	string
replace	string

CertificatePermissions

Permissões para certificados

Name	Tipo	Description
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

Uma resposta de erro do fornecedor de recursos Key Vault

Name	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do fornecedor de recursos Key Vault

CloudErrorBody

Uma resposta de erro do fornecedor de recursos Key Vault

Name	Tipo	Description
code	string	Código de erro. Este é um mnemónico que pode ser consumido programaticamente.
message	string	Mensagem de erro amigável do utilizador. Normalmente, a mensagem é localizada e pode variar consoante a versão do serviço.

KeyPermissions

Permissões para chaves

Name	Tipo	Description
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

Permissões que a identidade tem para chaves, segredos, certificados e armazenamento.

Name	Tipo	Description
certificates	CertificatePermissions[]	Permissões para certificados
keys	KeyPermissions[]	Permissões para chaves
secrets	SecretPermissions[]	Permissões para segredos
storage	StoragePermissions[]	Permissões para contas de armazenamento

SecretPermissions

Permissões para segredos

Name	Tipo	Description
all	string
backup	string
delete	string
get	string
list	string
purge	string
recover	string
restore	string
set	string

StoragePermissions

Permissões para contas de armazenamento

Name	Tipo	Description
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

Parâmetros para atualizar a política de acesso num cofre

Name	Tipo	Description
id	string	O ID de recurso da política de acesso.
location	string	O tipo de recurso da política de acesso.
name	string	O nome do recurso da política de acesso.
properties	VaultAccessPolicyProperties	Propriedades da política de acesso
type	string	O nome do recurso da política de acesso.

VaultAccessPolicyProperties

Propriedades da política de acesso do cofre

Name	Tipo	Description
accessPolicies	AccessPolicyEntry[]	Uma matriz de 0 a 16 identidades que têm acesso ao cofre de chaves. Todas as identidades na matriz têm de utilizar o mesmo ID de inquilino que o ID de inquilino do cofre de chaves.