Managed Private Endpoints - Create Workspace Managed Private Endpoint

Serviço:: Core

Versão da API:: v1

Cria um ponto de extremidade privado gerenciado no workspace especificado.

Observação

Essa API faz parte de uma versão prévia e é fornecida apenas para fins de avaliação e desenvolvimento. Ele pode mudar com base nos comentários e não é recomendado para uso em produção.

Permissions

O chamador deve ter função de administrador workspace.

Escopos delegados necessários

Workspace.ReadWrite.All.

Limitations

Para criar um ponto de extremidade privado gerenciado, o workspace deve estar em uma capacidade do Fabric com suporte. Para obter mais informações, consulte: tipos de licença do Microsoft Fabric.

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

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

Interface

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
workspaceId	path	True	string (uuid)	A ID do workspace.

Corpo da solicitação

Nome	Obrigató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 de 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 de extremidade privado. Não deve ter mais de 140 caracteres.
targetFQDNs		string[]	FQDNs (nomes de domínio totalmente qualificados) a serem associados ao ponto de extremidade privado. Não deve ter mais de 20 FQDNs.
targetSubresourceType		string	Subprocurso apontando para resoure de link privado.

Respostas

Nome	Tipo	Description
201 Created	ManagedPrivateEndpoint	Solicitação concluída com êxito. Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Códigos de erro comuns: UnknownError – Ocorreu um erro.

Nome

Tipo

Description

201 Created

ManagedPrivateEndpoint

Solicitação concluída com êxito.

Cabeçalhos

Location: string

Other Status Codes

ErrorResponse

Códigos de erro comuns:

UnknownError – Ocorreu um erro.

Exemplos

Create a managed private endpoint example

Solicitação de exemplo

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 de exemplo

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

Nome	Description
ConnectionStatus	Status da conexão do ponto de extremidade privado. Status de conexão adicional pode ser adicionado ao longo do tempo.
CreateManagedPrivateEndpointRequest	Criar conteúdo de solicitação de ponto de extremidade 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 do ponto de extremidade privado. Status de conexão adicional pode ser adicionado ao longo do tempo.

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

CreateManagedPrivateEndpointRequest

Objeto

Criar conteúdo de solicitação de ponto de extremidade privado gerenciado.

Nome	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 de extremidade privado. Não deve ter mais de 140 caracteres.
targetFQDNs	string[]	FQDNs (nomes de domínio totalmente qualificados) a serem associados ao ponto de extremidade privado. Não deve ter mais de 20 FQDNs.
targetPrivateLinkResourceId	string	ID de recurso da fonte de dados para a qual o ponto de extremidade privado precisa ser criado.
targetSubresourceType	string	Subprocurso apontando para resoure de link privado.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

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

ErrorResponse

Objeto

A resposta de erro.

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

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

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