Connections - Update Connection

Tjeneste:: Core

API-versjon:: v1

Oppdaterer tilkobling etter ID.
Hvis du vil kryptere legitimasjon, kan du se Konfigurere legitimasjon programmatisk.

Permissions

Innringeren må ha tillatelse for tilkoblingen eller administratortillatelsen for gatewayen for tilkoblingen.

Nødvendige delegerte omfang

Connection.ReadWrite.All

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identity	Support
User	Yes
tjenestekontohaver og administrerte identiteter	Yes

Interface

PATCH https://api.fabric.microsoft.com/v1/connections/{connectionId}

URI-parametere

Name	I	Obligatorisk	Type	Beskrivelse
connectionId	path	True	string (uuid)	ID-en for tilkoblingen.

Brødtekst for forespørsel

Forespørselsteksten kan være ett av følgende:

Name	Beskrivelse
UpdateOnPremisesGatewayConnectionRequest
UpdateOnPremisesGatewayPersonalConnectionRequest
UpdatePersonalCloudConnectionRequest
UpdateShareableCloudConnectionRequest
UpdateStreamingVirtualNetworkGatewayConnectionRequest	Oppdaterer en tilkobling som kobles til via en datagateway for strømming av virtuelle nettverk.
UpdateVirtualNetworkGatewayConnectionRequest

UpdateOnPremisesGatewayConnectionRequest

Name	Obligatorisk	Type	Beskrivelse
connectivityType	True	string: OnPremisesGateway	Tilkoblingstypen for tilkoblingen.
credentialDetails		UpdateOnPremisesGatewayCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName		string	Visningsnavnet for tilkoblingen. Maksimal lengde er 200 tegn.
privacyLevel		PrivacyLevel	Personvernnivået for tilkoblingen.

UpdateOnPremisesGatewayPersonalConnectionRequest

Name	Obligatorisk	Type	Beskrivelse
connectivityType	True	string: OnPremisesGatewayPersonal	Tilkoblingstypen for tilkoblingen.
credentialDetails		UpdateOnPremisesGatewayPersonalCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
privacyLevel		PrivacyLevel	Personvernnivået for tilkoblingen.

UpdatePersonalCloudConnectionRequest

Name	Obligatorisk	Type	Beskrivelse
connectivityType	True	string: PersonalCloud	Tilkoblingstypen for tilkoblingen.
allowConnectionUsageInGateway		boolean	Tillat at denne tilkoblingen brukes med enten lokale datagatewayer eller VNet-datagatewayer.
credentialDetails		UpdateCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
privacyLevel		PrivacyLevel	Personvernnivået for tilkoblingen.

UpdateShareableCloudConnectionRequest

Name	Obligatorisk	Type	Beskrivelse
connectivityType	True	string: ShareableCloud	Tilkoblingstypen for tilkoblingen.
allowConnectionUsageInGateway		boolean	Tillat at denne tilkoblingen brukes med enten lokale datagatewayer eller VNet-datagatewayer.
credentialDetails		UpdateCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName		string	Visningsnavnet for tilkoblingen. Maksimal lengde er 200 tegn.
privacyLevel		PrivacyLevel	Personvernnivået for tilkoblingen.

UpdateStreamingVirtualNetworkGatewayConnectionRequest

Oppdaterer en tilkobling som kobles til via en datagateway for strømming av virtuelle nettverk.

Name	Obligatorisk	Type	Beskrivelse
connectivityType	True	string: StreamingVirtualNetworkGateway	Tilkoblingstypen for tilkoblingen.
credentialDetails		UpdateCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName		string	Visningsnavnet for tilkoblingen. Maksimal lengde er 200 tegn.
privacyLevel		PrivacyLevel	Personvernnivået for tilkoblingen.

UpdateVirtualNetworkGatewayConnectionRequest

Name	Obligatorisk	Type	Beskrivelse
connectivityType	True	string: VirtualNetworkGateway	Tilkoblingstypen for tilkoblingen.
credentialDetails		UpdateCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName		string	Visningsnavnet for tilkoblingen. Maksimal lengde er 200 tegn.
privacyLevel		PrivacyLevel	Personvernnivået for tilkoblingen.

Svar

Name Type Beskrivelse

200 OK

Name	Type	Beskrivelse
200 OK	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection StreamingVirtualNetworkGatewayConnection	OK. Operasjonen var vellykket.
429 Too Many Requests	ErrorResponse	Grensen for tjenestesats ble overskredet. Serveren returnerer en `Retry-After` topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler. Overskrifter Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: EntityNotFound – Finner ikke den forespurte ressursen. InsufficientPermissionsToManageConnection – innringeren har ikke tilstrekkelige tillatelser til å administrere denne tilkoblingen. DuplicateConnectionName – tilkoblingsnavnet er allerede i bruk. IncorrectCredentials – Kan ikke opprette tilkobling ved hjelp av legitimasjonsinndata. UpdateGatewayConnectionFailed – kan ikke oppdatere gatewaytilkoblingen.

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection
StreamingVirtualNetworkGatewayConnection

OK. Operasjonen var vellykket.

429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer

Other Status Codes

ErrorResponse

Vanlige feilkoder:

EntityNotFound – Finner ikke den forespurte ressursen.
InsufficientPermissionsToManageConnection – innringeren har ikke tilstrekkelige tillatelser til å administrere denne tilkoblingen.
DuplicateConnectionName – tilkoblingsnavnet er allerede i bruk.
IncorrectCredentials – Kan ikke opprette tilkobling ved hjelp av legitimasjonsinndata.
UpdateGatewayConnectionFailed – kan ikke oppdatere gatewaytilkoblingen.

Eksempler

On-premises gateway (personal mode) example

On-premises gateway example

Personal cloud example

Shareable cloud example

Streaming virtual network gateway example

Virtual network gateway example

On-premises gateway (personal mode) example

Eksempelforespørsel

HTTP

PATCH https://api.fabric.microsoft.com/v1/connections/ef8f408d-2ab7-4a18-b662-9251febda49c

{
  "connectivityType": "OnPremisesGatewayPersonal",
  "credentialDetails": {
    "credentials": {
      "credentialType": "WindowsWithoutImpersonation",
      "encryptedCredentials": "************************************"
    }
  }
}

Eksempelsvar

Statuskode:: 200

{
  "id": "ef8f408d-2ab7-4a18-b662-9251febda49c",
  "gatewayId": "429a773e-5633-45ee-8584-a192bd79c16a",
  "connectivityType": "OnPremisesGatewayPersonal",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;reporting"
  },
  "privacyLevel": "Private",
  "credentialDetails": {
    "credentialType": "WindowsWithoutImpersonation",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

On-premises gateway example

Eksempelforespørsel

HTTP

PATCH https://api.fabric.microsoft.com/v1/connections/70b17680-48f1-4729-9df6-02576647dc3a

{
  "connectivityType": "OnPremisesGateway",
  "displayName": "ContosoSalesOnPremisesConnection",
  "credentialDetails": {
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Windows",
      "values": [
        {
          "gatewayId": "4f8b5d6e-8e99-4817-8b9e-6b6a613be707",
          "encryptedCredentials": "************************************"
        },
        {
          "gatewayId": "c6961028-1309-4183-9799-a0b0fa28a235",
          "encryptedCredentials": "************************************"
        }
      ]
    }
  }
}

Eksempelsvar

Statuskode:: 200

{
  "id": "70b17680-48f1-4729-9df6-02576647dc3a",
  "displayName": "ContosoSalesOnPremisesConnection",
  "gatewayId": "4f8b5d6e-8e99-4817-8b9e-6b6a613be707",
  "connectivityType": "OnPremisesGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Windows",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

Personal cloud example

Eksempelforespørsel

HTTP

PATCH https://api.fabric.microsoft.com/v1/connections/7a0369b2-58c4-4b67-b3f3-92156a95f1cd

{
  "connectivityType": "PersonalCloud",
  "privacyLevel": "Organizational"
}

Eksempelsvar

Statuskode:: 200

{
  "id": "7a0369b2-58c4-4b67-b3f3-92156a95f1cd",
  "gatewayId": "8f72eea3-d989-4a5a-aeed-02b3aaa2ddd0",
  "connectivityType": "PersonalCloud",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;finances"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "OAuth2",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

Shareable cloud example

Eksempelforespørsel

HTTP

PATCH https://api.fabric.microsoft.com/v1/connections/fa968eee-8075-48f6-8c6d-41260ee1396d

{
  "connectivityType": "ShareableCloud",
  "displayName": "ContosoCloudConnection"
}

Eksempelsvar

Statuskode:: 200

{
  "id": "fa968eee-8075-48f6-8c6d-41260ee1396d",
  "displayName": "ContosoCloudConnection",
  "gatewayId": "8f72eea3-d989-4a5a-aeed-02b3aaa2ddd0",
  "connectivityType": "ShareableCloud",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;networks"
  },
  "privacyLevel": "Public",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": true
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

Streaming virtual network gateway example

Eksempelforespørsel

HTTP

PATCH https://api.fabric.microsoft.com/v1/connections/6b571614-2e98-4bfd-b9ed-1cb8d3ffc396

{
  "connectivityType": "StreamingVirtualNetworkGateway",
  "displayName": "ContosoMarketingStreamingVirtualNetworkGatewayConnection",
  "credentialDetails": {
    "singleSignOnType": "None"
  }
}

Eksempelsvar

Statuskode:: 200

{
  "id": "6b571614-2e98-4bfd-b9ed-1cb8d3ffc396",
  "displayName": "ContosoMarketingStreamingVirtualNetworkGatewayConnection",
  "gatewayId": "befccff4-3ee6-40d7-b8f1-a0a9fd684a85",
  "connectivityType": "StreamingVirtualNetworkGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;marketing"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "Encrypted",
    "skipTestConnection": false
  },
  "myRole": "Owner"
}

Virtual network gateway example

Eksempelforespørsel

HTTP

PATCH https://api.fabric.microsoft.com/v1/connections/6b571614-2e98-4bfd-b9ed-1cb8d3ffc396

{
  "connectivityType": "VirtualNetworkGateway",
  "displayName": "ContosoMarketingVirtualNetworkGatewayConnection",
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None"
  }
}

Eksempelsvar

Statuskode:: 200

{
  "id": "6b571614-2e98-4bfd-b9ed-1cb8d3ffc396",
  "displayName": "ContosoMarketingVirtualNetworkGatewayConnection",
  "gatewayId": "befccff4-3ee6-40d7-b8f1-a0a9fd684a85",
  "connectivityType": "VirtualNetworkGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;marketing"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z",
    "lastBoundDateTime": "2023-05-26T16:22:20Z",
    "lastCredentialUsedDateTime": "2023-05-27T16:22:20Z",
    "myLastBoundDateTime": "2023-05-24T16:22:20Z",
    "myLastCredentialUsedDateTime": "2023-05-25T16:22:20Z"
  },
  "myRole": "Owner"
}

Definisjoner

Name	Beskrivelse
AnonymousCredentials	Legitimasjon for anonym legitimasjonstype.
BasicCredentials	Legitimasjon for grunnleggende legitimasjonstype.
ConnectionEncryption	Tilkoblingskrypteringstypen for tilkoblingen. Flere tilkoblingskrypteringsverdier kan legges til over tid.
ConnectionRecency	Representerer recency-detaljene om tilkoblingen.
ConnectionRole	En tilkoblingsrolle. Flere tilkoblingsroller kan legges til over tid.
ConnectivityType	Tilkoblingstypen for tilkoblingen. Flere tilkoblingstyper kan legges til over tid.
CredentialType	Legitimasjonstypen for tilkoblingen. Flere legitimasjonstyper kan legges til over tid.
ErrorParameter	En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
KeyCredentials	Legitimasjon for Key CredentialType.
KeyPairCredentials	Legitimasjon for KeyPair CredentialType.
KeyVaultSecretReference	Referansen til en hemmelighet som er lagret i Azure Key Vault.
ListConnectionDetails	Utdata for tilkoblingsdetaljer for listeoperasjoner.
ListCredentialDetails	Legitimasjonsdetaljene som returneres når du henter en tilkobling.
OnPremisesCredentialEntry	En gateway-ID og den krypterte serialiserte legitimasjonen.
OnPremisesGatewayConnection	En tilkobling som kobles til via lokal datagateway.
OnPremisesGatewayCredentials	Legitimasjon for godkjenning gjennom en lokal gateway.
OnPremisesGatewayPersonalConnection	En tilkobling som kobles til via en personlig lokal datagateway.
OnPremisesGatewayPersonalCredentials	Legitimasjon for godkjenning gjennom en lokal gateway (personlig modus).
PersonalCloudConnection	En tilkobling som kobles til via skyen og ikke kan deles.
PrivacyLevel	Innstillingen for personvernnivå for tilkoblingen. Flere personvernnivåer kan legges til over tid.
ServicePrincipalCredentials	Legitimasjon for ServicePrincipal CredentialType.
ShareableCloudConnection	En tilkobling som kobles til via skyen.
SharedAccessSignatureCredentials	Legitimasjon for SharedAccessSignature CredentialType.
SingleSignOnType	Enkel påloggingstype for tilkoblingen. Flere typer enkel pålogging kan legges til over tid.
StreamingVirtualNetworkGatewayConnection	En tilkobling som kobles til via en datagateway for strømming av virtuelle nettverk.
UpdateCredentialDetails	Inndata for legitimasjonsdetaljer for oppdatering av en tilkobling.
UpdateOnPremisesGatewayConnectionRequest
UpdateOnPremisesGatewayCredentialDetails	Inndata for legitimasjonsdetaljer for oppdatering av en lokal gatewaytilkobling.
UpdateOnPremisesGatewayPersonalConnectionRequest
UpdateOnPremisesGatewayPersonalCredentialDetails	Inndata for legitimasjonsdetaljer for oppdatering av en lokal gatewaytilkobling.
UpdatePersonalCloudConnectionRequest
UpdateShareableCloudConnectionRequest
UpdateStreamingVirtualNetworkGatewayConnectionRequest	Oppdaterer en tilkobling som kobles til via en datagateway for strømming av virtuelle nettverk.
UpdateVirtualNetworkGatewayConnectionRequest
VirtualNetworkGatewayConnection	En tilkobling som kobles til via en virtuell nettverksdatagateway.
WindowsCredentials	Legitimasjon for Windows CredentialType.
WindowsWithoutImpersonationCredentials	Legitimasjon for WindowsWithoutImpersonation CredentialType.
WorkspaceIdentityCredentials	Legitimasjon for CredentialType for WorkspaceIdentity.

AnonymousCredentials

Objekt

Legitimasjon for anonym legitimasjonstype.

Name	Type	Beskrivelse
credentialType	string: Anonymous	Legitimasjonstypen for tilkoblingen.

BasicCredentials

Objekt

Legitimasjon for grunnleggende legitimasjonstype.

Name	Type	Beskrivelse
credentialType	string: Basic	Legitimasjonstypen for tilkoblingen.
password	string	Passordet. Bruk passord eller passwordReference. Du kan ikke bruke begge samtidig
passwordReference	KeyVaultSecretReference	Referansen til et passord som er lagret i Azure Key Vault. Bruk passord eller passwordReference. Du kan ikke bruke begge samtidig.
username	string	Brukernavnet.

ConnectionEncryption

Opplisting

Tilkoblingskrypteringstypen for tilkoblingen. Flere tilkoblingskrypteringsverdier kan legges til over tid.

Verdi	Beskrivelse
Encrypted	Tilkoblingsforsøket utføres ved hjelp av en kryptert tilkobling.
Any	Tilkoblingsforsøket utføres først ved hjelp av en kryptert tilkobling, og faller deretter tilbake til ukryptert tilkobling hvis den ikke lykkes.
NotEncrypted	Tilkoblingsforsøket utføres ved hjelp av en ukryptert tilkobling.

ConnectionRecency

Objekt

Representerer recency-detaljene om tilkoblingen.

Name	Type	Beskrivelse
createdDateTime	string (date-time)	Tidsstempelet da tilkoblingen ble opprettet i UTC, ved hjelp av formatet YYYY-MM-DDTHH:mm:ssZ.
lastBoundDateTime	string (date-time)	Tidsstempelet da tilkoblingen sist ble bundet til et element i UTC, ved hjelp av formatet YYYY-MM-DDTHH:mm:ssZ.
lastCredentialUsedDateTime	string (date-time)	Tidsstempelet da tilkoblingslegitimasjonen sist ble brukt i UTC, ved hjelp av formatet YYYY-MM-DDTHH:mm:ssZ.
myLastBoundDateTime	string (date-time)	Tidsstempelet da tilkoblingen sist ble bundet til et element av anropsbrukeren i UTC, ved hjelp av YYYY-MM-DDTHH:mm:ssZ-formatet.
myLastCredentialUsedDateTime	string (date-time)	Tidsstempelet da tilkoblingslegitimasjonen sist ble brukt av anropsbrukeren i UTC, ved hjelp av formatet YYYY-MM-DDTHH:mm:ssZ.

ConnectionRole

Opplisting

En tilkoblingsrolle. Flere tilkoblingsroller kan legges til over tid.

Verdi	Beskrivelse
User	Aktiverer brukertilgang for tilkoblingen.
UserWithReshare	Aktiverer bruker med deling av tilgang på nytt for tilkoblingen.
Owner	Aktiverer eierskapstilgang for tilkoblingen.
PendingOwner	Eierskapet til tilkoblingen er ennå ikke effektivt. hovedstolen må oppdatere tilkoblingslegitimasjonen (ved hjelp av API for oppdateringstilkobling) for å gjøre den effektiv.

ConnectivityType

Opplisting

Tilkoblingstypen for tilkoblingen. Flere tilkoblingstyper kan legges til over tid.

Verdi	Beskrivelse
ShareableCloud	Tilkoblingen kobles til via skyen og kan deles med andre.
PersonalCloud	Tilkoblingen kobles til via skyen og kan ikke deles med andre.
OnPremisesGateway	Tilkoblingen kobles til via en lokal datagateway.
OnPremisesGatewayPersonal	Tilkoblingen kobles til via en personlig lokal datagateway.
VirtualNetworkGateway	Tilkoblingen kobles til via en virtuell nettverksdatagateway.
StreamingVirtualNetworkGateway	Tilkoblingen kobles til via en datagateway for strømming av virtuelle nettverk.
Automatic	Tilkoblingen kobles til via skyen ved hjelp av en implisitt datatilkobling. Dette alternativet er bare tilgjengelig for bestemte scenarioer som semantiske modeller som bruker enkel Sign-On (SSO)."
None	Tilkoblingen er ikke bundet

CredentialType

Opplisting

Legitimasjonstypen for tilkoblingen. Flere legitimasjonstyper kan legges til over tid.

Verdi	Beskrivelse
Windows	Tilkobling bruker Windows-godkjenning til å koble til. Støttes bare for lokale gatewayer.
Anonymous	Tilkobling bruker anonym godkjenning til å koble til.
Basic	Tilkobling bruker enkel godkjenning til å koble til.
Key	Tilkobling bruker nøkkelgodkjenning til å koble til.
OAuth2	Tilkobling bruker OAuth 2.0-godkjenning til å koble til.
WindowsWithoutImpersonation	Tilkobling bruker Windows -godkjenning (uten mulighet for representasjon) til å koble til. Støttes bare for lokale gatewayer (personlig modus).
SharedAccessSignature	Tilkobling bruker SAS-godkjenning (shared access signature) til å koble til.
ServicePrincipal	Tilkobling bruker tjenestekontohavergodkjenning til å koble til.
WorkspaceIdentity	Tilkobling bruker godkjenning av arbeidsområdeidentitet til å koble til.
KeyPair	Tilkobling bruker nøkkelpargodkjenning til å koble til.

ErrorParameter

Objekt

En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.

Name	Type	Beskrivelse
message	string	En lesbar beskrivelse av parameterens betydning.
name	string	Parameteridentifikatoren.
value	string	Parameterverdien.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Name	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Name	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
isRetriable	boolean	Når sann, kan forespørselen prøves på nytt. `Retry-After` Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string (uuid)	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Name	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
parameters	ErrorParameter[]	Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

KeyCredentials

Objekt

Legitimasjon for Key CredentialType.

Name	Type	Beskrivelse
credentialType	string: Key	Legitimasjonstypen for tilkoblingen.
key	string	Nøkkelen. Bruk nøkkel eller keyReference. Du kan ikke bruke begge samtidig.
keyReference	KeyVaultSecretReference	Referansen til en nøkkel som er lagret i Azure Key Vault. Bruk nøkkel eller keyReference. Du kan ikke bruke begge samtidig.

KeyPairCredentials

Objekt

Legitimasjon for KeyPair CredentialType.

Name	Type	Beskrivelse
credentialType	string: KeyPair	Legitimasjonstypen for tilkoblingen.
identifier	string	Identifikatoren for nøkkelen.
passphrase	string	Passfrasen for den private nøkkelen hvis den private nøkkelen krypteres.
privateKey	string	Den private nøkkelen basert på PKCS #8 standard.

KeyVaultSecretReference

Objekt

Referansen til en hemmelighet som er lagret i Azure Key Vault.

Name	Type	Beskrivelse
connectionId	string (uuid)	Tilkoblings-ID-en til Key Vault-tilkoblingen.
secretName	string	Navnet på hemmeligheten i Key Vault.
version	string	Versjonen av hemmeligheten i Key Vault.

ListConnectionDetails

Objekt

Utdata for tilkoblingsdetaljer for listeoperasjoner.

Name	Type	Beskrivelse
path	string	Banen til tilkoblingen.
type	string	Tilkoblingstypen.

ListCredentialDetails

Objekt

Legitimasjonsdetaljene som returneres når du henter en tilkobling.

Name	Type	Beskrivelse
connectionEncryption	ConnectionEncryption	Innstillingen for tilkoblingskryptering som brukes under testtilkoblingen.
credentialType	CredentialType	Legitimasjonstypen for tilkoblingen.
singleSignOnType	SingleSignOnType	Enkel påloggingstype for tilkoblingen.
skipTestConnection	boolean	Om tilkoblingen skal hoppe over testtilkoblingen under oppretting og oppdatering. Sann – Hopp over testtilkoblingen Usann – Ikke hopp over testtilkoblingen.

OnPremisesCredentialEntry

Objekt

En gateway-ID og den krypterte serialiserte legitimasjonen.

Name	Type	Beskrivelse
encryptedCredentials	string	Den krypterte serialiserte .json av listen over navneverdipar. Navnet er et legitimasjonsnavn, og verdien er en legitimasjonsverdi. Kryptering utføres ved hjelp av krypteringsalgoritmen Rivest-Shamir-Adleman (RSA) med den lokale gateway-medlemmets offentlige nøkkel.
gatewayId	string (uuid)	Objekt-ID-en for gatewayen.

OnPremisesGatewayConnection

Objekt

En tilkobling som kobles til via lokal datagateway.

Name	Type	Beskrivelse
connectionDetails	ListConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectionRecency	ConnectionRecency	Recency-detaljene om tilkoblingen.
connectivityType	string: OnPremisesGateway	Tilkoblingstypen for tilkoblingen.
credentialDetails	ListCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen.
gatewayId	string (uuid)	Gateway-objekt-ID-en som tilkoblingen utføres gjennom. For skytilkoblinger er dette den virtuelle gateway-ID-en.
id	string (uuid)	Objekt-ID-en for tilkoblingen.
myRole	ConnectionRole	Anropskontohaverens effektive rolle på tilkoblingen. Når hovedstolen er en del av flere sikkerhetsgrupper med ulike roller, returneres den høyeste rollen. Hvis hovedstolen ikke har noen rolle i tilkoblingen, returneres ikke denne egenskapen.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

OnPremisesGatewayCredentials

Objekt

Legitimasjon for godkjenning gjennom en lokal gateway.

Name	Type	Beskrivelse
credentialType	CredentialType	Legitimasjonstypen for tilkoblingen.
values	OnPremisesCredentialEntry[]	Nyttelasten for legitimasjon som skal sendes til den lokale gatewayen.

OnPremisesGatewayPersonalConnection

Objekt

En tilkobling som kobles til via en personlig lokal datagateway.

Name	Type	Beskrivelse
connectionDetails	ListConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectionRecency	ConnectionRecency	Recency-detaljene om tilkoblingen.
connectivityType	string: OnPremisesGatewayPersonal	Tilkoblingstypen for tilkoblingen.
credentialDetails	ListCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen.
gatewayId	string (uuid)	Gateway-objekt-ID-en som tilkoblingen utføres gjennom. For skytilkoblinger er dette den virtuelle gateway-ID-en.
id	string (uuid)	Objekt-ID-en for tilkoblingen.
myRole	ConnectionRole	Anropskontohaverens effektive rolle på tilkoblingen. Når hovedstolen er en del av flere sikkerhetsgrupper med ulike roller, returneres den høyeste rollen. Hvis hovedstolen ikke har noen rolle i tilkoblingen, returneres ikke denne egenskapen.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

OnPremisesGatewayPersonalCredentials

Objekt

Legitimasjon for godkjenning gjennom en lokal gateway (personlig modus).

Name	Type	Beskrivelse
credentialType	CredentialType	Legitimasjonstypen for tilkoblingen.
encryptedCredentials	string	Den krypterte serialiserte .json av listen over navneverdipar. Navnet er et legitimasjonsnavn, og verdien er en legitimasjonsverdi. Kryptering utføres ved hjelp av krypteringsalgoritmen Rivest-Shamir-Adleman (RSA) med den lokale gatewayens offentlige nøkkel.

PersonalCloudConnection

Objekt

En tilkobling som kobles til via skyen og ikke kan deles.

Name	Type	Beskrivelse
allowConnectionUsageInGateway	boolean	Tillat at denne tilkoblingen brukes med enten lokale datagatewayer eller VNet-datagatewayer.
connectionDetails	ListConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectionRecency	ConnectionRecency	Recency-detaljene om tilkoblingen.
connectivityType	string: PersonalCloud	Tilkoblingstypen for tilkoblingen.
credentialDetails	ListCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen.
gatewayId	string (uuid)	Gateway-objekt-ID-en som tilkoblingen utføres gjennom. For skytilkoblinger er dette den virtuelle gateway-ID-en.
id	string (uuid)	Objekt-ID-en for tilkoblingen.
myRole	ConnectionRole	Anropskontohaverens effektive rolle på tilkoblingen. Når hovedstolen er en del av flere sikkerhetsgrupper med ulike roller, returneres den høyeste rollen. Hvis hovedstolen ikke har noen rolle i tilkoblingen, returneres ikke denne egenskapen.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

PrivacyLevel

Opplisting

Innstillingen for personvernnivå for tilkoblingen. Flere personvernnivåer kan legges til over tid.

Verdi	Beskrivelse
None	Ingen innstilling for personvernnivå er konfigurert.
Private	Tilkoblinger som er satt til privat, inneholder sensitiv eller konfidensiell informasjon. Synlighet kan begrenses til autoriserte brukere. Data fra en privat tilkobling vil ikke foldes inn i andre tilkoblinger, inkludert andre private tilkoblinger.
Organizational	Tilkoblinger som er satt til organisatoriske, kan foldes inn i private og andre organisatoriske tilkoblinger. De kan ikke kaste seg inn i offentlige tilkoblinger. Synlighet er satt til en klarert gruppe.
Public	Filer, Internett-tilkoblinger og arbeidsbokdata kan settes til offentlig. Data kan brettes inn i andre tilkoblinger. Synlighet er tilgjengelig for alle.

ServicePrincipalCredentials

Objekt

Legitimasjon for ServicePrincipal CredentialType.

Name	Type	Beskrivelse
credentialType	string: ServicePrincipal	Legitimasjonstypen for tilkoblingen.
servicePrincipalClientId	string (uuid)	Klient-ID-en til tjenestekontohaveren.
servicePrincipalSecret	string	Hemmeligheten bak tjenestekontohaveren. Bruk servicePrincipalSecret eller servicePrincipalSecretReference. Du kan ikke bruke begge samtidig.
servicePrincipalSecretReference	KeyVaultSecretReference	Referansen til en tjenestekontohaverhemmelighet lagret i Azure Key Vault. Bruk servicePrincipalSecret eller servicePrincipalSecretReference. Du kan ikke bruke begge samtidig.
tenantId	string (uuid)	Leier-ID-en til tjenestekontohaveren.

ShareableCloudConnection

Objekt

En tilkobling som kobles til via skyen.

Name	Type	Beskrivelse
allowConnectionUsageInGateway	boolean	Tillat at denne tilkoblingen brukes med enten lokale datagatewayer eller VNet-datagatewayer.
allowUsageInUserControlledCode	boolean	Tillat at denne tilkoblingen brukes med elementer som tillater brukerstyrt kode, for eksempel notatblokk.
connectionDetails	ListConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectionRecency	ConnectionRecency	Recency-detaljene om tilkoblingen.
connectivityType	string: ShareableCloud	Tilkoblingstypen for tilkoblingen.
credentialDetails	ListCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen.
gatewayId	string (uuid)	Gateway-objekt-ID-en som tilkoblingen utføres gjennom. For skytilkoblinger er dette den virtuelle gateway-ID-en.
id	string (uuid)	Objekt-ID-en for tilkoblingen.
myRole	ConnectionRole	Anropskontohaverens effektive rolle på tilkoblingen. Når hovedstolen er en del av flere sikkerhetsgrupper med ulike roller, returneres den høyeste rollen. Hvis hovedstolen ikke har noen rolle i tilkoblingen, returneres ikke denne egenskapen.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

SharedAccessSignatureCredentials

Objekt

Legitimasjon for SharedAccessSignature CredentialType.

Name	Type	Beskrivelse
credentialType	string: SharedAccessSignature	Legitimasjonstypen for tilkoblingen.
token	string	Tokenet. Bruk token eller tokenReference. Du kan ikke bruke begge samtidig.
tokenReference	KeyVaultSecretReference	Referansen til et token som er lagret i Azure Key Vault. Bruk token eller tokenReference. Du kan ikke bruke begge samtidig.

SingleSignOnType

Opplisting

Enkel påloggingstype for tilkoblingen. Flere typer enkel pålogging kan legges til over tid.

Verdi	Beskrivelse
None	Tilkoblingen bruker ikke enkel pålogging for å koble til.
Kerberos	Tilkobling bruker Kerberos enkel pålogging til å koble til.
MicrosoftEntraID	Tilkobling bruker enkel pålogging for Microsoft Entra ID til å koble til.
SecurityAssertionMarkupLanguage	Tilkobling bruker SAML (Security Assertion Markup Language) enkel pålogging for å koble til.
KerberosDirectQueryAndRefresh	Tilkobling bruker Kerberos DirectQuery og Oppdater enkel pålogging for å koble til.

StreamingVirtualNetworkGatewayConnection

Objekt

En tilkobling som kobles til via en datagateway for strømming av virtuelle nettverk.

Name	Type	Beskrivelse
connectionDetails	ListConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectionRecency	ConnectionRecency	Recency-detaljene om tilkoblingen.
connectivityType	string: StreamingVirtualNetworkGateway	Tilkoblingstypen for tilkoblingen.
credentialDetails	ListCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen.
gatewayId	string (uuid)	Gateway-objekt-ID-en for tilkoblingen.
id	string (uuid)	Objekt-ID-en for tilkoblingen.
myRole	ConnectionRole	Anropskontohaverens effektive rolle på tilkoblingen. Når hovedstolen er en del av flere sikkerhetsgrupper med ulike roller, returneres den høyeste rollen. Hvis hovedstolen ikke har noen rolle i tilkoblingen, returneres ikke denne egenskapen.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

UpdateCredentialDetails

Objekt

Inndata for legitimasjonsdetaljer for oppdatering av en tilkobling.

Name	Type	Beskrivelse
connectionEncryption	ConnectionEncryption	Innstillingen for tilkoblingskryptering som brukes under testtilkoblingen.
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials KeyPairCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	Legitimasjonen for tilkoblingen.
singleSignOnType	SingleSignOnType	Enkel påloggingstype for tilkoblingen.
skipTestConnection	boolean	Om tilkoblingen skal hoppe over testtilkoblingen under oppretting og oppdatering. Sann – Hopp over testtilkoblingen Usann – Ikke hopp over testtilkoblingen.

UpdateOnPremisesGatewayConnectionRequest

Objekt

Name	Type	Beskrivelse
connectivityType	string: OnPremisesGateway	Tilkoblingstypen for tilkoblingen.
credentialDetails	UpdateOnPremisesGatewayCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen. Maksimal lengde er 200 tegn.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

UpdateOnPremisesGatewayCredentialDetails

Objekt

Inndata for legitimasjonsdetaljer for oppdatering av en lokal gatewaytilkobling.

Name	Type	Beskrivelse
connectionEncryption	ConnectionEncryption	Innstillingen for tilkoblingskryptering som brukes under testtilkoblingen.
credentials	OnPremisesGatewayCredentials	Legitimasjonen for tilkoblingen.
singleSignOnType	SingleSignOnType	Enkel påloggingstype for tilkoblingen.
skipTestConnection	boolean	Om tilkoblingen skal hoppe over testtilkoblingen under oppretting og oppdatering. Sann – Hopp over testtilkoblingen Usann – Ikke hopp over testtilkoblingen.

UpdateOnPremisesGatewayPersonalConnectionRequest

Objekt

Name	Type	Beskrivelse
connectivityType	string: OnPremisesGatewayPersonal	Tilkoblingstypen for tilkoblingen.
credentialDetails	UpdateOnPremisesGatewayPersonalCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

UpdateOnPremisesGatewayPersonalCredentialDetails

Objekt

Inndata for legitimasjonsdetaljer for oppdatering av en lokal gatewaytilkobling.

Name	Type	Beskrivelse
connectionEncryption	ConnectionEncryption	Innstillingen for tilkoblingskryptering som brukes under testtilkoblingen.
credentials	OnPremisesGatewayPersonalCredentials	Legitimasjonen for tilkoblingen.
singleSignOnType	SingleSignOnType	Enkel påloggingstype for tilkoblingen.
skipTestConnection	boolean	Om tilkoblingen skal hoppe over testtilkoblingen under oppretting og oppdatering. Sann – Hopp over testtilkoblingen Usann – Ikke hopp over testtilkoblingen.

UpdatePersonalCloudConnectionRequest

Objekt

Name	Type	Beskrivelse
allowConnectionUsageInGateway	boolean	Tillat at denne tilkoblingen brukes med enten lokale datagatewayer eller VNet-datagatewayer.
connectivityType	string: PersonalCloud	Tilkoblingstypen for tilkoblingen.
credentialDetails	UpdateCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

UpdateShareableCloudConnectionRequest

Objekt

Name	Type	Beskrivelse
allowConnectionUsageInGateway	boolean	Tillat at denne tilkoblingen brukes med enten lokale datagatewayer eller VNet-datagatewayer.
connectivityType	string: ShareableCloud	Tilkoblingstypen for tilkoblingen.
credentialDetails	UpdateCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen. Maksimal lengde er 200 tegn.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

UpdateStreamingVirtualNetworkGatewayConnectionRequest

Objekt

Oppdaterer en tilkobling som kobles til via en datagateway for strømming av virtuelle nettverk.

Name	Type	Beskrivelse
connectivityType	string: StreamingVirtualNetworkGateway	Tilkoblingstypen for tilkoblingen.
credentialDetails	UpdateCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen. Maksimal lengde er 200 tegn.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

UpdateVirtualNetworkGatewayConnectionRequest

Objekt

Name	Type	Beskrivelse
connectivityType	string: VirtualNetworkGateway	Tilkoblingstypen for tilkoblingen.
credentialDetails	UpdateCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen. Maksimal lengde er 200 tegn.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

VirtualNetworkGatewayConnection

Objekt

En tilkobling som kobles til via en virtuell nettverksdatagateway.

Name	Type	Beskrivelse
connectionDetails	ListConnectionDetails	Tilkoblingsdetaljene for tilkoblingen.
connectionRecency	ConnectionRecency	Recency-detaljene om tilkoblingen.
connectivityType	string: VirtualNetworkGateway	Tilkoblingstypen for tilkoblingen.
credentialDetails	ListCredentialDetails	Legitimasjonsdetaljene for tilkoblingen.
displayName	string	Visningsnavnet for tilkoblingen.
gatewayId	string (uuid)	Gateway-objekt-ID-en som tilkoblingen utføres gjennom. For skytilkoblinger er dette den virtuelle gateway-ID-en.
id	string (uuid)	Objekt-ID-en for tilkoblingen.
myRole	ConnectionRole	Anropskontohaverens effektive rolle på tilkoblingen. Når hovedstolen er en del av flere sikkerhetsgrupper med ulike roller, returneres den høyeste rollen. Hvis hovedstolen ikke har noen rolle i tilkoblingen, returneres ikke denne egenskapen.
privacyLevel	PrivacyLevel	Personvernnivået for tilkoblingen.

WindowsCredentials

Objekt

Legitimasjon for Windows CredentialType.

Name	Type	Beskrivelse
credentialType	string: Windows	Legitimasjonstypen for tilkoblingen.
password	string	Passordet.
username	string	Brukernavnet.

WindowsWithoutImpersonationCredentials

Objekt

Legitimasjon for WindowsWithoutImpersonation CredentialType.

Name	Type	Beskrivelse
credentialType	string: WindowsWithoutImpersonation	Legitimasjonstypen for tilkoblingen.

WorkspaceIdentityCredentials

Objekt

Legitimasjon for CredentialType for WorkspaceIdentity.

Name	Type	Beskrivelse
credentialType	string: WorkspaceIdentity	Legitimasjonstypen for tilkoblingen.