MHSM Private Endpoint Connections - List By Resource

Referencia

Szolgáltatás:: Key Vault

API-verzió:: 2022-07-01

A List művelet információkat kap a felügyelt HSM-készlethez társított privát végponti kapcsolatokról.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
name	path	True	string	A felügyelt HSM-készlet neve
resourceGroupName	path	True	string	A felügyelt HSM-készletet tartalmazó erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
api-version	query	True	string	Client API-verzió.

Válaszok

Name	Típus	Description
200 OK	MHSMPrivateEndpointConnectionsListResult	A megadott előfizetés összes felügyelt HSM-készletével kapcsolatos információk lekérése.
Other Status Codes	ManagedHsmError	A művelet meghiúsulásának okát leíró hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

List managed HSM Pools in a subscription

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

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_list_private_endpoint_connections_by_resource.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.list_by_resource(
        resource_group_name="sample-group",
        name="sample-mhsm",
    )
    for item in response:
        print(item)


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

Mintaválasz

Állapotkód:: 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
}

Definíciók

Name	Description
ActionsRequired	Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére.
Error	A kiszolgálóhiba.
identityType	A Key Vault-erőforrást létrehozó identitás típusa.
ManagedHsmError	A hibakivétel.
ManagedHsmSku	Termékváltozat részletei
ManagedHsmSkuFamily	A felügyelt HSM-készlet termékváltozatcsaládja
ManagedHsmSkuName	A felügyelt HSM-készlet termékváltozata
MHSMPrivateEndpoint	Privát végpont objektumtulajdonságai.
MHSMPrivateEndpointConnection	Privát végpont kapcsolati erőforrása.
MHSMPrivateEndpointConnectionsListResult	Felügyelt HSM-készletekhez társított privát végpontkapcsolatok listája
MHSMPrivateLinkServiceConnectionState	Egy objektum, amely a privát kapcsolati kapcsolat jóváhagyási állapotát jelöli.
PrivateEndpointConnectionProvisioningState	A privát végponti kapcsolat kiépítési állapota.
PrivateEndpointServiceConnectionStatus	Azt jelzi, hogy a kulcstartó tulajdonosa jóváhagyta, elutasította vagy eltávolította-e a kapcsolatot.
SystemData	A Key Vault-erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

ActionsRequired

Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére.

Name	Típus	Description
None	string

Error

A kiszolgálóhiba.

Name	Típus	Description
code	string	A hibakód.
innererror	Error	A belső hiba pontosabb hibakódot tartalmaz.
message	string	A hibaüzenet.

identityType

A Key Vault-erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmError

A hibakivétel.

Name	Típus	Description
error	Error	A kiszolgálóhiba.

ManagedHsmSku

Termékváltozat részletei

Name	Típus	Description
family	ManagedHsmSkuFamily	A felügyelt HSM-készlet termékváltozatcsaládja
name	ManagedHsmSkuName	A felügyelt HSM-készlet termékváltozata

ManagedHsmSkuFamily

A felügyelt HSM-készlet termékváltozatcsaládja

Name	Típus	Description
B	string

ManagedHsmSkuName

A felügyelt HSM-készlet termékváltozata

Name	Típus	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string