RestServiceLinkedService Class

Rest Service linked service.

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

Inheritance
azure.synapse.artifacts.models._models_py3.LinkedService
RestServiceLinkedService

Constructor

RestServiceLinkedService(*, url: object, authentication_type: typing.Union[str, _ForwardRef('RestServiceAuthenticationType')], additional_properties: typing.Union[typing.Dict[str, object], NoneType] = None, connect_via: typing.Union[_ForwardRef('IntegrationRuntimeReference'), NoneType] = None, description: typing.Union[str, NoneType] = None, parameters: typing.Union[typing.Dict[str, _ForwardRef('ParameterSpecification')], NoneType] = None, annotations: typing.Union[typing.List[object], NoneType] = None, enable_server_certificate_validation: object = None, user_name: object = None, password: typing.Union[_ForwardRef('SecretBase'), NoneType] = None, service_principal_id: object = None, service_principal_key: typing.Union[_ForwardRef('SecretBase'), NoneType] = None, tenant: object = None, azure_cloud_type: object = None, aad_resource_id: object = None, encrypted_credential: object = None, **kwargs)

Parameters

additional_properties
dict[str, object]
Required

Unmatched properties from the message are deserialized to this collection.

type
str
Required

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

connect_via
IntegrationRuntimeReference
Required

The integration runtime reference.

description
str
Required

Linked service description.

parameters
dict[str, ParameterSpecification]
Required

Parameters for linked service.

annotations
list[object]
Required

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

url
object
Required

Required. The base URL of the REST service.

enable_server_certificate_validation
object
Required

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

Required. Type of authentication used to connect to the REST service. Possible values include: "Anonymous", "Basic", "AadServicePrincipal", "ManagedServiceIdentity".

user_name
object
Required

The user name used in Basic authentication type.

password
SecretBase
Required

The password used in Basic authentication type.

service_principal_id
object
Required

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

service_principal_key
SecretBase
Required

The application's key used in AadServicePrincipal authentication type.

tenant
object
Required

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

azure_cloud_type
object
Required

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
object
Required

The resource you are requesting authorization to use.

encrypted_credential
object
Required

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