RestServiceLinkedService Class

Definition

Rest Service linked service.

public class RestServiceLinkedService : Azure.ResourceManager.DataFactory.Models.DataFactoryLinkedServiceProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.RestServiceLinkedService>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.RestServiceLinkedService>
public class RestServiceLinkedService : Azure.ResourceManager.DataFactory.Models.DataFactoryLinkedServiceProperties
type RestServiceLinkedService = class
    inherit DataFactoryLinkedServiceProperties
    interface IJsonModel<RestServiceLinkedService>
    interface IPersistableModel<RestServiceLinkedService>
type RestServiceLinkedService = class
    inherit DataFactoryLinkedServiceProperties
Public Class RestServiceLinkedService
Inherits DataFactoryLinkedServiceProperties
Implements IJsonModel(Of RestServiceLinkedService), IPersistableModel(Of RestServiceLinkedService)
Public Class RestServiceLinkedService
Inherits DataFactoryLinkedServiceProperties
Inheritance
RestServiceLinkedService
Implements

Constructors

RestServiceLinkedService(DataFactoryElement<String>, RestServiceAuthenticationType)

Initializes a new instance of RestServiceLinkedService.

Properties

AadResourceId

The resource you are requesting authorization to use. Type: string (or Expression with resultType string).

AdditionalProperties

Additional Properties

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
(Inherited from DataFactoryLinkedServiceProperties)
Annotations

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

To assign an object to the element of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
(Inherited from DataFactoryLinkedServiceProperties)
AuthenticationType

Type of authentication used to connect to the REST service.

AuthHeaders

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

AzureCloudType

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).

ClientId

The client ID associated with your application. Type: string (or Expression with resultType string).

ClientSecret

The client secret associated with your application.

ConnectVia

The integration runtime reference.

(Inherited from DataFactoryLinkedServiceProperties)
Credential

The credential reference containing authentication information.

Description

Linked service description.

(Inherited from DataFactoryLinkedServiceProperties)
EnableServerCertificateValidation

Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean).

EncryptedCredential

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

Parameters

Parameters for linked service.

(Inherited from DataFactoryLinkedServiceProperties)
Password

The password used in Basic authentication type.

Resource

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

Scope

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

ServicePrincipalId

The application's client ID used in AadServicePrincipal authentication type. Type: string (or Expression with resultType string).

ServicePrincipalKey

The application's key used in AadServicePrincipal authentication type.

Tenant

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).

TokenEndpoint

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

Uri

The base URL of the REST service. Type: string (or Expression with resultType string).

UserName

The user name used in Basic authentication type. Type: string (or Expression with resultType string).

Explicit Interface Implementations

IJsonModel<DataFactoryLinkedServiceProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from DataFactoryLinkedServiceProperties)
IJsonModel<DataFactoryLinkedServiceProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from DataFactoryLinkedServiceProperties)
IJsonModel<RestServiceLinkedService>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<RestServiceLinkedService>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<DataFactoryLinkedServiceProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<DataFactoryLinkedServiceProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<DataFactoryLinkedServiceProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<RestServiceLinkedService>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<RestServiceLinkedService>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<RestServiceLinkedService>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to