Connections - Update Connection

Referentie

Service:: Core

API-versie:: v1

Notitie

Deze API is in preview.

Hiermee wordt de verbinding bijgewerkt op id.
Zie Referenties programmatisch configurerenom referenties te versleutelen.

Machtigingen

De aanroeper moet gemachtigd zijn voor de verbinding of beheerdersmachtiging voor de gateway van de verbinding.

Vereiste gedelegeerde bereiken

Connection.ReadWrite.All

Door Microsoft Entra ondersteunde identiteiten

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

Identiteit	Steunen
Gebruiker	Ja
service-principal en beheerde identiteiten	Ja

Interface

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

URI-parameters

Name	In	Vereist	Type	Description
connectionId	path	True	string (uuid)	De id van de verbinding.

Aanvraagbody

De aanvraagtekst kan een van de volgende zijn:

Name	Description
UpdateOnPremisesGatewayConnectionRequest
UpdateOnPremisesGatewayPersonalConnectionRequest
UpdatePersonalCloudConnectionRequest
UpdateShareableCloudConnectionRequest
UpdateVirtualNetworkGatewayConnectionRequest

UpdateOnPremisesGatewayConnectionRequest

Name	Vereist	Type	Description
connectivityType	True	string: OnPremisesGateway	Het verbindingstype van de verbinding.
credentialDetails		UpdateOnPremisesGatewayCredentialDetails	De referentiegegevens van de verbinding.
displayName		string	De weergavenaam van de verbinding. De maximale lengte is 200 tekens.
privacyLevel		PrivacyLevel	Het privacyniveau van de verbinding.

UpdateOnPremisesGatewayPersonalConnectionRequest

Name	Vereist	Type	Description
connectivityType	True	string: OnPremisesGatewayPersonal	Het verbindingstype van de verbinding.
credentialDetails		UpdateOnPremisesGatewayPersonalCredentialDetails	De referentiegegevens van de verbinding.
privacyLevel		PrivacyLevel	Het privacyniveau van de verbinding.

UpdatePersonalCloudConnectionRequest

Name	Vereist	Type	Description
connectivityType	True	string: PersonalCloud	Het verbindingstype van de verbinding.
credentialDetails		UpdateCredentialDetails	De referentiegegevens van de verbinding.
privacyLevel		PrivacyLevel	Het privacyniveau van de verbinding.

UpdateShareableCloudConnectionRequest

Name	Vereist	Type	Description
connectivityType	True	string: ShareableCloud	Het verbindingstype van de verbinding.
credentialDetails		UpdateCredentialDetails	De referentiegegevens van de verbinding.
displayName		string	De weergavenaam van de verbinding. De maximale lengte is 200 tekens.
privacyLevel		PrivacyLevel	Het privacyniveau van de verbinding.

UpdateVirtualNetworkGatewayConnectionRequest

Name	Vereist	Type	Description
connectivityType	True	string: VirtualNetworkGateway	Het verbindingstype van de verbinding.
credentialDetails		UpdateCredentialDetails	De referentiegegevens van de verbinding.
displayName		string	De weergavenaam van de verbinding. De maximale lengte is 200 tekens.
privacyLevel		PrivacyLevel	Het privacyniveau van de verbinding.

Antwoorden

Name	Type	Description
200 OK	Connection	OK. De bewerking is geslaagd.
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: EntityNotFound : de aangevraagde resource is niet gevonden. InsufficientPermissionsToManageConnection - De beller heeft onvoldoende machtigingen om deze verbinding te beheren. DuplicateConnectionName: de naam van de verbinding is al in gebruik. IncorrectCredentials : kan geen verbinding tot stand brengen met behulp van de referentiesinvoer. UpdateGatewayConnectionFailed : gatewayverbinding kan niet worden bijgewerkt.

Name

Type

Description

200 OK

Connection

OK. De bewerking is geslaagd.

Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

EntityNotFound : de aangevraagde resource is niet gevonden.
InsufficientPermissionsToManageConnection - De beller heeft onvoldoende machtigingen om deze verbinding te beheren.
DuplicateConnectionName: de naam van de verbinding is al in gebruik.
IncorrectCredentials : kan geen verbinding tot stand brengen met behulp van de referentiesinvoer.
UpdateGatewayConnectionFailed : gatewayverbinding kan niet worden bijgewerkt.

Voorbeelden

On-premises gateway (personal mode) example

On-premises gateway example

Personal cloud example

Shareable cloud example

Virtual network gateway example

On-premises gateway (personal mode) example

Voorbeeldaanvraag

HTTP

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

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

Voorbeeldrespons

Statuscode:: 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
  }
}

On-premises gateway example

Voorbeeldaanvraag

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": "************************************"
        }
      ]
    }
  }
}

Voorbeeldrespons

Statuscode:: 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
  }
}

Personal cloud example

Voorbeeldaanvraag

HTTP

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

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

Voorbeeldrespons

Statuscode:: 200

{
  "id": "7a0369b2-58c4-4b67-b3f3-92156a95f1cd",
  "connectivityType": "PersonalCloud",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;finances"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "OAuth2",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  }
}

Shareable cloud example

Voorbeeldaanvraag

HTTP

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

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

Voorbeeldrespons

Statuscode:: 200

{
  "id": "fa968eee-8075-48f6-8c6d-41260ee1396d",
  "displayName": "ContosoCloudConnection",
  "connectivityType": "ShareableCloud",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;networks"
  },
  "privacyLevel": "Public",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": true
  }
}

Virtual network gateway example

Voorbeeldaanvraag

HTTP

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

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

Voorbeeldrespons

Statuscode:: 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
  }
}

Definities

Name	Description
AnonymousCredentials	Referenties voor Anonymous CredentialType.
BasicCredentials	Referenties voor Basic CredentialType.
Connection
ConnectionEncryption	Het type verbindingsversleuteling van de verbinding. Er kunnen na verloop van tijd extra verbindingsversleutelingswaarden worden toegevoegd.
ConnectivityType	Het verbindingstype van de verbinding. Er kunnen in de loop van de tijd extra verbindingstypen worden toegevoegd.
CredentialType	Het referentietype van de verbinding. Er kunnen in de loop van de tijd extra referentietypen worden toegevoegd.
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
KeyCredentials	Referenties voor Key CredentialType.
ListConnectionDetails	De uitvoer van de verbindingsgegevens voor lijstbewerkingen.
ListCredentialDetails	De referentiegegevens die worden geretourneerd bij het ophalen van een verbinding.
OnPremisesCredentialEntry	Een gateway-id en de versleutelde geserialiseerde referenties.
OnPremisesGatewayCredentials	Referenties voor verificatie via een on-premises gateway.
OnPremisesGatewayPersonalCredentials	Referenties voor verificatie via een on-premises gateway (persoonlijke modus).
PrivacyLevel	De instelling op privacyniveau van de verbinding. Er kunnen na verloop van tijd extra privacyniveaus worden toegevoegd.
ServicePrincipalCredentials	Referenties voor ServicePrincipal CredentialType.
SharedAccessSignatureCredentials	Referenties voor SharedAccessSignature CredentialType.
SingleSignOnType	Het type eenmalige aanmelding van de verbinding. Er kunnen in de loop van de tijd extra typen eenmalige aanmelding worden toegevoegd.
UpdateCredentialDetails	De referentiegegevensinvoer voor het bijwerken van een verbinding.
UpdateOnPremisesGatewayConnectionRequest
UpdateOnPremisesGatewayCredentialDetails	De referentiegegevensinvoer voor het bijwerken van een on-premises gatewayverbinding.
UpdateOnPremisesGatewayPersonalConnectionRequest
UpdateOnPremisesGatewayPersonalCredentialDetails	De referentiegegevensinvoer voor het bijwerken van een on-premises gatewayverbinding.
UpdatePersonalCloudConnectionRequest
UpdateShareableCloudConnectionRequest
UpdateVirtualNetworkGatewayConnectionRequest
WindowsCredentials	Referenties voor Windows CredentialType.
WindowsWithoutImpersonationCredentials	Referenties voor WindowsWithoutImpersonation CredentialType.
WorkspaceIdentityCredentials	Referenties voor WorkspaceIdentity CredentialType.

AnonymousCredentials

Object

Referenties voor Anonymous CredentialType.

Name	Type	Description
credentialType	string: Anonymous	Het referentietype van de verbinding.

BasicCredentials

Object

Referenties voor Basic CredentialType.

Name	Type	Description
credentialType	string: Basic	Het referentietype van de verbinding.
password	string	Het wachtwoord.
username	string	De gebruikersnaam.

Connection

Object

Name	Type	Description
connectionDetails	ListConnectionDetails	De verbindingsgegevens van de verbinding.
connectivityType	ConnectivityType	Het verbindingstype van de verbinding.
credentialDetails	ListCredentialDetails	De referentiegegevens van de verbinding.
displayName	string	De weergavenaam van de verbinding.
gatewayId	string (uuid)	De gatewayobject-id van de verbinding.
id	string (uuid)	De object-id van de verbinding.
privacyLevel	PrivacyLevel	Het privacyniveau van de verbinding.

ConnectionEncryption

Inventarisatie

Het type verbindingsversleuteling van de verbinding. Er kunnen na verloop van tijd extra verbindingsversleutelingswaarden worden toegevoegd.

Waarde	Description
Any	De verbindingspoging wordt eerst uitgevoerd met behulp van een versleutelde verbinding en valt vervolgens terug op niet-versleutelde verbinding als dit mislukt.
Encrypted	De verbindingspoging wordt uitgevoerd met behulp van een versleutelde verbinding.
NotEncrypted	De verbindingspoging wordt uitgevoerd met behulp van een niet-versleutelde verbinding.

ConnectivityType

Inventarisatie

Het verbindingstype van de verbinding. Er kunnen in de loop van de tijd extra verbindingstypen worden toegevoegd.

Waarde	Description
Automatic	De verbinding maakt verbinding via de cloud met behulp van een impliciete gegevensverbinding. Deze optie is alleen beschikbaar voor specifieke scenario's, zoals semantische modellen die gebruikmaken van Single Sign-On (SSO)."
None	De verbinding is niet gebonden
OnPremisesGateway	De verbinding maakt verbinding via een on-premises gegevensgateway.
OnPremisesGatewayPersonal	De verbinding maakt verbinding via een persoonlijke on-premises gegevensgateway.
PersonalCloud	De verbinding maakt verbinding via de cloud en kan niet met anderen worden gedeeld.
ShareableCloud	De verbinding maakt verbinding via de cloud en kan worden gedeeld met anderen.
VirtualNetworkGateway	De verbinding maakt verbinding via een gegevensgateway van een virtueel netwerk.

CredentialType

Inventarisatie

Het referentietype van de verbinding. Er kunnen in de loop van de tijd extra referentietypen worden toegevoegd.

Waarde	Description
Anonymous	Verbinding maakt gebruik van anonieme verificatie om verbinding te maken.
Basic	Verbinding maakt gebruik van basisverificatie om verbinding te maken.
Key	Verbinding maakt gebruik van sleutelverificatie om verbinding te maken.
OAuth2	Verbinding maakt gebruik van OAuth 2.0-verificatie om verbinding te maken.
ServicePrincipal	Verbinding maakt gebruik van verificatie van de service-principal om verbinding te maken.
SharedAccessSignature	Verbinding maakt gebruik van SAS-verificatie (Shared Access Signature) om verbinding te maken.
Windows	Verbinding maakt gebruik van Windows-verificatie om verbinding te maken. Alleen ondersteund voor on-premises gateways.
WindowsWithoutImpersonation	Verbinding maakt gebruik van Windows-verificatie (zonder de optie voor imitatie) om verbinding te maken. Alleen ondersteund voor on-premises gateways (persoonlijke modus).
WorkspaceIdentity	Verbinding maakt gebruik van verificatie van werkruimte-id's om verbinding te maken.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	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.

Name	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.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	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.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

KeyCredentials

Object

Referenties voor Key CredentialType.

Name	Type	Description
credentialType	string: Key	Het referentietype van de verbinding.
key	string	De sleutel.

ListConnectionDetails

Object

De uitvoer van de verbindingsgegevens voor lijstbewerkingen.

Name	Type	Description
path	string	Het pad van de verbinding.
type	string	Het type verbinding.

ListCredentialDetails

Object

De referentiegegevens die worden geretourneerd bij het ophalen van een verbinding.

Name	Type	Description
connectionEncryption	ConnectionEncryption	De instelling voor verbindingsversleuteling die wordt gebruikt tijdens de testverbinding.
credentialType	CredentialType	Het referentietype van de verbinding.
singleSignOnType	SingleSignOnType	Het type eenmalige aanmelding van de verbinding.
skipTestConnection	boolean	Of de verbinding de testverbinding moet overslaan tijdens het maken en bijwerken. True - Sla de testverbinding over, False - Sla de testverbinding niet over.

OnPremisesCredentialEntry

Object

Een gateway-id en de versleutelde geserialiseerde referenties.

Name	Type	Description
encryptedCredentials	string	De versleutelde geserialiseerde .json van de lijst met naam-waardeparen. De naam is een referentienaam en waarde is een referentiewaarde. Versleuteling wordt uitgevoerd met behulp van het RSA-versleutelingsalgoritme (Rivest-Shamir-Adleman) met de openbare sleutel van het on-premises gatewaylid.
gatewayId	string (uuid)	De object-id van de gateway.

OnPremisesGatewayCredentials

Object

Referenties voor verificatie via een on-premises gateway.

Name	Type	Description
credentialType	CredentialType	Het referentietype van de verbinding.
values	OnPremisesCredentialEntry[]	De nettolading van de referentie die naar de on-premises gateway moet worden verzonden.

OnPremisesGatewayPersonalCredentials

Object

Referenties voor verificatie via een on-premises gateway (persoonlijke modus).

Name	Type	Description
credentialType	CredentialType	Het referentietype van de verbinding.
encryptedCredentials	string	De versleutelde geserialiseerde .json van de lijst met naam-waardeparen. De naam is een referentienaam en waarde is een referentiewaarde. Versleuteling wordt uitgevoerd met behulp van het RSA-versleutelingsalgoritme (Rivest-Shamir-Adleman) met de openbare sleutel van de on-premises gateway.

PrivacyLevel

Inventarisatie

De instelling op privacyniveau van de verbinding. Er kunnen na verloop van tijd extra privacyniveaus worden toegevoegd.

Waarde	Description
None	Er is geen instelling voor privacyniveau geconfigureerd.
Organizational	Verbindingen die zijn ingesteld op de organisatie, kunnen worden ingevouwen tot privé- en andere organisatieverbindingen. Ze kunnen niet invouwen tot openbare verbindingen. Zichtbaarheid is ingesteld op een vertrouwde groep.
Private	Verbindingen die zijn ingesteld op privé bevatten gevoelige of vertrouwelijke informatie. Zichtbaarheid kan worden beperkt tot geautoriseerde gebruikers. Gegevens van een privéverbinding worden niet naar andere verbindingen gevouwen, inclusief andere privéverbindingen.
Public	Bestanden, internetverbinding en werkmapgegevens kunnen worden ingesteld op openbaar. Gegevens kunnen worden ingevouwen naar andere verbindingen. Zichtbaarheid is voor iedereen beschikbaar.

ServicePrincipalCredentials

Object

Referenties voor ServicePrincipal CredentialType.

Name	Type	Description
credentialType	string: ServicePrincipal	Het referentietype van de verbinding.
servicePrincipalClientId	string (uuid)	De client-id van de service-principal.
servicePrincipalSecret	string	Het geheim van de service-principal.
tenantId	string (uuid)	De tenant-id van de service-principal.

SharedAccessSignatureCredentials

Object

Referenties voor SharedAccessSignature CredentialType.

Name	Type	Description
credentialType	string: SharedAccessSignature	Het referentietype van de verbinding.
token	string	Het token.

SingleSignOnType

Inventarisatie

Het type eenmalige aanmelding van de verbinding. Er kunnen in de loop van de tijd extra typen eenmalige aanmelding worden toegevoegd.

Waarde	Description
Kerberos	Connection maakt gebruik van eenmalige aanmelding van Kerberos om verbinding te maken.
KerberosDirectQueryAndRefresh	Connection maakt gebruik van Kerberos DirectQuery en Refresh-eenmalige aanmelding om verbinding te maken.
MicrosoftEntraID	Connection maakt gebruik van eenmalige aanmelding van Microsoft Entra ID om verbinding te maken.
None	Connection maakt geen gebruik van eenmalige aanmelding om verbinding te maken.
SecurityAssertionMarkupLanguage	Connection maakt gebruik van eenmalige aanmelding van Security Assertion Markup Language (SAML) om verbinding te maken.

UpdateCredentialDetails

Object

De referentiegegevensinvoer voor het bijwerken van een verbinding.

Name	Type	Description
connectionEncryption	ConnectionEncryption	De instelling voor verbindingsversleuteling die wordt gebruikt tijdens de testverbinding.
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	De referenties van de verbinding.
singleSignOnType	SingleSignOnType	Het type eenmalige aanmelding van de verbinding.
skipTestConnection	boolean	Of de verbinding de testverbinding moet overslaan tijdens het maken en bijwerken. True - Sla de testverbinding over, False - Sla de testverbinding niet over.

UpdateOnPremisesGatewayConnectionRequest

Object

Name	Type	Description
connectivityType	string: OnPremisesGateway	Het verbindingstype van de verbinding.
credentialDetails	UpdateOnPremisesGatewayCredentialDetails	De referentiegegevens van de verbinding.
displayName	string	De weergavenaam van de verbinding. De maximale lengte is 200 tekens.
privacyLevel	PrivacyLevel	Het privacyniveau van de verbinding.

UpdateOnPremisesGatewayCredentialDetails

Object

De referentiegegevensinvoer voor het bijwerken van een on-premises gatewayverbinding.

Name	Type	Description
connectionEncryption	ConnectionEncryption	De instelling voor verbindingsversleuteling die wordt gebruikt tijdens de testverbinding.
credentials	OnPremisesGatewayCredentials	De referenties van de verbinding.
singleSignOnType	SingleSignOnType	Het type eenmalige aanmelding van de verbinding.
skipTestConnection	boolean	Of de verbinding de testverbinding moet overslaan tijdens het maken en bijwerken. True - Sla de testverbinding over, False - Sla de testverbinding niet over.

UpdateOnPremisesGatewayPersonalConnectionRequest

Object

Name	Type	Description
connectivityType	string: OnPremisesGatewayPersonal	Het verbindingstype van de verbinding.
credentialDetails	UpdateOnPremisesGatewayPersonalCredentialDetails	De referentiegegevens van de verbinding.
privacyLevel	PrivacyLevel	Het privacyniveau van de verbinding.

UpdateOnPremisesGatewayPersonalCredentialDetails

Object

De referentiegegevensinvoer voor het bijwerken van een on-premises gatewayverbinding.

Name	Type	Description
connectionEncryption	ConnectionEncryption	De instelling voor verbindingsversleuteling die wordt gebruikt tijdens de testverbinding.
credentials	OnPremisesGatewayPersonalCredentials	De referenties van de verbinding.
singleSignOnType	SingleSignOnType	Het type eenmalige aanmelding van de verbinding.
skipTestConnection	boolean	Of de verbinding de testverbinding moet overslaan tijdens het maken en bijwerken. True - Sla de testverbinding over, False - Sla de testverbinding niet over.

UpdatePersonalCloudConnectionRequest

Object

Name	Type	Description
connectivityType	string: PersonalCloud	Het verbindingstype van de verbinding.
credentialDetails	UpdateCredentialDetails	De referentiegegevens van de verbinding.
privacyLevel	PrivacyLevel	Het privacyniveau van de verbinding.

UpdateShareableCloudConnectionRequest

Object

Name	Type	Description
connectivityType	string: ShareableCloud	Het verbindingstype van de verbinding.
credentialDetails	UpdateCredentialDetails	De referentiegegevens van de verbinding.
displayName	string	De weergavenaam van de verbinding. De maximale lengte is 200 tekens.
privacyLevel	PrivacyLevel	Het privacyniveau van de verbinding.

UpdateVirtualNetworkGatewayConnectionRequest

Object

Name	Type	Description
connectivityType	string: VirtualNetworkGateway	Het verbindingstype van de verbinding.
credentialDetails	UpdateCredentialDetails	De referentiegegevens van de verbinding.
displayName	string	De weergavenaam van de verbinding. De maximale lengte is 200 tekens.
privacyLevel	PrivacyLevel	Het privacyniveau van de verbinding.

WindowsCredentials

Object

Referenties voor Windows CredentialType.

Name	Type	Description
credentialType	string: Windows	Het referentietype van de verbinding.
password	string	Het wachtwoord.
username	string	De gebruikersnaam.

WindowsWithoutImpersonationCredentials

Object

Referenties voor WindowsWithoutImpersonation CredentialType.

Name	Type	Description
credentialType	string: WindowsWithoutImpersonation	Het referentietype van de verbinding.

WorkspaceIdentityCredentials

Object

Referenties voor WorkspaceIdentity CredentialType.

Name	Type	Description
credentialType	string: WorkspaceIdentity	Het referentietype van de verbinding.

Delen via

Connections - Update Connection

Machtigingen

Vereiste gedelegeerde bereiken

Door Microsoft Entra ondersteunde identiteiten

Interface

URI-parameters

Aanvraagbody

UpdateOnPremisesGatewayConnectionRequest

UpdateOnPremisesGatewayPersonalConnectionRequest

UpdatePersonalCloudConnectionRequest

UpdateShareableCloudConnectionRequest

UpdateVirtualNetworkGatewayConnectionRequest

Antwoorden

Voorbeelden

On-premises gateway (personal mode) example

Voorbeeldaanvraag

Voorbeeldrespons

On-premises gateway example

Voorbeeldaanvraag

Voorbeeldrespons

Personal cloud example

Voorbeeldaanvraag

Voorbeeldrespons

Shareable cloud example

Voorbeeldaanvraag

Voorbeeldrespons

Virtual network gateway example

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AnonymousCredentials

BasicCredentials

Connection

ConnectionEncryption

ConnectivityType

CredentialType

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

KeyCredentials

ListConnectionDetails

ListCredentialDetails

OnPremisesCredentialEntry

OnPremisesGatewayCredentials

OnPremisesGatewayPersonalCredentials

PrivacyLevel

ServicePrincipalCredentials

SharedAccessSignatureCredentials

SingleSignOnType

UpdateCredentialDetails

UpdateOnPremisesGatewayConnectionRequest

UpdateOnPremisesGatewayCredentialDetails

UpdateOnPremisesGatewayPersonalConnectionRequest

UpdateOnPremisesGatewayPersonalCredentialDetails

UpdatePersonalCloudConnectionRequest

UpdateShareableCloudConnectionRequest

UpdateVirtualNetworkGatewayConnectionRequest

WindowsCredentials

WindowsWithoutImpersonationCredentials

WorkspaceIdentityCredentials

Aanvullende resources