Vaults - Update Access Policy

Referencia

Service:: Key Vault

API Version:: 2022-07-01

Actualice las directivas de acceso en un almacén de claves de la suscripción especificada.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
operationKind	path	True	AccessPolicyUpdateKind	Nombre de la operación
resourceGroupName	path	True	string	Nombre del grupo de recursos al que pertenece el almacén.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
vaultName	path	True	string	Nombre del almacén Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Versión de api de cliente.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties	True	VaultAccessPolicyProperties	Propiedades de la directiva de acceso

Respuestas

Nombre	Tipo	Description
200 OK	VaultAccessPolicyParameters	Las directivas de acceso actualizadas
201 Created	VaultAccessPolicyParameters	Las directivas de acceso actualizadas
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Ejemplos

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

Definiciones

Nombre	Description
AccessPolicyEntry	Identidad que tiene acceso al almacén de claves. Todas las identidades de la matriz deben usar el mismo identificador de inquilino que el identificador de inquilino del almacén de claves.
AccessPolicyUpdateKind	Nombre de la operación
CertificatePermissions	Permisos para certificados
CloudError	Respuesta de error del proveedor de recursos de Key Vault
CloudErrorBody	Respuesta de error del proveedor de recursos de Key Vault
KeyPermissions	Permisos para claves
Permissions	Permisos que la identidad tiene para claves, secretos, certificados y almacenamiento.
SecretPermissions	Permisos para secretos
StoragePermissions	Permisos para cuentas de almacenamiento
VaultAccessPolicyParameters	Parámetros para actualizar la directiva de acceso en un almacén
VaultAccessPolicyProperties	Propiedades de la directiva de acceso del almacén

AccessPolicyEntry

Identidad que tiene acceso al almacén de claves. Todas las identidades de la matriz deben usar el mismo identificador de inquilino que el identificador de inquilino del almacén de claves.

Nombre	Tipo	Description
applicationId	string	Identificador de aplicación del cliente que realiza una solicitud en nombre de una entidad de seguridad
objectId	string	Identificador de objeto de un usuario, una entidad de servicio o un grupo de seguridad en el inquilino de Azure Active Directory para el almacén. El identificador de objeto debe ser único para la lista de directivas de acceso.
permissions	Permissions	Permisos que la identidad tiene para claves, secretos y certificados.
tenantId	string	Identificador de inquilino de Azure Active Directory que se debe usar para autenticar solicitudes en el almacén de claves.

AccessPolicyUpdateKind

Nombre de la operación

Nombre	Tipo	Description
add	string
remove	string
replace	string

CertificatePermissions

Permisos para certificados

Nombre	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

Respuesta de error del proveedor de recursos de Key Vault

Nombre	Tipo	Description
error	CloudErrorBody	Respuesta de error del proveedor de recursos de Key Vault

CloudErrorBody

Respuesta de error del proveedor de recursos de Key Vault

Nombre	Tipo	Description
code	string	Código de error. Se trata de una mnemónica que se puede consumir mediante programación.
message	string	Mensaje de error descriptivo. El mensaje suele localizarse y puede variar con la versión del servicio.

KeyPermissions

Permisos para claves

Nombre	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

Permisos que la identidad tiene para claves, secretos, certificados y almacenamiento.

Nombre	Tipo	Description
certificates	CertificatePermissions[]	Permisos para certificados
keys	KeyPermissions[]	Permisos para claves
secrets	SecretPermissions[]	Permisos para secretos
storage	StoragePermissions[]	Permisos para cuentas de almacenamiento

SecretPermissions

Permisos para secretos

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

StoragePermissions

Permisos para cuentas de almacenamiento

Nombre	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 actualizar la directiva de acceso en un almacén

Nombre	Tipo	Description
id	string	Identificador de recurso de la directiva de acceso.
location	string	Tipo de recurso de la directiva de acceso.
name	string	Nombre del recurso de la directiva de acceso.
properties	VaultAccessPolicyProperties	Propiedades de la directiva de acceso
type	string	Nombre del recurso de la directiva de acceso.

VaultAccessPolicyProperties

Propiedades de la directiva de acceso del almacén

Nombre	Tipo	Description
accessPolicies	AccessPolicyEntry[]	Matriz de 0 a 16 identidades que tienen acceso al almacén de claves. Todas las identidades de la matriz deben usar el mismo identificador de inquilino que el identificador de inquilino del almacén de claves.