Items - Create Variable Library

Usługa:: VariableLibrary

Wersja interfejsu API:: v1

Tworzy bibliotekę zmiennych w określonym obszarze roboczym.
Ten interfejs API obsługuje długotrwałych operacji (LRO).

Aby utworzyć zmiennąLibrary z publiczną definicją, zapoznaj się z artykułem VariableLibrary .

Uprawnienia

Obiekt wywołujący musi mieć rolę obszaru roboczego współautora .

Wymagane zakresy delegowane

VariableLibrary.ReadWrite.All lub Item.ReadWrite.All

Ograniczenia

Aby utworzyć zmiennąLibrary, obszar roboczy musi znajdować się w obsługiwanej pojemności Fabric. Aby uzyskać więcej informacji, zobacz: typy licencji Microsoft Fabric.

Microsoft Entra obsługiwane tożsamości

Ten interfejs API obsługuje Microsoft identities wymienione w tej sekcji.

Tożsamość	Wsparcie
Użytkownik	Tak
Główne usługi i Tożsamości zarządzane	Tak

Interfejs

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

Parametry identyfikatora URI

Nazwisko	W	Wymagane	Typ	Opis
workspaceId	path	True	string (uuid)	Identyfikator obszaru roboczego.

Treść żądania

Nazwisko	Wymagane	Typ	Opis
displayName	True	string	Nazwa wyświetlana zmiennejLibrary. Nazwa wyświetlana musi być zgodna z regułami nazewnictwa zgodnie z typem elementu.
definition		VariableLibraryPublicDefinition	Definicja publiczna zmiennejLibrary.
description		string	Opis zmiennejLibrary. Maksymalna długość to 256 znaków.
folderId		string (uuid)	Identyfikator folderu. Jeśli nie zostanie określony lub ma wartość null, zmiennaLibrary zostanie utworzona z obszarem roboczym jako jego folderem.
sensitivityLabelSettings		SensitivityLabelSettings	Ustawienia etykiety poufności dla zmiennejLibrary.

Odpowiedzi

Nazwisko	Typ	Opis
201 Created	VariableLibrary	Pomyślnie utworzono
202 Accepted		Żądanie zaakceptowane, aprowizowanie zmiennejLibrary jest w toku. Nagłówki Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący `Retry-After` w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: InvalidItemType — typ elementu jest nieprawidłowy ItemDisplayNameAlreadyInUse — nazwa wyświetlana elementu jest już używana. CorruptedPayload — podany ładunek jest uszkodzony.

Przykłady

Create a VariableLibrary example

Create a VariableLibrary with public definition example

Create a VariableLibrary example

Przykładowe żądanie

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/variableLibraries

{
  "displayName": "VariableLibrary 1",
  "description": "A VariableLibrary description."
}

Przykładowa odpowiedź

Kod stanu:: 201

{
  "displayName": "VariableLibrary 1",
  "description": "A VariableLibrary description.",
  "type": "VariableLibrary",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Kod stanu:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create a VariableLibrary with public definition example

Przykładowe żądanie

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/variableLibraries

{
  "displayName": "VariableLibrary 1",
  "description": "A VariableLibrary description.",
  "definition": {
    "format": "VariableLibraryV1",
    "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"
      }
    ]
  }
}

Przykładowa odpowiedź

Kod stanu:: 201

{
  "displayName": "VariableLibrary 1",
  "description": "A VariableLibrary description.",
  "type": "VariableLibrary",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Kod stanu:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definicje

Nazwisko	Opis
CreateVariableLibraryRequest	Utwórz ładunek żądania VariableLibrary.
EntireTenantPrincipal	Reprezentuje podmiot zabezpieczeń dzierżawy
ErrorParameter	Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
GroupDetails	Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń to `Group`.
GroupPrincipal	Reprezentuje grupę zabezpieczeń.
GroupType	Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.
ItemTag	Reprezentuje tag zastosowany w elemencie.
ItemType	Typ elementu. Dodatkowe typy elementów można dodawać w czasie.
PayloadType	Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.
PrincipalType	Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.
SensitivityLabel	Reprezentuje etykietę poufności zastosowaną do elementu.
SensitivityLabelApplyStrategy	Strategia stosowania etykiety poufności. Wartość domyślna to ApplyOrFail. Dodatkowe typy mogą być dodawane w czasie.
SensitivityLabelSettings	Ustawienia etykiety poufności.
ServicePrincipalDetails	Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń to `ServicePrincipal`.
ServicePrincipalPrincipal	Reprezentuje Microsoft Entra jednostkę usługi.
ServicePrincipalProfileDetails	Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń to `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Reprezentuje profil jednostki usługi.
UserDetails	Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń to `User`.
UserPrincipal	Reprezentuje Microsoft Entra podmiot zabezpieczeń użytkownika.
VariableLibrary	Obiekt VariableLibrary.
VariableLibraryProperties	Właściwości VariableLibrary.
VariableLibraryPublicDefinition	Obiekt definicji publicznej VariableLibrary. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat struktury definicji VariableLibrary.
VariableLibraryPublicDefinitionPart	Obiekt części definicji ZmiennejLibrary.

CreateVariableLibraryRequest

Objekt

Utwórz ładunek żądania VariableLibrary.

Nazwisko	Typ	Opis
definition	VariableLibraryPublicDefinition	Definicja publiczna zmiennejLibrary.
description	string	Opis zmiennejLibrary. Maksymalna długość to 256 znaków.
displayName	string	Nazwa wyświetlana zmiennejLibrary. Nazwa wyświetlana musi być zgodna z regułami nazewnictwa zgodnie z typem elementu.
folderId	string (uuid)	Identyfikator folderu. Jeśli nie zostanie określony lub ma wartość null, zmiennaLibrary zostanie utworzona z obszarem roboczym jako jego folderem.
sensitivityLabelSettings	SensitivityLabelSettings	Ustawienia etykiety poufności dla zmiennejLibrary.

EntireTenantPrincipal

Objekt

Reprezentuje podmiot zabezpieczeń dzierżawy

Nazwisko	Typ	Opis
displayName	string	Nazwa wyświetlana podmiotu zabezpieczeń.
id	string (uuid)	Identyfikator podmiotu zabezpieczeń.
type	string: EntireTenant	Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

ErrorParameter

Objekt

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.

Nazwisko	Typ	Opis
message	string	Czytelny dla człowieka opis znaczenia parametru.
name	string	Identyfikator parametru.
value	string	Wartość parametru.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwisko	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwisko	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
isRetriable	boolean	Jeśli to prawda, żądanie można ponowić. Użyj nagłówka `Retry-After` odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string (uuid)	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwisko	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

GroupDetails

Objekt

Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń to Group.

Nazwisko	Typ	Opis
groupType	GroupType	Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.

GroupPrincipal

Objekt

Reprezentuje grupę zabezpieczeń.

Nazwisko	Typ	Opis
displayName	string	Nazwa wyświetlana podmiotu zabezpieczeń.
groupDetails	GroupDetails	Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń to `Group`.
id	string (uuid)	Identyfikator podmiotu zabezpieczeń.
type	string: Group	Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

GroupType

Wyliczenie

Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.

Wartość	Opis
Unknown	Typ grupy podmiotu zabezpieczeń jest nieznany.
SecurityGroup	Podmiot zabezpieczeń jest grupą zabezpieczeń.
DistributionList	Podmiot zabezpieczeń jest listą dystrybucyjną.

ItemTag

Objekt

Reprezentuje tag zastosowany w elemencie.

Nazwisko	Typ	Opis
displayName	string	Nazwa znacznika.
id	string (uuid)	Identyfikator tagu.

ItemType

Wyliczenie

Typ elementu. Dodatkowe typy elementów można dodawać w czasie.

Wartość	Opis
Dashboard	Pulpit nawigacyjny usługi Power BI.
Report	Raport usługi Power BI.
SemanticModel	Model semantyczny usługi PowerBI.
PaginatedReport	Raport podzielony na strony usługi PowerBI.
Datamart	Datamart usługi Power BI.
Lakehouse	Jezioro.
Eventhouse	Magazyn zdarzeń.
Environment	Środowisko.
KQLDatabase	Baza danych KQL.
KQLQueryset	Zestaw zapytań KQL.
KQLDashboard	Pulpit nawigacyjny KQL.
DataPipeline	Potok danych.
Notebook	Notes.
SparkJobDefinition	Definicja zadania platformy Spark.
MLExperiment	Eksperyment uczenia maszynowego.
MLModel	Model uczenia maszynowego.
Warehouse	Magazyn.
Eventstream	Strumień zdarzeń.
SQLEndpoint	Punkt końcowy SQL.
MirroredWarehouse	Dublowany magazyn.
MirroredDatabase	Dublowana baza danych.
Reflex	Refleks.
GraphQLApi	Interfejs API dla elementu GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Baza danych SQLDatabase.
CopyJob	Zadanie kopiowania.
VariableLibrary	ZmiennaLibrary.
Dataflow	Przepływ danych.
ApacheAirflowJob	Zadanie ApacheAirflowJob.
WarehouseSnapshot	Migawka magazynu.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Przepływ usługi Digital Twin Builder.
MirroredAzureDatabricksCatalog	Dublowany wykaz usługi Azure Databricks.
Map	Mapa.
AnomalyDetector	Wykrywacz anomalii.
UserDataFunction	Funkcja danych użytkownika.
GraphModel	Model programu Graph.
GraphQuerySet	Zestaw zapytań programu Graph.
SnowflakeDatabase	Baza danych Snowflake do przechowywania tabel góry lodowej utworzonych na podstawie konta Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Baza danych usługi Cosmos DB.
Ontology	Ontologia.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.
MirroredCatalog	A MirroredCatalog.
AppBackend	Element AppBackend.
OrgApp	Aplikacja organizacji.
OrgAppAudience	Odbiorcy aplikacji organizacji.
DataBuildToolJob	Obiekt DataBuildToolJob.
AzureDatabricksStorage	Element magazynu oparty na usłudze OneLake dla Azure Databricks.
Plan	Plan.

PayloadType

Wyliczenie

Typ ładunku części definicji. Dodatkowe typy ładunków mogą być dodawane w czasie.

Wartość	Opis
InlineBase64	Śródliniowa baza 64.

PrincipalType

Wyliczenie

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

Wartość	Opis
User	Podmiot zabezpieczeń jest podmiotem zabezpieczeń Microsoft Entra użytkownika.
ServicePrincipal	Jednostka jest jednostką usługi Microsoft Entra.
Group	Podmiot zabezpieczeń jest grupą zabezpieczeń.
ServicePrincipalProfile	Jednostka jest profilem jednostki usługi.
EntireTenant	Podmiot zabezpieczeń reprezentuje wszystkich użytkowników dzierżawy.

SensitivityLabel

Objekt

Reprezentuje etykietę poufności zastosowaną do elementu.

Nazwisko	Typ	Opis
id	string (uuid)	Identyfikator etykiety poufności.

SensitivityLabelApplyStrategy

Wyliczenie

Strategia stosowania etykiety poufności. Wartość domyślna to ApplyOrFail. Dodatkowe typy mogą być dodawane w czasie.

Wartość	Opis
ApplyOrFail	Zastosuj etykietę poufności lub nie powiedzie się operacji, jeśli nie można jej zastosować.
Ignore	Zignoruj etykietę poufności, jeśli nie można jej zastosować i kontynuuj operację bez stosowania etykiety.

SensitivityLabelSettings

Objekt

Ustawienia etykiety poufności.

Nazwisko	Typ	Opis
labelId	string (uuid)	Identyfikator etykiety poufności.
sensitivityLabelApplyStrategy	SensitivityLabelApplyStrategy	Strategia stosowania etykiety poufności.

ServicePrincipalDetails

Objekt

Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń to ServicePrincipal.

Nazwisko	Typ	Opis
aadAppId	string (uuid)	Microsoft Entra AppId jednostki usługi.

ServicePrincipalPrincipal

Objekt

Reprezentuje Microsoft Entra jednostkę usługi.

Nazwisko	Typ	Opis
displayName	string	Nazwa wyświetlana podmiotu zabezpieczeń.
id	string (uuid)	Identyfikator podmiotu zabezpieczeń.
servicePrincipalDetails	ServicePrincipalDetails	Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń to `ServicePrincipal`.
type	string: ServicePrincipal	Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

ServicePrincipalProfileDetails

Objekt

Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń to ServicePrincipalProfile.

Nazwisko	Typ	Opis
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Jednostka nadrzędna profilu jednostki usługi.

ServicePrincipalProfilePrincipal

Objekt

Reprezentuje profil jednostki usługi.

Nazwisko	Typ	Opis
displayName	string	Nazwa wyświetlana podmiotu zabezpieczeń.
id	string (uuid)	Identyfikator podmiotu zabezpieczeń.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń to `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

UserDetails

Objekt

Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń to User.

Nazwisko	Typ	Opis
userPrincipalName	string	Główna nazwa użytkownika.

UserPrincipal

Objekt

Reprezentuje Microsoft Entra podmiot zabezpieczeń użytkownika.

Nazwisko	Typ	Opis
displayName	string	Nazwa wyświetlana podmiotu zabezpieczeń.
id	string (uuid)	Identyfikator podmiotu zabezpieczeń.
type	string: User	Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.
userDetails	UserDetails	Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń to `User`.

VariableLibrary

Objekt

Obiekt VariableLibrary.

Nazwisko	Typ	Opis
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Tożsamość domyślna elementu.
description	string	Opis elementu.
displayName	string	Nazwa wyświetlana elementu.
folderId	string (uuid)	Identyfikator folderu.
id	string (uuid)	Identyfikator elementu.
logicalId	string (uuid)	Identyfikator logiczny elementu. Odpowiadające wystąpienia elementów mają ten sam identyfikator logiczny. Wartość ma wartość null, gdy nie przypisano identyfikatora logicznego.
properties	VariableLibraryProperties	Właściwości VariableLibrary.
sensitivityLabel	SensitivityLabel	Etykieta poufności elementu.
tags	ItemTag[]	Lista zastosowanych tagów.
type	ItemType	Typ elementu.
workspaceId	string (uuid)	Identyfikator obszaru roboczego.

VariableLibraryProperties

Objekt

Właściwości VariableLibrary.

Nazwisko	Typ	Opis
activeValueSetName	string	Bieżący zestaw wartości aktywnej zmiennejLibrary.

VariableLibraryPublicDefinition

Objekt

Obiekt definicji publicznej VariableLibrary. Zapoznaj się z tym artykułem , aby uzyskać więcej informacji na temat struktury definicji VariableLibrary.

Nazwisko	Typ	Opis
format	string	Format definicji biblioteki zmiennych. Obsługiwany format: `VariableLibraryV1`.
parts	VariableLibraryPublicDefinitionPart[]	Lista części definicji.

VariableLibraryPublicDefinitionPart

Objekt

Obiekt części definicji ZmiennejLibrary.

Nazwisko	Typ	Opis
path	string	Ścieżka części definicji publicznej VariableLibrary.
payload	string	Ładunek części definicji publicznej VariableLibrary.
payloadType	PayloadType	Typ ładunku.