Vaults - Update Access Policy

Odwołanie

Usługa:: Key Vault

Wersja interfejsu API:: 2022-07-01

Aktualizowanie zasad dostępu w magazynie kluczy w określonej subskrypcji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
operationKind	path	True	AccessPolicyUpdateKind	Nazwa operacji
resourceGroupName	path	True	string	Nazwa grupy zasobów, do której należy magazyn.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
vaultName	path	True	string	Nazwa magazynu Wzorzec wyrażenia regularnego: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Wymagane	Typ	Opis
properties	True	VaultAccessPolicyProperties	Właściwości zasad dostępu

Odpowiedzi

Nazwa	Typ	Opis
200 OK	VaultAccessPolicyParameters	Zaktualizowane zasady dostępu
201 Created	VaultAccessPolicyParameters	Zaktualizowane zasady dostępu
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Przykłady

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

Przykładowa odpowiedź

Kod stanu:: 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"
          ]
        }
      }
    ]
  }
}

Kod stanu:: 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"
          ]
        }
      }
    ]
  }
}

Definicje

Nazwa	Opis
AccessPolicyEntry	Tożsamość, która ma dostęp do magazynu kluczy. Wszystkie tożsamości w tablicy muszą używać tego samego identyfikatora dzierżawy co identyfikator dzierżawy magazynu kluczy.
AccessPolicyUpdateKind	Nazwa operacji
CertificatePermissions	Uprawnienia do certyfikatów
CloudError	Odpowiedź na błąd dostawcy zasobów Key Vault
CloudErrorBody	Odpowiedź na błąd dostawcy zasobów Key Vault
KeyPermissions	Uprawnienia do kluczy
Permissions	Uprawnienia tożsamości są dostępne dla kluczy, wpisów tajnych, certyfikatów i magazynu.
SecretPermissions	Uprawnienia do wpisów tajnych
StoragePermissions	Uprawnienia do kont magazynu
VaultAccessPolicyParameters	Parametry aktualizowania zasad dostępu w magazynie
VaultAccessPolicyProperties	Właściwości zasad dostępu magazynu

AccessPolicyEntry

Tożsamość, która ma dostęp do magazynu kluczy. Wszystkie tożsamości w tablicy muszą używać tego samego identyfikatora dzierżawy co identyfikator dzierżawy magazynu kluczy.

Nazwa	Typ	Opis
applicationId	string	Identyfikator aplikacji klienta wysyłającego żądanie w imieniu podmiotu zabezpieczeń
objectId	string	Identyfikator obiektu użytkownika, jednostki usługi lub grupy zabezpieczeń w dzierżawie usługi Azure Active Directory dla magazynu. Identyfikator obiektu musi być unikatowy dla listy zasad dostępu.
permissions	Permissions	Uprawnienia tożsamości są dostępne dla kluczy, wpisów tajnych i certyfikatów.
tenantId	string	Identyfikator dzierżawy usługi Azure Active Directory, który powinien być używany do uwierzytelniania żądań w magazynie kluczy.

AccessPolicyUpdateKind

Nazwa operacji

Nazwa	Typ	Opis
add	string
remove	string
replace	string

CertificatePermissions

Uprawnienia do certyfikatów

Nazwa	Typ	Opis
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

Odpowiedź na błąd dostawcy zasobów Key Vault

Nazwa	Typ	Opis
error	CloudErrorBody	Odpowiedź na błąd dostawcy zasobów Key Vault

CloudErrorBody

Odpowiedź na błąd dostawcy zasobów Key Vault

Nazwa	Typ	Opis
code	string	Kod błędu. Jest to mnemonic, który może być używany programowo.
message	string	Przyjazny dla użytkownika komunikat o błędzie. Komunikat jest zazwyczaj zlokalizowany i może się różnić w zależności od wersji usługi.

KeyPermissions

Uprawnienia do kluczy

Nazwa	Typ	Opis
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

Uprawnienia tożsamości są dostępne dla kluczy, wpisów tajnych, certyfikatów i magazynu.

Nazwa	Typ	Opis
certificates	CertificatePermissions[]	Uprawnienia do certyfikatów
keys	KeyPermissions[]	Uprawnienia do kluczy
secrets	SecretPermissions[]	Uprawnienia do wpisów tajnych
storage	StoragePermissions[]	Uprawnienia do kont magazynu

SecretPermissions

Uprawnienia do wpisów tajnych

Nazwa	Typ	Opis
all	string
backup	string
delete	string
get	string
list	string
purge	string
recover	string
restore	string
set	string

StoragePermissions

Uprawnienia do kont magazynu

Nazwa	Typ	Opis
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

Parametry aktualizowania zasad dostępu w magazynie

Nazwa	Typ	Opis
id	string	Identyfikator zasobu zasad dostępu.
location	string	Typ zasobu zasad dostępu.
name	string	Nazwa zasobu zasad dostępu.
properties	VaultAccessPolicyProperties	Właściwości zasad dostępu
type	string	Nazwa zasobu zasad dostępu.

VaultAccessPolicyProperties

Właściwości zasad dostępu magazynu

Nazwa	Typ	Opis
accessPolicies	AccessPolicyEntry[]	Tablica z od 0 do 16 tożsamości, które mają dostęp do magazynu kluczy. Wszystkie tożsamości w tablicy muszą używać tego samego identyfikatora dzierżawy co identyfikator dzierżawy magazynu kluczy.

Udostępnij za pośrednictwem