RestServiceLinkedService Class

Reference

Rest Service linked service.

All required parameters must be populated in order to send to server.

Inheritance: azure.mgmt.datafactory.models._models_py3.LinkedService

RestServiceLinkedService

Constructor

RestServiceLinkedService(*, url: MutableMapping[str, Any], authentication_type: str | _models.RestServiceAuthenticationType, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, version: str | None = None, connect_via: _models.IntegrationRuntimeReference | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str, Any]] | None = None, enable_server_certificate_validation: MutableMapping[str, Any] | None = None, user_name: MutableMapping[str, Any] | None = None, password: _models.SecretBase | None = None, auth_headers: MutableMapping[str, Any] | None = None, service_principal_id: MutableMapping[str, Any] | None = None, service_principal_key: _models.SecretBase | None = None, tenant: MutableMapping[str, Any] | None = None, azure_cloud_type: MutableMapping[str, Any] | None = None, aad_resource_id: MutableMapping[str, Any] | None = None, encrypted_credential: str | None = None, credential: _models.CredentialReference | None = None, client_id: MutableMapping[str, Any] | None = None, client_secret: _models.SecretBase | None = None, token_endpoint: MutableMapping[str, Any] | None = None, resource: MutableMapping[str, Any] | None = None, scope: MutableMapping[str, Any] | None = None, service_principal_credential_type: MutableMapping[str, Any] | None = None, service_principal_embedded_cert: _models.SecretBase | None = None, service_principal_embedded_cert_password: _models.SecretBase | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
version	str Version of the linked service.
connect_via	IntegrationRuntimeReference The integration runtime reference.
description	str Linked service description.
parameters	dict[str, ParameterSpecification] Parameters for linked service.
annotations	list[<xref:JSON>] List of tags that can be used for describing the linked service.
url	<xref:JSON> The base URL of the REST service. Type: string (or Expression with resultType string). Required.
enable_server_certificate_validation	<xref:JSON> Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean).
authentication_type	str or RestServiceAuthenticationType Type of authentication used to connect to the REST service. Required. Known values are: "Anonymous", "Basic", "AadServicePrincipal", "ManagedServiceIdentity", and "OAuth2ClientCredential".
user_name	<xref:JSON> The user name used in Basic authentication type. Type: string (or Expression with resultType string).
password	SecretBase The password used in Basic authentication type.
auth_headers	<xref:JSON> The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).
service_principal_id	<xref:JSON> The application's client ID used in AadServicePrincipal authentication type. Type: string (or Expression with resultType string).
service_principal_key	SecretBase The application's key used in AadServicePrincipal authentication type.
tenant	<xref:JSON> The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides. Type: string (or Expression with resultType string).
azure_cloud_type	<xref:JSON> Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions' cloud type. Type: string (or Expression with resultType string).
aad_resource_id	<xref:JSON> The resource you are requesting authorization to use. Type: string (or Expression with resultType string).
encrypted_credential	str The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
credential	CredentialReference The credential reference containing authentication information.
client_id	<xref:JSON> The client ID associated with your application. Type: string (or Expression with resultType string).
client_secret	SecretBase The client secret associated with your application.
token_endpoint	<xref:JSON> The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string).
resource	<xref:JSON> The target service or resource to which the access will be requested. Type: string (or Expression with resultType string).
scope	<xref:JSON> The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string).
service_principal_credential_type	<xref:JSON> The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
service_principal_embedded_cert	SecretBase Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
service_principal_embedded_cert_password	SecretBase Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).

Variables

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
type	str Type of linked service. Required.
version	str Version of the linked service.
connect_via	IntegrationRuntimeReference The integration runtime reference.
description	str Linked service description.
parameters	dict[str, ParameterSpecification] Parameters for linked service.
annotations	list[<xref:JSON>] List of tags that can be used for describing the linked service.
url	<xref:JSON> The base URL of the REST service. Type: string (or Expression with resultType string). Required.
enable_server_certificate_validation	<xref:JSON> Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean).
authentication_type	str or RestServiceAuthenticationType Type of authentication used to connect to the REST service. Required. Known values are: "Anonymous", "Basic", "AadServicePrincipal", "ManagedServiceIdentity", and "OAuth2ClientCredential".
user_name	<xref:JSON> The user name used in Basic authentication type. Type: string (or Expression with resultType string).
password	SecretBase The password used in Basic authentication type.
auth_headers	<xref:JSON> The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).
service_principal_id	<xref:JSON> The application's client ID used in AadServicePrincipal authentication type. Type: string (or Expression with resultType string).
service_principal_key	SecretBase The application's key used in AadServicePrincipal authentication type.
tenant	<xref:JSON> The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides. Type: string (or Expression with resultType string).
azure_cloud_type	<xref:JSON> Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions' cloud type. Type: string (or Expression with resultType string).
aad_resource_id	<xref:JSON> The resource you are requesting authorization to use. Type: string (or Expression with resultType string).
encrypted_credential	str The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
credential	CredentialReference The credential reference containing authentication information.
client_id	<xref:JSON> The client ID associated with your application. Type: string (or Expression with resultType string).
client_secret	SecretBase The client secret associated with your application.
token_endpoint	<xref:JSON> The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string).
resource	<xref:JSON> The target service or resource to which the access will be requested. Type: string (or Expression with resultType string).
scope	<xref:JSON> The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string).
service_principal_credential_type	<xref:JSON> The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
service_principal_embedded_cert	SecretBase Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
service_principal_embedded_cert_password	SecretBase Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).

Share via

RestServiceLinkedService Class

Constructor

Keyword-Only Parameters

Variables

Additional resources