Items - Get Variable Library Definition

Serviço:

VariableLibrary

Versão da API:

v1

Retorna a definição pública da biblioteca de variáveis especificada.
Esta API suporta operações de longa duração (LRO).

Quando você obtém a definição pública de uma VariableLibrary, o rótulo de sensibilidade não faz parte da definição.

Permissões

O chamador deve ter permissões de leitura e gravação para a biblioteca de variáveis.

Escopos delegados necessários

VariableLibrary.ReadWrite.All ou Item.ReadWrite.All

Identidades suportadas pelo Entra da Microsoft

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

Identidade	Apoio
Utilizador	Sim
Entidade de serviço e identidades geridas	Sim

Interfaz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/VariableLibraries/{variableLibraryId}/getDefinition

Com parâmetros opcionais:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/VariableLibraries/{variableLibraryId}/getDefinition?format={format}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
variableLibraryId	path	True	string (uuid)	O ID da VariableLibrary.
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.
format	query		string	O formato da definição pública de VariableLibrary.

Respostas

Name	Tipo	Description
200 OK	VariableLibraryDefinitionResponse	Pedido concluído com sucesso.
202 Accepted		Pedido aceite. Está em curso a recuperação da definição. Cabeçalhos Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: OperationNotSupportedForItem - Operação não suportada para o item solicitado.

Exemplos

Get a VariableLibrary public definition example

Pedido de amostra

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/VariableLibraries/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Resposta da amostra

Código de estado:

200

{
  "definition": {
    "parts": [
      {
        "path": "variables.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "valueSets/valueSet1.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "settings.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Código de estado:

202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definições

Name	Description
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
PayloadType	O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.
VariableLibraryDefinitionResponse	Resposta de definição pública VariableLibrary.
VariableLibraryPublicDefinition	Objeto de definição pública VariableLibrary. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública de VariableLibrary.
VariableLibraryPublicDefinitionPart	Objeto de parte de definição VariableLibrary.

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.

PayloadType

Enumeração

O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.

Valor	Description
InlineBase64	Base em linha 64.

VariableLibraryDefinitionResponse

Object

Resposta de definição pública VariableLibrary.

Name	Tipo	Description
definition	VariableLibraryPublicDefinition	Objeto de definição pública VariableLibrary. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública de VariableLibrary.

VariableLibraryPublicDefinition

Object

Objeto de definição pública VariableLibrary. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública de VariableLibrary.

Name	Tipo	Description
format	string	O formato da definição do item. Formato suportado: VariableLibraryV1.
parts	VariableLibraryPublicDefinitionPart[]	Uma lista de partes de definição.

VariableLibraryPublicDefinitionPart

Object

Objeto de parte de definição VariableLibrary.

Name	Tipo	Description
path	string	O caminho da parte de definição pública VariableLibrary.
payload	string	A carga útil da parte de definição pública da VariableLibrary.
payloadType	PayloadType	O tipo de carga útil.