Private Endpoint Connections - Put

Referentie

Service:: Key Vault

API Version:: 2022-07-01

Updates de opgegeven privé-eindpuntverbinding die is gekoppeld aan de sleutelkluis.

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

URI-parameters

Name	In	Vereist	Type	Description
privateEndpointConnectionName	path	True	string	Naam van de privé-eindpuntverbinding die is gekoppeld aan de sleutelkluis.
resourceGroupName	path	True	string	Naam van de resourcegroep die de sleutelkluis bevat.
subscriptionId	path	True	string	Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
vaultName	path	True	string	De naam van de sleutelkluis. Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Client-API-versie.

Aanvraagbody

Name	Type	Description
etag	string	Gewijzigd wanneer er een wijziging is in de status van de privé-eindpuntverbinding.
properties.privateEndpoint	PrivateEndpoint	Eigenschappen van het privé-eindpuntobject.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Goedkeuringsstatus van de private link-verbinding.

Antwoorden

Name	Type	Description
200 OK	PrivateEndpointConnection	De status van de privé-eindpuntverbinding is bijgewerkt. Headers Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Name

Type

Description

200 OK

PrivateEndpointConnection

De status van de privé-eindpuntverbinding is bijgewerkt.

Headers

Retry-After: integer
Azure-AsyncOperation: string

Other Status Codes

CloudError

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

KeyVaultPutPrivateEndpointConnection

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec?api-version=2022-07-01

{
  "etag": "",
  "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 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.private_endpoint_connections.put(
        resource_group_name="sample-group",
        vault_name="sample-vault",
        private_endpoint_connection_name="sample-pec",
        properties={
            "etag": "",
            "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/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/vaults/sample-vault/privateEndpointConnections/sample-pec",
  "name": "sample-pec",
  "type": "Microsoft.KeyVault/vaults/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": "My name is Joe and I'm approving this.",
      "actionsRequired": "None"
    }
  }
}

Definities

Name	Description
ActionsRequired	Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates van de consument vereisen.
CloudError	Een foutreactie van Key Vault resourceprovider
CloudErrorBody	Een foutreactie van Key Vault resourceprovider
PrivateEndpoint	Eigenschappen van privé-eindpuntobjecten.
PrivateEndpointConnection	Privé-eindpuntverbindingsresource.
PrivateEndpointConnectionProvisioningState	De huidige inrichtingsstatus.
PrivateEndpointServiceConnectionStatus	De verbindingsstatus van het privé-eindpunt.
PrivateLinkServiceConnectionState	Een object dat de goedkeuringsstatus van de private link-verbinding vertegenwoordigt.

ActionsRequired

Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates van de consument vereisen.

Name	Type	Description
None	string

CloudError

Een foutreactie van Key Vault resourceprovider

Name	Type	Description
error	CloudErrorBody	Een foutreactie van Key Vault resourceprovider

CloudErrorBody

Een foutreactie van Key Vault resourceprovider

Name	Type	Description
code	string	Foutcode. Dit is een ezelsbruggetje dat programmatisch kan worden gebruikt.
message	string	Gebruiksvriendelijk foutbericht. Het bericht is doorgaans gelokaliseerd en kan per serviceversie verschillen.