Connections - Update Connection

Tjeneste:: Core

API-version:: v1

Opdaterer forbindelsen efter id.
Hvis du vil kryptere legitimationsoplysninger, skal du se Konfigurer legitimationsoplysninger programmatisk.

Permissions

Den, der ringer op, skal have tilladelse til forbindelsen eller administratortilladelsen til gatewayen for forbindelsen.

Påkrævede delegerede områder

Connection.ReadWrite.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identity	Support
User	Yes
tjenesteprincipal og administrerede identiteter	Yes

Interface

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

URI-parametre

Navn	I	Påkrævet	Type	Beskrivelse
connectionId	path	True	string (uuid)	Id'et for forbindelsen.

Brødtekst for anmodning

Brødteksten i denne anmodning kan være en af følgende:

Navn	Beskrivelse
UpdateOnPremisesGatewayConnectionRequest
UpdateOnPremisesGatewayPersonalConnectionRequest
UpdatePersonalCloudConnectionRequest
UpdateShareableCloudConnectionRequest
UpdateStreamingVirtualNetworkGatewayConnectionRequest	Opdaterer en forbindelse, der opretter forbindelse via en streaming af en virtuel netværksdatagateway.
UpdateVirtualNetworkGatewayConnectionRequest

UpdateOnPremisesGatewayConnectionRequest

Navn	Påkrævet	Type	Beskrivelse
connectivityType	True	string: OnPremisesGateway	Forbindelsestypen for forbindelsen.
credentialDetails		UpdateOnPremisesGatewayCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName		string	Det viste navn på forbindelsen. Maksimumlængden er 200 tegn.
privacyLevel		PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

UpdateOnPremisesGatewayPersonalConnectionRequest

Navn	Påkrævet	Type	Beskrivelse
connectivityType	True	string: OnPremisesGatewayPersonal	Forbindelsestypen for forbindelsen.
credentialDetails		UpdateOnPremisesGatewayPersonalCredentialDetails	Legitimationsoplysningerne for forbindelsen.
privacyLevel		PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

UpdatePersonalCloudConnectionRequest

Navn	Påkrævet	Type	Beskrivelse
connectivityType	True	string: PersonalCloud	Forbindelsestypen for forbindelsen.
allowConnectionUsageInGateway		boolean	Tillad, at denne forbindelse bruges med enten datagateways i det lokale miljø eller VNet-datagateways.
credentialDetails		UpdateCredentialDetails	Legitimationsoplysningerne for forbindelsen.
privacyLevel		PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

UpdateShareableCloudConnectionRequest

Navn	Påkrævet	Type	Beskrivelse
connectivityType	True	string: ShareableCloud	Forbindelsestypen for forbindelsen.
allowConnectionUsageInGateway		boolean	Tillad, at denne forbindelse bruges med enten datagateways i det lokale miljø eller VNet-datagateways.
credentialDetails		UpdateCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName		string	Det viste navn på forbindelsen. Maksimumlængden er 200 tegn.
privacyLevel		PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

UpdateStreamingVirtualNetworkGatewayConnectionRequest

Opdaterer en forbindelse, der opretter forbindelse via en streaming af en virtuel netværksdatagateway.

Navn	Påkrævet	Type	Beskrivelse
connectivityType	True	string: StreamingVirtualNetworkGateway	Forbindelsestypen for forbindelsen.
credentialDetails		UpdateCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName		string	Det viste navn på forbindelsen. Maksimumlængden er 200 tegn.
privacyLevel		PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

UpdateVirtualNetworkGatewayConnectionRequest

Navn	Påkrævet	Type	Beskrivelse
connectivityType	True	string: VirtualNetworkGateway	Forbindelsestypen for forbindelsen.
credentialDetails		UpdateCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName		string	Det viste navn på forbindelsen. Maksimumlængden er 200 tegn.
privacyLevel		PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

Svar

Navn Type Beskrivelse

200 OK

Navn	Type	Beskrivelse
200 OK	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection StreamingVirtualNetworkGatewayConnection	OK. Handlingen blev udført.
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: EntityNotFound – Den ønskede ressource blev ikke fundet. InsufficientPermissionsToManageConnection – Kalderen har ikke tilstrækkelige tilladelser til at administrere denne forbindelse. DuplicateConnectionName – Forbindelsesnavnet er allerede i brug. IncorrectCredentials – Der kunne ikke oprettes forbindelse ved hjælp af inputtet legitimationsoplysninger. UpdateGatewayConnectionFailed – Gatewayforbindelsen kunne ikke opdateres.

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection
StreamingVirtualNetworkGatewayConnection

OK. Handlingen blev udført.

429 Too Many Requests

ErrorResponse

Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger.

Headere

Retry-After: integer

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

EntityNotFound – Den ønskede ressource blev ikke fundet.
InsufficientPermissionsToManageConnection – Kalderen har ikke tilstrækkelige tilladelser til at administrere denne forbindelse.
DuplicateConnectionName – Forbindelsesnavnet er allerede i brug.
IncorrectCredentials – Der kunne ikke oprettes forbindelse ved hjælp af inputtet legitimationsoplysninger.
UpdateGatewayConnectionFailed – Gatewayforbindelsen kunne ikke opdateres.

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

Eksempelanmodning

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

Eksempelanmodning

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

Eksempelanmodning

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

Eksempelanmodning

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

Eksempelanmodning

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

Eksempelanmodning

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"
}

Definitioner

Navn	Beskrivelse
AnonymousCredentials	Legitimationsoplysninger for Anonymous CredentialType.
BasicCredentials	Legitimationsoplysninger for Basic CredentialType.
ConnectionEncryption	Forbindelseskrypteringstypen for forbindelsen. Der kan tilføjes yderligere krypteringsværdier for forbindelsen over tid.
ConnectionRecency	Repræsenterer oplysningerne om recency om forbindelsen.
ConnectionRole	En forbindelsesrolle. Der kan tilføjes flere forbindelsesroller over tid.
ConnectivityType	Forbindelsestypen for forbindelsen. Der kan tilføjes flere forbindelsestyper over tid.
CredentialType	Legitimationstypen for forbindelsen. Der kan tilføjes flere typer legitimationsoplysninger over tid.
ErrorParameter	En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
KeyCredentials	Legitimationsoplysninger for NøglelegitimationsoplysningerType.
KeyPairCredentials	Legitimationsoplysninger for KeyPair CredentialType.
KeyVaultSecretReference	Referencen til en hemmelighed, der er gemt i Azure Key Vault.
ListConnectionDetails	Outputtet med forbindelsesoplysninger for listehandlinger.
ListCredentialDetails	De legitimationsoplysninger, der returneres, når der hentes en forbindelse.
OnPremisesCredentialEntry	Et gateway-id og dets krypterede serialiserede legitimationsoplysninger.
OnPremisesGatewayConnection	En forbindelse, der opretter forbindelse via datagatewayen i det lokale miljø.
OnPremisesGatewayCredentials	Legitimationsoplysninger til godkendelse via en gateway i det lokale miljø.
OnPremisesGatewayPersonalConnection	En forbindelse, der opretter forbindelse via en personlig datagateway i det lokale miljø.
OnPremisesGatewayPersonalCredentials	Legitimationsoplysninger til godkendelse via en gateway i det lokale miljø (personlig tilstand).
PersonalCloudConnection	En forbindelse, der opretter forbindelse via cloudmiljøet og ikke kan deles.
PrivacyLevel	Indstillingen for niveauet for beskyttelse af personlige oplysninger for forbindelsen. Der kan tilføjes yderligere niveauer for beskyttelse af personlige oplysninger over tid.
ServicePrincipalCredentials	Legitimationsoplysninger for ServicePrincipal CredentialType.
ShareableCloudConnection	En forbindelse, der opretter forbindelse via cloudmiljøet.
SharedAccessSignatureCredentials	Legitimationsoplysninger for SharedAccessSignature CredentialType.
SingleSignOnType	Forbindelsestypen enkeltlogon. Der kan tilføjes flere enkeltlogontyper over tid.
StreamingVirtualNetworkGatewayConnection	En forbindelse, der opretter forbindelse via en streaming af en virtuel netværksdatagateway.
UpdateCredentialDetails	Inputtet med legitimationsoplysninger til opdatering af en forbindelse.
UpdateOnPremisesGatewayConnectionRequest
UpdateOnPremisesGatewayCredentialDetails	Inputtet med legitimationsoplysninger til opdatering af en gatewayforbindelse i det lokale miljø.
UpdateOnPremisesGatewayPersonalConnectionRequest
UpdateOnPremisesGatewayPersonalCredentialDetails	Inputtet med legitimationsoplysninger til opdatering af en gatewayforbindelse i det lokale miljø.
UpdatePersonalCloudConnectionRequest
UpdateShareableCloudConnectionRequest
UpdateStreamingVirtualNetworkGatewayConnectionRequest	Opdaterer en forbindelse, der opretter forbindelse via en streaming af en virtuel netværksdatagateway.
UpdateVirtualNetworkGatewayConnectionRequest
VirtualNetworkGatewayConnection	En forbindelse, der opretter forbindelse via en virtuel netværksdatagateway.
WindowsCredentials	Legitimationsoplysninger for Windows CredentialType.
WindowsWithoutImpersonationCredentials	Legitimationsoplysninger for WindowsWithoutImpersonation CredentialType.
WorkspaceIdentityCredentials	Legitimationsoplysninger for WorkspaceIdentity CredentialType.

AnonymousCredentials

Objekt

Legitimationsoplysninger for Anonymous CredentialType.

Navn	Type	Beskrivelse
credentialType	string: Anonymous	Legitimationstypen for forbindelsen.

BasicCredentials

Objekt

Legitimationsoplysninger for Basic CredentialType.

Navn	Type	Beskrivelse
credentialType	string: Basic	Legitimationstypen for forbindelsen.
password	string	Adgangskoden. Brug adgangskode eller adgangskodeReference. Du kan ikke bruge begge dele på samme tid
passwordReference	KeyVaultSecretReference	Referencen til en adgangskode, der er gemt i Azure Key Vault. Brug adgangskode eller adgangskodeReference. Du kan ikke bruge begge dele på samme tid.
username	string	Brugernavnet.

ConnectionEncryption

Optælling

Forbindelseskrypteringstypen for forbindelsen. Der kan tilføjes yderligere krypteringsværdier for forbindelsen over tid.

Værdi	Beskrivelse
Encrypted	Forbindelsesforsøget foretages ved hjælp af en krypteret forbindelse.
Any	Forbindelsesforsøget foretages først ved hjælp af en krypteret forbindelse og går derefter tilbage til ukrypteret forbindelse, hvis det mislykkes.
NotEncrypted	Forbindelsesforsøget udføres ved hjælp af en ukrypteret forbindelse.

ConnectionRecency

Objekt

Repræsenterer oplysningerne om recency om forbindelsen.

Navn	Type	Beskrivelse
createdDateTime	string (date-time)	Tidsstemplet, da forbindelsen blev oprettet i UTC, ved hjælp af formatet YYYY-MM-DDTHH:mm:ssZ.
lastBoundDateTime	string (date-time)	Tidsstemplet, hvor forbindelsen senest blev bundet til et element i UTC ved hjælp af formatet YYYY-MM-DDTHH:mm:ssZ.
lastCredentialUsedDateTime	string (date-time)	Tidsstemplet, hvor legitimationsoplysningerne for forbindelsen senest blev brugt i UTC ved hjælp af formatet YYYY-MM-DDTHH:mm:ssZ.
myLastBoundDateTime	string (date-time)	Tidsstemplet, hvor forbindelsen senest blev bundet til et element af den kaldende bruger i UTC ved hjælp af formatet YYYY-MM-DDTHH:mm:ssZ.
myLastCredentialUsedDateTime	string (date-time)	Tidsstemplet, hvor legitimationsoplysningerne for forbindelsen senest blev brugt af den kaldende bruger i UTC ved hjælp af formatet YYYY-MM-DDTHH:mm:ssZ.

ConnectionRole

Optælling

En forbindelsesrolle. Der kan tilføjes flere forbindelsesroller over tid.

Værdi	Beskrivelse
User	Giver brugeren adgang til forbindelsen.
UserWithReshare	Giver brugeren mulighed for at videredelingsadgangen for forbindelsen.
Owner	Aktiverer ejerskabsadgang for forbindelsen.
PendingOwner	Ejerskabet af forbindelsen er endnu ikke effektivt. hovedprincipalen skal opdatere legitimationsoplysningerne for forbindelsen (ved hjælp af Api til opdateringsforbindelse) for at gøre den gældende.

ConnectivityType

Optælling

Forbindelsestypen for forbindelsen. Der kan tilføjes flere forbindelsestyper over tid.

Værdi	Beskrivelse
ShareableCloud	Forbindelsen opretter forbindelse via cloudmiljøet og kan deles med andre.
PersonalCloud	Forbindelsen opretter forbindelse via cloudmiljøet og kan ikke deles med andre.
OnPremisesGateway	Forbindelsen opretter forbindelse via en datagateway i det lokale miljø.
OnPremisesGatewayPersonal	Forbindelsen opretter forbindelse via en personlig datagateway i det lokale miljø.
VirtualNetworkGateway	Forbindelsen opretter forbindelse via en virtuel netværksdatagateway.
StreamingVirtualNetworkGateway	Forbindelsen opretter forbindelse via en virtuel netværksdatagateway til streaming.
Automatic	Forbindelsen opretter forbindelse via cloudmiljøet ved hjælp af en implicit dataforbindelse. Denne indstilling er kun tilgængelig for bestemte scenarier, f.eks. semantiske modeller, der bruger Enkelt Sign-On (SSO)."
None	Forbindelsen er ikke bundet

CredentialType

Optælling

Legitimationstypen for forbindelsen. Der kan tilføjes flere typer legitimationsoplysninger over tid.

Værdi	Beskrivelse
Windows	Forbindelsen bruger Windows-godkendelse til at oprette forbindelse. Understøttes kun for gateways i det lokale miljø.
Anonymous	Forbindelsen bruger anonym godkendelse til at oprette forbindelse.
Basic	Forbindelse bruger basisgodkendelse til at oprette forbindelse.
Key	Forbindelse bruger nøglegodkendelse til at oprette forbindelse.
OAuth2	Forbindelsen bruger OAuth 2.0-godkendelse til at oprette forbindelse.
WindowsWithoutImpersonation	Forbindelse bruger Windows-godkendelse (uden mulighed for repræsentation) til at oprette forbindelse. Understøttes kun for gateways i det lokale miljø (personlig tilstand).
SharedAccessSignature	Forbindelse bruger SAS-godkendelse (Shared Access Signature) til at oprette forbindelse.
ServicePrincipal	Forbindelse bruger godkendelse af tjenesteprincipal til at oprette forbindelse.
WorkspaceIdentity	Forbindelse bruger identitetsgodkendelse for arbejdsområdet til at oprette forbindelse.
KeyPair	Forbindelsen bruger nøgleparsgodkendelse til at oprette forbindelse.

ErrorParameter

Objekt

En struktureret parameter, der giver yderligere kontekst, der kan læses af computeren, om en fejl.

Navn	Type	Beskrivelse
message	string	En læsevenlig beskrivelse af parameterens betydning.
name	string	Parameter-id'et.
value	string	Parameterens værdi.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Navn	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen `Retry-After` til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Navn	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
parameters	ErrorParameter[]	Strukturerede parametre, der giver yderligere kontekst, der kan læses af computeren, om fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

KeyCredentials

Objekt

Legitimationsoplysninger for NøglelegitimationsoplysningerType.

Navn	Type	Beskrivelse
credentialType	string: Key	Legitimationstypen for forbindelsen.
key	string	Nøglen. Brug nøgle eller nøgleReference. Du kan ikke bruge begge dele på samme tid.
keyReference	KeyVaultSecretReference	Referencen til en nøgle, der er gemt i Azure Key Vault. Brug nøgle eller nøgleReference. Du kan ikke bruge begge dele på samme tid.

KeyPairCredentials

Objekt

Legitimationsoplysninger for KeyPair CredentialType.

Navn	Type	Beskrivelse
credentialType	string: KeyPair	Legitimationstypen for forbindelsen.
identifier	string	Id'et for nøglen.
passphrase	string	Adgangsudtrykket for den private nøgle, hvis den private nøgle er krypteret.
privateKey	string	Den private nøgle baseret på PKCS #8 standard.

KeyVaultSecretReference

Objekt

Referencen til en hemmelighed, der er gemt i Azure Key Vault.

Navn	Type	Beskrivelse
connectionId	string (uuid)	Forbindelses-id'et for Key Vault-forbindelsen.
secretName	string	Navnet på hemmeligheden i Key Vault.
version	string	Versionen af hemmeligheden i Key Vault.

ListConnectionDetails

Objekt

Outputtet med forbindelsesoplysninger for listehandlinger.

Navn	Type	Beskrivelse
path	string	Stien til forbindelsen.
type	string	Forbindelsestypen.

ListCredentialDetails

Objekt

De legitimationsoplysninger, der returneres, når der hentes en forbindelse.

Navn	Type	Beskrivelse
connectionEncryption	ConnectionEncryption	Den indstilling for forbindelseskryptering, der bruges under testforbindelsen.
credentialType	CredentialType	Legitimationstypen for forbindelsen.
singleSignOnType	SingleSignOnType	Forbindelsestypen enkeltlogon.
skipTestConnection	boolean	Angiver, om forbindelsen skal springe testforbindelsen over under oprettelse og opdatering. True – Spring testforbindelsen over, False – Spring ikke testforbindelsen over.

OnPremisesCredentialEntry

Objekt

Et gateway-id og dets krypterede serialiserede legitimationsoplysninger.

Navn	Type	Beskrivelse
encryptedCredentials	string	Den krypterede serialiserede .json af listen over navneværdipar. Navn er et navn på legitimationsoplysninger, og værdien er en værdi for legitimationsoplysninger. Kryptering udføres ved hjælp af RSA-krypteringsalgoritmen (Rivest-Shamir-Adleman) med gatewaymedlemmets offentlige nøgle i det lokale miljø.
gatewayId	string (uuid)	Objekt-id'et for gatewayen.

OnPremisesGatewayConnection

Objekt

En forbindelse, der opretter forbindelse via datagatewayen i det lokale miljø.

Navn	Type	Beskrivelse
connectionDetails	ListConnectionDetails	Forbindelsesoplysningerne for forbindelsen.
connectionRecency	ConnectionRecency	Oplysningerne om recency om forbindelsen.
connectivityType	string: OnPremisesGateway	Forbindelsestypen for forbindelsen.
credentialDetails	ListCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	string	Det viste navn på forbindelsen.
gatewayId	string (uuid)	Det gatewayobjekt-id, som forbindelsen oprettes via. For cloudforbindelser er dette det virtuelle gateway-id.
id	string (uuid)	Objekt-id'et for forbindelsen.
myRole	ConnectionRole	Den kaldende hovedkontos effektive rolle på forbindelsen. Når hovedprincipalen er en del af flere sikkerhedsgrupper med forskellige roller, returneres den højeste rolle. Hvis hovedprincipalen ikke har nogen rolle på forbindelsen, returneres denne egenskab ikke.
privacyLevel	PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

OnPremisesGatewayCredentials

Objekt

Legitimationsoplysninger til godkendelse via en gateway i det lokale miljø.

Navn	Type	Beskrivelse
credentialType	CredentialType	Legitimationstypen for forbindelsen.
values	OnPremisesCredentialEntry[]	Nyttedata for legitimationsoplysninger, der skal sendes til gatewayen i det lokale miljø.

OnPremisesGatewayPersonalConnection

Objekt

En forbindelse, der opretter forbindelse via en personlig datagateway i det lokale miljø.

Navn	Type	Beskrivelse
connectionDetails	ListConnectionDetails	Forbindelsesoplysningerne for forbindelsen.
connectionRecency	ConnectionRecency	Oplysningerne om recency om forbindelsen.
connectivityType	string: OnPremisesGatewayPersonal	Forbindelsestypen for forbindelsen.
credentialDetails	ListCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	string	Det viste navn på forbindelsen.
gatewayId	string (uuid)	Det gatewayobjekt-id, som forbindelsen oprettes via. For cloudforbindelser er dette det virtuelle gateway-id.
id	string (uuid)	Objekt-id'et for forbindelsen.
myRole	ConnectionRole	Den kaldende hovedkontos effektive rolle på forbindelsen. Når hovedprincipalen er en del af flere sikkerhedsgrupper med forskellige roller, returneres den højeste rolle. Hvis hovedprincipalen ikke har nogen rolle på forbindelsen, returneres denne egenskab ikke.
privacyLevel	PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

OnPremisesGatewayPersonalCredentials

Objekt

Legitimationsoplysninger til godkendelse via en gateway i det lokale miljø (personlig tilstand).

Navn	Type	Beskrivelse
credentialType	CredentialType	Legitimationstypen for forbindelsen.
encryptedCredentials	string	Den krypterede serialiserede .json af listen over navneværdipar. Navn er et navn på legitimationsoplysninger, og værdien er en værdi for legitimationsoplysninger. Kryptering udføres ved hjælp af RSA-krypteringsalgoritmen (Rivest-Shamir-Adleman) med den offentlige nøgle for gatewayen i det lokale miljø.

PersonalCloudConnection

Objekt

En forbindelse, der opretter forbindelse via cloudmiljøet og ikke kan deles.

Navn	Type	Beskrivelse
allowConnectionUsageInGateway	boolean	Tillad, at denne forbindelse bruges med enten datagateways i det lokale miljø eller VNet-datagateways.
connectionDetails	ListConnectionDetails	Forbindelsesoplysningerne for forbindelsen.
connectionRecency	ConnectionRecency	Oplysningerne om recency om forbindelsen.
connectivityType	string: PersonalCloud	Forbindelsestypen for forbindelsen.
credentialDetails	ListCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	string	Det viste navn på forbindelsen.
gatewayId	string (uuid)	Det gatewayobjekt-id, som forbindelsen oprettes via. For cloudforbindelser er dette det virtuelle gateway-id.
id	string (uuid)	Objekt-id'et for forbindelsen.
myRole	ConnectionRole	Den kaldende hovedkontos effektive rolle på forbindelsen. Når hovedprincipalen er en del af flere sikkerhedsgrupper med forskellige roller, returneres den højeste rolle. Hvis hovedprincipalen ikke har nogen rolle på forbindelsen, returneres denne egenskab ikke.
privacyLevel	PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

PrivacyLevel

Optælling

Indstillingen for niveauet for beskyttelse af personlige oplysninger for forbindelsen. Der kan tilføjes yderligere niveauer for beskyttelse af personlige oplysninger over tid.

Værdi	Beskrivelse
None	Der er ikke konfigureret nogen indstilling for niveau for beskyttelse af personlige oplysninger.
Private	Forbindelser, der er angivet til private, indeholder følsomme eller fortrolige oplysninger. Synlighed kan begrænses til godkendte brugere. Data fra en privat forbindelse foldes ikke ind til andre forbindelser, herunder andre private forbindelser.
Organizational	Forbindelser, der er angivet til organisationsforbindelser, kan foldes ind på private og andre organisationsforbindelser. De kan ikke foldes ind til offentlige forbindelser. Synlighed er angivet til en gruppe, der er tillid til.
Public	Filer, internetforbindelser og projektmappedata kan angives til offentlige. Data kan foldes ind til andre forbindelser. Synlighed er tilgængelig for alle.

ServicePrincipalCredentials

Objekt

Legitimationsoplysninger for ServicePrincipal CredentialType.

Navn	Type	Beskrivelse
credentialType	string: ServicePrincipal	Legitimationstypen for forbindelsen.
servicePrincipalClientId	string (uuid)	Klient-id'et for tjenesteprincipalen.
servicePrincipalSecret	string	Hemmeligheden bag tjenesteprincipalen. Brug servicePrincipalSecret eller servicePrincipalSecretReference. Du kan ikke bruge begge dele på samme tid.
servicePrincipalSecretReference	KeyVaultSecretReference	Referencen til en tjenesteprincipalhemmelighed, der er gemt i Azure Key Vault. Brug servicePrincipalSecret eller servicePrincipalSecretReference. Du kan ikke bruge begge dele på samme tid.
tenantId	string (uuid)	Lejer-id'et for tjenesteprincipalen.

ShareableCloudConnection

Objekt

En forbindelse, der opretter forbindelse via cloudmiljøet.

Navn	Type	Beskrivelse
allowConnectionUsageInGateway	boolean	Tillad, at denne forbindelse bruges med enten datagateways i det lokale miljø eller VNet-datagateways.
allowUsageInUserControlledCode	boolean	Tillad, at denne forbindelse bruges sammen med elementer, der tillader brugerstyret kode, f.eks. Notesbog.
connectionDetails	ListConnectionDetails	Forbindelsesoplysningerne for forbindelsen.
connectionRecency	ConnectionRecency	Oplysningerne om recency om forbindelsen.
connectivityType	string: ShareableCloud	Forbindelsestypen for forbindelsen.
credentialDetails	ListCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	string	Det viste navn på forbindelsen.
gatewayId	string (uuid)	Det gatewayobjekt-id, som forbindelsen oprettes via. For cloudforbindelser er dette det virtuelle gateway-id.
id	string (uuid)	Objekt-id'et for forbindelsen.
myRole	ConnectionRole	Den kaldende hovedkontos effektive rolle på forbindelsen. Når hovedprincipalen er en del af flere sikkerhedsgrupper med forskellige roller, returneres den højeste rolle. Hvis hovedprincipalen ikke har nogen rolle på forbindelsen, returneres denne egenskab ikke.
privacyLevel	PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

SharedAccessSignatureCredentials

Objekt

Legitimationsoplysninger for SharedAccessSignature CredentialType.

Navn	Type	Beskrivelse
credentialType	string: SharedAccessSignature	Legitimationstypen for forbindelsen.
token	string	Tokenet. Brug token eller tokenReference. Du kan ikke bruge begge dele på samme tid.
tokenReference	KeyVaultSecretReference	Referencen til et token, der er gemt i Azure Key Vault. Brug token eller tokenReference. Du kan ikke bruge begge dele på samme tid.

SingleSignOnType

Optælling

Forbindelsestypen enkeltlogon. Der kan tilføjes flere enkeltlogontyper over tid.

Værdi	Beskrivelse
None	Forbindelsen bruger ikke enkeltlogon til at oprette forbindelse.
Kerberos	Forbindelse bruger Kerberos-enkeltlogon til at oprette forbindelse.
MicrosoftEntraID	Forbindelse bruger Enkeltlogon til Microsoft Entra-id til at oprette forbindelse.
SecurityAssertionMarkupLanguage	Forbindelse bruger SAML -enkeltlogon (Security Assertion Markup Language) til at oprette forbindelse.
KerberosDirectQueryAndRefresh	Forbindelse bruger Kerberos DirectQuery og Opdater enkeltlogon til at oprette forbindelse.

StreamingVirtualNetworkGatewayConnection

Objekt

En forbindelse, der opretter forbindelse via en streaming af en virtuel netværksdatagateway.

Navn	Type	Beskrivelse
connectionDetails	ListConnectionDetails	Forbindelsesoplysningerne for forbindelsen.
connectionRecency	ConnectionRecency	Oplysningerne om recency om forbindelsen.
connectivityType	string: StreamingVirtualNetworkGateway	Forbindelsestypen for forbindelsen.
credentialDetails	ListCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	string	Det viste navn på forbindelsen.
gatewayId	string (uuid)	Gatewayobjekt-id'et for forbindelsen.
id	string (uuid)	Objekt-id'et for forbindelsen.
myRole	ConnectionRole	Den kaldende hovedkontos effektive rolle på forbindelsen. Når hovedprincipalen er en del af flere sikkerhedsgrupper med forskellige roller, returneres den højeste rolle. Hvis hovedprincipalen ikke har nogen rolle på forbindelsen, returneres denne egenskab ikke.
privacyLevel	PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

UpdateCredentialDetails

Objekt

Inputtet med legitimationsoplysninger til opdatering af en forbindelse.

Navn	Type	Beskrivelse
connectionEncryption	ConnectionEncryption	Den indstilling for forbindelseskryptering, der bruges under testforbindelsen.
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials KeyPairCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	Legitimationsoplysningerne for forbindelsen.
singleSignOnType	SingleSignOnType	Forbindelsestypen enkeltlogon.
skipTestConnection	boolean	Angiver, om forbindelsen skal springe testforbindelsen over under oprettelse og opdatering. True – Spring testforbindelsen over, False – Spring ikke testforbindelsen over.

UpdateOnPremisesGatewayConnectionRequest

Objekt

Navn	Type	Beskrivelse
connectivityType	string: OnPremisesGateway	Forbindelsestypen for forbindelsen.
credentialDetails	UpdateOnPremisesGatewayCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	string	Det viste navn på forbindelsen. Maksimumlængden er 200 tegn.
privacyLevel	PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

UpdateOnPremisesGatewayCredentialDetails

Objekt

Inputtet med legitimationsoplysninger til opdatering af en gatewayforbindelse i det lokale miljø.

Navn	Type	Beskrivelse
connectionEncryption	ConnectionEncryption	Den indstilling for forbindelseskryptering, der bruges under testforbindelsen.
credentials	OnPremisesGatewayCredentials	Legitimationsoplysningerne for forbindelsen.
singleSignOnType	SingleSignOnType	Forbindelsestypen enkeltlogon.
skipTestConnection	boolean	Angiver, om forbindelsen skal springe testforbindelsen over under oprettelse og opdatering. True – Spring testforbindelsen over, False – Spring ikke testforbindelsen over.

UpdateOnPremisesGatewayPersonalConnectionRequest

Objekt

Navn	Type	Beskrivelse
connectivityType	string: OnPremisesGatewayPersonal	Forbindelsestypen for forbindelsen.
credentialDetails	UpdateOnPremisesGatewayPersonalCredentialDetails	Legitimationsoplysningerne for forbindelsen.
privacyLevel	PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

UpdateOnPremisesGatewayPersonalCredentialDetails

Objekt

Inputtet med legitimationsoplysninger til opdatering af en gatewayforbindelse i det lokale miljø.

Navn	Type	Beskrivelse
connectionEncryption	ConnectionEncryption	Den indstilling for forbindelseskryptering, der bruges under testforbindelsen.
credentials	OnPremisesGatewayPersonalCredentials	Legitimationsoplysningerne for forbindelsen.
singleSignOnType	SingleSignOnType	Forbindelsestypen enkeltlogon.
skipTestConnection	boolean	Angiver, om forbindelsen skal springe testforbindelsen over under oprettelse og opdatering. True – Spring testforbindelsen over, False – Spring ikke testforbindelsen over.

UpdatePersonalCloudConnectionRequest

Objekt

Navn	Type	Beskrivelse
allowConnectionUsageInGateway	boolean	Tillad, at denne forbindelse bruges med enten datagateways i det lokale miljø eller VNet-datagateways.
connectivityType	string: PersonalCloud	Forbindelsestypen for forbindelsen.
credentialDetails	UpdateCredentialDetails	Legitimationsoplysningerne for forbindelsen.
privacyLevel	PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

UpdateShareableCloudConnectionRequest

Objekt

Navn	Type	Beskrivelse
allowConnectionUsageInGateway	boolean	Tillad, at denne forbindelse bruges med enten datagateways i det lokale miljø eller VNet-datagateways.
connectivityType	string: ShareableCloud	Forbindelsestypen for forbindelsen.
credentialDetails	UpdateCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	string	Det viste navn på forbindelsen. Maksimumlængden er 200 tegn.
privacyLevel	PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

UpdateStreamingVirtualNetworkGatewayConnectionRequest

Objekt

Opdaterer en forbindelse, der opretter forbindelse via en streaming af en virtuel netværksdatagateway.

Navn	Type	Beskrivelse
connectivityType	string: StreamingVirtualNetworkGateway	Forbindelsestypen for forbindelsen.
credentialDetails	UpdateCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	string	Det viste navn på forbindelsen. Maksimumlængden er 200 tegn.
privacyLevel	PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

UpdateVirtualNetworkGatewayConnectionRequest

Objekt

Navn	Type	Beskrivelse
connectivityType	string: VirtualNetworkGateway	Forbindelsestypen for forbindelsen.
credentialDetails	UpdateCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	string	Det viste navn på forbindelsen. Maksimumlængden er 200 tegn.
privacyLevel	PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

VirtualNetworkGatewayConnection

Objekt

En forbindelse, der opretter forbindelse via en virtuel netværksdatagateway.

Navn	Type	Beskrivelse
connectionDetails	ListConnectionDetails	Forbindelsesoplysningerne for forbindelsen.
connectionRecency	ConnectionRecency	Oplysningerne om recency om forbindelsen.
connectivityType	string: VirtualNetworkGateway	Forbindelsestypen for forbindelsen.
credentialDetails	ListCredentialDetails	Legitimationsoplysningerne for forbindelsen.
displayName	string	Det viste navn på forbindelsen.
gatewayId	string (uuid)	Det gatewayobjekt-id, som forbindelsen oprettes via. For cloudforbindelser er dette det virtuelle gateway-id.
id	string (uuid)	Objekt-id'et for forbindelsen.
myRole	ConnectionRole	Den kaldende hovedkontos effektive rolle på forbindelsen. Når hovedprincipalen er en del af flere sikkerhedsgrupper med forskellige roller, returneres den højeste rolle. Hvis hovedprincipalen ikke har nogen rolle på forbindelsen, returneres denne egenskab ikke.
privacyLevel	PrivacyLevel	Niveauet for beskyttelse af personlige oplysninger for forbindelsen.

WindowsCredentials

Objekt

Legitimationsoplysninger for Windows CredentialType.

Navn	Type	Beskrivelse
credentialType	string: Windows	Legitimationstypen for forbindelsen.
password	string	Adgangskoden.
username	string	Brugernavnet.

WindowsWithoutImpersonationCredentials

Objekt

Legitimationsoplysninger for WindowsWithoutImpersonation CredentialType.

Navn	Type	Beskrivelse
credentialType	string: WindowsWithoutImpersonation	Legitimationstypen for forbindelsen.

WorkspaceIdentityCredentials

Objekt

Legitimationsoplysninger for WorkspaceIdentity CredentialType.

Navn	Type	Beskrivelse
credentialType	string: WorkspaceIdentity	Legitimationstypen for forbindelsen.