MHSM Private Endpoint Connections - Put

Referencia

Service:: Key Vault

API Version:: 2022-07-01

Frissítések a felügyelt hsm-készlethez társított megadott privát végpontkapcsolatot.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/privateEndpointConnections/{privateEndpointConnectionName}?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
privateEndpointConnectionName	path	True	string	A felügyelt hsm-készlethez társított privát végpontkapcsolat 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	Ügyfél API-verziója.

Kérelem törzse

Name	Típus	Description
etag	string	A privát végponti kapcsolat állapotának változásakor módosul.
location	string	A támogatott Azure-hely, ahol létre kell hozni a felügyelt HSM-készletet.
properties.privateEndpoint	MHSMPrivateEndpoint	A privát végpont objektumának tulajdonságai.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	A privát kapcsolat kapcsolatának jóváhagyási állapota.
sku	ManagedHsmSku	Termékváltozat részletei
tags	object	Erőforráscímkék

Válaszok

Name	Típus	Description
200 OK	MHSMPrivateEndpointConnection	A privát végponti kapcsolat állapota sikeresen frissült. Headers Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Name

Típus

Description

200 OK

MHSMPrivateEndpointConnection

A privát végponti kapcsolat állapota sikeresen frissült.

Headers

Retry-After: integer
Azure-AsyncOperation: string

Other Status Codes

CloudError

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Példák

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

Sample Response

Status code:: 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"
    }
  }
}

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.
CloudError	Hibaválasz Key Vault erőforrás-szolgáltatótól
CloudErrorBody	Hibaválasz Key Vault erőforrás-szolgáltatótól
identityType	A kulcstartó-erőforrást létrehozó identitás típusa.
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égpontobjektum tulajdonságai.
MHSMPrivateEndpointConnection	Privát végpont kapcsolati erőforrása.
MHSMPrivateLinkServiceConnectionState	Egy objektum, amely a privát kapcsolati kapcsolat jóváhagyási állapotát jelöli.
PrivateEndpointConnectionProvisioningState	A privát végpontkapcsolat kiépítési állapota.
PrivateEndpointServiceConnectionStatus	Azt jelzi, hogy a kulcstartó tulajdonosa jóváhagyta-e, elutasította vagy eltávolította-e a kapcsolatot.
SystemData	A kulcstartó-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

CloudError

Hibaválasz Key Vault erőforrás-szolgáltatótól

Name	Típus	Description
error	CloudErrorBody	Hibaválasz Key Vault erőforrás-szolgáltatótól

CloudErrorBody

Hibaválasz Key Vault erőforrás-szolgáltatótól

Name	Típus	Description
code	string	Hibakód. Ez egy mnemonikus, amely programozott módon használható.
message	string	Felhasználóbarát hibaüzenet. Az üzenet általában honosított, és a szolgáltatás verziójától függően változhat.

identityType

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

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

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