Vaults - List By Subscription

Operace list získává informace o trezorech přidružených k předplatnému.

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

Parametry identifikátoru URI

Name In Required Type Description
subscriptionId
path True
  • string

Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří část identifikátoru URI pro každé volání služby.

api-version
query True
  • string

Verze rozhraní API klienta

$top
query
  • integer
int32

Maximální počet výsledků, které se mají vrátit

Odpovědi

Name Type Description
200 OK

Získejte informace o všech trezorech klíčů v zadaném předplatném.

Other Status Codes

Chybová odezva popisující, proč se operace nezdařila

Příklady

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,
        "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000",
        "vaultUri": "https://sample-vault.vault.azure.net/",
        "provisioningState": "Succeeded"
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resources?api-version=22019-09-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}
{
  "error": {
    "code": "",
    "message": ""
  }
}

Definice

AccessPolicyEntry

Identita, která má přístup k trezoru klíčů. Všechny identity v poli musí používat stejné ID tenanta jako ID tenanta trezoru klíčů.

CloudError

Odpověď na chybu od poskytovatele prostředků Key Vault

CloudErrorBody

Odpověď na chybu od poskytovatele prostředků Key Vault

CreateMode

Režim vytvoření trezoru, který určuje, jestli se trezor musí obnovit, nebo ne.

IPRule

Pravidlo, které řídí přístupnost trezoru z konkrétní IP adresy nebo rozsahu IP adres.

NetworkRuleAction

Výchozí akce v případě, že se neshoduje žádné pravidlo z ipRules a ze virtualNetworkRules Používá se jenom po vyhodnocení vlastnosti bypass.

NetworkRuleBypassOptions

Informuje o tom, jaký provoz může obejít Síťová pravidla. Může to být "AzureServices" nebo "none". Pokud není zadaný, použije se výchozí hodnota ' AzureServices '.

NetworkRuleSet

Sada pravidel, kterými se řídí přístupnost trezoru v síti.

Permissions

Oprávnění, která má identita pro klíče, tajné klíče, certifikáty a úložiště.

PrivateEndpoint

Vlastnosti objektu privátního koncového bodu.

PrivateEndpointConnectionItem

Položka připojení privátního koncového bodu.

PrivateEndpointConnectionProvisioningState

Aktuální stav zřizování.

PrivateEndpointServiceConnectionStatus

Stav připojení privátního koncového bodu.

PrivateLinkServiceConnectionState

Objekt, který představuje stav schválení připojení k privátnímu propojení.

Sku

Podrobnosti SKU

SkuFamily

Název rodiny SKU

SkuName

Název SKU, abyste určili, jestli je Trezor klíčů standardním trezorem nebo trezorem Premium.

Vault

Informace o zdroji s rozšířenými podrobnostmi.

VaultListResult

Seznam trezorů

VaultProperties

Vlastnosti trezoru

VaultProvisioningState

Stav zřizování trezoru.

VirtualNetworkRule

Pravidlo, které řídí přístupnost trezoru z konkrétní virtuální sítě.

AccessPolicyEntry

Identita, která má přístup k trezoru klíčů. Všechny identity v poli musí používat stejné ID tenanta jako ID tenanta trezoru klíčů.

Name Type Description
applicationId
  • string

ID aplikace klienta, který podává požadavek jménem objektu zabezpečení

objectId
  • string

ID objektu uživatele, instančního objektu nebo skupiny zabezpečení v tenantovi Azure Active Directory pro trezor. ID objektu musí být pro seznam zásad přístupu jedinečné.

permissions

Oprávnění, která má identita pro klíče, tajné klíče a certifikáty.

tenantId
  • string

ID tenanta Azure Active Directory, které se má použít k ověřování požadavků do trezoru klíčů.

CloudError

Odpověď na chybu od poskytovatele prostředků Key Vault

Name Type Description
error

Odpověď na chybu od poskytovatele prostředků Key Vault

CloudErrorBody

Odpověď na chybu od poskytovatele prostředků Key Vault

Name Type Description
code
  • string

Kód chyby Toto je symbol, který se dá programově spotřebovat.

message
  • string

Uživatelsky přívětivá chybová zpráva Zpráva je obvykle lokalizovaná a může se lišit podle verze služby.

CreateMode

Režim vytvoření trezoru, který určuje, jestli se trezor musí obnovit, nebo ne.

Name Type Description
default
  • string
recover
  • string

IPRule

Pravidlo, které řídí přístupnost trezoru z konkrétní IP adresy nebo rozsahu IP adres.

Name Type Description
value
  • string

Rozsah adres IPv4 v zápisu CIDR, jako je například ' 124.56.78.91 ' (jednoduchá IP adresa) nebo ' 124.56.78.0/24 ' (všechny adresy, které začínají na 124.56.78).

NetworkRuleAction

Výchozí akce v případě, že se neshoduje žádné pravidlo z ipRules a ze virtualNetworkRules Používá se jenom po vyhodnocení vlastnosti bypass.

Name Type Description
Allow
  • string
Deny
  • string

NetworkRuleBypassOptions

Informuje o tom, jaký provoz může obejít Síťová pravidla. Může to být "AzureServices" nebo "none". Pokud není zadaný, použije se výchozí hodnota ' AzureServices '.

Name Type Description
AzureServices
  • string
None
  • string

NetworkRuleSet

Sada pravidel, kterými se řídí přístupnost trezoru v síti.

Name Type Description
bypass

Informuje o tom, jaký provoz může obejít Síťová pravidla. Může to být "AzureServices" nebo "none". Pokud není zadaný, použije se výchozí hodnota ' AzureServices '.

defaultAction

Výchozí akce v případě, že se neshoduje žádné pravidlo z ipRules a ze virtualNetworkRules Používá se jenom po vyhodnocení vlastnosti bypass.

ipRules

Seznam pravidel IP adres.

virtualNetworkRules

Seznam pravidel virtuální sítě.

Permissions

Oprávnění, která má identita pro klíče, tajné klíče, certifikáty a úložiště.

Name Type Description
certificates
  • string[]

Oprávnění k certifikátům

keys
  • string[]

Oprávnění k klíčům

secrets
  • string[]

Oprávnění k tajným klíčům

storage
  • string[]

Oprávnění k účtům úložiště

PrivateEndpoint

Vlastnosti objektu privátního koncového bodu.

Name Type Description
id
  • string

Úplný identifikátor prostředku privátního koncového bodu

PrivateEndpointConnectionItem

Položka připojení privátního koncového bodu.

Name Type Description
etag
  • string

Tato změna se změní vždy, když dojde ke změně stavu připojení privátního koncového bodu.

id
  • string

ID připojení privátního koncového bodu

properties.privateEndpoint

Vlastnosti objektu privátního koncového bodu

properties.privateLinkServiceConnectionState

Stav schválení připojení k privátnímu propojení

properties.provisioningState

Stav zřizování připojení privátního koncového bodu.

PrivateEndpointConnectionProvisioningState

Aktuální stav zřizování.

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

PrivateEndpointServiceConnectionStatus

Stav připojení privátního koncového bodu.

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

PrivateLinkServiceConnectionState

Objekt, který představuje stav schválení připojení k privátnímu propojení.

Name Type Description
actionsRequired
  • string

Zpráva s informacemi o tom, zda změny u poskytovatele služeb vyžadují jakékoli aktualizace na příjemci.

description
  • string

Důvod schválení nebo zamítnutí.

status

Označuje, zda bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem trezoru klíčů.

Sku

Podrobnosti SKU

Name Type Description
family

Název rodiny SKU

name

Název SKU, abyste určili, jestli je Trezor klíčů standardním trezorem nebo trezorem Premium.

SkuFamily

Název rodiny SKU

Name Type Description
A
  • string

SkuName

Název SKU, abyste určili, jestli je Trezor klíčů standardním trezorem nebo trezorem Premium.

Name Type Description
premium
  • string
standard
  • string

Vault

Informace o zdroji s rozšířenými podrobnostmi.

Name Type Description
id
  • string

Plně kvalifikovaný identifikátor prostředku trezoru klíčů.

location
  • string

Umístění prostředku trezoru klíčů Azure.

name
  • string

Název prostředku trezoru klíčů

properties

Vlastnosti trezoru

tags
  • object

Značky přiřazené k prostředku trezoru klíčů

type
  • string

Typ prostředku prostředku trezoru klíčů

VaultListResult

Seznam trezorů

Name Type Description
nextLink
  • string

Adresa URL pro získání další sady trezorů.

value

Seznam trezorů.

VaultProperties

Vlastnosti trezoru

Name Type Description
accessPolicies

Pole o identitách 0 až 1024, které mají přístup k trezoru klíčů. Všechny identity v poli musí používat stejné ID tenanta jako ID tenanta trezoru klíčů. Když createMode je nastavená na recover , zásady přístupu se nevyžadují. V opačném případě jsou vyžadovány zásady přístupu.

createMode

Režim vytvoření trezoru, který určuje, jestli se trezor musí obnovit, nebo ne.

enablePurgeProtection
  • boolean

Vlastnost určující, zda je pro tento trezor povolena ochrana proti vyprázdnění. Když se tato vlastnost nastaví na true, aktivuje se ochrana proti vyprázdnění pro tento trezor a její obsah – pouze služba Key Vault může iniciovat pevné, nezotavitelné odstranění. Nastavení je platné pouze v případě, že je povoleno i obnovitelné odstranění. Povolení této funkce je nevratné – to znamená, že vlastnost nepřijímá jako hodnotu false.

enableRbacAuthorization
  • boolean

Vlastnost, která určuje, jakým způsobem jsou datové akce autorizovány. V případě hodnoty true bude Trezor klíčů používat Access Control na základě rolí (RBAC) pro autorizaci datových akcí a zásady přístupu zadané ve vlastnostech trezoru budou ignorovány (upozornění: Tato funkce je ve verzi Preview). V případě hodnoty false bude Trezor klíčů používat zásady přístupu zadané ve vlastnostech trezoru a všechny zásady uložené v Azure Resource Manager budou ignorovány. Pokud je hodnota null nebo není zadána, je trezor vytvořen s výchozí hodnotou false. Mějte na paměti, že akce správy jsou vždy autorizovány pomocí RBAC.

enableSoftDelete
  • boolean

Vlastnost, která určuje, jestli je pro tento trezor klíčů povolená funkce Soft DELETE. Pokud při vytváření nového trezoru klíčů není nastavená žádná hodnota (true nebo false), bude ve výchozím nastavení nastavená na true. Po nastavení na hodnotu true nelze vrátit hodnotu false.

enabledForDeployment
  • boolean

Vlastnost, která určuje, jestli má Virtual Machines Azure oprávnění k načítání certifikátů uložených jako tajné klíče z trezoru klíčů.

enabledForDiskEncryption
  • boolean

Vlastnost, která určuje, zda je povoleno načítání tajných kódů z trezoru a rozbalení klíčů pomocí Azure Disk Encryption.

enabledForTemplateDeployment
  • boolean

Vlastnost, která určuje, zda je povoleno načítání tajných kódů z trezoru klíčů Azure Resource Manager.

hsmPoolResourceId
  • string

ID prostředku fondu HSM.

networkAcls

Pravidla upravující přístupnost trezoru klíčů z konkrétních umístění v síti.

privateEndpointConnections

Seznam připojení privátních koncových bodů přidružených k trezoru klíčů

provisioningState

Stav zřizování trezoru.

sku

Podrobnosti SKU

softDeleteRetentionInDays
  • integer

dny uchovávání dat softDelete. Přijímá >= 7 a <= 90.

tenantId
  • string

ID tenanta Azure Active Directory, které se má použít k ověřování požadavků do trezoru klíčů.

vaultUri
  • string

Identifikátor URI trezoru pro provádění operací s klíči a tajnými kódy Tato vlastnost je jen pro čtení.

VaultProvisioningState

Stav zřizování trezoru.

Name Type Description
RegisteringDns
  • string
Succeeded
  • string

VirtualNetworkRule

Pravidlo, které řídí přístupnost trezoru z konkrétní virtuální sítě.

Name Type Description
id
  • string

Úplné ID prostředku podsítě virtuální sítě, jako je například '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1 '.

ignoreMissingVnetServiceEndpoint
  • boolean

Vlastnost, která určuje, jestli bude NRP ignorovat kontrolu, jestli má nadřazená podsíť nakonfigurované koncové body.