MHSM Private Endpoint Connections - Put

Servizio:: Key Vault

Versione API:: 2024-11-01

Aggiorna la connessione all'endpoint privato specificata associata al pool di moduli hardware gestiti.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-11-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 all'endpoint privato associata al pool di moduli hardware gestiti.
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 al servizio.
api-version	query	True	string	Versione dell'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.
identity	ManagedServiceIdentity	Identità del servizio gestita (identità assegnate dal sistema e/o assegnate dall'utente)
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 al 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

Esempio di richiesta

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=2024-11-01

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

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 sul consumer.
CloudError	Risposta di errore dal provider di risorse Key Vault
CloudErrorBody	Risposta di errore dal provider di risorse Key Vault
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
ManagedServiceIdentity	Identità del servizio gestita (identità assegnate dal sistema e/o assegnate dall'utente)
ManagedServiceIdentityType	Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned).
MHSMPrivateEndpoint	Proprietà dell'oggetto endpoint privato.
MHSMPrivateEndpointConnection	Risorsa di connessione all'endpoint privato.
MHSMPrivateLinkServiceConnectionState	Oggetto che rappresenta lo stato di approvazione della connessione di 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.
UserAssignedIdentity	Proprietà di identità assegnate dall'utente

ActionsRequired

Enumerazione

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

Valore	Descrizione
None

CloudError

Oggetto

Risposta di errore dal provider di risorse Key Vault

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

CloudErrorBody

Oggetto

Risposta di errore dal provider di risorse Key Vault

Nome	Tipo	Descrizione
code	string	Codice di errore. Si tratta di un tasto mnemonico che può essere utilizzato a livello di codice.
message	string	Messaggio di errore di facile utilizzo. Il messaggio è in genere localizzato e può variare in base alla versione del servizio.

identityType

Enumerazione

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

Valore	Descrizione
User
Application
ManagedIdentity
Key

ManagedHsmSku

Oggetto

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

Enumerazione

Famiglia di SKU del pool di moduli di protezione hardware gestito

Valore	Descrizione
B
C

ManagedHsmSkuName

Enumerazione

SKU del pool di moduli di protezione hardware gestito

Valore	Descrizione
Standard_B1
Custom_B32
Custom_B6
Custom_C42
Custom_C10

ManagedServiceIdentity

Oggetto

Identità del servizio gestita (identità assegnate dal sistema e/o assegnate dall'utente)

Nome	Tipo	Descrizione
principalId	string (uuid)	ID entità servizio dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.
tenantId	string (uuid)	ID tenant dell'identità assegnata dal sistema. Questa proprietà verrà fornita solo per un'identità assegnata dal sistema.
type	ManagedServiceIdentityType	Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned).
userAssignedIdentities	<string, UserAssignedIdentity>	identità User-Assigned Set di identità assegnate dall'utente associate alla risorsa. Le chiavi del dizionario userAssignedIdentities saranno ID risorsa ARM nel formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. I valori del dizionario possono essere oggetti vuoti ({}) nelle richieste.

ManagedServiceIdentityType

Enumerazione

Tipo di identità del servizio gestito (in cui sono consentiti sia i tipi SystemAssigned che UserAssigned).

Valore	Descrizione
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned