MHSM Private Endpoint Connections - Delete

Service:

Key Vault

API-versie:

2022-07-01

Hiermee verwijdert u de opgegeven privé-eindpuntverbinding die is gekoppeld aan de beheerde hsm-pool.

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

URI-parameters

Name	In	Vereist	Type	Description
name	path	True	string	Naam van de beheerde HSM-pool
privateEndpointConnectionName	path	True	string	Naam van de privé-eindpuntverbinding die is gekoppeld aan de beheerde hsm-pool.
resourceGroupName	path	True	string	Naam van de resourcegroep die de beheerde HSM-pool 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.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	MHSMPrivateEndpointConnection	De privé-eindpuntverbinding is verwijderd.
202 Accepted		De privé-eindpuntverbinding wordt verwijderd. Kopteksten Location: string
204 No Content		De privé-eindpuntverbinding bestaat niet.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ManagedHsmDeletePrivateEndpointConnection

Voorbeeldaanvraag

HTTP

DELETE 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

Python

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_delete_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.begin_delete(
        resource_group_name="sample-group",
        name="sample-mhsm",
        private_endpoint_connection_name="sample-pec",
    ).result()
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_deletePrivateEndpointConnection.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

Voorbeeldrespons

Statuscode:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-vault/privateEndpointConnections/sample-pec",
  "name": "sample-pec",
  "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections",
  "properties": {
    "provisioningState": "Disconnected"
  }
}

Statuscode:

202

Location: https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec?operationid=25334578

Statuscode:

204

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
identityType	Het type identiteit waarmee de sleutelkluisresource is gemaakt.
ManagedHsmSku	SKU-details
ManagedHsmSkuFamily	SKU-familie van de beheerde HSM-pool
ManagedHsmSkuName	SKU van de beheerde HSM-pool
MHSMPrivateEndpoint	Eigenschappen van privé-eindpuntobjecten.
MHSMPrivateEndpointConnection	Privé-eindpuntverbindingsresource.
MHSMPrivateLinkServiceConnectionState	Een object dat de goedkeuringsstatus van de private link-verbinding vertegenwoordigt.
PrivateEndpointConnectionProvisioningState	Inrichtingsstatus van de privé-eindpuntverbinding.
PrivateEndpointServiceConnectionStatus	Geeft aan of de verbinding is goedgekeurd, geweigerd of verwijderd door de eigenaar van de sleutelkluis.
SystemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de sleutelkluisresource.

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.

identityType

Het type identiteit waarmee de sleutelkluisresource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmSku

SKU-details

Name	Type	Description
family	ManagedHsmSkuFamily	SKU-familie van de beheerde HSM-pool
name	ManagedHsmSkuName	SKU van de beheerde HSM-pool

ManagedHsmSkuFamily

SKU-familie van de beheerde HSM-pool

Name	Type	Description
B	string

ManagedHsmSkuName

SKU van de beheerde HSM-pool

Name	Type	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMPrivateEndpoint

Eigenschappen van privé-eindpuntobjecten.

Name	Type	Description
id	string	Volledige id van de privé-eindpuntresource.

MHSMPrivateEndpointConnection

Privé-eindpuntverbindingsresource.

Name	Type	Description
etag	string	Gewijzigd wanneer er een wijziging is in de status van de privé-eindpuntverbinding.
id	string	De Azure Resource Manager resource-id voor de beheerde HSM-pool.
location	string	De ondersteunde Azure-locatie waar de beheerde HSM-pool moet worden gemaakt.
name	string	De naam van de beheerde HSM-pool.
properties.privateEndpoint	MHSMPrivateEndpoint	Eigenschappen van het privé-eindpuntobject.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Goedkeuringsstatus van de private link-verbinding.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Inrichtingsstatus van de privé-eindpuntverbinding.
sku	ManagedHsmSku	SKU-details
systemData	SystemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de sleutelkluisresource.
tags	object	Resourcetags
type	string	Het resourcetype van de beheerde HSM-pool.

MHSMPrivateLinkServiceConnectionState

Een object dat de goedkeuringsstatus van de private link-verbinding vertegenwoordigt.

Name	Type	Description
actionsRequired	ActionsRequired	Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates van de consument vereisen.
description	string	De reden voor goedkeuring of afwijzing.
status	PrivateEndpointServiceConnectionStatus	Geeft aan of de verbinding is goedgekeurd, geweigerd of verwijderd door de eigenaar van de sleutelkluis.

PrivateEndpointConnectionProvisioningState

Inrichtingsstatus van de privé-eindpuntverbinding.

Name	Type	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Geeft aan of de verbinding is goedgekeurd, geweigerd of verwijderd door de eigenaar van de sleutelkluis.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

SystemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de sleutelkluisresource.

Name	Type	Description
createdAt	string	De tijdstempel van het maken van de sleutelkluisresource (UTC).
createdBy	string	De identiteit die de sleutelkluisresource heeft gemaakt.
createdByType	identityType	Het type identiteit waarmee de sleutelkluisresource is gemaakt.
lastModifiedAt	string	Het tijdstempel van de laatste wijziging van de sleutelkluisresource (UTC).
lastModifiedBy	string	De identiteit die de sleutelkluisresource het laatst heeft gewijzigd.
lastModifiedByType	identityType	Het type identiteit dat de sleutelkluisresource het laatst heeft gewijzigd.