Vaults - Update Access Policy

Service:

Key Vault

API Version:

2022-07-01

Belirtilen abonelikteki bir anahtar kasasında erişim ilkelerini güncelleştirin.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
operationKind	path	True	AccessPolicyUpdateKind	İşlemin adı
resourceGroupName	path	True	string	Kasanın ait olduğu Kaynak Grubunun adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
vaultName	path	True	string	Kasanın adı Regex pattern: ^[a-zA-Z0-9-]{3,24}$
api-version	query	True	string	İstemci Api Sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
properties	True	VaultAccessPolicyProperties	Erişim ilkesinin özellikleri

Yanıtlar

Name	Tür	Description
200 OK	VaultAccessPolicyParameters	Güncelleştirilmiş erişim ilkeleri
201 Created	VaultAccessPolicyParameters	Güncelleştirilmiş erişim ilkeleri
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Örnekler

Add an access policy, or update an access policy with new permissions

Sample Request

HTTP

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

Python

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

Tanımlar

Name	Description
AccessPolicyEntry	Anahtar kasasına erişimi olan bir kimlik. Dizideki tüm kimlikler, anahtar kasasının kiracı kimliğiyle aynı kiracı kimliğini kullanmalıdır.
AccessPolicyUpdateKind	İşlemin adı
CertificatePermissions	Sertifika izinleri
CloudError	Key Vault kaynak sağlayıcısından hata yanıtı
CloudErrorBody	Key Vault kaynak sağlayıcısından hata yanıtı
KeyPermissions	Anahtar izinleri
Permissions	Kimliğin anahtarlar, gizli diziler, sertifikalar ve depolama için sahip olduğu izinler.
SecretPermissions	Gizli dizilere yönelik izinler
StoragePermissions	Depolama hesaplarına yönelik izinler
VaultAccessPolicyParameters	Kasadaki erişim ilkesini güncelleştirme parametreleri
VaultAccessPolicyProperties	Kasa erişim ilkesinin özellikleri

AccessPolicyEntry

Anahtar kasasına erişimi olan bir kimlik. Dizideki tüm kimlikler, anahtar kasasının kiracı kimliğiyle aynı kiracı kimliğini kullanmalıdır.

Name	Tür	Description
applicationId	string	Sorumlu adına istekte bulunan istemcinin uygulama kimliği
objectId	string	Kasa için Azure Active Directory kiracısında bir kullanıcının, hizmet sorumlusunun veya güvenlik grubunun nesne kimliği. Erişim ilkeleri listesi için nesne kimliği benzersiz olmalıdır.
permissions	Permissions	Kimliğin anahtarlar, gizli diziler ve sertifikalar için sahip olduğu izinler.
tenantId	string	Anahtar kasasına yönelik isteklerin kimliğini doğrulamak için kullanılması gereken Azure Active Directory kiracı kimliği.

AccessPolicyUpdateKind

İşlemin adı

Name	Tür	Description
add	string
remove	string
replace	string

CertificatePermissions

Sertifika izinleri

Name	Tür	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

Key Vault kaynak sağlayıcısından hata yanıtı

Name	Tür	Description
error	CloudErrorBody	Key Vault kaynak sağlayıcısından hata yanıtı

CloudErrorBody

Key Vault kaynak sağlayıcısından hata yanıtı

Name	Tür	Description
code	string	Hata kodu. Bu, program aracılığıyla tüketilebilen bir anımsatıcıdır.
message	string	Kullanıcı dostu hata iletisi. İleti genellikle yerelleştirilir ve hizmet sürümüne göre farklılık gösterebilir.

KeyPermissions

Anahtar izinleri

Name	Tür	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

Kimliğin anahtarlar, gizli diziler, sertifikalar ve depolama için sahip olduğu izinler.

Name	Tür	Description
certificates	CertificatePermissions[]	Sertifika izinleri
keys	KeyPermissions[]	Anahtar izinleri
secrets	SecretPermissions[]	Gizli dizilere yönelik izinler
storage	StoragePermissions[]	Depolama hesaplarına yönelik izinler

SecretPermissions

Gizli dizilere yönelik izinler

Name	Tür	Description
all	string
backup	string
delete	string
get	string
list	string
purge	string
recover	string
restore	string
set	string

StoragePermissions

Depolama hesaplarına yönelik izinler

Name	Tür	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

Kasadaki erişim ilkesini güncelleştirme parametreleri

Name	Tür	Description
id	string	Erişim ilkesinin kaynak kimliği.
location	string	Erişim ilkesinin kaynak türü.
name	string	Erişim ilkesinin kaynak adı.
properties	VaultAccessPolicyProperties	Erişim ilkesinin özellikleri
type	string	Erişim ilkesinin kaynak adı.

VaultAccessPolicyProperties

Kasa erişim ilkesinin özellikleri

Name	Tür	Description
accessPolicies	AccessPolicyEntry[]	Anahtar kasasına erişimi olan 0 ile 16 kimlik arasında bir dizi. Dizideki tüm kimlikler, anahtar kasasının kiracı kimliğiyle aynı kiracı kimliğini kullanmalıdır.