MHSM Private Endpoint Connections - Get

Reference

Služba:: Key Vault

Verze rozhraní API:: 2022-07-01

Získá zadané připojení privátního koncového bodu přidružené ke spravovanému fondu HSM.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
name	path	True	string	Název spravovaného fondu HSM
privateEndpointConnectionName	path	True	string	Název připojení privátního koncového bodu přidruženého ke spravovanému fondu hsm.
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje spravovaný fond HSM.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	MHSMPrivateEndpointConnection	Připojení privátního koncového bodu bylo úspěšně vráceno.
Other Status Codes	ManagedHsmError	Odpověď na chybu popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ManagedHsmGetPrivateEndpointConnection

GET 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

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_get_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.get(
        resource_group_name="sample-group",
        name="sample-mhsm",
        private_endpoint_connection_name="sample-pec",
    )
    print(response)


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

Ukázková odpověď

Stavový kód:: 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",
  "etag": "",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "This was automatically approved by user1234@contoso.com",
      "actionsRequired": "None"
    }
  }
}

Definice

Name	Description
ActionsRequired	Zpráva, která indikuje, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.
Error	Chyba serveru.
identityType	Typ identity, která vytvořila prostředek trezoru klíčů.
ManagedHsmError	Výjimka chyby.
ManagedHsmSku	Podrobnosti skladové položky
ManagedHsmSkuFamily	Řada skladových položek spravovaného fondu HSM
ManagedHsmSkuName	Skladová položka spravovaného fondu HSM
MHSMPrivateEndpoint	Vlastnosti objektu privátního koncového bodu.
MHSMPrivateEndpointConnection	Prostředek připojení privátního koncového bodu
MHSMPrivateLinkServiceConnectionState	Objekt, který představuje stav schválení připojení privátního propojení.
PrivateEndpointConnectionProvisioningState	Stav zřizování připojení privátního koncového bodu
PrivateEndpointServiceConnectionStatus	Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem trezoru klíčů.
SystemData	Metadata týkající se vytvoření a poslední změny prostředku trezoru klíčů

ActionsRequired

Výčet

Zpráva, která indikuje, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.

Hodnota	Description
None

Error

Objekt

Chyba serveru.

Name	Typ	Description
code	string	Kód chyby.
innererror	Error	Vnitřní chyba obsahuje konkrétnější kód chyby.
message	string	Chybová zpráva.

identityType

Výčet

Typ identity, která vytvořila prostředek trezoru klíčů.

Hodnota	Description
Application
Key
ManagedIdentity
User

ManagedHsmError

Objekt

Výjimka chyby.

Name	Typ	Description
error	Error	Chyba serveru.

ManagedHsmSku

Objekt

Podrobnosti skladové položky

Name	Typ	Description
family	ManagedHsmSkuFamily	Řada skladových položek spravovaného fondu HSM
name	ManagedHsmSkuName	Skladová položka spravovaného fondu HSM

ManagedHsmSkuFamily

Výčet

Řada skladových položek spravovaného fondu HSM

Hodnota	Description
B

ManagedHsmSkuName

Výčet

Skladová položka spravovaného fondu HSM

Hodnota	Description
Custom_B32
Custom_B6
Standard_B1