Vaults - Update Access Policy

Referenz

Service:: Key Vault

API Version:: 2022-07-01

Aktualisieren Sie Zugriffsrichtlinien in einem Schlüsseltresor im angegebenen Abonnement.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
operationKind	path	True	AccessPolicyUpdateKind	Name des Vorgangs.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, zu der der Tresor gehört.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
vaultName	path	True	string	Name des Tresors Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties	True	VaultAccessPolicyProperties	Eigenschaften der Zugriffsrichtlinie

Antworten

Name	Typ	Beschreibung
200 OK	VaultAccessPolicyParameters	Die aktualisierten Zugriffsrichtlinien
201 Created	VaultAccessPolicyParameters	Die aktualisierten Zugriffsrichtlinien
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Beispiele

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

Definitionen

Name	Beschreibung
AccessPolicyEntry	Eine Identität, die Zugriff auf den Schlüsseltresor hat. Alle Identitäten im Array müssen dieselbe Mandanten-ID wie die Mandanten-ID des Schlüsseltresors verwenden.
AccessPolicyUpdateKind	Name des Vorgangs.
CertificatePermissions	Berechtigungen für Zertifikate
CloudError	Eine Fehlerantwort von Key Vault Ressourcenanbieter
CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter
KeyPermissions	Berechtigungen für Schlüssel
Permissions	Berechtigungen, die die Identität für Schlüssel, Geheimnisse, Zertifikate und Speicher hat.
SecretPermissions	Berechtigungen für Geheimnisse
StoragePermissions	Berechtigungen für Speicherkonten
VaultAccessPolicyParameters	Parameter zum Aktualisieren der Zugriffsrichtlinie in einem Tresor
VaultAccessPolicyProperties	Eigenschaften der Tresorzugriffsrichtlinie

AccessPolicyEntry

Eine Identität, die Zugriff auf den Schlüsseltresor hat. Alle Identitäten im Array müssen dieselbe Mandanten-ID wie die Mandanten-ID des Schlüsseltresors verwenden.

Name	Typ	Beschreibung
applicationId	string	Anwendungs-ID des Clients, der eine Anforderung im Auftrag eines Prinzipals stellt
objectId	string	Die Objekt-ID eines Benutzers, Eines Dienstprinzipals oder einer Sicherheitsgruppe im Azure Active Directory-Mandanten für den Tresor. Die Objekt-ID muss für die Liste der Zugriffsrichtlinien eindeutig sein.
permissions	Permissions	Berechtigungen, über die die Identität für Schlüssel, Geheimnisse und Zertifikate verfügt.
tenantId	string	Die Azure Active Directory-Mandanten-ID, die zum Authentifizieren von Anforderungen an den Schlüsseltresor verwendet werden soll.

AccessPolicyUpdateKind

Name des Vorgangs.

Name	Typ	Beschreibung
add	string
remove	string
replace	string

CertificatePermissions

Berechtigungen für Zertifikate

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

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter

CloudErrorBody

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name	Typ	Beschreibung
code	string	Fehlercode Dies ist ein mnemonisches, das programmgesteuert genutzt werden kann.
message	string	Benutzerfreundliche Fehlermeldung. Die Nachricht ist in der Regel lokalisiert und kann je nach Dienstversion variieren.

KeyPermissions

Berechtigungen für Schlüssel

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

Berechtigungen, die die Identität für Schlüssel, Geheimnisse, Zertifikate und Speicher hat.

Name	Typ	Beschreibung
certificates	CertificatePermissions[]	Berechtigungen für Zertifikate
keys	KeyPermissions[]	Berechtigungen für Schlüssel
secrets	SecretPermissions[]	Berechtigungen für Geheimnisse
storage	StoragePermissions[]	Berechtigungen für Speicherkonten

SecretPermissions

Berechtigungen für Geheimnisse

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

StoragePermissions

Berechtigungen für Speicherkonten

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

Parameter zum Aktualisieren der Zugriffsrichtlinie in einem Tresor

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID der Zugriffsrichtlinie.
location	string	Der Ressourcentyp der Zugriffsrichtlinie.
name	string	Der Ressourcenname der Zugriffsrichtlinie.
properties	VaultAccessPolicyProperties	Eigenschaften der Zugriffsrichtlinie
type	string	Der Ressourcenname der Zugriffsrichtlinie.

VaultAccessPolicyProperties

Eigenschaften der Tresorzugriffsrichtlinie

Name	Typ	Beschreibung
accessPolicies	AccessPolicyEntry[]	Ein Array von 0 bis 16 Identitäten, die Zugriff auf den Schlüsseltresor haben. Alle Identitäten im Array müssen dieselbe Mandanten-ID wie die Mandanten-ID des Schlüsseltresors verwenden.