MHSM Private Link Resources - List By MHSM Resource

Ссылка

Служба:: Key Vault

Версия API:: 2022-07-01

Возвращает ресурсы приватного канала, поддерживаемые для управляемого пула hsm.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
name	path	True	string	Имя управляемого пула HSM
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей управляемый пул HSM.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string	Версия клиентского API.

Ответы

Имя	Тип	Описание
200 OK	MHSMPrivateLinkResourceListResult	Успешно извлечены ресурсы приватного канала.
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Пример ответа

Код состояния:: 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"
        ]
      }
    }
  ]
}

Определения

Имя	Описание
CloudError	Ответ об ошибке от поставщика ресурсов Key Vault
CloudErrorBody	Ответ об ошибке от поставщика ресурсов Key Vault
identityType	Тип удостоверения, создавшего ресурс хранилища ключей.
ManagedHsmSku	Сведения о номере SKU
ManagedHsmSkuFamily	Семейство SKU управляемого пула HSM
ManagedHsmSkuName	SKU управляемого пула HSM
MHSMPrivateLinkResource	Ресурс приватного канала
MHSMPrivateLinkResourceListResult	Список ресурсов приватного канала
SystemData	Метаданные, относящиеся к созданию и последнему изменении ресурса хранилища ключей.

CloudError

Object

Ответ об ошибке от поставщика ресурсов Key Vault

Имя	Тип	Описание
error	CloudErrorBody	Ответ об ошибке от поставщика ресурсов Key Vault

CloudErrorBody

Object

Ответ об ошибке от поставщика ресурсов Key Vault

Имя	Тип	Описание
code	string	Код ошибки. Это mnemonic, который можно использовать программным способом.
message	string	Понятное сообщение об ошибке. Сообщение обычно локализовано и может отличаться от версии службы.

identityType

Перечисление

Тип удостоверения, создавшего ресурс хранилища ключей.

Значение	Описание
Application
Key
ManagedIdentity
User

ManagedHsmSku

Object

Сведения о номере SKU

Имя	Тип	Описание
family	ManagedHsmSkuFamily	Семейство SKU управляемого пула HSM
name	ManagedHsmSkuName	SKU управляемого пула HSM

ManagedHsmSkuFamily

Перечисление

Семейство SKU управляемого пула HSM

Значение	Описание
B

ManagedHsmSkuName

Перечисление

SKU управляемого пула HSM

Значение	Описание
Custom_B32
Custom_B6
Standard_B1