MHSM Private Endpoint Connections - Put

Dienst:

Key Vault

API-Version:

2022-07-01

Updates die angegebene private Endpunktverbindung, die dem verwalteten HSM-Pool zugeordnet ist.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Name des verwalteten HSM-Pools
privateEndpointConnectionName	path	True	string	Name der privaten Endpunktverbindung, die dem verwalteten HSM-Pool zugeordnet ist.
resourceGroupName	path	True	string	Name der Ressourcengruppe, die den verwalteten HSM-Pool enthält.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Anforderungstext

Name	Typ	Beschreibung
etag	string	Wird immer geändert, wenn der Status der Verbindung mit einem privaten Endpunkt geändert wird.
location	string	Der unterstützte Azure-Standort, an dem der verwaltete HSM-Pool erstellt werden soll.
properties.privateEndpoint	MHSMPrivateEndpoint	Eigenschaften des privaten Endpunktobjekts.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Genehmigungsstatus der Private Link-Verbindung.
sku	ManagedHsmSku	SKU-Details
tags	object	Ressourcentags

Antworten

Name	Typ	Beschreibung
200 OK	MHSMPrivateEndpointConnection	Der Status der Verbindung mit dem privaten Endpunkt wurde erfolgreich aktualisiert. Header Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ManagedHsmPutPrivateEndpointConnection

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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"
    }
  }
}

Definitionen

Name	Beschreibung
ActionsRequired	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer erfordern.
CloudError	Eine Fehlerantwort von Key Vault Ressourcenanbieter
CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter
identityType	Der Identitätstyp, der die Schlüsseltresorressource erstellt hat.
ManagedHsmSku	SKU-Details
ManagedHsmSkuFamily	SKU-Familie des verwalteten HSM-Pools
ManagedHsmSkuName	SKU des verwalteten HSM-Pools
MHSMPrivateEndpoint	Eigenschaften des privaten Endpunktobjekts.
MHSMPrivateEndpointConnection	Verbindungsressource für private Endpunkte.
MHSMPrivateLinkServiceConnectionState	Ein -Objekt, das den Genehmigungsstatus der Private Link-Verbindung darstellt.
PrivateEndpointConnectionProvisioningState	Bereitstellungsstatus der Verbindung mit dem privaten Endpunkt.
PrivateEndpointServiceConnectionStatus	Gibt an, ob die Verbindung vom Besitzer des Schlüsseltresors genehmigt, abgelehnt oder entfernt wurde.
SystemData	Metadaten zur Erstellung und letzten Änderung der Schlüsseltresorressource.

ActionsRequired

Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer erfordern.

Name	Typ	Beschreibung
None	string

CloudError

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter

CloudErrorBody

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name	Typ	Beschreibung
code	string	Fehlercode Dies ist ein mnemonisches, das programmgesteuert genutzt werden kann.
message	string	Benutzerfreundliche Fehlermeldung. Die Nachricht ist in der Regel lokalisiert und kann je nach Dienstversion variieren.

identityType

Der Identitätstyp, der die Schlüsseltresorressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmSku

SKU-Details

Name	Typ	Beschreibung
family	ManagedHsmSkuFamily	SKU-Familie des verwalteten HSM-Pools
name	ManagedHsmSkuName	SKU des verwalteten HSM-Pools

ManagedHsmSkuFamily

SKU-Familie des verwalteten HSM-Pools

Name	Typ	Beschreibung
B	string

ManagedHsmSkuName

SKU des verwalteten HSM-Pools

Name	Typ	Beschreibung
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMPrivateEndpoint

Eigenschaften des privaten Endpunktobjekts.

Name	Typ	Beschreibung
id	string	Vollständiger Bezeichner der privaten Endpunktressource.

MHSMPrivateEndpointConnection

Verbindungsressource für private Endpunkte.

Name	Typ	Beschreibung
etag	string	Wird immer geändert, wenn der Status der Verbindung mit einem privaten Endpunkt geändert wird.
id	string	Die Azure Resource Manager-Ressourcen-ID für den verwalteten HSM-Pool.
location	string	Der unterstützte Azure-Standort, an dem der verwaltete HSM-Pool erstellt werden soll.
name	string	Der Name des verwalteten HSM-Pools.
properties.privateEndpoint	MHSMPrivateEndpoint	Eigenschaften des privaten Endpunktobjekts.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Genehmigungsstatus der Private Link-Verbindung.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Bereitstellungsstatus der Verbindung mit dem privaten Endpunkt.
sku	ManagedHsmSku	SKU-Details
systemData	SystemData	Metadaten zur Erstellung und letzten Änderung der Schlüsseltresorressource.
tags	object	Ressourcentags
type	string	Der Ressourcentyp des verwalteten HSM-Pools.

MHSMPrivateLinkServiceConnectionState

Ein -Objekt, das den Genehmigungsstatus der Private Link-Verbindung darstellt.

Name	Typ	Beschreibung
actionsRequired	ActionsRequired	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer erfordern.
description	string	Der Grund für die Genehmigung oder Ablehnung.
status	PrivateEndpointServiceConnectionStatus	Gibt an, ob die Verbindung vom Besitzer des Schlüsseltresors genehmigt, abgelehnt oder entfernt wurde.

PrivateEndpointConnectionProvisioningState

Bereitstellungsstatus der Verbindung mit dem privaten Endpunkt.

Name	Typ	Beschreibung
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Gibt an, ob die Verbindung vom Besitzer des Schlüsseltresors genehmigt, abgelehnt oder entfernt wurde.

Name	Typ	Beschreibung
Approved	string
Disconnected	string
Pending	string
Rejected	string

SystemData

Metadaten zur Erstellung und letzten Änderung der Schlüsseltresorressource.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Schlüsseltresorressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Schlüsseltresorressource erstellt hat.
createdByType	identityType	Der Identitätstyp, der die Schlüsseltresorressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung (UTC) der Schlüsseltresorressource.
lastModifiedBy	string	Die Identität, die die Schlüsseltresorressource zuletzt geändert hat.
lastModifiedByType	identityType	Der Identitätstyp, der die Schlüsseltresorressource zuletzt geändert hat.