Managed Hsms - List By Subscription

참조

Service:: Key Vault

API Version:: 2022-07-01

목록 작업은 구독과 연결된 관리형 HSM 풀에 대한 정보를 가져옵니다.

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

With optional parameters:

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
api-version	query	True	string	클라이언트 API 버전.
$top	query		integer int32	반환할 최대 결과 수입니다.

응답

Name	형식	Description
200 OK	ManagedHsmListResult	지정된 구독의 모든 관리형 HSM 풀에 대한 정보를 가져옵니다.
Other Status Codes	ManagedHsmError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

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	사용자 계정 가장

예제

List managed HSM Pools in a subscription

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/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_subscription.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_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_ListBySubscription.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/providers/Microsoft.KeyVault/managedHSMs?api-version=2022-07-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}

정의

Name	Description
ActionsRequired	서비스 공급자의 변경 내용에 소비자에 대한 업데이트가 필요한지 여부를 나타내는 메시지입니다.
ActivationStatus	활성화 상태
CreateMode	리소스가 만들어지고 있는지 아니면 삭제된 리소스에서 복구 중인지를 나타내는 만들기 모드입니다.
Error	서버 오류입니다.
identityType	키 자격 증명 모음 리소스를 만든 ID 유형입니다.
ManagedHsm	확장된 세부 정보가 있는 리소스 정보입니다.
ManagedHsmError	오류 예외입니다.
ManagedHsmListResult	관리형 HSM 풀 목록
ManagedHsmProperties	관리형 HSM 풀의 속성
ManagedHSMSecurityDomainProperties	관리되는 hsm의 보안 도메인 속성입니다.
ManagedHsmSku	SKU 세부 정보
ManagedHsmSkuFamily	관리되는 HSM 풀의 SKU 제품군
ManagedHsmSkuName	관리형 HSM 풀의 SKU
MHSMIPRule	특정 IP 주소 또는 IP 범위에서 관리되는 hsm 풀의 접근성을 제어하는 규칙입니다.
MHSMNetworkRuleSet	관리되는 hsm 풀의 네트워크 접근성을 제어하는 규칙 집합입니다.
MHSMPrivateEndpoint	프라이빗 엔드포인트 개체 속성입니다.
MHSMPrivateEndpointConnectionItem	프라이빗 엔드포인트 연결 항목입니다.
MHSMPrivateLinkServiceConnectionState	프라이빗 링크 연결의 승인 상태를 나타내는 개체입니다.
MHSMVirtualNetworkRule	특정 가상 네트워크에서 관리되는 hsm 풀의 접근성을 제어하는 규칙입니다.
NetworkRuleAction	ipRules 및 virtualNetworkRules의 규칙이 일치하지 않는 경우의 기본 작업입니다. 바이패스 속성이 평가된 후에만 사용됩니다.
NetworkRuleBypassOptions	네트워크 규칙을 무시할 수 있는 트래픽을 알려줍니다. 'AzureServices' 또는 'None'일 수 있습니다. 지정하지 않으면 기본값은 'AzureServices'입니다.
PrivateEndpointConnectionProvisioningState	프라이빗 엔드포인트 연결의 프로비전 상태입니다.
PrivateEndpointServiceConnectionStatus	키 자격 증명 모음 소유자가 연결을 승인, 거부 또는 제거했는지 여부를 나타냅니다.
ProvisioningState	프로비전 상태입니다.
PublicNetworkAccess	공용 네트워크에서 관리되는 HSM에 대한 권한을 제어합니다.
SystemData	키 자격 증명 모음 리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

ActionsRequired

서비스 공급자의 변경 내용에 소비자에 대한 업데이트가 필요한지 여부를 나타내는 메시지입니다.

Name	형식	Description
None	string

ActivationStatus

활성화 상태

Name	형식	Description
Active	string	관리형 HSM 풀이 활성화되어 있습니다.
Failed	string	관리되는 hsm을 활성화하지 못했습니다.
NotActivated	string	관리형 HSM 풀이 아직 활성화되지 않았습니다.
Unknown	string	관리형 hsm을 활성화하는 동안 알 수 없는 오류가 발생했습니다.

CreateMode

리소스가 만들어지고 있는지 아니면 삭제된 리소스에서 복구 중인지를 나타내는 만들기 모드입니다.

Name	형식	Description
default	string	새 관리형 HSM 풀을 만듭니다. 기본 옵션입니다.
recover	string	일시 삭제된 리소스에서 관리되는 HSM 풀을 복구합니다.

Error

서버 오류입니다.

Name	형식	Description
code	string	오류 코드입니다.
innererror	Error	내부 오류에는 보다 구체적인 오류 코드가 포함되어 있습니다.
message	string	오류 메시지입니다.

identityType

키 자격 증명 모음 리소스를 만든 ID 유형입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsm

확장된 세부 정보가 있는 리소스 정보입니다.

Name	형식	Description
id	string	관리되는 HSM 풀에 대한 Azure Resource Manager 리소스 ID입니다.
location	string	관리형 HSM 풀을 만들어야 하는 지원되는 Azure 위치입니다.
name	string	관리되는 HSM 풀의 이름입니다.
properties	ManagedHsmProperties	관리되는 HSM의 속성
sku	ManagedHsmSku	SKU 세부 정보
systemData	SystemData	키 자격 증명 모음 리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
tags	object	리소스 태그
type	string	관리되는 HSM 풀의 리소스 유형입니다.

ManagedHsmError

오류 예외입니다.

Name	형식	Description
error	Error	서버 오류입니다.

ManagedHsmListResult

관리형 HSM 풀 목록

Name	형식	Description
nextLink	string	관리되는 HSM 풀의 다음 집합을 가져올 URL입니다.
value	ManagedHsm[]	관리되는 HSM 풀 목록입니다.

ManagedHsmProperties

관리형 HSM 풀의 속성

Name	형식	기본값	Description
createMode	CreateMode		리소스가 만들어지고 있는지 아니면 삭제된 리소스에서 복구 중인지를 나타내는 만들기 모드입니다.
enablePurgeProtection	boolean	True	이 관리형 HSM 풀에 대해 제거 방지를 사용할 수 있는지 여부를 지정하는 속성입니다. 이 속성을 true로 설정하면 관리형 HSM 풀 및 해당 콘텐츠에 대한 제거 방지가 활성화됩니다. 관리형 HSM 서비스만 하드 복구할 수 없는 삭제를 시작할 수 있습니다. 이 기능을 사용하도록 설정하는 것은 되돌릴 수 없습니다.
enableSoftDelete	boolean	True	이 관리형 HSM 풀에 대해 '일시 삭제' 기능을 사용할 수 있는지 여부를 지정하는 속성입니다. 일시 삭제는 관리되는 모든 HSM에 대해 기본적으로 사용하도록 설정되며 변경할 수 없습니다.
hsmUri	string		키에 대한 작업을 수행하기 위한 관리형 hsm 풀의 URI입니다.
initialAdminObjectIds	string[]		이 관리되는 hsm 풀에 대한 초기 관리자 개체 ID의 배열입니다.
networkAcls	MHSMNetworkRuleSet		특정 네트워크 위치에서 키 자격 증명 모음의 접근성을 제어하는 규칙입니다.
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		관리되는 hsm 풀과 연결된 프라이빗 엔드포인트 연결 목록입니다.
provisioningState	ProvisioningState		프로비전 상태입니다.
publicNetworkAccess	PublicNetworkAccess	Enabled	공용 네트워크에서 관리되는 HSM에 대한 권한을 제어합니다.
scheduledPurgeDate	string		UTC의 예약된 제거 날짜입니다.
securityDomainProperties	ManagedHSMSecurityDomainProperties		관리형 HSM 보안 도메인 속성입니다.
softDeleteRetentionInDays	integer	90	일시 삭제된 데이터 보존일입니다. HSM 또는 키를 삭제하면 구성된 보존 기간 또는 기본 기간 90일 동안 복구 가능한 상태로 유지됩니다. 7에서 90 사이의 값을 허용합니다.
statusMessage	string		리소스 상태 메시지입니다.
tenantId	string		관리되는 HSM 풀에 대한 요청을 인증하는 데 사용해야 하는 Azure Active Directory 테넌트 ID입니다.

ManagedHSMSecurityDomainProperties

관리되는 hsm의 보안 도메인 속성입니다.

Name	형식	Description
activationStatus	ActivationStatus	활성화 상태
activationStatusMessage	string	활성화 상태 메시지입니다.

ManagedHsmSku

SKU 세부 정보

Name	형식	Description
family	ManagedHsmSkuFamily	관리되는 HSM 풀의 SKU 제품군
name	ManagedHsmSkuName	관리형 HSM 풀의 SKU

ManagedHsmSkuFamily

관리되는 HSM 풀의 SKU 제품군

Name	형식	Description
B	string

ManagedHsmSkuName

관리형 HSM 풀의 SKU

Name	형식	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMIPRule

특정 IP 주소 또는 IP 범위에서 관리되는 hsm 풀의 접근성을 제어하는 규칙입니다.

Name	형식	Description
value	string	CIDR 표기법의 IPv4 주소 범위(예: '124.56.78.91'(단순 IP 주소) 또는 '124.56.78.0/24'(124.56.78로 시작하는 모든 주소).

MHSMNetworkRuleSet

관리되는 hsm 풀의 네트워크 접근성을 제어하는 규칙 집합입니다.

Name	형식	Description
bypass	NetworkRuleBypassOptions	네트워크 규칙을 무시할 수 있는 트래픽을 알려줍니다. 'AzureServices' 또는 'None'일 수 있습니다. 지정하지 않으면 기본값은 'AzureServices'입니다.
defaultAction	NetworkRuleAction	ipRules 및 virtualNetworkRules의 규칙이 일치하지 않는 경우의 기본 작업입니다. 바이패스 속성이 평가된 후에만 사용됩니다.
ipRules	MHSMIPRule[]	IP 주소 규칙 목록입니다.
virtualNetworkRules	MHSMVirtualNetworkRule[]	가상 네트워크 규칙 목록입니다.

MHSMPrivateEndpoint

프라이빗 엔드포인트 개체 속성입니다.

Name	형식	Description
id	string	프라이빗 엔드포인트 리소스의 전체 식별자입니다.

MHSMPrivateEndpointConnectionItem

프라이빗 엔드포인트 연결 항목입니다.

Name	형식	Description
etag	string	프라이빗 엔드포인트 연결 상태가 변경되면 수정됩니다.
id	string	프라이빗 엔드포인트 연결의 ID입니다.
properties.privateEndpoint	MHSMPrivateEndpoint	프라이빗 엔드포인트 개체의 속성입니다.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	프라이빗 링크 연결의 승인 상태입니다.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	프라이빗 엔드포인트 연결의 프로비전 상태입니다.

MHSMPrivateLinkServiceConnectionState

프라이빗 링크 연결의 승인 상태를 나타내는 개체입니다.

Name	형식	Description
actionsRequired	ActionsRequired	서비스 공급자의 변경 내용에 소비자에 대한 업데이트가 필요한지 여부를 나타내는 메시지입니다.
description	string	승인 또는 거부 이유입니다.
status	PrivateEndpointServiceConnectionStatus	키 자격 증명 모음 소유자가 연결을 승인, 거부 또는 제거했는지 여부를 나타냅니다.

MHSMVirtualNetworkRule

특정 가상 네트워크에서 관리되는 hsm 풀의 접근성을 제어하는 규칙입니다.

Name	형식	Description
id	string	'/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'과 같은 vnet 서브넷의 전체 리소스 ID입니다.

NetworkRuleAction

ipRules 및 virtualNetworkRules의 규칙이 일치하지 않는 경우의 기본 작업입니다. 바이패스 속성이 평가된 후에만 사용됩니다.

Name	형식	Description
Allow	string
Deny	string

NetworkRuleBypassOptions

네트워크 규칙을 무시할 수 있는 트래픽을 알려줍니다. 'AzureServices' 또는 'None'일 수 있습니다. 지정하지 않으면 기본값은 'AzureServices'입니다.

Name	형식	Description
AzureServices	string
None	string

PrivateEndpointConnectionProvisioningState

프라이빗 엔드포인트 연결의 프로비전 상태입니다.

Name	형식	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

키 자격 증명 모음 소유자가 연결을 승인, 거부 또는 제거했는지 여부를 나타냅니다.

Name	형식	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

프로비전 상태입니다.

Name	형식	Description
Activated	string	관리형 HSM 풀은 정상적으로 사용할 준비가 되어 있습니다.
Deleting	string	관리되는 HSM 풀이 현재 삭제되고 있습니다.
Failed	string	관리되는 HSM 풀의 프로비저닝에 실패했습니다.
Provisioning	string	관리형 HSM 풀이 현재 프로비전되고 있습니다.
Restoring	string	관리되는 HSM 풀이 전체 HSM 백업에서 복원되고 있습니다.
SecurityDomainRestore	string	관리형 HSM 풀이 보안 도메인 복원 작업을 기다리고 있습니다.
Succeeded	string	관리되는 HSM 풀이 완전히 프로비전되었습니다.
Updating	string	관리형 HSM 풀이 현재 업데이트되고 있습니다.

PublicNetworkAccess

공용 네트워크에서 관리되는 HSM에 대한 권한을 제어합니다.

Name	형식	Description
Disabled	string
Enabled	string

SystemData

키 자격 증명 모음 리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	키 자격 증명 모음 리소스 만들기(UTC)의 타임스탬프입니다.
createdBy	string	키 자격 증명 모음 리소스를 만든 ID입니다.
createdByType	identityType	키 자격 증명 모음 리소스를 만든 ID 유형입니다.
lastModifiedAt	string	키 자격 증명 모음 리소스 마지막 수정(UTC)의 타임스탬프입니다.
lastModifiedBy	string	키 자격 증명 모음 리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	identityType	키 자격 증명 모음 리소스를 마지막으로 수정한 ID 유형입니다.