MHSM Private Endpoint Connections - Put

Reference

Služba:: Key Vault

Verze rozhraní API:: 2022-07-01

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

PUT 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 je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Typ	Description
etag	string	Změněno vždy, když dojde ke změně stavu připojení privátního koncového bodu.
location	string	Podporované umístění Azure, ve kterém by se měl vytvořit spravovaný fond HSM.
properties.privateEndpoint	MHSMPrivateEndpoint	Vlastnosti objektu privátního koncového bodu.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Stav schválení připojení privátního propojení
sku	ManagedHsmSku	Podrobnosti o skladové pořidce
tags	object	Značky prostředků

Odpovědi

Name	Typ	Description
200 OK	MHSMPrivateEndpointConnection	Stav připojení privátního koncového bodu se úspěšně aktualizoval. Hlavičky Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Name

Typ

Description

200 OK

MHSMPrivateEndpointConnection

Stav připojení privátního koncového bodu se úspěšně aktualizoval.

Hlavičky

Retry-After: integer
Azure-AsyncOperation: string

Other Status Codes

CloudError

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

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

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",
  "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"
    }
  }
}

Definice

Name	Description
ActionsRequired	Zpráva s informací, že změny poskytovatele služeb vyžadují aktualizace příjemce.
CloudError	Chybová odpověď od poskytovatele prostředků Key Vault
CloudErrorBody	Chybová odpověď od poskytovatele prostředků Key Vault
identityType	Typ identity, která vytvořila prostředek trezoru klíčů.
ManagedHsmSku	Podrobnosti o skladové pořidce
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	Označuje, jestli vlastník trezoru klíčů připojení schválil, odmítl nebo odebral.
SystemData	Metadata týkající se vytvoření a poslední změny prostředku trezoru klíčů

ActionsRequired

Zpráva s informací, že změny poskytovatele služeb vyžadují aktualizace příjemce.

Name	Typ	Description
None	string

CloudError

Chybová odpověď od poskytovatele prostředků Key Vault

Name	Typ	Description
error	CloudErrorBody	Chybová odpověď od poskytovatele prostředků Key Vault

CloudErrorBody

Chybová odpověď od poskytovatele prostředků Key Vault

Name	Typ	Description
code	string	Kód chyby Jedná se o mnemotechnický objekt, který je možné využívat programově.
message	string	Uživatelsky přívětivá chybová zpráva. Zpráva je obvykle lokalizovaná a může se lišit podle verze služby.

identityType

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

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmSku

Podrobnosti o skladové pořidce

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

ManagedHsmSkuFamily

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

Name	Typ	Description
B	string

ManagedHsmSkuName

Skladová položka spravovaného fondu HSM

Name	Typ	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string