Private Endpoint Connections - Put

Layanan:

Key Vault

Versi API:

2024-11-01

Memperbarui koneksi titik akhir privat yang ditentukan yang terkait dengan brankas kunci.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-11-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
privateEndpointConnectionName	path	True	string	Nama koneksi titik akhir privat yang terkait dengan brankas kunci.
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 pattern: ^[a-zA-Z0-9-]{3,24}$	Nama brankas kunci.
api-version	query	True	string	Versi Api Klien.

Isi Permintaan

Nama	Jenis	Deskripsi
etag	string	Dimodifikasi setiap kali ada perubahan dalam status koneksi titik akhir privat.
properties.privateEndpoint	PrivateEndpoint	Properti objek titik akhir privat.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Status persetujuan koneksi tautan privat.

Respons

Nama	Jenis	Deskripsi
200 OK	PrivateEndpointConnection	Status koneksi titik akhir privat berhasil diperbarui. Header Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

KeyVaultPutPrivateEndpointConnection

Permintaan sampel

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec?api-version=2024-11-01

{
  "etag": "",
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "My name is Joe and I'm approving this."
    }
  }
}

Respon sampel

Kode status:

200

{
  "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": "My name is Joe and I'm approving this.",
      "actionsRequired": "None"
    }
  }
}

Definisi

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

ActionsRequired

Enumerasi

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

Nilai	Deskripsi
None

CloudError

Objek

Respons error dari penyedia resource Key Vault

Nama	Jenis	Deskripsi
error	CloudErrorBody	Respons error dari penyedia resource Key Vault

CloudErrorBody

Objek

Respons error dari penyedia resource Key Vault

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

PrivateEndpoint

Objek

Properti objek titik akhir privat.

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

PrivateEndpointConnection

Objek

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 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.

PrivateEndpointConnectionProvisioningState

Enumerasi

Status provisi saat ini.

Nilai	Deskripsi
Succeeded
Creating
Updating
Deleting
Failed
Disconnected

PrivateEndpointServiceConnectionStatus

Enumerasi

Status koneksi titik akhir privat.

Nilai	Deskripsi
Pending
Approved
Rejected
Disconnected

PrivateLinkServiceConnectionState

Objek

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.