MHSM Private Link Resources - List By MHSM Resource

Referência

Serviço:: Key Vault

Versão da API:: 2022-07-01

Obtém os recursos de link privado com suporte para o pool de hsm gerenciado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
name	path	True	string	Nome do pool de HSM gerenciado
resourceGroupName	path	True	string	Nome do grupo de recursos que contém o pool de HSM gerenciado.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Respostas

Nome	Tipo	Description
200 OK	MHSMPrivateLinkResourceListResult	Recursos de link privado recuperados com êxito.
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

KeyVaultListPrivateLinkResources

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-mhsm/privateLinkResources?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_private_link_resources.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.mhsm_private_link_resources.list_by_mhsm_resource(
        resource_group_name="sample-group",
        name="sample-mhsm",
    )
    print(response)


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

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateLinkResources/managedhsm",
      "name": "managedhsm",
      "type": "Microsoft.KeyVault/managedhsms/privateLinkResources",
      "properties": {
        "groupId": "managedhsms",
        "requiredMembers": [
          "default"
        ],
        "requiredZoneNames": [
          "privatelink.managedhsm.azure.net"
        ]
      }
    }
  ]
}

Definições

Nome	Description
CloudError	Uma resposta de erro do provedor de recursos Key Vault
CloudErrorBody	Uma resposta de erro do provedor de recursos Key Vault
identityType	O tipo de identidade que criou o recurso do cofre de chaves.
ManagedHsmSku	Detalhes do SKU
ManagedHsmSkuFamily	Família de SKU do pool de HSM gerenciado
ManagedHsmSkuName	SKU do pool de HSM gerenciado
MHSMPrivateLinkResource	Um recurso de link privado
MHSMPrivateLinkResourceListResult	Uma lista de recursos de link privado
SystemData	Metadados relativos à criação e última modificação do recurso do cofre de chaves.

CloudError

Uma resposta de erro do provedor de recursos Key Vault

Nome	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do provedor de recursos Key Vault

CloudErrorBody

Uma resposta de erro do provedor de recursos Key Vault

Nome	Tipo	Description
code	string	Código do erro. Este é um mnemônico que pode ser consumido programaticamente.
message	string	Mensagem de erro amigável. A mensagem normalmente é localizada e pode variar com a versão do serviço.

identityType

O tipo de identidade que criou o recurso do cofre de chaves.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmSku

Detalhes do SKU

Nome	Tipo	Description
family	ManagedHsmSkuFamily	Família de SKU do pool de HSM gerenciado
name	ManagedHsmSkuName	SKU do pool de HSM gerenciado

ManagedHsmSkuFamily

Família de SKU do pool de HSM gerenciado

Nome	Tipo	Description
B	string

ManagedHsmSkuName

SKU do pool de HSM gerenciado

Nome	Tipo	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string