Vaults - Update Access Policy

Referens

Service:: Key Vault

API Version:: 2022-07-01

Uppdatera åtkomstprinciper i ett nyckelvalv i den angivna prenumerationen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
operationKind	path	True	AccessPolicyUpdateKind	Namnet på åtgärden
resourceGroupName	path	True	string	Namnet på den resursgrupp som valvet tillhör.
subscriptionId	path	True	string	Autentiseringsuppgifter för prenumeration som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
vaultName	path	True	string	Namn på valvet Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Obligatorisk	Typ	Description
properties	True	VaultAccessPolicyProperties	Egenskaper för åtkomstprincipen

Svar

Name	Typ	Description
200 OK	VaultAccessPolicyParameters	De uppdaterade åtkomstprinciperna
201 Created	VaultAccessPolicyParameters	De uppdaterade åtkomstprinciperna
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Exempel

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

Definitioner

Name	Description
AccessPolicyEntry	En identitet som har åtkomst till nyckelvalvet. Alla identiteter i matrisen måste använda samma klientorganisations-ID som nyckelvalvets klientorganisations-ID.
AccessPolicyUpdateKind	Namnet på åtgärden
CertificatePermissions	Behörigheter till certifikat
CloudError	Ett felsvar från Key Vault resursprovider
CloudErrorBody	Ett felsvar från Key Vault resursprovider
KeyPermissions	Behörigheter till nycklar
Permissions	Behörigheter som identiteten har för nycklar, hemligheter, certifikat och lagring.
SecretPermissions	Behörigheter till hemligheter
StoragePermissions	Behörigheter till lagringskonton
VaultAccessPolicyParameters	Parametrar för att uppdatera åtkomstprincipen i ett valv
VaultAccessPolicyProperties	Egenskaper för principen för valvåtkomst

AccessPolicyEntry

En identitet som har åtkomst till nyckelvalvet. Alla identiteter i matrisen måste använda samma klientorganisations-ID som nyckelvalvets klientorganisations-ID.

Name	Typ	Description
applicationId	string	Program-ID för klienten som begär för ett huvudkonto
objectId	string	Objekt-ID för en användare, tjänstens huvudnamn eller säkerhetsgrupp i Azure Active Directory-klientorganisationen för valvet. Objekt-ID:t måste vara unikt för listan över åtkomstprinciper.
permissions	Permissions	Behörigheter som identiteten har för nycklar, hemligheter och certifikat.
tenantId	string	Det Azure Active Directory-klientorganisations-ID som ska användas för att autentisera begäranden till nyckelvalvet.

AccessPolicyUpdateKind

Namnet på åtgärden

Name	Typ	Description
add	string
remove	string
replace	string

CertificatePermissions

Behörigheter till certifikat

Name	Typ	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

Ett felsvar från Key Vault resursprovider

Name	Typ	Description
error	CloudErrorBody	Ett felsvar från Key Vault resursprovider

CloudErrorBody

Ett felsvar från Key Vault resursprovider

Name	Typ	Description
code	string	Felkod. Detta är en mnemonic som kan konsumeras programmatiskt.
message	string	Användarvänligt felmeddelande. Meddelandet är vanligtvis lokaliserat och kan variera beroende på tjänstversion.

KeyPermissions

Behörigheter till nycklar

Name	Typ	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

Behörigheter som identiteten har för nycklar, hemligheter, certifikat och lagring.

Name	Typ	Description
certificates	CertificatePermissions[]	Behörigheter till certifikat
keys	KeyPermissions[]	Behörigheter till nycklar
secrets	SecretPermissions[]	Behörigheter till hemligheter
storage	StoragePermissions[]	Behörigheter till lagringskonton

SecretPermissions

Behörigheter till hemligheter

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

StoragePermissions

Behörigheter till lagringskonton

Name	Typ	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

Parametrar för att uppdatera åtkomstprincipen i ett valv

Name	Typ	Description
id	string	Resurs-ID för åtkomstprincipen.
location	string	Åtkomstprincipens resurstyp.
name	string	Resursnamnet för åtkomstprincipen.
properties	VaultAccessPolicyProperties	Egenskaper för åtkomstprincipen
type	string	Resursnamnet för åtkomstprincipen.

VaultAccessPolicyProperties

Egenskaper för principen för valvåtkomst

Name	Typ	Description
accessPolicies	AccessPolicyEntry[]	En matris med 0 till 16 identiteter som har åtkomst till nyckelvalvet. Alla identiteter i matrisen måste använda samma klientorganisations-ID som nyckelvalvets klientorganisations-ID.