MHSM Private Endpoint Connections - Put

Referens

Tjänst:: Key Vault

API-version:: 2022-07-01

Uppdateringar den angivna privata slutpunktsanslutningen som är associerad med den hanterade hsm-poolen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
name	path	True	string	Namnet på den hanterade HSM-poolen
privateEndpointConnectionName	path	True	string	Namnet på den privata slutpunktsanslutning som är associerad med den hanterade hsm-poolen.
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller den hanterade HSM-poolen.
subscriptionId	path	True	string	Autentiseringsuppgifter för prenumeration som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Begärandetext

Name	Typ	Description
etag	string	Ändras när det sker en ändring i tillståndet för den privata slutpunktsanslutningen.
location	string	Den Azure-plats som stöds där den hanterade HSM-poolen ska skapas.
properties.privateEndpoint	MHSMPrivateEndpoint	Egenskaper för det privata slutpunktsobjektet.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Godkännandetillstånd för den privata länkanslutningen.
sku	ManagedHsmSku	SKU-information
tags	object	Resurstaggar

Svar

Name	Typ	Description
200 OK	MHSMPrivateEndpointConnection	Tillståndet för den privata slutpunktsanslutningen har uppdaterats. Sidhuvuden Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Name

Typ

Description

200 OK

MHSMPrivateEndpointConnection

Tillståndet för den privata slutpunktsanslutningen har uppdaterats.

Sidhuvuden

Retry-After: integer
Azure-AsyncOperation: string

Other Status Codes

CloudError

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Exempelsvar

Statuskod:: 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"
    }
  }
}

Definitioner

Name	Description
ActionsRequired	Ett meddelande som anger om ändringar i tjänstleverantören kräver uppdateringar på konsumenten.
CloudError	Ett felsvar från Key Vault resursprovider
CloudErrorBody	Ett felsvar från Key Vault resursprovider
identityType	Den typ av identitet som skapade nyckelvalvsresursen.
ManagedHsmSku	SKU-information
ManagedHsmSkuFamily	SKU-familjen för den hanterade HSM-poolen
ManagedHsmSkuName	SKU för den hanterade HSM-poolen
MHSMPrivateEndpoint	Egenskaper för privat slutpunktsobjekt.
MHSMPrivateEndpointConnection	Anslutningsresurs för privat slutpunkt.
MHSMPrivateLinkServiceConnectionState	Ett objekt som representerar godkännandetillståndet för den privata länkanslutningen.
PrivateEndpointConnectionProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.
PrivateEndpointServiceConnectionStatus	Anger om anslutningen har godkänts, avvisats eller tagits bort av nyckelvalvets ägare.
SystemData	Metadata som rör skapande och senaste ändring av nyckelvalvsresursen.

ActionsRequired

Ett meddelande som anger om ändringar i tjänstleverantören kräver uppdateringar på konsumenten.

Name	Typ	Description
None	string

CloudError

Ett felsvar från Key Vault resursprovider

Name	Typ	Description
error	CloudErrorBody	Ett felsvar från Key Vault resursprovider

CloudErrorBody

Ett felsvar från Key Vault resursprovider

Name	Typ	Description
code	string	Felkod. Detta är en mnemonic som kan konsumeras programmatiskt.
message	string	Användarvänligt felmeddelande. Meddelandet är vanligtvis lokaliserat och kan variera beroende på tjänstversion.

identityType

Den typ av identitet som skapade nyckelvalvsresursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmSku

SKU-information

Name	Typ	Description
family	ManagedHsmSkuFamily	SKU-familjen för den hanterade HSM-poolen
name	ManagedHsmSkuName	SKU för den hanterade HSM-poolen

ManagedHsmSkuFamily

SKU-familjen för den hanterade HSM-poolen

Name	Typ	Description
B	string

ManagedHsmSkuName

SKU för den hanterade HSM-poolen

Name	Typ	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string