Managed Hsms - List By Resource Group

Referencia

Szolgáltatás:: Key Vault

API-verzió:: 2022-07-01

A Lista 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

Opcionális paraméterekkel:

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ója minden szolgáltatáshíváshoz az URI részét képezi.
api-version	query	True	string	Ügyfél API-verziója.
$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áscsoport összes felügyelt HSM-készletével kapcsolatos információk lekérése.
Other Status Codes	ManagedHsmError	A művelet sikertelen voltát leíró hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a 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

Mintaválasz

Állapotkód:: 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 jelzi, hogy az erőforrás létrehozása folyamatban van-e, vagy egy törölt erőforrásból van-e helyreállítva.
Error	A kiszolgáló hibája.
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 hiba kivétele.
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 egy adott IP-címről vagy IP-tartományból való elérhetőségét szabályozó szabály.
MHSMNetworkRuleSet	A felügyelt hsm-készlet hálózati akadálymentességét szabályozó szabályok készlete.
MHSMPrivateEndpoint	Privát végpontobjektum tulajdonságai.
MHSMPrivateEndpointConnectionItem	Privát végpont kapcsolateleme.
MHSMPrivateLinkServiceConnectionState	Egy objektum, amely a privát kapcsolat kapcsolat jóváhagyási állapotát jelöli.
MHSMVirtualNetworkRule	Egy felügyelt hsm-készlet egy adott virtuális hálózatból való akadálymentessé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égpontkapcsolat 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 kulcstartó-erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

ActionsRequired

Enumerálás

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

Érték	Description
None

ActivationStatus

Enumerálás

Aktiválás állapota

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

CreateMode

Enumerálás

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

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

Error

Objektum

A kiszolgáló hibája.

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

identityType

Enumerálás

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

Érték	Description
Application
Key
ManagedIdentity
User

ManagedHsm

Objektum

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

Name	Típus	Description
id	string	A felügyelt HSM-készlet Azure Resource Manager-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 kulcstartó-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

Objektum

A hiba kivétele.

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

ManagedHsmListResult

Objektum

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

Objektum

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

Name	Típus	Alapértelmezett érték	Description
createMode	CreateMode		A létrehozási mód jelzi, hogy az erőforrás létrehozása folyamatban van-e, vagy egy törölt erőforrásból van-e helyreállítva.
enablePurgeProtection	boolean	True	Tulajdonság, amely meghatározza, hogy engedélyezve van-e a törlés elleni védelem a felügyelt HSM-készlethez. A tulajdonság igaz értékre állítása aktiválja a felügyelt HSM-készlet és tartalma kiüríté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 visszavonhatatlan.
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ó akadálymentességét szabályozó szabályok.
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		A felügyelt hsm-készlethez társított privát végpontkapcsolatok 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 (date-time)		Az ütemezett törlés dátuma UTC-ben.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Felügyelt HSM biztonsági tartomány tulajdonságai.
softDeleteRetentionInDays	integer (int32)	90	Helyreállítható adatmegőrzési napok. Ha töröl egy HSM-et vagy egy 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 (uuid)		Az Azure Active Directory-bérlőazonosító, amelyet a felügyelt HSM-készletbe irányuló kérelmek hitelesítéséhez kell használni.

ManagedHSMSecurityDomainProperties

Objektum

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

Objektum

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

Enumerálás

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

Érték	Description
B

ManagedHsmSkuName

Enumerálás

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

Érték	Description
Custom_B32
Custom_B6
Standard_B1

MHSMIPRule

Objektum

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

Name	Típus	Description
value	string	Egy IPv4-címtartomány a 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

Objektum

A felügyelt hsm-készlet hálózati akadálymentességét szabályozó szabályok készlete.

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

Objektum

Privát végpontobjektum tulajdonságai.

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

MHSMPrivateEndpointConnectionItem

Objektum

Privát végpont kapcsolateleme.

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

MHSMPrivateLinkServiceConnectionState

Objektum

Egy objektum, amely a privát kapcsolat 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

Objektum

Egy felügyelt hsm-készlet egy adott virtuális hálózatból való akadálymentessé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

Enumerálás

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.

Érték	Description
Allow
Deny

NetworkRuleBypassOptions

Enumerálás

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".

Érték	Description
AzureServices
None

PrivateEndpointConnectionProvisioningState

Enumerálás

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

Érték	Description
Creating
Deleting
Disconnected
Failed
Succeeded
Updating

PrivateEndpointServiceConnectionStatus

Enumerálás

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

Érték	Description
Approved
Disconnected
Pending
Rejected

ProvisioningState

Enumerálás

Kiépítési állapot.

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

PublicNetworkAccess

Enumerálás

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

Érték	Description
Disabled
Enabled

SystemData

Objektum

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

Name	Típus	Description
createdAt	string (date-time)	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 (date-time)	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 kulcstartó erőforrását.

Megosztás a következőn keresztül:

Managed Hsms - List By Resource Group

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

List managed HSM Pools in a resource group

Mintakérelem

Mintaválasz

Definíciók

ActionsRequired

ActivationStatus

CreateMode

Error

identityType

ManagedHsm

ManagedHsmError

ManagedHsmListResult

ManagedHsmProperties

ManagedHSMSecurityDomainProperties

ManagedHsmSku

ManagedHsmSkuFamily

ManagedHsmSkuName

MHSMIPRule

MHSMNetworkRuleSet

MHSMPrivateEndpoint

MHSMPrivateEndpointConnectionItem

MHSMPrivateLinkServiceConnectionState

MHSMVirtualNetworkRule

NetworkRuleAction

NetworkRuleBypassOptions

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

ProvisioningState

PublicNetworkAccess

SystemData