Private Link Resources - List By Vault

Ссылка

Служба:: Key Vault

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

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей хранилище ключей.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
vaultName	path	True	string	Имя хранилища ключей. Шаблон регулярного выражения: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Версия API клиента.

Ответы

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

Примеры

KeyVaultListPrivateLinkResources

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/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 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.private_link_resources.list_by_vault(
        resource_group_name="sample-group",
        vault_name="sample-vault",
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/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/vaults/sample-vault/privateLinkResources/vault",
      "name": "vault",
      "type": "Microsoft.KeyVault/vaults/privateLinkResources",
      "properties": {
        "groupId": "vault",
        "requiredMembers": [
          "default"
        ],
        "requiredZoneNames": [
          "privatelink.vaultcore.azure.net"
        ]
      }
    }
  ]
}

Определения

Имя	Описание
CloudError	Ответ об ошибке от поставщика ресурсов Key Vault
CloudErrorBody	Ответ об ошибке от поставщика ресурсов Key Vault
PrivateLinkResource	Ресурс приватного канала
PrivateLinkResourceListResult	Список ресурсов приватного канала

CloudError

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

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

CloudErrorBody

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

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

PrivateLinkResource

Ресурс приватного канала

Имя	Тип	Описание
id	string	Полный идентификатор ресурса хранилища ключей.
location	string	Расположение ресурса хранилища ключей в Azure.
name	string	Имя ресурса хранилища ключей.
properties.groupId	string	Идентификатор группы ресурса приватного канала.
properties.requiredMembers	string[]	Обязательные имена элементов ресурса приватного канала.
properties.requiredZoneNames	string[]	Обязательные имена зон DNS для ресурса приватного канала.
tags	object	Теги, назначенные ресурсу хранилища ключей.
type	string	Тип ресурса хранилища ключей.

PrivateLinkResourceListResult

Список ресурсов приватного канала

Имя	Тип	Описание
value	PrivateLinkResource[]	Массив ресурсов приватного канала

Поделиться через