RestServiceLinkedService interface

Pakiet:

@azure/synapse-artifacts

Połączona usługa Rest Service.

Rozszerzenie

LinkedService

Właściwości

aadResourceId	Zasób, którego żądasz autoryzacji do użycia.
authenticationType	Typ uwierzytelniania używanego do nawiązywania połączenia z usługą REST.
authHeaders	Dodatkowe nagłówki HTTP w żądaniu interfejsu API RESTful używane do autoryzacji. Typ: obiekt (lub wyrażenie z obiektem resultType).
azureCloudType	Wskazuje typ chmury platformy Azure uwierzytelniania jednostki usługi. Dozwolone wartości to AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Wartość domyślna to typ chmury regionów fabryki danych. Typ: ciąg (lub wyrażenie z ciągiem resultType).
clientId	Identyfikator klienta skojarzony z aplikacją. Typ: ciąg (lub wyrażenie z ciągiem resultType).
clientSecret	Klucz tajny klienta skojarzony z aplikacją.
credential	Odwołanie do poświadczeń zawierające informacje o uwierzytelnianiu.
enableServerCertificateValidation	Czy weryfikować certyfikat SSL po stronie serwera podczas nawiązywania połączenia z punktem końcowym. Wartość domyślna to true. Typ: wartość logiczna (lub wyrażenie z wartością logiczną resultType).
encryptedCredential	Zaszyfrowane poświadczenia używane do uwierzytelniania. Poświadczenia są szyfrowane przy użyciu menedżera poświadczeń środowiska Integration Runtime. Typ: ciąg (lub wyrażenie z ciągiem resultType).
password	Hasło używane w typie uwierzytelniania podstawowego.
resource	Docelowa usługa lub zasób, do którego zostanie żądany dostęp. Typ: ciąg (lub wyrażenie z ciągiem resultType).
scope	Wymagany zakres dostępu. Opisuje on, jakiego rodzaju dostęp zostanie zażądany. Typ: ciąg (lub wyrażenie z ciągiem resultType).
servicePrincipalCredentialType	Typ poświadczeń jednostki usługi do użycia w uwierzytelnianiuTo-Server serwera. "ServicePrincipalKey" dla klucza/wpisu tajnego, "ServicePrincipalCert" dla certyfikatu. Typ: ciąg (lub wyrażenie z ciągiem resultType).
servicePrincipalEmbeddedCert	Określ certyfikat zakodowany w formacie base64 aplikacji zarejestrowanej w usłudze Azure Active Directory. Typ: ciąg (lub wyrażenie z ciągiem resultType).
servicePrincipalEmbeddedCertPassword	Określ hasło certyfikatu, jeśli certyfikat ma hasło i używasz uwierzytelniania AadServicePrincipal. Typ: ciąg (lub wyrażenie z ciągiem resultType).
servicePrincipalId	Identyfikator klienta aplikacji używany w typie uwierzytelniania AadServicePrincipal.
servicePrincipalKey	Klucz aplikacji używany w typie uwierzytelniania AadServicePrincipal.
tenant	Informacje o dzierżawie (nazwa domeny lub identyfikator dzierżawy) używane w typie uwierzytelniania AadServicePrincipal, w którym znajduje się aplikacja.
tokenEndpoint	Punkt końcowy tokenu serwera autoryzacji w celu uzyskania tokenu dostępu. Typ: ciąg (lub wyrażenie z ciągiem resultType).
type	Dyskryminujący polimorficzny, który określa różne typy tego obiektu może być
url	Podstawowy adres URL usługi REST.
userName	Nazwa użytkownika używana w typie uwierzytelniania podstawowego.

Właściwości dziedziczone

annotations	Lista tagów, których można użyć do opisywania połączonej usługi.
connectVia	Dokumentacja środowiska Integration Runtime.
description	Opis połączonej usługi.
parameters	Parametry połączonej usługi.
version	Wersja połączonej usługi.

Szczegóły właściwości

aadResourceId

Zasób, którego żądasz autoryzacji do użycia.

aadResourceId?: any

Wartość właściwości

any

authenticationType

Typ uwierzytelniania używanego do nawiązywania połączenia z usługą REST.

authenticationType: string

Wartość właściwości

string

authHeaders

Dodatkowe nagłówki HTTP w żądaniu interfejsu API RESTful używane do autoryzacji. Typ: obiekt (lub wyrażenie z obiektem resultType).

authHeaders?: any

Wartość właściwości

any

azureCloudType

Wskazuje typ chmury platformy Azure uwierzytelniania jednostki usługi. Dozwolone wartości to AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Wartość domyślna to typ chmury regionów fabryki danych. Typ: ciąg (lub wyrażenie z ciągiem resultType).

azureCloudType?: any

Wartość właściwości

any

clientId

Identyfikator klienta skojarzony z aplikacją. Typ: ciąg (lub wyrażenie z ciągiem resultType).

clientId?: any

Wartość właściwości

any

clientSecret

Klucz tajny klienta skojarzony z aplikacją.

clientSecret?: SecretBaseUnion

Wartość właściwości

SecretBaseUnion

credential

Odwołanie do poświadczeń zawierające informacje o uwierzytelnianiu.

credential?: CredentialReference

Wartość właściwości

CredentialReference

enableServerCertificateValidation

Czy weryfikować certyfikat SSL po stronie serwera podczas nawiązywania połączenia z punktem końcowym. Wartość domyślna to true. Typ: wartość logiczna (lub wyrażenie z wartością logiczną resultType).

enableServerCertificateValidation?: any

Wartość właściwości

any

encryptedCredential

Zaszyfrowane poświadczenia używane do uwierzytelniania. Poświadczenia są szyfrowane przy użyciu menedżera poświadczeń środowiska Integration Runtime. Typ: ciąg (lub wyrażenie z ciągiem resultType).

encryptedCredential?: any

Wartość właściwości

any

password

Hasło używane w typie uwierzytelniania podstawowego.

password?: SecretBaseUnion

Wartość właściwości

SecretBaseUnion

resource

Docelowa usługa lub zasób, do którego zostanie żądany dostęp. Typ: ciąg (lub wyrażenie z ciągiem resultType).

resource?: any

Wartość właściwości

any

scope

Wymagany zakres dostępu. Opisuje on, jakiego rodzaju dostęp zostanie zażądany. Typ: ciąg (lub wyrażenie z ciągiem resultType).

scope?: any

Wartość właściwości

any

servicePrincipalCredentialType

Typ poświadczeń jednostki usługi do użycia w uwierzytelnianiuTo-Server serwera. "ServicePrincipalKey" dla klucza/wpisu tajnego, "ServicePrincipalCert" dla certyfikatu. Typ: ciąg (lub wyrażenie z ciągiem resultType).

servicePrincipalCredentialType?: any

Wartość właściwości

any

servicePrincipalEmbeddedCert

Określ certyfikat zakodowany w formacie base64 aplikacji zarejestrowanej w usłudze Azure Active Directory. Typ: ciąg (lub wyrażenie z ciągiem resultType).

servicePrincipalEmbeddedCert?: SecretBaseUnion

Wartość właściwości

SecretBaseUnion

servicePrincipalEmbeddedCertPassword

Określ hasło certyfikatu, jeśli certyfikat ma hasło i używasz uwierzytelniania AadServicePrincipal. Typ: ciąg (lub wyrażenie z ciągiem resultType).

servicePrincipalEmbeddedCertPassword?: SecretBaseUnion

Wartość właściwości

SecretBaseUnion

servicePrincipalId

Identyfikator klienta aplikacji używany w typie uwierzytelniania AadServicePrincipal.

servicePrincipalId?: any

Wartość właściwości

any

servicePrincipalKey

Klucz aplikacji używany w typie uwierzytelniania AadServicePrincipal.

servicePrincipalKey?: SecretBaseUnion

Wartość właściwości

SecretBaseUnion

tenant

Informacje o dzierżawie (nazwa domeny lub identyfikator dzierżawy) używane w typie uwierzytelniania AadServicePrincipal, w którym znajduje się aplikacja.

tenant?: any

Wartość właściwości

any

tokenEndpoint

Punkt końcowy tokenu serwera autoryzacji w celu uzyskania tokenu dostępu. Typ: ciąg (lub wyrażenie z ciągiem resultType).

tokenEndpoint?: any

Wartość właściwości

any

type

Dyskryminujący polimorficzny, który określa różne typy tego obiektu może być

type: "RestService"

Wartość właściwości

"RestService"

url

Podstawowy adres URL usługi REST.

url: any

Wartość właściwości

any

userName

Nazwa użytkownika używana w typie uwierzytelniania podstawowego.

userName?: any

Wartość właściwości

any

Szczegóły właściwości dziedziczonej

annotations

Lista tagów, których można użyć do opisywania połączonej usługi.

annotations?: any[]

Wartość właściwości

any[]

dziedziczone zLinkedService.annotations

connectVia

Dokumentacja środowiska Integration Runtime.

connectVia?: IntegrationRuntimeReference

Wartość właściwości

IntegrationRuntimeReference

dziedziczone zLinkedService.connectVia

description

Opis połączonej usługi.

description?: string

Wartość właściwości

string

dziedziczone zLinkedService.description

parameters

Parametry połączonej usługi.

parameters?: {[propertyName: string]: ParameterSpecification}

Wartość właściwości

{[propertyName: string]: ParameterSpecification}

dziedziczone zLinkedService.parameters

version

Wersja połączonej usługi.

version?: string

Wartość właściwości

string

dziedziczone zLinkedService.version