Items - Get Variable Library Definition

Служба:: VariableLibrary

Версия API:: v1

Возвращает открытое определение указанной библиотеки переменных.
Этот API поддерживает длительные операции (LRO).

При получении общедоступного определения VariableLibrary метка конфиденциальности не является частью определения.

Разрешения

Вызывающий объект должен иметь разрешения на чтение и запись для библиотеки переменных.

Обязательные делегированные области

VariableLibrary.ReadWrite.All или Item.ReadWrite.All

Поддерживаемые удостоверения Microsoft Entra

Этот API поддерживает удостоверения Microsoft, перечисленные в этом разделе.

Идентичность	Поддержка
Пользователь	Да
учетные записи службы и управляемые удостоверения	Да

Интерфейс

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
variableLibraryId	path	True	string (uuid)	Идентификатор VariableLibrary.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.
format	query		string	Формат общедоступного определения VariableLibrary.

Ответы

Имя	Тип	Описание
200 OK	VariableLibraryDefinitionResponse	Запрос успешно завершен.
202 Accepted		Запрос принят. Получение определения выполняется. Заголовки Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: OperationNotSupportedForItem — операция не поддерживается для запрошенного элемента.

Примеры

Get a VariableLibrary public definition example

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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"
      }
    ]
  }
}

Код состояния:: 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

Определения

Имя	Описание
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
PayloadType	Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.
VariableLibraryDefinitionResponse	Ответ общедоступного определения VariableLibrary.
VariableLibraryPublicDefinition	Объект общедоступного определения VariableLibrary. Дополнительные сведения о структуре определения VariableLibrary см. в этой статье .
VariableLibraryPublicDefinitionPart	Объект части определения VariableLibrary.

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
isRetriable	boolean	Если задано значение true, запрос можно получить. `Retry-After` Используйте заголовок ответа, чтобы определить задержку, если она доступна.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

PayloadType

Перечисление

Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.

Значение	Описание
InlineBase64	Встроенная база 64.

VariableLibraryDefinitionResponse

Объект

Ответ общедоступного определения VariableLibrary.

Имя	Тип	Описание
definition	VariableLibraryPublicDefinition	Объект общедоступного определения VariableLibrary. Дополнительные сведения о структуре определения VariableLibrary см. в этой статье .

VariableLibraryPublicDefinition

Объект

Объект общедоступного определения VariableLibrary. Дополнительные сведения о структуре определения VariableLibrary см. в этой статье .

Имя	Тип	Описание
format	string	Формат определения библиотеки переменных. Поддерживаемый формат: `VariableLibraryV1`.
parts	VariableLibraryPublicDefinitionPart[]	Список частей определения.

VariableLibraryPublicDefinitionPart

Объект

Объект части определения VariableLibrary.

Имя	Тип	Описание
path	string	Путь к части общедоступного определения VariableLibrary.
payload	string	Полезные данные общедоступного определения VariableLibrary.
payloadType	PayloadType	Тип полезных данных.