MHSM Private Endpoint Connections - Put

Odwołanie

Usługa:: Key Vault

Wersja interfejsu API:: 2022-07-01

Aktualizacje określone połączenie prywatnego punktu końcowego skojarzone z zarządzaną pulą modułów HSM.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
name	path	True	string	Nazwa zarządzanej puli modułów HSM
privateEndpointConnectionName	path	True	string	Nazwa połączenia prywatnego punktu końcowego skojarzonego z zarządzaną pulą modułów HSM.
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej zarządzaną pulę modułów HSM.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
etag	string	Modyfikowane za każdym razem, gdy nastąpi zmiana stanu połączenia prywatnego punktu końcowego.
location	string	Obsługiwana lokalizacja platformy Azure, w której powinna zostać utworzona zarządzana pula modułów HSM.
properties.privateEndpoint	MHSMPrivateEndpoint	Właściwości obiektu prywatnego punktu końcowego.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Stan zatwierdzenia połączenia łącza prywatnego.
sku	ManagedHsmSku	Szczegóły jednostki SKU
tags	object	Tagi zasobów

Odpowiedzi

Nazwa	Typ	Opis
200 OK	MHSMPrivateEndpointConnection	Stan połączenia prywatnego punktu końcowego został pomyślnie zaktualizowany. Nagłówki Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Nazwa

Typ

Opis

200 OK

MHSMPrivateEndpointConnection

Stan połączenia prywatnego punktu końcowego został pomyślnie zaktualizowany.

Nagłówki

Retry-After: integer
Azure-AsyncOperation: string

Other Status Codes

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Przykładowa odpowiedź

Kod stanu:: 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"
    }
  }
}

Definicje

Nazwa	Opis
ActionsRequired	Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji u konsumenta.
CloudError	Odpowiedź o błędzie od dostawcy zasobów Key Vault
CloudErrorBody	Odpowiedź o błędzie od dostawcy zasobów Key Vault
identityType	Typ tożsamości, która utworzyła zasób magazynu kluczy.
ManagedHsmSku	Szczegóły jednostki SKU
ManagedHsmSkuFamily	Rodzina jednostek SKU zarządzanej puli modułów HSM
ManagedHsmSkuName	Jednostka SKU zarządzanej puli modułów HSM
MHSMPrivateEndpoint	Właściwości obiektu prywatnego punktu końcowego.
MHSMPrivateEndpointConnection	Zasób połączenia z prywatnym punktem końcowym.
MHSMPrivateLinkServiceConnectionState	Obiekt reprezentujący stan zatwierdzenia połączenia łącza prywatnego.
PrivateEndpointConnectionProvisioningState	Stan aprowizacji połączenia prywatnego punktu końcowego.
PrivateEndpointServiceConnectionStatus	Wskazuje, czy połączenie zostało zatwierdzone, odrzucone lub usunięte przez właściciela magazynu kluczy.
SystemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu magazynu kluczy.

ActionsRequired

Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji u konsumenta.

Nazwa	Typ	Opis
None	string

CloudError

Odpowiedź o błędzie od dostawcy zasobów Key Vault

Nazwa	Typ	Opis
error	CloudErrorBody	Odpowiedź o błędzie od dostawcy zasobów Key Vault

CloudErrorBody

Odpowiedź o błędzie od dostawcy zasobów Key Vault

Nazwa	Typ	Opis
code	string	Kod błędu. Jest to mnemonic, który może być używany programowo.
message	string	Przyjazny dla użytkownika komunikat o błędzie. Komunikat jest zazwyczaj zlokalizowany i może się różnić w zależności od wersji usługi.

identityType

Typ tożsamości, która utworzyła zasób magazynu kluczy.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmSku

Szczegóły jednostki SKU

Nazwa	Typ	Opis
family	ManagedHsmSkuFamily	Rodzina jednostek SKU zarządzanej puli modułów HSM
name	ManagedHsmSkuName	Jednostka SKU zarządzanej puli modułów HSM

ManagedHsmSkuFamily

Rodzina jednostek SKU zarządzanej puli modułów HSM

Nazwa	Typ	Opis
B	string

ManagedHsmSkuName

Jednostka SKU zarządzanej puli modułów HSM

Nazwa	Typ	Opis
Custom_B32	string
Custom_B6	string
Standard_B1	string