MHSM Private Endpoint Connections - Put

Referência

Serviço:: Key Vault

Versão da API:: 2022-07-01

Atualizações a conexão de ponto de extremidade privado especificada associada ao pool de hsm gerenciado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
name	path	True	string	Nome do pool de HSM gerenciado
privateEndpointConnectionName	path	True	string	Nome da conexão de ponto de extremidade privado associada ao pool de hsm gerenciado.
resourceGroupName	path	True	string	Nome do grupo de recursos que contém o pool de HSM gerenciado.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Corpo da solicitação

Nome	Tipo	Description
etag	string	Modificado sempre que há uma alteração no estado da conexão de ponto de extremidade privado.
location	string	O local do Azure com suporte em que o pool de HSM gerenciado deve ser criado.
properties.privateEndpoint	MHSMPrivateEndpoint	Propriedades do objeto de ponto de extremidade privado.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Estado de aprovação da conexão de link privado.
sku	ManagedHsmSku	Detalhes do SKU
tags	object	Marcações de recursos

Respostas

Nome	Tipo	Description
200 OK	MHSMPrivateEndpointConnection	O estado da conexão de ponto de extremidade privado foi atualizado com êxito. Cabeçalhos Retry-After: integer Azure-AsyncOperation: string
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Nome

Tipo

Description

200 OK

MHSMPrivateEndpointConnection

O estado da conexão de ponto de extremidade privado foi atualizado com êxito.

Cabeçalhos

Retry-After: integer
Azure-AsyncOperation: string

Other Status Codes

CloudError

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Resposta de exemplo

Código de status:: 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"
    }
  }
}

Definições

Nome	Description
ActionsRequired	Uma mensagem que indica se as alterações no provedor de serviços exigem atualizações no consumidor.
CloudError	Uma resposta de erro do provedor de recursos Key Vault
CloudErrorBody	Uma resposta de erro do provedor de recursos Key Vault
identityType	O tipo de identidade que criou o recurso do cofre de chaves.
ManagedHsmSku	Detalhes do SKU
ManagedHsmSkuFamily	Família de SKU do pool de HSM gerenciado
ManagedHsmSkuName	SKU do pool de HSM gerenciado
MHSMPrivateEndpoint	Propriedades do objeto de ponto de extremidade privado.
MHSMPrivateEndpointConnection	Recurso de conexão de ponto de extremidade privado.
MHSMPrivateLinkServiceConnectionState	Um objeto que representa o estado de aprovação da conexão de link privado.
PrivateEndpointConnectionProvisioningState	Estado de provisionamento da conexão de ponto de extremidade privado.
PrivateEndpointServiceConnectionStatus	Indica se a conexão foi aprovada, rejeitada ou removida pelo proprietário do cofre de chaves.
SystemData	Metadados relativos à criação e última modificação do recurso do cofre de chaves.

ActionsRequired

Uma mensagem que indica se as alterações no provedor de serviços exigem atualizações no consumidor.

Nome	Tipo	Description
None	string

CloudError

Uma resposta de erro do provedor de recursos Key Vault

Nome	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do provedor de recursos Key Vault

CloudErrorBody

Uma resposta de erro do provedor de recursos Key Vault

Nome	Tipo	Description
code	string	Código do erro. Este é um mnemônico que pode ser consumido programaticamente.
message	string	Mensagem de erro amigável. A mensagem normalmente é localizada e pode variar com a versão do serviço.

identityType

O tipo de identidade que criou o recurso do cofre de chaves.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmSku

Detalhes do SKU

Nome	Tipo	Description
family	ManagedHsmSkuFamily	Família de SKU do pool de HSM gerenciado
name	ManagedHsmSkuName	SKU do pool de HSM gerenciado

ManagedHsmSkuFamily

Família de SKU do pool de HSM gerenciado

Nome	Tipo	Description
B	string

ManagedHsmSkuName

SKU do pool de HSM gerenciado

Nome	Tipo	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string