MHSM Private Link Resources - List By MHSM Resource

Referência

Service:: Key Vault

API Version:: 2022-07-01

Obtém os recursos de ligação privada suportados para o conjunto hsm gerido.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
name	path	True	string	Nome do Conjunto HSM gerido
resourceGroupName	path	True	string	Nome do grupo de recursos que contém o conjunto de HSM gerido.
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API de Cliente.

Respostas

Name	Tipo	Description
200 OK	MHSMPrivateLinkResourceListResult	Recursos de ligação privada obtidos com êxito.
Other Status Codes	CloudError	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

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

Sample Response

Status code:: 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

Name	Description
CloudError	Uma resposta de erro do fornecedor de recursos Key Vault
CloudErrorBody	Uma resposta de erro do fornecedor 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 Conjunto de HSM gerido
ManagedHsmSkuName	SKU do Conjunto de HSM gerido
MHSMPrivateLinkResource	Um recurso de ligação privada
MHSMPrivateLinkResourceListResult	Uma lista de recursos de ligação privada
SystemData	Metadados relativos à criação e última modificação do recurso do cofre de chaves.

CloudError

Uma resposta de erro do fornecedor de recursos Key Vault

Name	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do fornecedor de recursos Key Vault

CloudErrorBody

Uma resposta de erro do fornecedor de recursos Key Vault

Name	Tipo	Description
code	string	Código de erro. Este é um mnemónico que pode ser consumido programaticamente.
message	string	Mensagem de erro amigável do utilizador. Normalmente, a mensagem é localizada e pode variar consoante a versão do serviço.

identityType

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

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmSku

Detalhes do SKU

Name	Tipo	Description
family	ManagedHsmSkuFamily	Família de SKU do Conjunto de HSM gerido
name	ManagedHsmSkuName	SKU do Conjunto de HSM gerido

ManagedHsmSkuFamily

Família de SKU do Conjunto de HSM gerido

Name	Tipo	Description
B	string

ManagedHsmSkuName

SKU do Conjunto de HSM gerido

Name	Tipo	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string