Connections - Update Connection

Usługa:: Core

Wersja interfejsu API:: v1

Aktualizuje połączenie według identyfikatora.
Aby zaszyfrować poświadczenia, zobacz Programowe konfigurowanie poświadczeń.

Permissions

Obiekt wywołujący musi mieć uprawnienia do połączenia lub uprawnienia administratora dla bramy połączenia.

Wymagane zakresy delegowane

Connection.ReadWrite.All

Tożsamości obsługiwane przez firmę Microsoft

Ten interfejs API obsługuje tożsamości firmy Microsoft wymienione w tej sekcji.

Identity	Support
User	Yes
jednostki usługi i tożsamości zarządzanych	Yes

Interface

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

Parametry identyfikatora URI

Nazwisko	W	Wymagane	Typ	Opis
connectionId	path	True	string (uuid)	Identyfikator połączenia.

Treść żądania

Treść żądania może być jedną z następujących:

Nazwisko	Opis
UpdateOnPremisesGatewayConnectionRequest
UpdateOnPremisesGatewayPersonalConnectionRequest
UpdatePersonalCloudConnectionRequest
UpdateShareableCloudConnectionRequest
UpdateStreamingVirtualNetworkGatewayConnectionRequest	Aktualizuje połączenie, które łączy się za pośrednictwem bramy danych sieci wirtualnej przesyłania strumieniowego.
UpdateVirtualNetworkGatewayConnectionRequest

UpdateOnPremisesGatewayConnectionRequest

Nazwisko	Wymagane	Typ	Opis
connectivityType	True	string: OnPremisesGateway	Typ połączenia.
credentialDetails		UpdateOnPremisesGatewayCredentialDetails	Szczegóły poświadczeń połączenia.
displayName		string	Nazwa wyświetlana połączenia. Maksymalna długość to 200 znaków.
privacyLevel		PrivacyLevel	Poziom prywatności połączenia.

UpdateOnPremisesGatewayPersonalConnectionRequest

Nazwisko	Wymagane	Typ	Opis
connectivityType	True	string: OnPremisesGatewayPersonal	Typ połączenia.
credentialDetails		UpdateOnPremisesGatewayPersonalCredentialDetails	Szczegóły poświadczeń połączenia.
privacyLevel		PrivacyLevel	Poziom prywatności połączenia.

UpdatePersonalCloudConnectionRequest

Nazwisko	Wymagane	Typ	Opis
connectivityType	True	string: PersonalCloud	Typ połączenia.
allowConnectionUsageInGateway		boolean	Zezwalaj na korzystanie z tego połączenia z lokalnymi bramami danych lub bramami danych sieci wirtualnej.
credentialDetails		UpdateCredentialDetails	Szczegóły poświadczeń połączenia.
privacyLevel		PrivacyLevel	Poziom prywatności połączenia.

UpdateShareableCloudConnectionRequest

Nazwisko	Wymagane	Typ	Opis
connectivityType	True	string: ShareableCloud	Typ połączenia.
allowConnectionUsageInGateway		boolean	Zezwalaj na korzystanie z tego połączenia z lokalnymi bramami danych lub bramami danych sieci wirtualnej.
credentialDetails		UpdateCredentialDetails	Szczegóły poświadczeń połączenia.
displayName		string	Nazwa wyświetlana połączenia. Maksymalna długość to 200 znaków.
privacyLevel		PrivacyLevel	Poziom prywatności połączenia.

UpdateStreamingVirtualNetworkGatewayConnectionRequest

Aktualizuje połączenie, które łączy się za pośrednictwem bramy danych sieci wirtualnej przesyłania strumieniowego.

Nazwisko	Wymagane	Typ	Opis
connectivityType	True	string: StreamingVirtualNetworkGateway	Typ połączenia.
credentialDetails		UpdateCredentialDetails	Szczegóły poświadczeń połączenia.
displayName		string	Nazwa wyświetlana połączenia. Maksymalna długość to 200 znaków.
privacyLevel		PrivacyLevel	Poziom prywatności połączenia.

UpdateVirtualNetworkGatewayConnectionRequest

Nazwisko	Wymagane	Typ	Opis
connectivityType	True	string: VirtualNetworkGateway	Typ połączenia.
credentialDetails		UpdateCredentialDetails	Szczegóły poświadczeń połączenia.
displayName		string	Nazwa wyświetlana połączenia. Maksymalna długość to 200 znaków.
privacyLevel		PrivacyLevel	Poziom prywatności połączenia.

Odpowiedzi

Nazwisko Typ Opis

200 OK

Nazwisko	Typ	Opis
200 OK	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection StreamingVirtualNetworkGatewayConnection	OK. Operacja zakończyła się pomyślnie.
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący `Retry-After` w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: EntityNotFound — nie można odnaleźć żądanego zasobu. InsufficientPermissionsToManageConnection — obiekt wywołujący ma niewystarczające uprawnienia do zarządzania tym połączeniem. DuplicateConnectionName — nazwa połączenia jest już używana. IncorrectCredentials — nie można nawiązać połączenia przy użyciu danych wejściowych poświadczeń. UpdateGatewayConnectionFailed — nie można zaktualizować połączenia bramy.

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection
StreamingVirtualNetworkGatewayConnection

OK. Operacja zakończyła się pomyślnie.

429 Too Many Requests

ErrorResponse

Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań.

Nagłówki

Retry-After: integer

Other Status Codes

ErrorResponse

Typowe kody błędów:

EntityNotFound — nie można odnaleźć żądanego zasobu.
InsufficientPermissionsToManageConnection — obiekt wywołujący ma niewystarczające uprawnienia do zarządzania tym połączeniem.
DuplicateConnectionName — nazwa połączenia jest już używana.
IncorrectCredentials — nie można nawiązać połączenia przy użyciu danych wejściowych poświadczeń.
UpdateGatewayConnectionFailed — nie można zaktualizować połączenia bramy.

Przykłady

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

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwisko	Opis
AnonymousCredentials	Poświadczenia dla anonimowego typu poświadczeń.
BasicCredentials	Poświadczenia dla parametru CredentialType w warstwie Podstawowa.
ConnectionEncryption	Typ szyfrowania połączenia. Dodatkowe wartości szyfrowania połączeń mogą być dodawane w czasie.
ConnectionRecency	Reprezentuje szczegółowe informacje o połączeniu.
ConnectionRole	Rola połączenia. Dodatkowe role połączenia można dodawać w czasie.
ConnectivityType	Typ połączenia. Dodatkowe typy połączeń mogą być dodawane w czasie.
CredentialType	Typ poświadczeń połączenia. Dodatkowe typy poświadczeń można dodawać w czasie.
ErrorParameter	Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
KeyCredentials	Poświadczenia dla klucza CredentialType.
KeyPairCredentials	Poświadczenia dla keyPair CredentialType.
KeyVaultSecretReference	Odwołanie do wpisu tajnego przechowywanego w usłudze Azure Key Vault.
ListConnectionDetails	Dane wyjściowe szczegółów połączenia dla operacji listy.
ListCredentialDetails	Szczegóły poświadczeń zwracane podczas pobierania połączenia.
OnPremisesCredentialEntry	Identyfikator bramy i zaszyfrowane poświadczenia serializowane.
OnPremisesGatewayConnection	Połączenie łączące się za pośrednictwem lokalnej bramy danych.
OnPremisesGatewayCredentials	Poświadczenia do uwierzytelniania za pośrednictwem bramy lokalnej.
OnPremisesGatewayPersonalConnection	Połączenie, które łączy się za pośrednictwem osobistej lokalnej bramy danych.
OnPremisesGatewayPersonalCredentials	Poświadczenia do uwierzytelniania za pośrednictwem bramy lokalnej (tryb osobisty).
PersonalCloudConnection	Połączenie, które łączy się za pośrednictwem chmury i nie może być współużytkowane.
PrivacyLevel	Ustawienie poziomu prywatności połączenia. Dodatkowe poziomy prywatności można dodawać z upływem czasu.
ServicePrincipalCredentials	Poświadczenia dla parametru ServicePrincipal CredentialType.
ShareableCloudConnection	Połączenie, które łączy się za pośrednictwem chmury.
SharedAccessSignatureCredentials	Poświadczenia elementu SharedAccessSignature CredentialType.
SingleSignOnType	Typ logowania jednokrotnego połączenia. Dodatkowe typy logowania jednokrotnego mogą być dodawane z upływem czasu.
StreamingVirtualNetworkGatewayConnection	Połączenie łączące się za pośrednictwem bramy danych sieci wirtualnej przesyłania strumieniowego.
UpdateCredentialDetails	Dane wejściowe szczegółów poświadczeń służące do aktualizowania połączenia.
UpdateOnPremisesGatewayConnectionRequest
UpdateOnPremisesGatewayCredentialDetails	Dane wejściowe poświadczeń służące do aktualizowania połączenia bramy lokalnej.
UpdateOnPremisesGatewayPersonalConnectionRequest
UpdateOnPremisesGatewayPersonalCredentialDetails	Dane wejściowe poświadczeń służące do aktualizowania połączenia bramy lokalnej.
UpdatePersonalCloudConnectionRequest
UpdateShareableCloudConnectionRequest
UpdateStreamingVirtualNetworkGatewayConnectionRequest	Aktualizuje połączenie, które łączy się za pośrednictwem bramy danych sieci wirtualnej przesyłania strumieniowego.
UpdateVirtualNetworkGatewayConnectionRequest
VirtualNetworkGatewayConnection	Połączenie łączące się za pośrednictwem bramy danych sieci wirtualnej.
WindowsCredentials	Poświadczenia dla elementu CredentialType systemu Windows.
WindowsWithoutImpersonationCredentials	Poświadczenia dla elementu WindowsWithoutImpersonation CredentialType.
WorkspaceIdentityCredentials	Poświadczenia dla workspaceIdentity CredentialType.

AnonymousCredentials

Objekt

Poświadczenia dla anonimowego typu poświadczeń.

Nazwisko	Typ	Opis
credentialType	string: Anonymous	Typ poświadczeń połączenia.

BasicCredentials

Objekt

Poświadczenia dla parametru CredentialType w warstwie Podstawowa.

Nazwisko	Typ	Opis
credentialType	string: Basic	Typ poświadczeń połączenia.
password	string	Hasło. Użyj hasła lub hasłaReference. Nie można używać obu w tym samym czasie
passwordReference	KeyVaultSecretReference	Odwołanie do hasła przechowywanego w usłudze Azure Key Vault. Użyj hasła lub hasłaReference. Nie można używać obu tych elementów w tym samym czasie.
username	string	Nazwa użytkownika.

ConnectionEncryption

Wyliczenie

Typ szyfrowania połączenia. Dodatkowe wartości szyfrowania połączeń mogą być dodawane w czasie.

Wartość	Opis
Encrypted	Próba połączenia jest podejmowana przy użyciu szyfrowanego połączenia.
Any	Próba połączenia jest najpierw podejmowana przy użyciu szyfrowanego połączenia, a następnie wraca do niezaszyfrowanego połączenia, jeśli nie powiedzie się.
NotEncrypted	Próba połączenia jest podejmowana przy użyciu nieszyfrowanego połączenia.

ConnectionRecency

Objekt

Reprezentuje szczegółowe informacje o połączeniu.

Nazwisko	Typ	Opis
createdDateTime	string (date-time)	Sygnatura czasowa utworzenia połączenia w formacie UTC przy użyciu formatu RRRR-MM-DDTHH:mm:ssZ.
lastBoundDateTime	string (date-time)	Sygnatura czasowa ostatniego powiązania połączenia z dowolnym elementem w formacie UTC przy użyciu formatu RRRR-MM-DDTHH:mm:ssZ.
lastCredentialUsedDateTime	string (date-time)	Sygnatura czasowa ostatnio używanych poświadczeń połączenia w formacie UTC przy użyciu formatu RRRR-MM-DDTHH:mm:ssZ.
myLastBoundDateTime	string (date-time)	Sygnatura czasowa ostatniego powiązania połączenia z dowolnym elementem przez użytkownika wywołującego w formacie UTC przy użyciu formatu RRRR-MM-DDTHH:mm:ssZ.
myLastCredentialUsedDateTime	string (date-time)	Sygnatura czasowa, kiedy poświadczenia połączenia były ostatnio używane przez użytkownika wywołującego w formacie UTC, przy użyciu formatu RRRR-MM-DDTHH:mm:ssZ.

ConnectionRole

Wyliczenie

Rola połączenia. Dodatkowe role połączenia można dodawać w czasie.

Wartość	Opis
User	Umożliwia użytkownikowi dostęp do połączenia.
UserWithReshare	Umożliwia użytkownikowi ponowne udostępnianie dostępu do połączenia.
Owner	Umożliwia dostęp do własności dla połączenia.
PendingOwner	Własność połączenia nie jest jeszcze skuteczna; podmiot zabezpieczeń musi zaktualizować poświadczenia połączenia (przy użyciu interfejsu API aktualizacji połączenia), aby było skuteczne.

ConnectivityType

Wyliczenie

Typ połączenia. Dodatkowe typy połączeń mogą być dodawane w czasie.

Wartość	Opis
ShareableCloud	Połączenie łączy się za pośrednictwem chmury i może być współużytkowane przez inne osoby.
PersonalCloud	Połączenie łączy się za pośrednictwem chmury i nie może być udostępniane innym osobom.
OnPremisesGateway	Połączenie łączy się za pośrednictwem lokalnej bramy danych.
OnPremisesGatewayPersonal	Połączenie łączy się za pośrednictwem osobistej lokalnej bramy danych.
VirtualNetworkGateway	Połączenie łączy się za pośrednictwem bramy danych sieci wirtualnej.
StreamingVirtualNetworkGateway	Połączenie łączy się za pośrednictwem bramy danych sieci wirtualnej przesyłania strumieniowego.
Automatic	Połączenie łączy się za pośrednictwem chmury przy użyciu niejawnego połączenia danych. Ta opcja jest dostępna tylko w przypadku określonych scenariuszy, takich jak modele semantyczne korzystające z pojedynczego Sign-On (SSO).
None	Połączenie nie jest powiązane

CredentialType

Wyliczenie

Typ poświadczeń połączenia. Dodatkowe typy poświadczeń można dodawać w czasie.

Wartość	Opis
Windows	Połączenie używa uwierzytelniania systemu Windows do nawiązania połączenia. Obsługiwane tylko w przypadku bram lokalnych.
Anonymous	Połączenie używa uwierzytelniania anonimowego do nawiązania połączenia.
Basic	Połączenie używa uwierzytelniania podstawowego do nawiązania połączenia.
Key	Połączenie używa uwierzytelniania klucza do nawiązania połączenia.
OAuth2	Połączenie używa uwierzytelniania OAuth 2.0 do nawiązania połączenia.
WindowsWithoutImpersonation	Połączenie używa systemu Windows (bez opcji personifikacji) uwierzytelniania w celu nawiązania połączenia. Obsługiwane tylko w przypadku bram lokalnych (tryb osobisty).
SharedAccessSignature	Połączenie używa uwierzytelniania sygnatury dostępu współdzielonego (SAS) w celu nawiązania połączenia.
ServicePrincipal	Połączenie używa uwierzytelniania jednostki usługi w celu nawiązania połączenia.
WorkspaceIdentity	Połączenie używa uwierzytelniania tożsamości obszaru roboczego do nawiązania połączenia.
KeyPair	Połączenie używa uwierzytelniania par kluczy do nawiązania połączenia.

ErrorParameter

Objekt

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.

Nazwisko	Typ	Opis
message	string	Czytelny dla człowieka opis znaczenia parametru.
name	string	Identyfikator parametru.
value	string	Wartość parametru.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwisko	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwisko	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
isRetriable	boolean	Jeśli to prawda, żądanie można ponowić. Użyj nagłówka `Retry-After` odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string (uuid)	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwisko	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

KeyCredentials

Objekt

Poświadczenia dla klucza CredentialType.

Nazwisko	Typ	Opis
credentialType	string: Key	Typ poświadczeń połączenia.
key	string	Klucz. Użyj klucza lub kluczaReference. Nie można używać obu tych elementów w tym samym czasie.
keyReference	KeyVaultSecretReference	Odwołanie do klucza przechowywanego w usłudze Azure Key Vault. Użyj klucza lub kluczaReference. Nie można używać obu tych elementów w tym samym czasie.

KeyPairCredentials

Objekt

Poświadczenia dla keyPair CredentialType.

Nazwisko	Typ	Opis
credentialType	string: KeyPair	Typ poświadczeń połączenia.
identifier	string	Identyfikator klucza.
passphrase	string	Hasło klucza prywatnego, jeśli klucz prywatny jest zaszyfrowany.
privateKey	string	Klucz prywatny oparty na standardzie PKCS #8.

KeyVaultSecretReference

Objekt

Odwołanie do wpisu tajnego przechowywanego w usłudze Azure Key Vault.

Nazwisko	Typ	Opis
connectionId	string (uuid)	Identyfikator połączenia połączenia usługi Key Vault.
secretName	string	Nazwa wpisu tajnego w usłudze Key Vault.
version	string	Wersja wpisu tajnego w usłudze Key Vault.

ListConnectionDetails

Objekt

Dane wyjściowe szczegółów połączenia dla operacji listy.

Nazwisko	Typ	Opis
path	string	Ścieżka połączenia.
type	string	Typ połączenia.

ListCredentialDetails

Objekt

Szczegóły poświadczeń zwracane podczas pobierania połączenia.

Nazwisko	Typ	Opis
connectionEncryption	ConnectionEncryption	Ustawienie szyfrowania połączeń używane podczas testu połączenia.
credentialType	CredentialType	Typ poświadczeń połączenia.
singleSignOnType	SingleSignOnType	Typ logowania jednokrotnego połączenia.
skipTestConnection	boolean	Czy połączenie powinno pominąć połączenie testowe podczas tworzenia i aktualizowania. True — pomiń połączenie testowe, False — nie pomijaj połączenia testowego.

OnPremisesCredentialEntry

Objekt

Identyfikator bramy i zaszyfrowane poświadczenia serializowane.

Nazwisko	Typ	Opis
encryptedCredentials	string	Zaszyfrowana serializowana .json listy par wartości nazw. Nazwa to nazwa poświadczenia, a wartość jest wartością poświadczeń. Szyfrowanie jest wykonywane przy użyciu algorytmu szyfrowania Rivest-Shamir-Adleman (RSA) z kluczem publicznym członka bramy lokalnej.
gatewayId	string (uuid)	Identyfikator obiektu bramy.

OnPremisesGatewayConnection

Objekt

Połączenie łączące się za pośrednictwem lokalnej bramy danych.

Nazwisko	Typ	Opis
connectionDetails	ListConnectionDetails	Szczegóły połączenia.
connectionRecency	ConnectionRecency	Szczegółowe informacje o połączeniu.
connectivityType	string: OnPremisesGateway	Typ połączenia.
credentialDetails	ListCredentialDetails	Szczegóły poświadczeń połączenia.
displayName	string	Nazwa wyświetlana połączenia.
gatewayId	string (uuid)	Identyfikator obiektu bramy, za pomocą którego jest wykonywane połączenie. W przypadku połączeń w chmurze jest to identyfikator bramy wirtualnej.
id	string (uuid)	Identyfikator obiektu połączenia.
myRole	ConnectionRole	Efektywna rola podmiotu zabezpieczeń wywołującego w połączeniu. Gdy podmiot zabezpieczeń jest częścią wielu grup zabezpieczeń z różnymi rolami, zwracana jest najwyższa rola. Jeśli podmiot zabezpieczeń nie ma roli w połączeniu, ta właściwość nie jest zwracana.
privacyLevel	PrivacyLevel	Poziom prywatności połączenia.

OnPremisesGatewayCredentials

Objekt

Poświadczenia do uwierzytelniania za pośrednictwem bramy lokalnej.

Nazwisko	Typ	Opis
credentialType	CredentialType	Typ poświadczeń połączenia.
values	OnPremisesCredentialEntry[]	Ładunek poświadczeń do wysłania do bramy lokalnej.

OnPremisesGatewayPersonalConnection

Objekt

Połączenie, które łączy się za pośrednictwem osobistej lokalnej bramy danych.

Nazwisko	Typ	Opis
connectionDetails	ListConnectionDetails	Szczegóły połączenia.
connectionRecency	ConnectionRecency	Szczegółowe informacje o połączeniu.
connectivityType	string: OnPremisesGatewayPersonal	Typ połączenia.
credentialDetails	ListCredentialDetails	Szczegóły poświadczeń połączenia.
displayName	string	Nazwa wyświetlana połączenia.
gatewayId	string (uuid)	Identyfikator obiektu bramy, za pomocą którego jest wykonywane połączenie. W przypadku połączeń w chmurze jest to identyfikator bramy wirtualnej.
id	string (uuid)	Identyfikator obiektu połączenia.
myRole	ConnectionRole	Efektywna rola podmiotu zabezpieczeń wywołującego w połączeniu. Gdy podmiot zabezpieczeń jest częścią wielu grup zabezpieczeń z różnymi rolami, zwracana jest najwyższa rola. Jeśli podmiot zabezpieczeń nie ma roli w połączeniu, ta właściwość nie jest zwracana.
privacyLevel	PrivacyLevel	Poziom prywatności połączenia.

OnPremisesGatewayPersonalCredentials

Objekt

Poświadczenia do uwierzytelniania za pośrednictwem bramy lokalnej (tryb osobisty).

Nazwisko	Typ	Opis
credentialType	CredentialType	Typ poświadczeń połączenia.
encryptedCredentials	string	Zaszyfrowana serializowana .json listy par wartości nazw. Nazwa to nazwa poświadczenia, a wartość jest wartością poświadczeń. Szyfrowanie jest wykonywane przy użyciu algorytmu szyfrowania Rivest-Shamir-Adleman (RSA) z kluczem publicznym bramy lokalnej.

PersonalCloudConnection

Objekt

Połączenie, które łączy się za pośrednictwem chmury i nie może być współużytkowane.

Nazwisko	Typ	Opis
allowConnectionUsageInGateway	boolean	Zezwalaj na korzystanie z tego połączenia z lokalnymi bramami danych lub bramami danych sieci wirtualnej.
connectionDetails	ListConnectionDetails	Szczegóły połączenia.
connectionRecency	ConnectionRecency	Szczegółowe informacje o połączeniu.
connectivityType	string: PersonalCloud	Typ połączenia.
credentialDetails	ListCredentialDetails	Szczegóły poświadczeń połączenia.
displayName	string	Nazwa wyświetlana połączenia.
gatewayId	string (uuid)	Identyfikator obiektu bramy, za pomocą którego jest wykonywane połączenie. W przypadku połączeń w chmurze jest to identyfikator bramy wirtualnej.
id	string (uuid)	Identyfikator obiektu połączenia.
myRole	ConnectionRole	Efektywna rola podmiotu zabezpieczeń wywołującego w połączeniu. Gdy podmiot zabezpieczeń jest częścią wielu grup zabezpieczeń z różnymi rolami, zwracana jest najwyższa rola. Jeśli podmiot zabezpieczeń nie ma roli w połączeniu, ta właściwość nie jest zwracana.
privacyLevel	PrivacyLevel	Poziom prywatności połączenia.

PrivacyLevel

Wyliczenie

Ustawienie poziomu prywatności połączenia. Dodatkowe poziomy prywatności można dodawać z upływem czasu.

Wartość	Opis
None	Nie skonfigurowano ustawienia poziomu prywatności.
Private	Połączenia ustawione na prywatne zawierają poufne lub poufne informacje. Widoczność może być ograniczona do autoryzowanych użytkowników. Dane z połączenia prywatnego nie będą składane do innych połączeń, w tym z innymi połączeniami prywatnymi.
Organizational	Połączenia ustawione na organizację mogą składać się na prywatne i inne połączenia organizacyjne. Nie mogą one składać się do połączeń publicznych. Widoczność jest ustawiona na zaufaną grupę.
Public	Pliki, połączenia internetowe i dane skoroszytu można ustawić na publiczne. Dane mogą składać się do innych połączeń. Widoczność jest dostępna dla wszystkich.

ServicePrincipalCredentials

Objekt

Poświadczenia dla parametru ServicePrincipal CredentialType.

Nazwisko	Typ	Opis
credentialType	string: ServicePrincipal	Typ poświadczeń połączenia.
servicePrincipalClientId	string (uuid)	Identyfikator klienta jednostki usługi.
servicePrincipalSecret	string	Wpis tajny jednostki usługi. Użyj servicePrincipalSecret lub servicePrincipalSecretReference. Nie można używać obu tych elementów w tym samym czasie.
servicePrincipalSecretReference	KeyVaultSecretReference	Odwołanie do wpisu tajnego jednostki usługi przechowywanego w usłudze Azure Key Vault. Użyj servicePrincipalSecret lub servicePrincipalSecretReference. Nie można używać obu tych elementów w tym samym czasie.
tenantId	string (uuid)	Identyfikator dzierżawy jednostki usługi.

ShareableCloudConnection

Objekt

Połączenie, które łączy się za pośrednictwem chmury.

Nazwisko	Typ	Opis
allowConnectionUsageInGateway	boolean	Zezwalaj na korzystanie z tego połączenia z lokalnymi bramami danych lub bramami danych sieci wirtualnej.
allowUsageInUserControlledCode	boolean	Zezwalaj na używanie tego połączenia z elementami, które zezwalają na kod kontrolowany przez użytkownika, taki jak notes.
connectionDetails	ListConnectionDetails	Szczegóły połączenia.
connectionRecency	ConnectionRecency	Szczegółowe informacje o połączeniu.
connectivityType	string: ShareableCloud	Typ połączenia.
credentialDetails	ListCredentialDetails	Szczegóły poświadczeń połączenia.
displayName	string	Nazwa wyświetlana połączenia.
gatewayId	string (uuid)	Identyfikator obiektu bramy, za pomocą którego jest wykonywane połączenie. W przypadku połączeń w chmurze jest to identyfikator bramy wirtualnej.
id	string (uuid)	Identyfikator obiektu połączenia.
myRole	ConnectionRole	Efektywna rola podmiotu zabezpieczeń wywołującego w połączeniu. Gdy podmiot zabezpieczeń jest częścią wielu grup zabezpieczeń z różnymi rolami, zwracana jest najwyższa rola. Jeśli podmiot zabezpieczeń nie ma roli w połączeniu, ta właściwość nie jest zwracana.
privacyLevel	PrivacyLevel	Poziom prywatności połączenia.

SharedAccessSignatureCredentials

Objekt

Poświadczenia elementu SharedAccessSignature CredentialType.

Nazwisko	Typ	Opis
credentialType	string: SharedAccessSignature	Typ poświadczeń połączenia.
token	string	Znacznik. Użyj tokenu lub tokenuReference. Nie można używać obu tych elementów w tym samym czasie.
tokenReference	KeyVaultSecretReference	Odwołanie do tokenu przechowywanego w usłudze Azure Key Vault. Użyj tokenu lub tokenuReference. Nie można używać obu tych elementów w tym samym czasie.

SingleSignOnType

Wyliczenie

Typ logowania jednokrotnego połączenia. Dodatkowe typy logowania jednokrotnego mogą być dodawane z upływem czasu.

Wartość	Opis
None	Połączenie nie używa logowania jednokrotnego do nawiązywania połączenia.
Kerberos	Połączenie używa logowania jednokrotnego protokołu Kerberos w celu nawiązania połączenia.
MicrosoftEntraID	Połączenie używa logowania jednokrotnego microsoft Entra ID, aby nawiązać połączenie.
SecurityAssertionMarkupLanguage	Połączenie używa logowania jednokrotnego języka SAML (Security Assertion Markup Language).
KerberosDirectQueryAndRefresh	Połączenie używa trybu DirectQuery protokołu Kerberos i odświeżania logowania jednokrotnego w celu nawiązania połączenia.

StreamingVirtualNetworkGatewayConnection

Objekt

Połączenie łączące się za pośrednictwem bramy danych sieci wirtualnej przesyłania strumieniowego.

Nazwisko	Typ	Opis
connectionDetails	ListConnectionDetails	Szczegóły połączenia.
connectionRecency	ConnectionRecency	Szczegółowe informacje o połączeniu.
connectivityType	string: StreamingVirtualNetworkGateway	Typ połączenia.
credentialDetails	ListCredentialDetails	Szczegóły poświadczeń połączenia.
displayName	string	Nazwa wyświetlana połączenia.
gatewayId	string (uuid)	Identyfikator obiektu bramy połączenia.
id	string (uuid)	Identyfikator obiektu połączenia.
myRole	ConnectionRole	Efektywna rola podmiotu zabezpieczeń wywołującego w połączeniu. Gdy podmiot zabezpieczeń jest częścią wielu grup zabezpieczeń z różnymi rolami, zwracana jest najwyższa rola. Jeśli podmiot zabezpieczeń nie ma roli w połączeniu, ta właściwość nie jest zwracana.
privacyLevel	PrivacyLevel	Poziom prywatności połączenia.

UpdateCredentialDetails

Objekt

Dane wejściowe szczegółów poświadczeń służące do aktualizowania połączenia.

Nazwisko	Typ	Opis
connectionEncryption	ConnectionEncryption	Ustawienie szyfrowania połączeń używane podczas testu połączenia.
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials KeyPairCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	Poświadczenia połączenia.
singleSignOnType	SingleSignOnType	Typ logowania jednokrotnego połączenia.
skipTestConnection	boolean	Czy połączenie powinno pominąć połączenie testowe podczas tworzenia i aktualizowania. True — pomiń połączenie testowe, False — nie pomijaj połączenia testowego.

UpdateOnPremisesGatewayConnectionRequest

Objekt

Nazwisko	Typ	Opis
connectivityType	string: OnPremisesGateway	Typ połączenia.
credentialDetails	UpdateOnPremisesGatewayCredentialDetails	Szczegóły poświadczeń połączenia.
displayName	string	Nazwa wyświetlana połączenia. Maksymalna długość to 200 znaków.
privacyLevel	PrivacyLevel	Poziom prywatności połączenia.

UpdateOnPremisesGatewayCredentialDetails

Objekt

Dane wejściowe poświadczeń służące do aktualizowania połączenia bramy lokalnej.

Nazwisko	Typ	Opis
connectionEncryption	ConnectionEncryption	Ustawienie szyfrowania połączeń używane podczas testu połączenia.
credentials	OnPremisesGatewayCredentials	Poświadczenia połączenia.
singleSignOnType	SingleSignOnType	Typ logowania jednokrotnego połączenia.
skipTestConnection	boolean	Czy połączenie powinno pominąć połączenie testowe podczas tworzenia i aktualizowania. True — pomiń połączenie testowe, False — nie pomijaj połączenia testowego.

UpdateOnPremisesGatewayPersonalConnectionRequest

Objekt

Nazwisko	Typ	Opis
connectivityType	string: OnPremisesGatewayPersonal	Typ połączenia.
credentialDetails	UpdateOnPremisesGatewayPersonalCredentialDetails	Szczegóły poświadczeń połączenia.
privacyLevel	PrivacyLevel	Poziom prywatności połączenia.

UpdateOnPremisesGatewayPersonalCredentialDetails

Objekt

Dane wejściowe poświadczeń służące do aktualizowania połączenia bramy lokalnej.

Nazwisko	Typ	Opis
connectionEncryption	ConnectionEncryption	Ustawienie szyfrowania połączeń używane podczas testu połączenia.
credentials	OnPremisesGatewayPersonalCredentials	Poświadczenia połączenia.
singleSignOnType	SingleSignOnType	Typ logowania jednokrotnego połączenia.
skipTestConnection	boolean	Czy połączenie powinno pominąć połączenie testowe podczas tworzenia i aktualizowania. True — pomiń połączenie testowe, False — nie pomijaj połączenia testowego.

UpdatePersonalCloudConnectionRequest

Objekt

Nazwisko	Typ	Opis
allowConnectionUsageInGateway	boolean	Zezwalaj na korzystanie z tego połączenia z lokalnymi bramami danych lub bramami danych sieci wirtualnej.
connectivityType	string: PersonalCloud	Typ połączenia.
credentialDetails	UpdateCredentialDetails	Szczegóły poświadczeń połączenia.
privacyLevel	PrivacyLevel	Poziom prywatności połączenia.

UpdateShareableCloudConnectionRequest

Objekt

Nazwisko	Typ	Opis
allowConnectionUsageInGateway	boolean	Zezwalaj na korzystanie z tego połączenia z lokalnymi bramami danych lub bramami danych sieci wirtualnej.
connectivityType	string: ShareableCloud	Typ połączenia.
credentialDetails	UpdateCredentialDetails	Szczegóły poświadczeń połączenia.
displayName	string	Nazwa wyświetlana połączenia. Maksymalna długość to 200 znaków.
privacyLevel	PrivacyLevel	Poziom prywatności połączenia.

UpdateStreamingVirtualNetworkGatewayConnectionRequest

Objekt

Aktualizuje połączenie, które łączy się za pośrednictwem bramy danych sieci wirtualnej przesyłania strumieniowego.

Nazwisko	Typ	Opis
connectivityType	string: StreamingVirtualNetworkGateway	Typ połączenia.
credentialDetails	UpdateCredentialDetails	Szczegóły poświadczeń połączenia.
displayName	string	Nazwa wyświetlana połączenia. Maksymalna długość to 200 znaków.
privacyLevel	PrivacyLevel	Poziom prywatności połączenia.

UpdateVirtualNetworkGatewayConnectionRequest

Objekt

Nazwisko	Typ	Opis
connectivityType	string: VirtualNetworkGateway	Typ połączenia.
credentialDetails	UpdateCredentialDetails	Szczegóły poświadczeń połączenia.
displayName	string	Nazwa wyświetlana połączenia. Maksymalna długość to 200 znaków.
privacyLevel	PrivacyLevel	Poziom prywatności połączenia.

VirtualNetworkGatewayConnection

Objekt

Połączenie łączące się za pośrednictwem bramy danych sieci wirtualnej.

Nazwisko	Typ	Opis
connectionDetails	ListConnectionDetails	Szczegóły połączenia.
connectionRecency	ConnectionRecency	Szczegółowe informacje o połączeniu.
connectivityType	string: VirtualNetworkGateway	Typ połączenia.
credentialDetails	ListCredentialDetails	Szczegóły poświadczeń połączenia.
displayName	string	Nazwa wyświetlana połączenia.
gatewayId	string (uuid)	Identyfikator obiektu bramy, za pomocą którego jest wykonywane połączenie. W przypadku połączeń w chmurze jest to identyfikator bramy wirtualnej.
id	string (uuid)	Identyfikator obiektu połączenia.
myRole	ConnectionRole	Efektywna rola podmiotu zabezpieczeń wywołującego w połączeniu. Gdy podmiot zabezpieczeń jest częścią wielu grup zabezpieczeń z różnymi rolami, zwracana jest najwyższa rola. Jeśli podmiot zabezpieczeń nie ma roli w połączeniu, ta właściwość nie jest zwracana.
privacyLevel	PrivacyLevel	Poziom prywatności połączenia.

WindowsCredentials

Objekt

Poświadczenia dla elementu CredentialType systemu Windows.

Nazwisko	Typ	Opis
credentialType	string: Windows	Typ poświadczeń połączenia.
password	string	Hasło.
username	string	Nazwa użytkownika.

WindowsWithoutImpersonationCredentials

Objekt

Poświadczenia dla elementu WindowsWithoutImpersonation CredentialType.

Nazwisko	Typ	Opis
credentialType	string: WindowsWithoutImpersonation	Typ poświadczeń połączenia.

WorkspaceIdentityCredentials

Objekt

Poświadczenia dla workspaceIdentity CredentialType.

Nazwisko	Typ	Opis
credentialType	string: WorkspaceIdentity	Typ poświadczeń połączenia.