Items - Get SQL Database Definition

Palauttaa määritetyn SQL-tietokannan julkisen määrityksen.
Tämä ohjelmointirajapinta tukee pitkäkestoisia toimintoja.

Kun saat SQL-tietokannan julkisen määrityksen, luottamuksellisuustunniste ei ole osa määritystä.

Käyttöoikeudet

Soittajalla on oltava SQL-tietokannan luku- ja kirjoitusoikeudet .

Vaaditut delegoidut vaikutusalueet

SQLDatabase.ReadWrite.All tai Item.ReadWrite.All

Rajoitukset

Jotta soittaja voi noutaa salatulla luottamuksellisuustunnisteellä suojatun SQL-tietokantakohteen määrityksen, hänellä on oltava riittävät käyttöoikeudet tunnisteen poistamiseen, kuten Microsoft Purview on määritetty.

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Käyttäjätiedot Tuki
Käyttäjä Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen Kyllä

Liittymä

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

URI-parametrit

Nimi Kohteessa Pakollinen Tyyppi Kuvaus
sqlDatabaseId
path True

string (uuid)

SQL-tietokannan tunnus.

workspaceId
path True

string (uuid)

Työtilan tunnus.

format
query

string

SQL-tietokannan julkisen määrityksen muoto. Tuettu muoto: dacpac ja sqlproj. Jos muotoa ei ole annettu, dacpac käytetään kohdetta .

Vastaukset

Nimi Tyyppi Kuvaus
200 OK

SQLDatabaseDefinitionResponse

Pyynnön valmistuttua.

202 Accepted

Pyyntö hyväksytty. Määrityksen noutaminen on kesken.

Otsikot

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka Retry-After ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään.

Otsikot

Retry-After: integer

Other Status Codes

ErrorResponse

Yleiset virhekoodit:

  • OperationNotSupportedForItem – Toimintoa ei tueta pyydetylle kohteelle.

Esimerkit

Get a Digital Twin Builder Flow public definition example

Mallipyyntö

POST https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/sqlDatabases/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/getDefinition

Mallivastaus

{
  "definition": {
    "parts": [
      {
        "path": "definition.dacpac",
        "payload": "ew0KICAibGFrZWhvdXNlSWQiOiAiYjliNWQzNmYtNDQ0NS00MDNiLWFjODctMDE2YjFjZDIwMjExIg0KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
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

Määritelmät

Nimi Kuvaus
ErrorParameter

Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.

ErrorRelatedResource

Virheeseen liittyvä resurssitieto-objekti.

ErrorResponse

Virhevastaus.

ErrorResponseDetails

Virheen vastauksen tiedot.

PayloadType

Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.

SQLDatabaseDefinition

SQL-tietokannan julkinen määritysobjekti. Katso tästä artikkelista lisätietoja SQL-tietokannan määrityksen rakenteesta.

SQLDatabaseDefinitionResponse

SQL-tietokannan julkinen määritysvastaus.

SQLDatabasePublicDefinitionPart

SQL-tietokannan määritysosan objekti.

ErrorParameter

Jäsennetty parametri, joka antaa koneluettavaa lisäkontekstia virheestä.

Nimi Tyyppi Kuvaus
message

string

Ihmisen luettavissa oleva kuvaus parametrin merkityksestä.

name

string

Parametritunniste.

value

string

Parametriarvo.

ErrorRelatedResource

Virheeseen liittyvä resurssitieto-objekti.

Nimi Tyyppi Kuvaus
resourceId

string

Virheestä liittyvä resurssitunnus.

resourceType

string

Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Virhevastaus.

Nimi Tyyppi Kuvaus
errorCode

string

Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.

isRetriable

boolean

Kun arvo on tosi, pyyntöä voidaan yrittää uudelleen. Määritä viive vastausotsikon Retry-After avulla, jos se on käytettävissä.

message

string

Ihmisen luettavissa oleva esitys virheestä.

moreDetails

ErrorResponseDetails[]

Luettelo virheiden lisätiedoista.

parameters

ErrorParameter[]

Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä.

relatedResource

ErrorRelatedResource

Virheisiin liittyvät resurssitiedot.

requestId

string (uuid)

Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Virheen vastauksen tiedot.

Nimi Tyyppi Kuvaus
errorCode

string

Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.

message

string

Ihmisen luettavissa oleva esitys virheestä.

parameters

ErrorParameter[]

Jäsennettyjä parametreja, jotka antavat koneluettavaa lisäkontekstia virheestä.

relatedResource

ErrorRelatedResource

Virheisiin liittyvät resurssitiedot.

PayloadType

Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.

Arvo Kuvaus
InlineBase64

Inline Base 64.

SQLDatabaseDefinition

SQL-tietokannan julkinen määritysobjekti. Katso tästä artikkelista lisätietoja SQL-tietokannan määrityksen rakenteesta.

Nimi Tyyppi Kuvaus
format

string

SQL-tietokannan määrityksen muoto. Tuettu muoto: dacpac ja sqlproj. Jos muotoa ei ole annettu, dacpac käytetään kohdetta .

parts

SQLDatabasePublicDefinitionPart[]

Luettelo määritysosista.

SQLDatabaseDefinitionResponse

SQL-tietokannan julkinen määritysvastaus.

Nimi Tyyppi Kuvaus
definition

SQLDatabaseDefinition

SQL-tietokannan julkinen määritysobjekti. Katso tästä artikkelista lisätietoja SQL-tietokannan määrityksen rakenteesta.

SQLDatabasePublicDefinitionPart

SQL-tietokannan määritysosan objekti.

Nimi Tyyppi Kuvaus
path

string

SQL-tietokannan julkisen määrityksen osan polku. Tuetut SQL-tietokannan sisältölaajennukset: .dacpacdacpac for format; .sqlproj, .sql for sqlproj format.

payload

string

SQL-tietokannan julkisen määrityksen osakuormitus.

payloadType

PayloadType

Hyötykuorman tyyppi.