Managed Private Endpoints - Create Workspace Managed Private Endpoint

Serviço:: Core

Versão da API:: v1

Cria um ponto de extremidade privado gerenciado no espaço de trabalho especificado.

Observação

Esta API faz parte de uma versão de pré-visualização e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base no feedback e não é recomendado para uso em produção.

Permissions

O chamador deve ter a função de espaço de trabalho de administrador .

Escopos delegados necessários

Workspace.ReadWrite.All.

Limitations

Para criar um ponto de extremidade privado gerenciado, o espaço de trabalho deve estar em uma capacidade de malha suportada. Para obter mais informações, consulte: Tipos de licença do Microsoft Fabric.

Identidades suportadas pelo Microsoft Entra

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identity	Support
User	Yes
Entidade de serviço e identidades geridas	Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/managedPrivateEndpoints

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.

Corpo do Pedido

Name	Necessário	Tipo	Description
name	True	string	O nome do ponto de extremidade privado. Não deve ter mais de 64 caracteres.
targetPrivateLinkResourceId	True	string	ID do recurso da fonte de dados para a qual o ponto de extremidade privado precisa ser criado.
requestMessage		string	Mensagem para aprovar a solicitação de ponto final privado. Não deve ter mais de 140 caracteres.
targetFQDNs		string[]	Nomes de domínio totalmente qualificados (FQDNs) a serem associados ao ponto de extremidade privado. Não deve ser superior a 20 FQDNs.
targetSubresourceType		string	Sub-recurso apontando para o recurso de link privado.

Respostas

Name	Tipo	Description
201 Created	ManagedPrivateEndpoint	Pedido concluído com sucesso. Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Códigos de erro comuns: UnknownError - Ocorreu um erro.

Name

Tipo

Description

201 Created

ManagedPrivateEndpoint

Pedido concluído com sucesso.

Cabeçalhos

Location: string

Other Status Codes

ErrorResponse

Códigos de erro comuns:

UnknownError - Ocorreu um erro.

Exemplos

Create a managed private endpoint example

Pedido de amostra

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/managedPrivateEndpoints

{
  "name": "testprivatendpoint1",
  "targetPrivateLinkResourceId": "/subscriptions/2374e587-d28b-4898-a39c-6070e078ae31/resourceGroups/testrg/providers/Microsoft.Sql/servers/testsql1",
  "targetSubresourceType": "sqlServer",
  "requestMessage": "Request message to approve private endpoint"
}

Resposta da amostra

Código de estado:: 201

Location: https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/managedPrivateEndpoints/59a92b06-6e5a-468c-b748-e28c8ff28da3

{
  "id": "59a92b06-6e5a-468c-b748-e28c8ff28da3",
  "name": "SqlPE",
  "targetPrivateLinkResourceId": "/subscriptions/e3bf3f1a-4d64-4e42-85e9-aa1b84e3874/resourceGroups/testRG/providers/Microsoft.SqlServer/SqlServer/sql1",
  "provisioningState": "Provisioning",
  "targetSubresourceType": "sqlServer"
}

Definições

Name	Description
ConnectionStatus	Status da conexão de ponto de extremidade privado. Status de conexão adicional pode ser adicionado ao longo do tempo.
CreateManagedPrivateEndpointRequest	Crie carga útil de solicitação de ponto final privado gerenciado.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
ManagedPrivateEndpoint	Ponto de extremidade privado gerenciado.
PrivateEndpointConnectionState	Estado de conexão de ponto de extremidade privado
PrivateEndpointProvisioningState	Estado de provisionamento do ponto de extremidade.

ConnectionStatus

Enumeração

Status da conexão de ponto de extremidade privado. Status de conexão adicional pode ser adicionado ao longo do tempo.

Valor	Description
Pending	Aprovação pendente
Approved	Ponto final aprovado
Rejected	Ponto final rejeitado
Disconnected	Ponto de extremidade desconectado

CreateManagedPrivateEndpointRequest

Object

Crie carga útil de solicitação de ponto final privado gerenciado.

Name	Tipo	Description
name	string	O nome do ponto de extremidade privado. Não deve ter mais de 64 caracteres.
requestMessage	string	Mensagem para aprovar a solicitação de ponto final privado. Não deve ter mais de 140 caracteres.
targetFQDNs	string[]	Nomes de domínio totalmente qualificados (FQDNs) a serem associados ao ponto de extremidade privado. Não deve ser superior a 20 FQDNs.
targetPrivateLinkResourceId	string	ID do recurso da fonte de dados para a qual o ponto de extremidade privado precisa ser criado.
targetSubresourceType	string	Sub-recurso apontando para o recurso de link privado.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível por humanos do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível por humanos do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.