Private Endpoint Connections - Create Or Update

Referência

Service:: Event Hubs

API Version:: 2024-01-01

Cria ou atualiza PrivateEndpointConnections do namespace de serviço.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-01-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
namespaceName	path	True	string	O nome do namespace Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
privateEndpointConnectionName	path	True	string	O nome PrivateEndpointConnection
resourceGroupName	path	True	string	Nome do grupo de recursos na assinatura do azure.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente uma 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
properties.privateEndpoint	PrivateEndpoint	O recurso ponto de extremidade privado para esta Conexão.
properties.privateLinkServiceConnectionState	ConnectionState	Detalhes sobre o estado da conexão.
properties.provisioningState	EndPointProvisioningState	Estado de provisionamento da Conexão de Ponto de Extremidade Privado.

Respostas

Nome	Tipo	Description
200 OK	PrivateEndpointConnection	Status da conexão PrivateEndPoint criada com êxito.
201 Created	PrivateEndpointConnection	Solicitação para atualizar o Status da Conexão PrivateEndPoint aceita.
202 Accepted	PrivateEndpointConnection	Solicitação para atualizar o Status da Conexão PrivateEndPoint aceita.
Other Status Codes	ErrorResponse	Resposta de erro do Eventhub que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

NameSpacePrivateEndPointConnectionCreate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subID/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-2924/privateEndpointConnections/privateEndpointConnectionName?api-version=2024-01-01

{
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-8396/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-2847"
    },
    "privateLinkServiceConnectionState": {
      "status": "Rejected",
      "description": "testing"
    },
    "provisioningState": "Succeeded"
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}

Status code:: 201

{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}

Status code:: 202

{
  "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0",
  "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-Approved"
    }
  }
}

Definições

Nome	Description
ConnectionState	Informações de ConnectionState.
createdByType	O tipo de identidade que criou o recurso.
EndPointProvisioningState	Estado de provisionamento da Conexão de Ponto de Extremidade Privado.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	A resposta de erro indica que o serviço hub de eventos não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.
PrivateEndpoint	Informações de PrivateEndpoint.
PrivateEndpointConnection	Propriedades do PrivateEndpointConnection.
PrivateLinkConnectionStatus	Status da conexão.
systemData	Metadados relativos à criação e à última modificação do recurso.

ConnectionState

Informações de ConnectionState.

Nome	Tipo	Description
description	string	Descrição do estado da conexão.
status	PrivateLinkConnectionStatus	Status da conexão.

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EndPointProvisioningState

Estado de provisionamento da Conexão de Ponto de Extremidade Privado.

Nome	Tipo	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

A resposta de erro indica que o serviço hub de eventos não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.