Private Link Resources - List By Vault

Référence

Service:: Key Vault

API Version:: 2022-07-01

Obtient les ressources de liaison privée prises en charge pour le coffre de clés.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient le coffre de clés.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
vaultName	path	True	string	Nom du coffre de clés. Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Version de l’API cliente.

Réponses

Nom	Type	Description
200 OK	PrivateLinkResourceListResult	Ressources de liaison privée récupérées avec succès.
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

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

Sample Response

Status code:: 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"
        ]
      }
    }
  ]
}

Définitions

Nom	Description
CloudError	Réponse d’erreur de Key Vault fournisseur de ressources
CloudErrorBody	Réponse d’erreur de Key Vault fournisseur de ressources
PrivateLinkResource	Une ressource de liaison privée
PrivateLinkResourceListResult	Liste des ressources de liaison privée

CloudError

Réponse d’erreur de Key Vault fournisseur de ressources

Nom	Type	Description
error	CloudErrorBody	Réponse d’erreur de Key Vault fournisseur de ressources

CloudErrorBody

Réponse d’erreur de Key Vault fournisseur de ressources

Nom	Type	Description
code	string	Code d’erreur. Il s’agit d’un mnémonique qui peut être consommé par programmation.
message	string	Message d’erreur convivial. Le message est généralement localisé et peut varier en fonction de la version du service.

PrivateLinkResource

Une ressource de liaison privée

Nom	Type	Description
id	string	Identificateur complet de la ressource de coffre de clés.
location	string	Emplacement Azure de la ressource de coffre de clés.
name	string	Nom de la ressource de coffre de clés.
properties.groupId	string	Identificateur de groupe de la ressource de liaison privée.
properties.requiredMembers	string[]	Noms de membres obligatoires de la ressource de liaison privée.
properties.requiredZoneNames	string[]	Noms de zone DNS requis de la ressource de liaison privée.
tags	object	Étiquettes affectées à la ressource de coffre de clés.
type	string	Type de ressource de la ressource de coffre de clés.

PrivateLinkResourceListResult

Liste des ressources de liaison privée

Nom	Type	Description
value	PrivateLinkResource[]	Tableau de ressources de liaison privée

Share via