RestServiceLinkedService Class

Rest Service linked service.

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

Inheritance

azure.mgmt.datafactory.models._models_py3.LinkedService

RestServiceLinkedService

Constructor

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

Variables

additional_properties

dict[str, any]

Unmatched properties from the message are deserialized to this collection.

type

str

Required. Type of linked service.Constant filled by server.

connect_via

IntegrationRuntimeReference

The integration runtime reference.

description

str

Linked service description.

parameters

dict[str, ParameterSpecification]

Parameters for linked service.

annotations

list[any]

List of tags that can be used for describing the linked service.

url

any

Required. The base URL of the REST service.

enable_server_certificate_validation

any

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

Required. Type of authentication used to connect to the REST service. Known values are: "Anonymous", "Basic", "AadServicePrincipal", "ManagedServiceIdentity", "OAuth2ClientCredential".

user_name

any

The user name used in Basic authentication type.

password

SecretBase

The password used in Basic authentication type.

auth_headers

any

The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).

service_principal_id

any

The application's client ID used in AadServicePrincipal authentication type.

service_principal_key

SecretBase

The application's key used in AadServicePrincipal authentication type.

tenant

any

The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides.

azure_cloud_type

any

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

any

The resource you are requesting authorization to use.

encrypted_credential

any

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

credential

CredentialReference

The credential reference containing authentication information.

client_id

any

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

any

The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string).

resource

any

The target service or resource to which the access will be requested. Type: string (or Expression with resultType string).

scope

any

The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string).