MHSM Private Endpoint Connections - Put

Riferimento

Servizio:: Key Vault

Versione API:: 2022-07-01

Aggiornamenti la connessione dell'endpoint privato specificata associata al pool di moduli di protezione hardware gestito.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
name	path	True	string	Nome del pool di moduli di protezione hardware gestito
privateEndpointConnectionName	path	True	string	Nome della connessione dell'endpoint privato associata al pool hsm gestito.
resourceGroupName	path	True	string	Nome del gruppo di risorse che contiene il pool di moduli di protezione hardware gestito.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
api-version	query	True	string	Versione api client.

Corpo della richiesta

Nome	Tipo	Descrizione
etag	string	Modifica ogni volta che si verifica una modifica dello stato della connessione all'endpoint privato.
location	string	Percorso di Azure supportato in cui deve essere creato il pool di moduli di protezione hardware gestito.
properties.privateEndpoint	MHSMPrivateEndpoint	Proprietà dell'oggetto endpoint privato.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Stato di approvazione della connessione di collegamento privato.
sku	ManagedHsmSku	Dettagli SKU
tags	object	Tag delle risorse

Risposte

Nome	Tipo	Descrizione
200 OK	MHSMPrivateEndpointConnection	Lo stato della connessione all'endpoint privato è stato aggiornato correttamente. Intestazioni Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Nome

Tipo

Descrizione

200 OK

MHSMPrivateEndpointConnection

Lo stato della connessione all'endpoint privato è stato aggiornato correttamente.

Intestazioni

Retry-After: integer
Azure-AsyncOperation: string

Other Status Codes

CloudError

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ManagedHsmPutPrivateEndpointConnection

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

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

Risposta di esempio

Codice di stato:: 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"
    }
  }
}

Definizioni

Nome	Descrizione
ActionsRequired	Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti nel consumer.
CloudError	Risposta di errore da Key Vault provider di risorse
CloudErrorBody	Risposta di errore da Key Vault provider di risorse
identityType	Tipo di identità che ha creato la risorsa dell'insieme di credenziali delle chiavi.
ManagedHsmSku	Dettagli SKU
ManagedHsmSkuFamily	Famiglia di SKU del pool di moduli di protezione hardware gestito
ManagedHsmSkuName	SKU del pool di moduli di protezione hardware gestito
MHSMPrivateEndpoint	Proprietà dell'oggetto endpoint privato.
MHSMPrivateEndpointConnection	Risorsa di connessione dell'endpoint privato.
MHSMPrivateLinkServiceConnectionState	Oggetto che rappresenta lo stato di approvazione della connessione al collegamento privato.
PrivateEndpointConnectionProvisioningState	Stato di provisioning della connessione dell'endpoint privato.
PrivateEndpointServiceConnectionStatus	Indica se la connessione è stata approvata, rifiutata o rimossa dal proprietario dell'insieme di credenziali delle chiavi.
SystemData	Metadati relativi alla creazione e all'ultima modifica della risorsa dell'insieme di credenziali delle chiavi.

ActionsRequired

Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti nel consumer.

Nome	Tipo	Descrizione
None	string

CloudError

Risposta di errore da Key Vault provider di risorse

Nome	Tipo	Descrizione
error	CloudErrorBody	Risposta di errore da Key Vault provider di risorse

CloudErrorBody

Risposta di errore da Key Vault provider di risorse

Nome	Tipo	Descrizione
code	string	Codice di errore. Si tratta di un mnemonico che può essere utilizzato a livello di codice.
message	string	Messaggio di errore descrittivo. Il messaggio viene in genere localizzato e può variare con la versione del servizio.

identityType

Tipo di identità che ha creato la risorsa dell'insieme di credenziali delle chiavi.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmSku

Dettagli SKU

Nome	Tipo	Descrizione
family	ManagedHsmSkuFamily	Famiglia di SKU del pool di moduli di protezione hardware gestito
name	ManagedHsmSkuName	SKU del pool di moduli di protezione hardware gestito

ManagedHsmSkuFamily

Famiglia di SKU del pool di moduli di protezione hardware gestito

Nome	Tipo	Descrizione
B	string

ManagedHsmSkuName

SKU del pool di moduli di protezione hardware gestito

Nome	Tipo	Descrizione
Custom_B32	string
Custom_B6	string
Standard_B1	string