MHSM Private Endpoint Connections - List By Resource

Servizio:: Key Vault

Versione API:: 2024-11-01

L'operazione List ottiene informazioni sulle connessioni dell'endpoint privato associate al pool di moduli hardware gestiti.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/privateEndpointConnections?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
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.

Risposte

Nome	Tipo	Descrizione
200 OK	MHSMPrivateEndpointConnectionsListResult	Ottenere informazioni su tutti i pool di moduli di protezione hardware gestiti nella sottoscrizione specificata.
Other Status Codes	ManagedHsmError	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

List managed HSM Pools in a subscription

Esempio di richiesta

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-mhsm/privateEndpointConnections?api-version=2024-11-01

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec1",
      "name": "sample-pec1",
      "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections",
      "etag": "",
      "properties": {
        "provisioningState": "Succeeded",
        "privateEndpoint": {
          "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe1"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "description": "This was automatically approved by user1234@contoso.com",
          "actionsRequired": "None"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec2",
      "name": "sample-pec2",
      "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections",
      "etag": "",
      "properties": {
        "provisioningState": "Succeeded",
        "privateEndpoint": {
          "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe2"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "description": "This was automatically approved by user1234@contoso.com",
          "actionsRequired": "None"
        }
      }
    }
  ],
  "nextLink": null
}

Definizioni

Nome	Descrizione
ActionsRequired	Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti sul consumer.
Error	L'errore del server.
identityType	Tipo di identità che ha creato la risorsa dell'insieme di credenziali delle chiavi.
ManagedHsmError	Eccezione di errore.
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.
MHSMPrivateEndpointConnectionsListResult	Elenco delle connessioni endpoint private associate a un pool di moduli hardware gestiti
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

Error

Oggetto

L'errore del server.

Nome	Tipo	Descrizione
code	string	Codice di errore.
innererror	Error	L'errore interno, contiene un codice di errore più specifico.
message	string	Messaggio di errore.

identityType

Enumerazione

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

Valore	Descrizione
User
Application
ManagedIdentity
Key

ManagedHsmError

Oggetto

Eccezione di errore.

Nome	Tipo	Descrizione
error	Error	L'errore del server.

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