Vaults - List By Subscription

Liste işlemi, abonelikle ilişkili kasalar hakkında bilgi alır.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/vaults?api-version=2019-09-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/vaults?$top={$top}&api-version=2019-09-01

URI Parametreleri

Name In Required Type Description
subscriptionId
path True
  • string

Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her servis çağrısı için URI'nin bir parçasını oluşturur.

api-version
query True
  • string

İstemci Api Sürümü.

$top
query
  • integer
int32

Döndürülecek maksimum sonuç sayısı.

Yanıtlar

Name Type Description
200 OK

Belirtilen abonelikteki tüm önemli kasalar hakkında bilgi alın.

Örnekler

List vaults in the specified subscription

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/vaults?$top=1&api-version=2019-09-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault",
      "name": "sample-vault",
      "type": "Microsoft.KeyVault/vaults",
      "location": "westus",
      "tags": {},
      "properties": {
        "sku": {
          "family": "A",
          "name": "premium"
        },
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "accessPolicies": [
          {
            "tenantId": "00000000-0000-0000-0000-000000000000",
            "objectId": "00000000-0000-0000-0000-000000000000",
            "permissions": {
              "keys": [
                "encrypt",
                "decrypt",
                "wrapKey",
                "unwrapKey",
                "sign",
                "verify",
                "get",
                "list",
                "create",
                "update",
                "import",
                "delete",
                "backup",
                "restore",
                "recover",
                "purge"
              ],
              "secrets": [
                "get",
                "list",
                "set",
                "delete",
                "backup",
                "restore",
                "recover",
                "purge"
              ],
              "certificates": [
                "get",
                "list",
                "delete",
                "create",
                "import",
                "update",
                "managecontacts",
                "getissuers",
                "listissuers",
                "setissuers",
                "deleteissuers",
                "manageissuers",
                "recover",
                "purge"
              ]
            }
          }
        ],
        "enabledForDeployment": true,
        "enabledForDiskEncryption": true,
        "enabledForTemplateDeployment": true,
        "enableSoftDelete": true,
        "vaultUri": "https://sample-vault.vault.azure.net/"
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resources?api-version=22019-09-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}

Tanımlar

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.

CreateMode

Kasanın kurtarılıp kurtarılmadığını belirtmek için kasanın oluşturma modu.

IPRule

Belirli bir ip adresinden veya ip aralığından kasanın erişilebilirliğini yöneten bir kural.

NetworkRuleAction

ipRules ve virtualNetworkRules hiçbir kural eşleşir zaman varsayılan eylem. Bu yalnızca baypas özelliği değerlendirildikten sonra kullanılır.

NetworkRuleBypassOptions

Trafiğin ağ kurallarını atlayabileceğini söyler. Bu 'AzureHizmetleri' veya 'Hiçbiri' olabilir. Belirtilmemişse varsayılan değer 'AzureServices' olur.

NetworkRuleSet

Bir kasanın ağ erişilebilirliğini düzenleyen kurallar kümesi.

Permissions

Anahtarlar, sırlar, sertifikalar ve depolama için kimlik izinleri vardır.

PrivateEndpoint

Özel bitiş noktası nesne özellikleri.

PrivateEndpointConnectionItem

Özel uç nokta bağlantı öğesi.

PrivateEndpointConnectionProvisioningState

Geçerli sağlama durumu.

PrivateEndpointServiceConnectionStatus

Özel bitiş noktası bağlantı durumu.

PrivateLinkServiceConnectionState

Özel bağlantı bağlantısının onay durumunu temsil eden bir nesne.

Sku

SKU detayları

SkuFamily

SKU aile adı

SkuName

Anahtar kasasının standart bir kasa mı yoksa premium kasa mı olduğunu belirtmek için SKU adı.

Vault

Genişletilmiş ayrıntıları içeren kaynak bilgileri.

VaultListResult

Kasalar listesi

VaultProperties

Kasanın özellikleri

VirtualNetworkRule

Belirli bir sanal ağdan kasanın erişilebilirliğini düzenleyen bir kural.

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 Type Description
applicationId
  • string

Bir müdür adına talepte bulunduran müşterinin başvuru kimliği

objectId
  • string

Azure Etkin Dizin kiracısındaki bir kullanıcının, hizmet yöneticisinin veya güvenlik grubunun nesne kimliği. Nesne kimliği, erişim ilkeleri listesi için benzersiz olmalıdır.

permissions

Anahtarlar, sırlar ve sertifikalar için kimliğin sahip olduğu izinler.

tenantId
  • string

İstekleri anahtar kasasına doğrulamak için kullanılması gereken Azure Etkin Dizin kiracı kimliği.

CreateMode

Kasanın kurtarılıp kurtarılmadığını belirtmek için kasanın oluşturma modu.

Name Type Description
default
  • string
recover
  • string

IPRule

Belirli bir ip adresinden veya ip aralığından kasanın erişilebilirliğini yöneten bir kural.

Name Type Description
value
  • string

'124.56.78.91' (basit IP adresi) veya '124.56.78.0/24' gibi CIDR gösteriminde bir IPv4 adres aralığı (124.56.78 ile başlayan tüm adresler).

NetworkRuleAction

ipRules ve virtualNetworkRules hiçbir kural eşleşir zaman varsayılan eylem. Bu yalnızca baypas özelliği değerlendirildikten sonra kullanılır.

Name Type Description
Allow
  • string
Deny
  • string

NetworkRuleBypassOptions

Trafiğin ağ kurallarını atlayabileceğini söyler. Bu 'AzureHizmetleri' veya 'Hiçbiri' olabilir. Belirtilmemişse varsayılan değer 'AzureServices' olur.

Name Type Description
AzureServices
  • string
None
  • string

NetworkRuleSet

Bir kasanın ağ erişilebilirliğini düzenleyen kurallar kümesi.

Name Type Description
bypass

Trafiğin ağ kurallarını atlayabileceğini söyler. Bu 'AzureHizmetleri' veya 'Hiçbiri' olabilir. Belirtilmemişse varsayılan değer 'AzureServices' olur.

defaultAction

ipRules ve virtualNetworkRules hiçbir kural eşleşir zaman varsayılan eylem. Bu yalnızca baypas özelliği değerlendirildikten sonra kullanılır.

ipRules

IP adresi kurallarının listesi.

virtualNetworkRules

Sanal ağ kuralları listesi.

Permissions

Anahtarlar, sırlar, sertifikalar ve depolama için kimlik izinleri vardır.

Name Type Description
certificates
  • string[]

Sertifikaizinler

keys
  • string[]

Anahtarlara izinler

secrets
  • string[]

Sırlara izinler

storage
  • string[]

Depolama hesaplarına izinler

PrivateEndpoint

Özel bitiş noktası nesne özellikleri.

Name Type Description
id
  • string

Özel bitiş noktası kaynağının tam tanımlayıcısı.

PrivateEndpointConnectionItem

Özel uç nokta bağlantı öğesi.

Name Type Description
properties.privateEndpoint

Özel bitiş noktası nesnesinin özellikleri.

properties.privateLinkServiceConnectionState

Özel bağlantı bağlantısının onay durumu.

properties.provisioningState

Özel uç nokta bağlantısının sağlama durumu.

PrivateEndpointConnectionProvisioningState

Geçerli sağlama durumu.

Name Type Description
Creating
  • string
Deleting
  • string
Disconnected
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

PrivateEndpointServiceConnectionStatus

Özel bitiş noktası bağlantı durumu.

Name Type Description
Approved
  • string
Disconnected
  • string
Pending
  • string
Rejected
  • string

PrivateLinkServiceConnectionState

Özel bağlantı bağlantısının onay durumunu temsil eden bir nesne.

Name Type Description
actionRequired
  • string

Servis sağlayıcıdaki değişikliklerin tüketici yle ilgili herhangi bir güncelleştirme gerektirip gerektireceğini belirten bir ileti.

description
  • string

Onay veya ret nedeni.

status

Bağlantının anahtar kasa sahibi tarafından onaylanıp onaylanmadığını, reddedildiğini veya kaldırılıp kaldırılmadığını gösterir.

Sku

SKU detayları

Name Type Description
family

SKU aile adı

name

Anahtar kasasının standart bir kasa mı yoksa premium kasa mı olduğunu belirtmek için SKU adı.

SkuFamily

SKU aile adı

Name Type Description
A
  • string

SkuName

Anahtar kasasının standart bir kasa mı yoksa premium kasa mı olduğunu belirtmek için SKU adı.

Name Type Description
premium
  • string
standard
  • string

Vault

Genişletilmiş ayrıntıları içeren kaynak bilgileri.

Name Type Description
id
  • string

Anahtar kasa kaynağının tam nitelikli tanımlayıcısı.

location
  • string

Anahtar kasa kaynağının azure konumu.

name
  • string

Anahtar kasa kaynağının adı.

properties

Kasanın özellikleri

tags
  • object

Anahtar kasa kaynağına atanan etiketler.

type
  • string

Anahtar kasa kaynağının kaynak türü.

VaultListResult

Kasalar listesi

Name Type Description
nextLink
  • string

Bir sonraki kasa kümesini almak için URL.

value

Kasa listesi.

VaultProperties

Kasanın özellikleri

Name Type Description
accessPolicies

Anahtar kasasına erişimi olan 0 ile 1024 kimlik ler arası bir dizi. Dizideki tüm kimlikler, anahtar kasasının kiracı kimliğiyle aynı kiracı kimliğini kullanmalıdır. Ne createMode zaman recoverayarlanır, erişim ilkeleri gerekli değildir. Aksi takdirde, erişim ilkeleri gereklidir.

createMode

Kasanın kurtarılıp kurtarılmadığını belirtmek için kasanın oluşturma modu.

enablePurgeProtection
  • boolean

Bu kasa için tasfiyeye karşı korumanın etkin olup olmadığını belirten özellik. Bu özelliği gerçek olarak ayarlamak, bu kasa ve içeriği için tasfiyeye karşı korumayı etkinleştirir - yalnızca Key Vault hizmeti zor ve geri alınamaz bir silme işlemi başlatabilir. Ayar, yalnızca yumuşak silme de etkinse etkilidir. Bu işlevselliği etkinleştirmek geri alınamaz - yani, özellik değeri olarak yanlış kabul etmez.

enableRbacAuthorization
  • boolean

Veri eylemlerinin nasıl yetkiversen yılolduğunu kontrol eden özellik. Doğru olduğunda, anahtar kasaveri eylemlerinin yetkilendirmesi için Role Based Access Control 'ü (RBAC) kullanır ve kasa özelliklerinde belirtilen erişim ilkeleri göz ardı edilir (uyarı: bu bir önizleme özelliğidir). Yanlış olduğunda, anahtar kasa kasa özelliklerinde belirtilen erişim ilkelerini kullanır ve Azure Kaynak Yöneticisi'nde depolanan tüm ilkeler yoksayılır. Null veya belirtilmemişse, kasa varsayılan false değeriyle oluşturulur. Yönetim eylemlerinin her zaman RBAC ile yetkilendirilen olduğunu unutmayın.

enableSoftDelete
  • boolean

Bu anahtar kasası için 'yumuşak silme' işlevinin etkin olup olmadığını belirten özellik. Yeni anahtar kasası oluştururken herhangi bir değere (doğru veya yanlış) ayarlanmazsa, varsayılan olarak doğru olarak ayarlanır. Bir kez doğru ayarlanmış, yanlış geri alınamaz.

enabledForDeployment
  • boolean

Azure Sanal Makineleri'nin anahtar kasasından sır olarak depolanan sertifikaları almasına izin verilip verilmeyeceğini belirten özellik.

enabledForDiskEncryption
  • boolean

Azure Disk Şifrelemesinin kasadan sırları alıp anahtarlarını açmasına izin verilip verilmeyeceğini belirten özellik.

enabledForTemplateDeployment
  • boolean

Azure Kaynak Yöneticisi'nin anahtar kasasından sırları almasına izin verilip verilmeyeceğini belirten özellik.

networkAcls

Belirli ağ konumlarından anahtar kasasının erişilebilirliğini düzenleyen kurallar.

privateEndpointConnections

Anahtar kasasıyla ilişkili özel uç nokta bağlantılarının listesi.

sku

SKU detayları

softDeleteRetentionInDays
  • integer

softDelete veri saklama günleri. >=7 ve <=90 kabul eder.

tenantId
  • string

İstekleri anahtar kasasına doğrulamak için kullanılması gereken Azure Etkin Dizin kiracı kimliği.

vaultUri
  • string

Anahtarları ve sırları işlemleri gerçekleştirmek için kasanın URI.

VirtualNetworkRule

Belirli bir sanal ağdan kasanın erişilebilirliğini düzenleyen bir kural.

Name Type Description
id
  • string

'/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1' gibi bir vnet alt ağının tam kaynak kimliği.