Managed Hsms - Get

Reference

Služba:: Key Vault

Verze rozhraní API:: 2022-07-01

Získá zadaný spravovaný fond HSM.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
name	path	True	string	Název spravovaného fondu HSM.
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.

Odpovědi

Name	Typ	Description
200 OK	ManagedHsm	Načtení spravovaného fondu HSM
204 No Content		Žádost byla úspěšná. Prostředek neexistuje.
Other Status Codes	ManagedHsmError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Příklady

Retrieve a managed HSM Pool

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1?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_get.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.get(
        resource_group_name="hsm-group",
        name="hsm1",
    )
    print(response)


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

Ukázková odpověď

Stavový kód:: 200

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

Stavový kód:: 204

Definice

Name	Description
ActionsRequired	Zpráva s informacemi o tom, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.
ActivationStatus	Stav aktivace
CreateMode	Režim vytvoř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.
ManagedHsmProperties	Vlastnosti spravovaného fondu HSM
ManagedHSMSecurityDomainProperties	Vlastnosti domény zabezpečení spravovaného hsm
ManagedHsmSku	Podrobnosti o skladové pořidce
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í přístupnost sítě 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, pokud se žádné pravidlo z ipRules a z virtualNetworkRules neshoduje. Použije se pouze po vyhodnocení vlastnosti bypass.
NetworkRuleBypassOptions	Udává, jaký provoz může obejít pravidla sítě. Může to být AzureServices nebo None. Pokud není zadáno, výchozí hodnota je AzureServices.
PrivateEndpointConnectionProvisioningState	Stav zřizování připojení privátního koncového bodu.
PrivateEndpointServiceConnectionStatus	Určuje, jestli vlastník trezoru klíčů připojení schválil, zamítl nebo odebral.
ProvisioningState	Stav zřizování.
PublicNetworkAccess	Řízení oprávnění ke spravovanému modulu HSM z veřejných sítí
SystemData	Metadata týkající se vytvoření a poslední změny prostředku trezoru klíčů

ActionsRequired

Výčet

Zpráva s informacemi o tom, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.

Hodnota	Description
None

ActivationStatus

Výčet

Stav aktivace

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

CreateMode

Výčet

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

Hodnota	Description
default	Vytvořte nový spravovaný fond HSM. Toto je výchozí možnost.
recover	Obnovte spravovaný fond HSM z obnovitelného odstraněného prostředku.

Error

Objekt

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

Výčet

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

Hodnota	Description
Application
Key
ManagedIdentity
User

ManagedHsm

Objekt

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

Name	Typ	Description
id	string	ID prostředku Azure Resource Manager spravovaného fondu 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 modulu HSM
sku	ManagedHsmSku	Podrobnosti o skladové pořidce
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

Objekt

Výjimka chyby.

Name	Typ	Description
error	Error	Chyba serveru.

ManagedHsmProperties

Objekt

Vlastnosti spravovaného fondu HSM

Name	Typ	Default value	Description
createMode	CreateMode		Režim vytvoř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 spravovaná služba HSM může zahájit tvrdé a neodstranitelné odstranění. Povolení této funkce je nevratné.
enableSoftDelete	boolean	True	Vlastnost 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é moduly 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 POČÁTEČNÍCH ID objektů správců pro tento spravovaný fond 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 ke spravovanému fondu hsm
provisioningState	ProvisioningState		Stav zřizování.
publicNetworkAccess	PublicNetworkAccess	Enabled	Řízení oprávnění ke spravovanému modulu HSM z veřejných sítí
scheduledPurgeDate	string (date-time)		Plánované datum vyprázdnění v UTC.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Vlastnosti spravované domény zabezpečení HSM.
softDeleteRetentionInDays	integer (int32)	90	Dny uchovávání obnovitelného odstranění dat. Když odstraníte HSM nebo klíč, zůstane možné ho obnovit po nakonfigurovanou dobu uchovávání nebo po výchozí dobu 90 dnů. Přijímá hodnoty mezi 7 a 90.
statusMessage	string		Zpráva o stavu zdroje.
tenantId	string (uuid)		ID tenanta Azure Active Directory, které by se mělo použít k ověřování požadavků na spravovaný fond HSM.

ManagedHSMSecurityDomainProperties

Objekt

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

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

ManagedHsmSku

Objekt

Podrobnosti o skladové pořidce

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

ManagedHsmSkuFamily

Výčet

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

Hodnota	Description
B

ManagedHsmSkuName

Výčet

Skladová položka spravovaného fondu HSM

Hodnota	Description
Custom_B32
Custom_B6
Standard_B1

MHSMIPRule

Objekt

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

Name	Typ	Description
value	string	Rozsah IPv4 adres 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í na 124.56.78).

MHSMNetworkRuleSet

Objekt

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

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

MHSMPrivateEndpoint

Objekt

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

Objekt

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

Name	Typ	Description
etag	string	Změněno 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í privátního propojení
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stav zřizování připojení privátního koncového bodu.

MHSMPrivateLinkServiceConnectionState

Objekt

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

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

MHSMVirtualNetworkRule

Objekt

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ýčet

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

Hodnota	Description
Allow
Deny

NetworkRuleBypassOptions

Výčet

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

Hodnota	Description
AzureServices
None

PrivateEndpointConnectionProvisioningState

Výčet

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

Hodnota	Description
Creating
Deleting
Disconnected
Failed
Succeeded
Updating

PrivateEndpointServiceConnectionStatus

Výčet

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

Hodnota	Description
Approved
Disconnected
Pending
Rejected

ProvisioningState

Výčet

Stav zřizování.

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

PublicNetworkAccess

Výčet

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

Hodnota	Description
Disabled
Enabled

SystemData

Objekt

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

Name	Typ	Description
createdAt	string (date-time)	Č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 (date-time)	Časové razítko poslední změny prostředku trezoru klíčů (UTC).
lastModifiedBy	string	Identita, která naposledy změnila prostředek trezoru klíčů.
lastModifiedByType	identityType	Typ identity, která naposledy změnila prostředek trezoru klíčů.

Sdílet prostřednictvím

Managed Hsms - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Retrieve a managed HSM Pool

Ukázkový požadavek

Ukázková odpověď

Definice

ActionsRequired

ActivationStatus

CreateMode

Error

identityType

ManagedHsm

ManagedHsmError

ManagedHsmProperties

ManagedHSMSecurityDomainProperties

ManagedHsmSku

ManagedHsmSkuFamily

ManagedHsmSkuName

MHSMIPRule

MHSMNetworkRuleSet

MHSMPrivateEndpoint

MHSMPrivateEndpointConnectionItem

MHSMPrivateLinkServiceConnectionState

MHSMVirtualNetworkRule

NetworkRuleAction

NetworkRuleBypassOptions

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

ProvisioningState

PublicNetworkAccess

SystemData

Další materiály