Private Endpoint Connections - List By Resource

Referensi

Service:: Key Vault

API Version:: 2022-07-01

Operasi Daftar mendapatkan informasi tentang koneksi titik akhir privat yang terkait dengan vault.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya yang berisi key vault.
subscriptionId	path	True	string	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
vaultName	path	True	string	Nama brankas kunci. Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Versi Api Klien.

Respons

Nama	Jenis	Deskripsi
200 OK	PrivateEndpointConnectionListResult	Dapatkan informasi tentang semua koneksi titik akhir privat dalam grup sumber daya yang ditentukan.
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

KeyVaultListPrivateEndpointConnection

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections?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_endpoint_connection.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_endpoint_connections.list_by_resource(
        resource_group_name="sample-group",
        vault_name="sample-vault",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/listPrivateEndpointConnection.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-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec",
      "name": "sample-pec",
      "type": "Microsoft.KeyVault/vaults/privateEndpointConnections",
      "etag": "",
      "properties": {
        "provisioningState": "Succeeded",
        "privateEndpoint": {
          "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "description": "This was automatically approved by user1234@contoso.com",
          "actionsRequired": "None"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec",
      "name": "sample-pec",
      "type": "Microsoft.KeyVault/vaults/privateEndpointConnections",
      "etag": "",
      "properties": {
        "provisioningState": "Succeeded",
        "privateEndpoint": {
          "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "description": "This was automatically approved by user1234@contoso.com",
          "actionsRequired": "None"
        }
      }
    }
  ],
  "nextLink": null
}

Definisi

Nama	Deskripsi
ActionsRequired	Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan pada konsumen.
CloudError	Respons kesalahan dari penyedia sumber daya Key Vault
CloudErrorBody	Respons kesalahan dari penyedia sumber daya Key Vault
PrivateEndpoint	Properti objek titik akhir privat.
PrivateEndpointConnection	Sumber daya koneksi titik akhir privat.
PrivateEndpointConnectionListResult	Daftar koneksi titik akhir privat.
PrivateEndpointConnectionProvisioningState	Status penyediaan saat ini.
PrivateEndpointServiceConnectionStatus	Status koneksi titik akhir privat.
PrivateLinkServiceConnectionState	Objek yang mewakili status persetujuan koneksi tautan privat.

ActionsRequired

Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan pada konsumen.

Nama	Jenis	Deskripsi
None	string

CloudError

Respons kesalahan dari penyedia sumber daya Key Vault

Nama	Jenis	Deskripsi
error	CloudErrorBody	Respons kesalahan dari penyedia sumber daya Key Vault

CloudErrorBody

Respons kesalahan dari penyedia sumber daya Key Vault

Nama	Jenis	Deskripsi
code	string	Kode Kesalahan. Ini adalah mnemonic yang dapat dikonsumsi secara terprogram.
message	string	Pesan kesalahan yang mudah digunakan. Pesan biasanya dilokalkan dan dapat bervariasi menurut versi layanan.

PrivateEndpoint

Properti objek titik akhir privat.

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi lengkap sumber daya titik akhir privat.

PrivateEndpointConnection

Sumber daya koneksi titik akhir privat.

Nama	Jenis	Deskripsi
etag	string	Dimodifikasi setiap kali ada perubahan dalam status koneksi titik akhir privat.
id	string	Pengidentifikasi sumber daya brankas kunci yang sepenuhnya memenuhi syarat.
location	string	Lokasi Azure dari sumber daya brankas kunci.
name	string	Nama sumber daya brankas kunci.
properties.privateEndpoint	PrivateEndpoint	Properti objek titik akhir privat.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Status persetujuan koneksi tautan privat.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Status provisi koneksi titik akhir privat.
tags	object	Tag yang ditetapkan ke sumber daya brankas kunci.
type	string	Jenis sumber daya sumber daya brankas kunci.

PrivateEndpointConnectionListResult

Daftar koneksi titik akhir privat.

Nama	Jenis	Deskripsi
nextLink	string	URL untuk mendapatkan set koneksi titik akhir privat berikutnya.
value	PrivateEndpointConnection[]	Daftar koneksi titik akhir privat.

PrivateEndpointConnectionProvisioningState

Status penyediaan saat ini.

Nama	Jenis	Deskripsi
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Status koneksi titik akhir privat.

Nama	Jenis	Deskripsi
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Objek yang mewakili status persetujuan koneksi tautan privat.

Nama	Jenis	Deskripsi
actionsRequired	ActionsRequired	Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan pada konsumen.
description	string	Alasan persetujuan atau penolakan.
status	PrivateEndpointServiceConnectionStatus	Menunjukkan apakah koneksi telah disetujui, ditolak, atau dihapus oleh pemilik brankas kunci.