RestServiceLinkedService interface

パッケージ:

@azure/synapse-artifacts

Rest Service のリンクされたサービス。

Extends

LinkedService

プロパティ

aadResourceId	使用する承認を要求しているリソース。
authenticationType	REST サービスへの接続に使用される認証の種類。
authHeaders	承認に使用される RESTful API への要求内の追加の HTTP ヘッダー。 型: オブジェクト (または resultType オブジェクトを持つ式)。
azureCloudType	サービス プリンシパル認証の Azure クラウドの種類を示します。使用できる値は、AzurePublic、AzureChina、AzureUsGovernment、AzureGermany です。 既定値は、データ ファクトリ リージョンのクラウドの種類です。 型: string (または resultType 文字列を含む式)。
clientId	アプリケーションに関連付けられているクライアント ID。 型: string (または resultType 文字列を含む式)。
clientSecret	アプリケーションに関連付けられているクライアント シークレット。
credential	認証情報を含む資格情報参照。
enableServerCertificateValidation	エンドポイントに接続するときにサーバー側の SSL 証明書を検証するかどうか。既定値は true です。 型: boolean (または resultType ブール値を持つ式)。
encryptedCredential	認証に使用される暗号化された資格情報。 資格情報は、統合ランタイム資格情報マネージャーを使用して暗号化されます。 型: string (または resultType 文字列を含む式)。
password	基本認証の種類で使用されるパスワード。
resource	アクセスが要求されるターゲット サービスまたはリソース。 型: string (または resultType 文字列を含む式)。
scope	必要なアクセスのスコープ。 要求されるアクセスの種類について説明します。 型: string (または resultType 文字列を含む式)。
servicePrincipalCredentialType	サーバーTo-Server 認証で使用するサービス プリンシパル資格情報の種類。 キー/シークレットの場合は 'ServicePrincipalKey'、証明書の場合は 'ServicePrincipalCert' です。 型: string (または resultType 文字列を含む式)。
servicePrincipalEmbeddedCert	Azure Active Directory に登録されているアプリケーションの base64 でエンコードされた証明書を指定します。 型: string (または resultType 文字列を含む式)。
servicePrincipalEmbeddedCertPassword	証明書にパスワードがあり、AadServicePrincipal 認証を使用している場合は、証明書のパスワードを指定します。 型: string (または resultType 文字列を含む式)。
servicePrincipalId	AadServicePrincipal 認証の種類で使用されるアプリケーションのクライアント ID。
servicePrincipalKey	AadServicePrincipal 認証の種類で使用されるアプリケーションのキー。
tenant	アプリケーションが存在する AadServicePrincipal 認証の種類で使用されるテナント情報 (ドメイン名またはテナント ID)。
tokenEndpoint	アクセス トークンを取得する承認サーバーのトークン エンドポイント。 型: string (または resultType 文字列を含む式)。
type	ポリモーフィック識別子。このオブジェクトは、さまざまな型を指定します。
url	REST サービスのベース URL。
userName	基本認証の種類で使用されるユーザー名。

継承されたプロパティ

annotations	リンクされたサービスの説明に使用できるタグの一覧。
connectVia	統合ランタイムリファレンス。
description	リンクされたサービスの説明。
parameters	リンクされたサービスのパラメーター。
version	リンクされたサービスのバージョン。

プロパティの詳細

aadResourceId

使用する承認を要求しているリソース。

aadResourceId?: any

プロパティ値

any

authenticationType

REST サービスへの接続に使用される認証の種類。

authenticationType: string

プロパティ値

string

authHeaders

承認に使用される RESTful API への要求内の追加の HTTP ヘッダー。 型: オブジェクト (または resultType オブジェクトを持つ式)。

authHeaders?: any

プロパティ値

any

azureCloudType

サービス プリンシパル認証の Azure クラウドの種類を示します。使用できる値は、AzurePublic、AzureChina、AzureUsGovernment、AzureGermany です。 既定値は、データ ファクトリ リージョンのクラウドの種類です。 型: string (または resultType 文字列を含む式)。

azureCloudType?: any

プロパティ値

any

clientId

アプリケーションに関連付けられているクライアント ID。 型: string (または resultType 文字列を含む式)。

clientId?: any

プロパティ値

any

clientSecret

アプリケーションに関連付けられているクライアント シークレット。

clientSecret?: SecretBaseUnion

プロパティ値

SecretBaseUnion

credential

認証情報を含む資格情報参照。

credential?: CredentialReference

プロパティ値

CredentialReference

enableServerCertificateValidation

エンドポイントに接続するときにサーバー側の SSL 証明書を検証するかどうか。既定値は true です。 型: boolean (または resultType ブール値を持つ式)。

enableServerCertificateValidation?: any

プロパティ値

any

encryptedCredential

認証に使用される暗号化された資格情報。 資格情報は、統合ランタイム資格情報マネージャーを使用して暗号化されます。 型: string (または resultType 文字列を含む式)。

encryptedCredential?: any

プロパティ値

any

password

基本認証の種類で使用されるパスワード。

password?: SecretBaseUnion

プロパティ値

SecretBaseUnion

resource

アクセスが要求されるターゲット サービスまたはリソース。 型: string (または resultType 文字列を含む式)。

resource?: any

プロパティ値

any

scope

必要なアクセスのスコープ。 要求されるアクセスの種類について説明します。 型: string (または resultType 文字列を含む式)。

scope?: any

プロパティ値

any

servicePrincipalCredentialType

サーバーTo-Server 認証で使用するサービス プリンシパル資格情報の種類。 キー/シークレットの場合は 'ServicePrincipalKey'、証明書の場合は 'ServicePrincipalCert' です。 型: string (または resultType 文字列を含む式)。

servicePrincipalCredentialType?: any

プロパティ値

any

servicePrincipalEmbeddedCert

Azure Active Directory に登録されているアプリケーションの base64 でエンコードされた証明書を指定します。 型: string (または resultType 文字列を含む式)。

servicePrincipalEmbeddedCert?: SecretBaseUnion

プロパティ値

SecretBaseUnion

servicePrincipalEmbeddedCertPassword

証明書にパスワードがあり、AadServicePrincipal 認証を使用している場合は、証明書のパスワードを指定します。 型: string (または resultType 文字列を含む式)。

servicePrincipalEmbeddedCertPassword?: SecretBaseUnion

プロパティ値

SecretBaseUnion

servicePrincipalId

AadServicePrincipal 認証の種類で使用されるアプリケーションのクライアント ID。

servicePrincipalId?: any

プロパティ値

any

servicePrincipalKey

AadServicePrincipal 認証の種類で使用されるアプリケーションのキー。

servicePrincipalKey?: SecretBaseUnion

プロパティ値

SecretBaseUnion

tenant

アプリケーションが存在する AadServicePrincipal 認証の種類で使用されるテナント情報 (ドメイン名またはテナント ID)。

tenant?: any

プロパティ値

any

tokenEndpoint

アクセス トークンを取得する承認サーバーのトークン エンドポイント。 型: string (または resultType 文字列を含む式)。

tokenEndpoint?: any

プロパティ値

any

type

ポリモーフィック識別子。このオブジェクトは、さまざまな型を指定します。

type: "RestService"

プロパティ値

"RestService"

url

REST サービスのベース URL。

url: any

プロパティ値

any

userName

基本認証の種類で使用されるユーザー名。

userName?: any

プロパティ値

any

継承されたプロパティの詳細

annotations

リンクされたサービスの説明に使用できるタグの一覧。

annotations?: any[]

プロパティ値

any[]

linkedService.annotations から継承

connectVia

統合ランタイムリファレンス。

connectVia?: IntegrationRuntimeReference

プロパティ値

IntegrationRuntimeReference

LinkedService.connectVia から継承

description

リンクされたサービスの説明。

description?: string

プロパティ値

string

linkedService.description から継承

parameters

リンクされたサービスのパラメーター。

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

プロパティ値

{[propertyName: string]: ParameterSpecification}

LinkedService.parameters から継承

version

リンクされたサービスのバージョン。

version?: string

プロパティ値

string

linkedService.version から継承