Items - Get Mirrored Database Definition

Service:: MirroredDatabase

API-versie:: v1

Retourneert de opgegeven openbare definitie van de gespiegelde database.
Deze API ondersteunt langlopende bewerkingen (LRO).

Machtigingen

De aanroeper moet lees- en schrijfmachtigingen hebben voor de gespiegelde database.

Vereiste gedelegeerde bereiken

MirroredDatabase.ReadWrite.All of Item.ReadWrite.All

Limitations

Als u de definitie van een gespiegeld database-item wilt ophalen dat wordt beveiligd door een versleuteld vertrouwelijkheidslabel, moet de aanroeper over voldoende gebruiksrechten beschikken om het label te verwijderen, zoals geconfigureerd in Microsoft Purview.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit	Ondersteuning
Gebruiker	Ja
serviceprincipal en beheerde identiteiten	Ja

gebruikersinterface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/mirroredDatabases/{mirroredDatabaseId}/getDefinition

Met optionele parameters:

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

URI-parameters

Naam	In	Vereist	Type	Description
mirroredDatabaseId	path	True	string (uuid)	De gespiegelde database-id.
workspaceId	path	True	string (uuid)	De werkruimte-ID.
format	query		string	De indeling van de openbare definitie van de gespiegelde database.

Antwoorden

Naam	Type	Description
200 OK	MirroredDatabaseDefinitionResponse	De aanvraag is voltooid.
202 Accepted		Aanvraag geaccepteerd. Het ophalen van de definitie wordt uitgevoerd. Kopteksten Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	De servicesnelheidslimiet is overschreden. De server retourneert een `Retry-After` header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden. Kopteksten Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: OperationNotSupportedForItem - Bewerking wordt niet ondersteund voor aangevraagd item.

Voorbeelden

Get a mirrored database definition example

Voorbeeldaanvraag

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/mirroredDatabases/b1b1b1b1-cccc-dddd-eeee-f2f2f2f2f2f2/getDefinition

Voorbeeldrespons

Statuscode:: 200

{
  "definition": {
    "parts": [
      {
        "path": "mirroring.json",
        "payload": "eyAicHJvcGVydGllcy..WJsZSIgfSB9IH0gXSB9IH0",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Statuscode:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0000aaaa-11bb-cccc-dd22-eeeeee333333
x-ms-operation-id: 0000aaaa-11bb-cccc-dd22-eeeeee333333
Retry-After: 30

Definities

Naam	Description
ErrorParameter	Een gestructureerde parameter die extra machineleesbare context biedt over een fout.
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
MirroredDatabaseDefinition	Gespiegeld openbaar definitieobject voor database. Raadpleeg dit artikel voor meer informatie over de structuur van de definitie van de gespiegelde database.
MirroredDatabaseDefinitionPart	Gespiegeld databasedefinitieonderdeelobject.
MirroredDatabaseDefinitionResponse	Antwoord op openbare definitie van gespiegelde database.
PayloadType	Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.

ErrorParameter

Object

Een gestructureerde parameter die extra machineleesbare context biedt over een fout.

Naam	Type	Description
message	string	Een door mensen leesbare beschrijving van de betekenis van de parameter.
name	string	De parameter-id.
value	string	De waarde van de parameter.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Naam	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Naam	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable	boolean	Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de `Retry-After` antwoordheader om de vertraging te bepalen, indien beschikbaar.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
parameters	ErrorParameter[]	Gestructureerde parameters die extra machineleesbare context bieden over de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string (uuid)	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Naam	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
parameters	ErrorParameter[]	Gestructureerde parameters die extra machineleesbare context bieden over de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

MirroredDatabaseDefinition

Object

Gespiegeld openbaar definitieobject voor database. Raadpleeg dit artikel voor meer informatie over de structuur van de definitie van de gespiegelde database.

Naam	Type	Description
format	string	De indeling van de gespiegelde databasedefinitie.
parts	MirroredDatabaseDefinitionPart[]	Een lijst met definitieonderdelen.

MirroredDatabaseDefinitionPart

Object

Gespiegeld databasedefinitieonderdeelobject.

Naam	Type	Description
path	string	Het pad naar het gespiegelde databaseonderdeel.
payload	string	De nettolading van het gespiegelde databaseonderdeel.
payloadType	PayloadType	Het nettoladingstype.

MirroredDatabaseDefinitionResponse

Object

Antwoord op openbare definitie van gespiegelde database.

Naam	Type	Description
definition	MirroredDatabaseDefinition	Gespiegeld openbaar definitieobject voor database. Raadpleeg dit artikel voor meer informatie over de structuur van de definitie van de gespiegelde database.

PayloadType

Opsomming

Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.

Waarde	Description
InlineBase64	Inline base 64.