MHSM Private Endpoint Connections - Put

Service:

Key Vault

API Version:

2022-07-01

Updates koneksi titik akhir privat yang ditentukan yang terkait dengan kumpulan hsm terkelola.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
name	path	True	string	Nama Kumpulan HSM terkelola
privateEndpointConnectionName	path	True	string	Nama koneksi titik akhir privat yang terkait dengan kumpulan hsm terkelola.
resourceGroupName	path	True	string	Nama grup sumber daya yang berisi kumpulan HSM terkelola.
subscriptionId	path	True	string	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi Api Klien.

Isi Permintaan

Nama	Jenis	Deskripsi
etag	string	Dimodifikasi setiap kali ada perubahan status koneksi titik akhir privat.
location	string	Lokasi Azure yang didukung tempat Kumpulan HSM terkelola harus dibuat.
properties.privateEndpoint	MHSMPrivateEndpoint	Properti objek titik akhir privat.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Status persetujuan koneksi tautan privat.
sku	ManagedHsmSku	Detail SKU
tags	object	Tag sumber daya

Respons

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

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

ManagedHsmPutPrivateEndpointConnection

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-mhsm/privateEndpointConnections/sample-pec?api-version=2022-07-01

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

Python

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_put_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.mhsm_private_endpoint_connections.put(
        resource_group_name="sample-group",
        name="sample-mhsm",
        private_endpoint_connection_name="sample-pec",
        properties={
            "properties": {
                "privateLinkServiceConnectionState": {
                    "description": "My name is Joe and I'm approving this.",
                    "status": "Approved",
                }
            }
        },
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_putPrivateEndpointConnection.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

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec",
  "name": "sample-pec",
  "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections",
  "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 kesalahan dari penyedia sumber daya Key Vault
CloudErrorBody	Respons kesalahan dari penyedia sumber daya Key Vault
identityType	Jenis identitas yang membuat sumber daya brankas kunci.
ManagedHsmSku	Detail SKU
ManagedHsmSkuFamily	Keluarga SKU dari Kumpulan HSM terkelola
ManagedHsmSkuName	SKU kumpulan HSM terkelola
MHSMPrivateEndpoint	Properti objek titik akhir privat.
MHSMPrivateEndpointConnection	Sumber daya koneksi titik akhir privat.
MHSMPrivateLinkServiceConnectionState	Objek yang mewakili status persetujuan koneksi tautan privat.
PrivateEndpointConnectionProvisioningState	Status penyediaan koneksi titik akhir privat.
PrivateEndpointServiceConnectionStatus	Menunjukkan apakah koneksi telah disetujui, ditolak, atau dihapus oleh pemilik brankas kunci.
SystemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya brankas kunci.

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 mnemonik yang dapat dikonsumsi secara terprogram.
message	string	Pesan kesalahan yang mudah digunakan. Pesan biasanya dilokalkan dan dapat bervariasi menurut versi layanan.

identityType

Jenis identitas yang membuat sumber daya brankas kunci.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmSku

Detail SKU

Nama	Jenis	Deskripsi
family	ManagedHsmSkuFamily	Keluarga SKU dari Kumpulan HSM terkelola
name	ManagedHsmSkuName	SKU kumpulan HSM terkelola

ManagedHsmSkuFamily

Keluarga SKU dari Kumpulan HSM terkelola

Nama	Jenis	Deskripsi
B	string

ManagedHsmSkuName

SKU kumpulan HSM terkelola

Nama	Jenis	Deskripsi
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMPrivateEndpoint

Properti objek titik akhir privat.

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

MHSMPrivateEndpointConnection

Sumber daya koneksi titik akhir privat.

Nama	Jenis	Deskripsi
etag	string	Dimodifikasi setiap kali ada perubahan status koneksi titik akhir privat.
id	string	ID sumber daya Azure Resource Manager untuk Kumpulan HSM terkelola.
location	string	Lokasi Azure yang didukung tempat Kumpulan HSM terkelola harus dibuat.
name	string	Nama Kumpulan HSM terkelola.
properties.privateEndpoint	MHSMPrivateEndpoint	Properti objek titik akhir privat.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Status persetujuan koneksi tautan privat.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Status penyediaan koneksi titik akhir privat.
sku	ManagedHsmSku	Detail SKU
systemData	SystemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya brankas kunci.
tags	object	Tag sumber daya
type	string	Jenis sumber daya dari Kumpulan HSM terkelola.

MHSMPrivateLinkServiceConnectionState

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.

PrivateEndpointConnectionProvisioningState

Status penyediaan koneksi titik akhir privat.

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

PrivateEndpointServiceConnectionStatus

Menunjukkan apakah koneksi telah disetujui, ditolak, atau dihapus oleh pemilik brankas kunci.

Nama	Jenis	Deskripsi
Approved	string
Disconnected	string
Pending	string
Rejected	string

SystemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya brankas kunci.

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya brankas kunci (UTC).
createdBy	string	Identitas yang membuat sumber daya brankas kunci.
createdByType	identityType	Jenis identitas yang membuat sumber daya brankas kunci.
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya brankas kunci (UTC).
lastModifiedBy	string	Identitas yang terakhir memodifikasi sumber daya brankas kunci.
lastModifiedByType	identityType	Jenis identitas yang terakhir memodifikasi sumber daya brankas kunci.