Managed Hsms - List By Resource Group

Referencia

Service:: Key Vault

API Version:: 2022-07-01

A List művelet információkat kap az előfizetéshez társított felügyelt HSM-készletekről és a megadott erőforráscsoporton belül.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	A felügyelt HSM-készletet tartalmazó erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
api-version	query	True	string	Client API-verzió.
$top	query		integer int32	A visszaadandó eredmények maximális száma.

Válaszok

Name	Típus	Description
200 OK	ManagedHsmListResult	A megadott erőforráscsoportban található összes felügyelt HSM-készletre vonatkozó információk lekérése.
Other Status Codes	ManagedHsmError	A művelet meghiúsulásának okát leíró hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

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

Definíciók

Name	Description
ActionsRequired	Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére.
ActivationStatus	Aktiválás állapota
CreateMode	A létrehozási mód, amely jelzi, hogy az erőforrás létrehozása folyamatban van-e, vagy egy törölt erőforrásból lett-e helyreállítva.
Error	A kiszolgálóhiba.
identityType	A Key Vault-erőforrást létrehozó identitás típusa.
ManagedHsm	Erőforrás-információk bővített részletekkel.
ManagedHsmError	A hibakivétel.
ManagedHsmListResult	Felügyelt HSM-készletek listája
ManagedHsmProperties	A felügyelt HSM-készlet tulajdonságai
ManagedHSMSecurityDomainProperties	A felügyelt hsm biztonsági tartománytulajdonságai.
ManagedHsmSku	Termékváltozat részletei
ManagedHsmSkuFamily	A felügyelt HSM-készlet termékváltozatcsaládja
ManagedHsmSkuName	A felügyelt HSM-készlet termékváltozata
MHSMIPRule	Egy felügyelt hsm-készlet adott IP-címről vagy IP-címtartományból való elérhetőségét szabályozó szabály.
MHSMNetworkRuleSet	A felügyelt hsm-készlet hálózati elérhetőségére vonatkozó szabályok halmaza.
MHSMPrivateEndpoint	Privát végpont objektumtulajdonságai.
MHSMPrivateEndpointConnectionItem	Privát végpont kapcsolateleme.
MHSMPrivateLinkServiceConnectionState	Egy objektum, amely a privát kapcsolati kapcsolat jóváhagyási állapotát jelöli.
MHSMVirtualNetworkRule	Egy felügyelt hsm-készlet adott virtuális hálózatból való elérhetőségét szabályozó szabály.
NetworkRuleAction	Az alapértelmezett művelet, ha az ipRules és a virtualNetworkRules szabálya nem egyezik. Ezt csak a bypass tulajdonság kiértékelése után használja a rendszer.
NetworkRuleBypassOptions	Azt jelzi, hogy milyen forgalom kerülheti meg a hálózati szabályokat. Ez lehet "AzureServices" vagy "None". Ha nincs megadva, az alapértelmezett érték az "AzureServices".
PrivateEndpointConnectionProvisioningState	A privát végponti kapcsolat kiépítési állapota.
PrivateEndpointServiceConnectionStatus	Azt jelzi, hogy a kulcstartó tulajdonosa jóváhagyta, elutasította vagy eltávolította-e a kapcsolatot.
ProvisioningState	Kiépítési állapot.
PublicNetworkAccess	A felügyelt HSM-hez való hozzáférés vezérlése nyilvános hálózatokról.
SystemData	A Key Vault-erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

ActionsRequired

Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére.

Name	Típus	Description
None	string

ActivationStatus

Aktiválás állapota

Name	Típus	Description
Active	string	A felügyelt HSM-készlet aktív.
Failed	string	Nem sikerült aktiválni a felügyelt hsm-et.
NotActivated	string	A felügyelt HSM-készlet még nincs aktiválva.
Unknown	string	Ismeretlen hiba történt a felügyelt hsm aktiválása közben.

CreateMode

A létrehozási mód, amely jelzi, hogy az erőforrás létrehozása folyamatban van-e, vagy egy törölt erőforrásból lett-e helyreállítva.

Name	Típus	Description
default	string	Hozzon létre egy új felügyelt HSM-készletet. Ez az alapértelmezett beállítás.
recover	string	Helyreállíthatja a felügyelt HSM-készletet egy helyreállítható módon törölt erőforrásból.

Error

A kiszolgálóhiba.

Name	Típus	Description
code	string	A hibakód.
innererror	Error	A belső hiba pontosabb hibakódot tartalmaz.
message	string	A hibaüzenet.

identityType

A Key Vault-erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsm

Erőforrás-információk bővített részletekkel.

Name	Típus	Description
id	string	Az Azure Resource Manager felügyelt HSM-készlet erőforrás-azonosítója.
location	string	A támogatott Azure-hely, ahol létre kell hozni a felügyelt HSM-készletet.
name	string	A felügyelt HSM-készlet neve.
properties	ManagedHsmProperties	A felügyelt HSM tulajdonságai
sku	ManagedHsmSku	Termékváltozat részletei
systemData	SystemData	A Key Vault-erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
tags	object	Erőforráscímkék
type	string	A felügyelt HSM-készlet erőforrástípusa.

ManagedHsmError

A hibakivétel.

Name	Típus	Description
error	Error	A kiszolgálóhiba.

ManagedHsmListResult

Felügyelt HSM-készletek listája

Name	Típus	Description
nextLink	string	A felügyelt HSM-készletek következő készletének lekéréséhez tartozó URL-cím.
value	ManagedHsm[]	A felügyelt HSM-készletek listája.

ManagedHsmProperties

A felügyelt HSM-készlet tulajdonságai

Name	Típus	Alapértelmezett érték	Description
createMode	CreateMode		A létrehozási mód, amely jelzi, hogy az erőforrás létrehozása folyamatban van-e, vagy egy törölt erőforrásból lett-e helyreállítva.
enablePurgeProtection	boolean	True	Tulajdonság, amely azt határozza meg, hogy engedélyezve van-e a törlés elleni védelem ehhez a felügyelt HSM-készlethez. A tulajdonság true (igaz) értékre állítása aktiválja a felügyelt HSM-készlet és annak tartalma végleges törlése elleni védelmet – csak a felügyelt HSM-szolgáltatás kezdeményezhet helyreállíthatatlan törlést. A funkció engedélyezése visszafordíthatatlan.
enableSoftDelete	boolean	True	Tulajdonság annak megadásához, hogy engedélyezve van-e a "helyreállítható törlés" funkció ehhez a felügyelt HSM-készlethez. A helyreállítható törlés alapértelmezés szerint engedélyezve van az összes felügyelt HSM-hez, és nem módosítható.
hsmUri	string		A felügyelt hsm-készlet URI-ja a kulcsokon végzett műveletek végrehajtásához.
initialAdminObjectIds	string[]		A felügyelt hsm-készlet kezdeti rendszergazdai objektumazonosítóinak tömbje.
networkAcls	MHSMNetworkRuleSet		A kulcstartó adott hálózati helyekről való elérhetőségére vonatkozó szabályok.
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		A felügyelt hsm-készlethez társított privát végponti kapcsolatok listája.
provisioningState	ProvisioningState		Kiépítési állapot.
publicNetworkAccess	PublicNetworkAccess	Enabled	A felügyelt HSM-hez való hozzáférés vezérlése nyilvános hálózatokról.
scheduledPurgeDate	string		Az ütemezett végleges törlés dátuma (UTC).
securityDomainProperties	ManagedHSMSecurityDomainProperties		Felügyelt HSM biztonsági tartomány tulajdonságai.
softDeleteRetentionInDays	integer	90	Helyreállíthatóan törölt adatmegőrzési napok. Ha töröl egy HSM-et vagy kulcsot, az helyreállítható marad a konfigurált megőrzési időszakban vagy az alapértelmezett 90 napig. 7 és 90 közötti értékeket fogad el.
statusMessage	string		Erőforrás állapotüzenete.
tenantId	string		Az Azure Active Directory-bérlőazonosító, amelyet a felügyelt HSM-készlet felé irányuló kérések hitelesítéséhez kell használni.

ManagedHSMSecurityDomainProperties

A felügyelt hsm biztonsági tartománytulajdonságai.

Name	Típus	Description
activationStatus	ActivationStatus	Aktiválás állapota
activationStatusMessage	string	Aktiválási állapotüzenet.

ManagedHsmSku

Termékváltozat részletei

Name	Típus	Description
family	ManagedHsmSkuFamily	A felügyelt HSM-készlet termékváltozatcsaládja
name	ManagedHsmSkuName	A felügyelt HSM-készlet termékváltozata

ManagedHsmSkuFamily

A felügyelt HSM-készlet termékváltozatcsaládja

Name	Típus	Description
B	string

ManagedHsmSkuName

A felügyelt HSM-készlet termékváltozata

Name	Típus	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMIPRule

Egy felügyelt hsm-készlet adott IP-címről vagy IP-címtartományból való elérhetőségét szabályozó szabály.

Name	Típus	Description
value	string	Egy IPv4-címtartomány CIDR-jelölésben, például "124.56.78.91" (egyszerű IP-cím) vagy "124.56.78.0/24" (minden cím, amely a 124.56.78-as számmal kezdődik).

MHSMNetworkRuleSet

A felügyelt hsm-készlet hálózati elérhetőségére vonatkozó szabályok halmaza.

Name	Típus	Description
bypass	NetworkRuleBypassOptions	Azt jelzi, hogy milyen forgalom kerülheti meg a hálózati szabályokat. Ez lehet "AzureServices" vagy "None". Ha nincs megadva, az alapértelmezett érték az "AzureServices".
defaultAction	NetworkRuleAction	Az alapértelmezett művelet, ha az ipRules és a virtualNetworkRules szabálya nem egyezik. Ezt csak a bypass tulajdonság kiértékelése után használja a rendszer.
ipRules	MHSMIPRule[]	Az IP-címszabályok listája.
virtualNetworkRules	MHSMVirtualNetworkRule[]	A virtuális hálózati szabályok listája.

MHSMPrivateEndpoint

Privát végpont objektumtulajdonságai.

Name	Típus	Description
id	string	A privát végponti erőforrás teljes azonosítója.

MHSMPrivateEndpointConnectionItem

Privát végpont kapcsolateleme.

Name	Típus	Description
etag	string	A privát végponti kapcsolat állapotának változásakor módosul.
id	string	A privát végponti kapcsolat azonosítója.
properties.privateEndpoint	MHSMPrivateEndpoint	A privát végpont objektumának tulajdonságai.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	A privát kapcsolat jóváhagyási állapota.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	A privát végponti kapcsolat kiépítési állapota.

MHSMPrivateLinkServiceConnectionState

Egy objektum, amely a privát kapcsolati kapcsolat jóváhagyási állapotát jelöli.

Name	Típus	Description
actionsRequired	ActionsRequired	Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére.
description	string	A jóváhagyás vagy elutasítás oka.
status	PrivateEndpointServiceConnectionStatus	Azt jelzi, hogy a kulcstartó tulajdonosa jóváhagyta, elutasította vagy eltávolította-e a kapcsolatot.

MHSMVirtualNetworkRule

Egy felügyelt hsm-készlet adott virtuális hálózatból való elérhetőségét szabályozó szabály.

Name	Típus	Description
id	string	Egy virtuális hálózat alhálózatának teljes erőforrás-azonosítója, például "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".

NetworkRuleAction

Az alapértelmezett művelet, ha az ipRules és a virtualNetworkRules szabálya nem egyezik. Ezt csak a bypass tulajdonság kiértékelése után használja a rendszer.

Name	Típus	Description
Allow	string
Deny	string

NetworkRuleBypassOptions

Azt jelzi, hogy milyen forgalom kerülheti meg a hálózati szabályokat. Ez lehet "AzureServices" vagy "None". Ha nincs megadva, az alapértelmezett érték az "AzureServices".

Name	Típus	Description
AzureServices	string
None	string

PrivateEndpointConnectionProvisioningState

A privát végponti kapcsolat kiépítési állapota.

Name	Típus	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Azt jelzi, hogy a kulcstartó tulajdonosa jóváhagyta, elutasította vagy eltávolította-e a kapcsolatot.

Name	Típus	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Kiépítési állapot.

Name	Típus	Description
Activated	string	A felügyelt HSM-készlet készen áll a normál használatra.
Deleting	string	A felügyelt HSM-készlet törlése folyamatban van.
Failed	string	A felügyelt HSM-készlet kiépítése nem sikerült.
Provisioning	string	A felügyelt HSM-készlet kiépítése folyamatban van.
Restoring	string	A felügyelt HSM-készlet visszaállítása a teljes HSM-biztonsági mentésből történik.
SecurityDomainRestore	string	A felügyelt HSM-készlet biztonsági tartomány-visszaállítási műveletre vár.
Succeeded	string	A felügyelt HSM-készlet ki lett építve.
Updating	string	A felügyelt HSM-készlet frissítése folyamatban van.

PublicNetworkAccess

A felügyelt HSM-hez való hozzáférés vezérlése nyilvános hálózatokról.

Name	Típus	Description
Disabled	string
Enabled	string

SystemData

A Key Vault-erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	A Key Vault-erőforrás létrehozásának időbélyege (UTC).
createdBy	string	A Key Vault-erőforrást létrehozó identitás.
createdByType	identityType	A Key Vault-erőforrást létrehozó identitás típusa.
lastModifiedAt	string	A Key Vault-erőforrás utolsó módosításának időbélyege (UTC).
lastModifiedBy	string	Az identitás, amely legutóbb módosította a Key Vault-erőforrást.
lastModifiedByType	identityType	Az identitás típusa, amely legutóbb módosította a Key Vault-erőforrást.

Share via