Managed Hsms - Get
Získá zadaný spravovaný fond HSM.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}?api-version=2024-11-01
Parametry identifikátoru URI
| Name | V | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
name
|
path | True |
string |
Název spravovaného fondu HSM. |
|
resource
|
path | True |
string |
Název skupiny prostředků, která obsahuje spravovaný fond HSM. |
|
subscription
|
path | True |
string |
Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří 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 |
Načtený spravovaný fond HSM |
|
| 204 No Content |
Žádost byla úspěšná. Prostředek neexistuje. |
|
| Other Status Codes |
Chybová odpověď popisující, proč se operace nezdařila. |
Zabezpečení
azure_auth
Azure Active Directory OAuth2 Flow
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
Ukázkový požadavek
Ukázková odpověď
{
"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"
}
}
Definice
| Name | Description |
|---|---|
|
Actions |
Zpráva, která indikuje, jestli změny poskytovatele služeb vyžadují aktualizace příjemce. |
|
Activation |
Stav aktivace |
|
Create |
Režim vytvoření označující, jestli se prostředek vytváří nebo se obnovuje z odstraněného prostředku. |
| Error |
Chyba serveru. |
|
Geo |
Stav zřizování geograficky replikované oblasti. |
|
identity |
Typ identity, která vytvořila prostředek trezoru klíčů. |
|
Managed |
Informace o zdrojích s rozšířenými podrobnostmi. |
|
Managed |
Chybová výjimka. |
|
Managed |
Vlastnosti spravovaného fondu HSM |
|
Managed |
Vlastnosti domény zabezpečení spravovaného modulu hardwarového zabezpečení. |
|
Managed |
Podrobnosti skladové položky |
|
Managed |
Řada skladových položek spravovaného fondu HSM |
|
Managed |
Skladová položka spravovaného fondu HSM |
|
Managed |
Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem) |
|
Managed |
Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned). |
|
MHSMGeo |
Oblast, do které byl tento spravovaný fond HSM rozšířen. |
| MHSMIPRule |
Pravidlo, které řídí přístupnost spravovaného fondu HSM z konkrétní IP adresy nebo rozsahu IP adres. |
|
MHSMNetwork |
Sada pravidel, kterými se řídí síťová dostupnost spravovaného fondu HSM. |
|
MHSMPrivate |
Vlastnosti objektu privátního koncového bodu. |
|
MHSMPrivate |
Položka připojení privátního koncového bodu. |
|
MHSMPrivate |
Objekt, který představuje stav schválení připojení privátního propojení. |
|
MHSMVirtual |
Pravidlo, které řídí přístupnost spravovaného fondu HSM z konkrétní virtuální sítě. |
|
Network |
Výchozí akce, pokud se neshoduje žádné pravidlo z pravidel ipRules a virtualNetworkRules. Tento parametr se použije až po vyhodnocení vlastnosti bypass. |
|
Network |
Udává, jaký provoz může obejít pravidla sítě. Může to být AzureServices nebo None. Pokud nezadáte výchozí hodnotu AzureServices. |
|
Private |
Stav zřizování připojení privátního koncového bodu |
|
Private |
Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem trezoru klíčů. |
|
Provisioning |
Stav zřizování |
|
Public |
Řízení oprávnění ke spravovanému HSM z veřejných sítí |
|
System |
Metadata týkající se vytvoření a poslední úpravy prostředku trezoru klíčů. |
|
User |
Vlastnosti identity přiřazené uživatelem |
ActionsRequired
Zpráva, která indikuje, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.
| Hodnota | Description |
|---|---|
| None |
ActivationStatus
Stav aktivace
| Hodnota | Description |
|---|---|
| Active |
Spravovaný fond HSM je aktivní. |
| NotActivated |
Spravovaný fond HSM ještě není aktivován. |
| Unknown |
Při aktivaci spravovaného modulu hardwarového zabezpečení došlo k neznámé chybě. |
| Failed |
Aktivace spravovaného modulu hm se nezdařila. |
CreateMode
Režim vytvoření označující, jestli se prostředek vytváří nebo se obnovuje z odstraněného prostředku.
| Hodnota | Description |
|---|---|
| recover |
Obnovte spravovaný fond HSM z obnovitelně odstraněného prostředku. |
| default |
Vytvořte nový spravovaný fond HSM. Toto je výchozí možnost. |
Error
Chyba serveru.
| Name | Typ | Description |
|---|---|---|
| code |
string |
Kód chyby. |
| innererror |
Vnitřní chyba obsahuje konkrétnější kód chyby. |
|
| message |
string |
Chybová zpráva. |
GeoReplicationRegionProvisioningState
Stav zřizování geograficky replikované oblasti.
| Hodnota | Description |
|---|---|
| Preprovisioning | |
| Provisioning | |
| Succeeded | |
| Failed | |
| Deleting | |
| Cleanup |
identityType
Typ identity, která vytvořila prostředek trezoru klíčů.
| Hodnota | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
ManagedHsm
Informace o zdrojích s rozšířenými podrobnostmi.
| Name | Typ | Description |
|---|---|---|
| id |
string |
ID prostředku Azure Resource Manager pro spravovaný fond HSM. |
| identity |
Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem) |
|
| 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 |
Vlastnosti spravovaného HSM |
|
| sku |
Podrobnosti skladové položky |
|
| systemData |
Metadata týkající se vytvoření a poslední úpravy prostředku trezoru klíčů. |
|
| tags |
object |
Štítky prostředků |
| type |
string |
Typ prostředku spravovaného fondu HSM. |
ManagedHsmError
Chybová výjimka.
| Name | Typ | Description |
|---|---|---|
| error |
Chyba serveru. |
ManagedHsmProperties
Vlastnosti spravovaného fondu HSM
| Name | Typ | Default value | Description |
|---|---|---|---|
| createMode |
Režim vytvoření označující, jestli se prostředek vytváří nebo se obnovuje z odstraněného prostředku. |
||
| enablePurgeProtection |
boolean |
True |
Vlastnost určující, zda je pro tento spravovaný fond HSM povolená ochrana proti vymazání. Nastavení této vlastnosti na true aktivuje ochranu proti vymazání pro tento spravovaný fond HSM a jeho obsah – pouze spravovaná služba HSM může zahájit obtížné a nenapravitelné odstranění. Povolení této funkce je nevratné. |
| enableSoftDelete |
boolean |
True |
Vlastnost určující, 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 hardwarového zabezpečení pro provádění operací s klíči. |
|
| initialAdminObjectIds |
string[] |
Pole ID objektů počátečních správců pro tento spravovaný fond hsm |
|
| networkAcls |
Pravidla, která řídí přístupnost trezoru klíčů z konkrétních síťových umístění. |
||
| privateEndpointConnections |
Seznam připojení privátních koncových bodů přidružených ke spravovanému fondu HSM. |
||
| provisioningState |
Stav zřizování |
||
| publicNetworkAccess | Enabled |
Řízení oprávnění ke spravovanému HSM z veřejných sítí |
|
| regions |
Seznam všech oblastí přidružených ke spravovanému fondu hsm |
||
| scheduledPurgeDate |
string (date-time) |
Plánované datum vymazání ve formátu UTC. |
|
| securityDomainProperties |
Vlastnosti spravované domény zabezpečení HSM. |
||
| softDeleteRetentionInDays |
integer (int32) |
90 |
Dny uchovávání obnovitelně odstraněných dat Když odstraníte HSM nebo klíč, zůstane obnovitelný pro nakonfigurovanou dobu uchovávání nebo pro výchozí období 90 dnů. Přijímá hodnoty od 7 do 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ů ve spravovaném fondu HSM. |
ManagedHSMSecurityDomainProperties
Vlastnosti domény zabezpečení spravovaného modulu hardwarového zabezpečení.
| Name | Typ | Description |
|---|---|---|
| activationStatus |
Stav aktivace |
|
| activationStatusMessage |
string |
Zpráva o stavu aktivace. |
ManagedHsmSku
Podrobnosti skladové položky
| Name | Typ | Description |
|---|---|---|
| family |
Řada skladových položek spravovaného fondu HSM |
|
| name |
Skladová položka spravovaného fondu HSM |
ManagedHsmSkuFamily
Řada skladových položek spravovaného fondu HSM
| Hodnota | Description |
|---|---|
| B | |
| C |
ManagedHsmSkuName
Skladová položka spravovaného fondu HSM
| Hodnota | Description |
|---|---|
| Standard_B1 | |
| Custom_B32 | |
| Custom_B6 | |
| Custom_C42 | |
| Custom_C10 |
ManagedServiceIdentity
Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)
| Name | Typ | Description |
|---|---|---|
| principalId |
string (uuid) |
ID instančního objektu identity přiřazené systémem. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem. |
| tenantId |
string (uuid) |
ID tenanta přiřazené identity systému. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem. |
| type |
Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned). |
|
| userAssignedIdentities |
<string,
User |
identity User-Assigned |
ManagedServiceIdentityType
Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).
| Hodnota | Description |
|---|---|
| None | |
| SystemAssigned | |
| UserAssigned | |
| SystemAssigned,UserAssigned |
MHSMGeoReplicatedRegion
Oblast, do které byl tento spravovaný fond HSM rozšířen.
| Name | Typ | Description |
|---|---|---|
| isPrimary |
boolean |
Logická hodnota, která určuje, jestli je oblast primární nebo sekundární oblastí. |
| name |
string |
Název geograficky replikované oblasti |
| provisioningState |
Stav zřizování geograficky replikované oblasti. |
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 začínající 124.56.78). |
MHSMNetworkRuleSet
Sada pravidel, kterými se řídí síťová dostupnost spravovaného fondu HSM.
| Name | Typ | Description |
|---|---|---|
| bypass |
Udává, jaký provoz může obejít pravidla sítě. Může to být AzureServices nebo None. Pokud nezadáte výchozí hodnotu AzureServices. |
|
| defaultAction |
Výchozí akce, pokud se neshoduje žádné pravidlo z pravidel ipRules a virtualNetworkRules. Tento parametr se použije až po vyhodnocení vlastnosti bypass. |
|
| ipRules |
Seznam pravidel IP adres. |
|
| virtualNetworkRules |
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 |
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 |
Vlastnosti objektu privátního koncového bodu. |
|
| properties.privateLinkServiceConnectionState |
Stav schválení připojení privátního propojení |
|
| properties.provisioningState |
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 |
Zpráva, která indikuje, jestli změny poskytovatele služeb vyžadují aktualizace příjemce. |
|
| description |
string |
Důvod schválení nebo zamítnutí. |
| status |
Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem trezoru klíčů. |
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, pokud se neshoduje žádné pravidlo z pravidel ipRules a virtualNetworkRules. Tento parametr se použije až po vyhodnocení vlastnosti bypass.
| Hodnota | Description |
|---|---|
| Allow | |
| Deny |
NetworkRuleBypassOptions
Udává, jaký provoz může obejít pravidla sítě. Může to být AzureServices nebo None. Pokud nezadáte výchozí hodnotu AzureServices.
| Hodnota | Description |
|---|---|
| AzureServices | |
| None |
PrivateEndpointConnectionProvisioningState
Stav zřizování připojení privátního koncového bodu
| Hodnota | Description |
|---|---|
| Succeeded | |
| Creating | |
| Updating | |
| Deleting | |
| Failed | |
| Disconnected |
PrivateEndpointServiceConnectionStatus
Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem trezoru klíčů.
| Hodnota | Description |
|---|---|
| Pending | |
| Approved | |
| Rejected | |
| Disconnected |
ProvisioningState
Stav zřizování
| Hodnota | Description |
|---|---|
| Succeeded |
Spravovaný fond HSM byl plně zřízen. |
| Provisioning |
Spravovaný fond HSM se v současné době zřizuje. |
| Failed |
Zřizování spravovaného fondu HSM se nezdařilo. |
| Updating |
Spravovaný fond HSM se v současné době aktualizuje. |
| Deleting |
Spravovaný fond HSM se aktuálně odstraňuje. |
| Activated |
Spravovaný fond HSM je připraven k běžnému používání. |
| SecurityDomainRestore |
Spravovaný fond HSM čeká na akci obnovení domény zabezpečení. |
| Restoring |
Spravovaný fond HSM se obnovuje z úplné zálohy HSM. |
PublicNetworkAccess
Řízení oprávnění ke spravovanému HSM z veřejných sítí
| Hodnota | Description |
|---|---|
| Enabled | |
| Disabled |
SystemData
Metadata týkající se vytvoření a poslední úpravy 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 |
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 |
Typ identity, která naposledy změnila prostředek trezoru klíčů. |
UserAssignedIdentity
Vlastnosti identity přiřazené uživatelem
| Name | Typ | Description |
|---|---|---|
| clientId |
string (uuid) |
ID klienta přiřazené identity. |
| principalId |
string (uuid) |
ID objektu zabezpečení přiřazené identity. |