Managed Hsms - List By Resource Group

Reference

Service:: Key Vault

API Version:: 2022-07-01

Operace Výpis získá informace o spravovaných fondech HSM přidružených k předplatnému a v rámci zadané skupiny prostředků.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs?api-version=2022-07-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs?$top={$top}&api-version=2022-07-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje spravovaný fond HSM.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součá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 vrácených výsledků

Odpovědi

Name	Typ	Description
200 OK	ManagedHsmListResult	Získejte informace o všech spravovaných fondech HSM v zadané skupině prostředků.
Other Status Codes	ManagedHsmError	Odpověď na chybu popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

List managed HSM Pools in a resource group

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs?api-version=2022-07-01

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python managed_hsm_list_by_resource_group.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.managed_hsms.list_by_resource_group(
        resource_group_name="hsm-group",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_ListByResourceGroup.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

{
  "value": [
    {
      "properties": {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "initialAdminObjectIds": [
          "00000000-0000-0000-0000-000000000000"
        ],
        "enableSoftDelete": true,
        "softDeleteRetentionInDays": 90,
        "enablePurgeProtection": false,
        "hsmUri": "https://westus.hsm1.managedhsm.azure.net",
        "provisioningState": "Succeeded",
        "statusMessage": "ManagedHsm is functional."
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
      "name": "hsm1",
      "type": "Microsoft.KeyVault/managedHSMs",
      "location": "westus",
      "sku": {
        "family": "B",
        "name": "Standard_B1"
      },
      "tags": {
        "Dept": "hsm",
        "Environment": "dogfood"
      }
    },
    {
      "properties": {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "initialAdminObjectIds": [
          "00000000-0000-0000-0000-000000000000"
        ],
        "enableSoftDelete": true,
        "softDeleteRetentionInDays": 90,
        "enablePurgeProtection": false,
        "hsmUri": "https://westus.hsm2.managedhsm.azure.net",
        "provisioningState": "Succeeded",
        "statusMessage": "ManagedHsm is functional."
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm2",
      "name": "hsm2",
      "type": "Microsoft.KeyVault/managedHSMs",
      "location": "westus",
      "sku": {
        "family": "B",
        "name": "Standard_B1"
      },
      "tags": {
        "Dept": "hsm",
        "Environment": "production"
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs?api-version=2022-07-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}

Definice

Name	Description
ActionsRequired	Zpráva s informací, že změny poskytovatele služeb vyžadují aktualizace příjemce.
ActivationStatus	Stav aktivace
CreateMode	Režim vytváření, který označuje, jestli se prostředek vytváří nebo se obnovuje z odstraněného prostředku.
Error	Chyba serveru.
identityType	Typ identity, která vytvořila prostředek trezoru klíčů.
ManagedHsm	Informace o zdroji s rozšířenými podrobnostmi.
ManagedHsmError	Výjimka chyby.
ManagedHsmListResult	Seznam spravovaných fondů HSM
ManagedHsmProperties	Vlastnosti spravovaného fondu HSM
ManagedHSMSecurityDomainProperties	Vlastnosti domény zabezpečení spravovaného hsm.
ManagedHsmSku	Podrobnosti o SKU
ManagedHsmSkuFamily	Řada skladových položek spravovaného fondu HSM
ManagedHsmSkuName	Skladová položka spravovaného fondu HSM
MHSMIPRule	Pravidlo, které řídí přístupnost spravovaného fondu hsm z konkrétní IP adresy nebo rozsahu IP adres.
MHSMNetworkRuleSet	Sada pravidel, která řídí síťovou přístupnost spravovaného fondu hsm.
MHSMPrivateEndpoint	Vlastnosti objektu privátního koncového bodu.
MHSMPrivateEndpointConnectionItem	Položka připojení privátního koncového bodu.
MHSMPrivateLinkServiceConnectionState	Objekt, který představuje stav schválení připojení privátního propojení.
MHSMVirtualNetworkRule	Pravidlo, které řídí přístupnost spravovaného fondu hsm z konkrétní virtuální sítě.
NetworkRuleAction	Výchozí akce, když se neshoduje žádné pravidlo z pravidel ipRules a virtualNetworkRules. Použije se až po vyhodnocení vlastnosti bypass.
NetworkRuleBypassOptions	Říká, jaký provoz může obejít pravidla sítě. Může to být AzureServices nebo None. Pokud není zadaný, výchozí hodnota je AzureServices.
PrivateEndpointConnectionProvisioningState	Stav zřizování připojení privátního koncového bodu.
PrivateEndpointServiceConnectionStatus	Označuje, jestli vlastník trezoru klíčů připojení schválil, odmítl nebo odebral.
ProvisioningState	Stav zřizování.
PublicNetworkAccess	Řízení oprávnění ke spravovanému HSM z veřejných sítí
SystemData	Metadata týkající se vytvoření a poslední změny prostředku trezoru klíčů

ActionsRequired

Zpráva s informací, že změny poskytovatele služeb vyžadují aktualizace příjemce.

Name	Typ	Description
None	string

ActivationStatus

Stav aktivace

Name	Typ	Description
Active	string	Spravovaný fond HSM je aktivní.
Failed	string	Nepodařilo se aktivovat spravovaný hsm.
NotActivated	string	Spravovaný fond HSM ještě není aktivovaný.
Unknown	string	Při aktivaci spravovaného hsm došlo k neznámé chybě.

CreateMode

Režim vytváření, který označuje, jestli se prostředek vytváří nebo se obnovuje z odstraněného prostředku.

Name	Typ	Description
default	string	Vytvořte nový fond spravovaných HSM. Toto je výchozí možnost.
recover	string	Obnovení spravovaného fondu HSM z obnovitelně odstraněného prostředku

Error

Chyba serveru.

Name	Typ	Description
code	string	Kód chyby
innererror	Error	Vnitřní chyba obsahuje konkrétnější kód chyby.
message	string	Chybová zpráva

identityType

Typ identity, která vytvořila prostředek trezoru klíčů.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsm

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

Name	Typ	Description
id	string	Id prostředku Azure Resource Manager pro spravovaný fond HSM.
location	string	Podporované umístění Azure, ve kterém by se měl vytvořit spravovaný fond HSM.
name	string	Název spravovaného fondu HSM.
properties	ManagedHsmProperties	Vlastnosti spravovaného HSM
sku	ManagedHsmSku	Podrobnosti o SKU
systemData	SystemData	Metadata týkající se vytvoření a poslední změny prostředku trezoru klíčů
tags	object	Značky prostředků
type	string	Typ prostředku spravovaného fondu HSM.

ManagedHsmError

Výjimka chyby.

Name	Typ	Description
error	Error	Chyba serveru.

ManagedHsmListResult

Seznam spravovaných fondů HSM

Name	Typ	Description
nextLink	string	Adresa URL pro získání další sady spravovaných fondů HSM
value	ManagedHsm[]	Seznam spravovaných fondů HSM.

ManagedHsmProperties

Vlastnosti spravovaného fondu HSM

Name	Typ	Výchozí hodnota	Description
createMode	CreateMode		Režim vytváření, který označuje, jestli se prostředek vytváří nebo se obnovuje z odstraněného prostředku.
enablePurgeProtection	boolean	True	Vlastnost určující, jestli je pro tento spravovaný fond HSM povolená ochrana před vymazáním. Nastavení této vlastnosti na hodnotu true aktivuje ochranu před vymazáním pro tento spravovaný fond HSM a jeho obsah – pouze služba Managed HSM může zahájit tvrdé a neopravitelné odstranění. Povolení této funkce je nevratné.
enableSoftDelete	boolean	True	Vlastnost, která určuje, jestli je pro tento spravovaný fond HSM povolená funkce obnovitelného odstranění. Obnovitelné odstranění je ve výchozím nastavení povolené pro všechny spravované HSM a je neměnné.
hsmUri	string		Identifikátor URI spravovaného fondu hsm pro provádění operací s klíči
initialAdminObjectIds	string[]		Pole ID počátečních objektů administrators pro tento fond spravovaných hsm
networkAcls	MHSMNetworkRuleSet		Pravidla pro přístupnost trezoru klíčů z konkrétních síťových umístění
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		Seznam připojení privátních koncových bodů přidružených k fondu spravovaného hsm
provisioningState	ProvisioningState		Stav zřizování.
publicNetworkAccess	PublicNetworkAccess	Enabled	Řízení oprávnění ke spravovanému HSM z veřejných sítí
scheduledPurgeDate	string		Plánované datum vyprázdnění ve standardu UTC
securityDomainProperties	ManagedHSMSecurityDomainProperties		Vlastnosti domény zabezpečení spravovaného HSM
softDeleteRetentionInDays	integer	90	Dny uchovávání obnovitelně odstraněných dat Když odstraníte HSM nebo klíč, zůstane možné ho obnovit po nakonfigurovanou dobu uchovávání nebo po výchozí období 90 dnů. Přijímá hodnoty mezi 7 a 90.
statusMessage	string		Zpráva o stavu zdroje.
tenantId	string		ID tenanta Azure Active Directory, které by se mělo použít k ověřování požadavků do spravovaného fondu HSM.

ManagedHSMSecurityDomainProperties

Vlastnosti domény zabezpečení spravovaného hsm.

Name	Typ	Description
activationStatus	ActivationStatus	Stav aktivace
activationStatusMessage	string	Zpráva o stavu aktivace.

ManagedHsmSku

Podrobnosti o SKU

Name	Typ	Description
family	ManagedHsmSkuFamily	Řada skladových položek spravovaného fondu HSM
name	ManagedHsmSkuName	Skladová položka spravovaného fondu HSM

ManagedHsmSkuFamily

Řada skladových položek spravovaného fondu HSM

Name	Typ	Description
B	string

ManagedHsmSkuName

Skladová položka spravovaného fondu HSM

Name	Typ	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMIPRule

Pravidlo, které řídí přístupnost spravovaného fondu hsm z konkrétní IP adresy nebo rozsahu IP adres.

Name	Typ	Description
value	string	Rozsah adres IPv4 v zápisu CIDR, například "124.56.78.91" (jednoduchá IP adresa) nebo "124.56.78.0/24" (všechny adresy, které začínají 124.56.78).

MHSMNetworkRuleSet

Sada pravidel, která řídí síťovou přístupnost spravovaného fondu hsm.

Name	Typ	Description
bypass	NetworkRuleBypassOptions	Říká, jaký provoz může obejít pravidla sítě. Může to být AzureServices nebo None. Pokud není zadaný, výchozí hodnota je AzureServices.
defaultAction	NetworkRuleAction	Výchozí akce, když se neshoduje žádné pravidlo z pravidel ipRules a virtualNetworkRules. Použije se až po vyhodnocení vlastnosti bypass.
ipRules	MHSMIPRule[]	Seznam pravidel IP adres.
virtualNetworkRules	MHSMVirtualNetworkRule[]	Seznam pravidel virtuální sítě.

MHSMPrivateEndpoint

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

Name	Typ	Description
id	string	Úplný identifikátor prostředku privátního koncového bodu

MHSMPrivateEndpointConnectionItem

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

Name	Typ	Description
etag	string	Upraví se 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	MHSMPrivateEndpoint	Vlastnosti objektu privátního koncového bodu.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Stav schválení připojení private link.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stav zřizování připojení privátního koncového bodu.

MHSMPrivateLinkServiceConnectionState

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

Name	Typ	Description
actionsRequired	ActionsRequired	Zpráva s informacemi o tom, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.
description	string	Důvod schválení nebo zamítnutí.
status	PrivateEndpointServiceConnectionStatus	Určuje, jestli vlastník trezoru klíčů připojení schválil, zamítl nebo odebral.

MHSMVirtualNetworkRule

Pravidlo, které řídí přístupnost spravovaného fondu hsm z konkrétní virtuální sítě.

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

NetworkRuleAction

Výchozí akce, když se neshoduje žádné pravidlo z pravidel ipRules a virtualNetworkRules. Použije se až po vyhodnocení vlastnosti bypass.

Name	Typ	Description
Allow	string
Deny	string

NetworkRuleBypassOptions

Říká, jaký provoz může obejít pravidla sítě. Může to být AzureServices nebo None. Pokud není zadaný, výchozí hodnota je AzureServices.

Name	Typ	Description
AzureServices	string
None	string

PrivateEndpointConnectionProvisioningState

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

Name	Typ	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Označuje, jestli vlastník trezoru klíčů připojení schválil, odmítl nebo odebral.

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Stav zřizování.

Name	Typ	Description
Activated	string	Spravovaný fond HSM je připravený k běžnému použití.
Deleting	string	Spravovaný fond HSM se právě odstraňuje.
Failed	string	Zřizování spravovaného fondu HSM se nezdařilo.
Provisioning	string	V současné době se zřizuje fond spravovaných HSM.
Restoring	string	Spravovaný fond HSM se obnovuje z úplné zálohy HSM.
SecurityDomainRestore	string	Spravovaný fond HSM čeká na akci obnovení domény zabezpečení.
Succeeded	string	Fond spravovaných HSM je plně zřízený.
Updating	string	Spravovaný fond HSM se právě aktualizuje.

PublicNetworkAccess

Řízení oprávnění ke spravovanému HSM z veřejných sítí

Name	Typ	Description
Disabled	string
Enabled	string

SystemData

Metadata týkající se vytvoření a poslední změny prostředku trezoru klíčů

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku trezoru klíčů (UTC)
createdBy	string	Identita, která vytvořila prostředek trezoru klíčů.
createdByType	identityType	Typ identity, která vytvořila prostředek trezoru klíčů.
lastModifiedAt	string	Časové razítko poslední změny prostředku trezoru klíčů (UTC).
lastModifiedBy	string	Identita, která naposledy upravila prostředek trezoru klíčů.
lastModifiedByType	identityType	Typ identity, která naposledy změnila prostředek trezoru klíčů.