RestServiceLinkedService.yml

### YamlMime:TSType
name: RestServiceLinkedService
uid: '@azure/arm-datafactory.RestServiceLinkedService'
package: '@azure/arm-datafactory'
summary: Rest Service linked service.
fullName: RestServiceLinkedService
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: aadResourceId
    uid: '@azure/arm-datafactory.RestServiceLinkedService.aadResourceId'
    package: '@azure/arm-datafactory'
    summary: >-
      The resource you are requesting authorization to use. Type: string (or
      Expression with resultType string).
    fullName: aadResourceId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'aadResourceId?: any'
      return:
        description: ''
        type: any
  - name: authenticationType
    uid: '@azure/arm-datafactory.RestServiceLinkedService.authenticationType'
    package: '@azure/arm-datafactory'
    summary: Type of authentication used to connect to the REST service.
    fullName: authenticationType
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'authenticationType: string'
      return:
        description: ''
        type: string
  - name: authHeaders
    uid: '@azure/arm-datafactory.RestServiceLinkedService.authHeaders'
    package: '@azure/arm-datafactory'
    summary: >-
      The additional HTTP headers in the request to RESTful API used for
      authorization. Type: object (or Expression with resultType object).
    fullName: authHeaders
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'authHeaders?: any'
      return:
        description: ''
        type: any
  - name: azureCloudType
    uid: '@azure/arm-datafactory.RestServiceLinkedService.azureCloudType'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: azureCloudType
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'azureCloudType?: any'
      return:
        description: ''
        type: any
  - name: clientId
    uid: '@azure/arm-datafactory.RestServiceLinkedService.clientId'
    package: '@azure/arm-datafactory'
    summary: >-
      The client ID associated with your application. Type: string (or
      Expression with resultType string).
    fullName: clientId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'clientId?: any'
      return:
        description: ''
        type: any
  - name: clientSecret
    uid: '@azure/arm-datafactory.RestServiceLinkedService.clientSecret'
    package: '@azure/arm-datafactory'
    summary: The client secret associated with your application.
    fullName: clientSecret
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'clientSecret?: SecretBaseUnion'
      return:
        description: ''
        type: <xref uid="@azure/arm-datafactory.SecretBaseUnion" />
  - name: credential
    uid: '@azure/arm-datafactory.RestServiceLinkedService.credential'
    package: '@azure/arm-datafactory'
    summary: The credential reference containing authentication information.
    fullName: credential
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'credential?: CredentialReference'
      return:
        description: ''
        type: <xref uid="@azure/arm-datafactory.CredentialReference" />
  - name: enableServerCertificateValidation
    uid: >-
      @azure/arm-datafactory.RestServiceLinkedService.enableServerCertificateValidation
    package: '@azure/arm-datafactory'
    summary: >-
      Whether to validate server side SSL certificate when connecting to the
      endpoint.The default value is true. Type: boolean (or Expression with
      resultType boolean).
    fullName: enableServerCertificateValidation
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'enableServerCertificateValidation?: any'
      return:
        description: ''
        type: any
  - name: encryptedCredential
    uid: '@azure/arm-datafactory.RestServiceLinkedService.encryptedCredential'
    package: '@azure/arm-datafactory'
    summary: >-
      The encrypted credential used for authentication. Credentials are
      encrypted using the integration runtime credential manager. Type: string.
    fullName: encryptedCredential
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'encryptedCredential?: string'
      return:
        description: ''
        type: string
  - name: password
    uid: '@azure/arm-datafactory.RestServiceLinkedService.password'
    package: '@azure/arm-datafactory'
    summary: The password used in Basic authentication type.
    fullName: password
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'password?: SecretBaseUnion'
      return:
        description: ''
        type: <xref uid="@azure/arm-datafactory.SecretBaseUnion" />
  - name: resource
    uid: '@azure/arm-datafactory.RestServiceLinkedService.resource'
    package: '@azure/arm-datafactory'
    summary: >-
      The target service or resource to which the access will be requested.
      Type: string (or Expression with resultType string).
    fullName: resource
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'resource?: any'
      return:
        description: ''
        type: any
  - name: scope
    uid: '@azure/arm-datafactory.RestServiceLinkedService.scope'
    package: '@azure/arm-datafactory'
    summary: >-
      The scope of the access required. It describes what kind of access will be
      requested. Type: string (or Expression with resultType string).
    fullName: scope
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'scope?: any'
      return:
        description: ''
        type: any
  - name: servicePrincipalId
    uid: '@azure/arm-datafactory.RestServiceLinkedService.servicePrincipalId'
    package: '@azure/arm-datafactory'
    summary: >-
      The application's client ID used in AadServicePrincipal authentication
      type. Type: string (or Expression with resultType string).
    fullName: servicePrincipalId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'servicePrincipalId?: any'
      return:
        description: ''
        type: any
  - name: servicePrincipalKey
    uid: '@azure/arm-datafactory.RestServiceLinkedService.servicePrincipalKey'
    package: '@azure/arm-datafactory'
    summary: The application's key used in AadServicePrincipal authentication type.
    fullName: servicePrincipalKey
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'servicePrincipalKey?: SecretBaseUnion'
      return:
        description: ''
        type: <xref uid="@azure/arm-datafactory.SecretBaseUnion" />
  - name: tenant
    uid: '@azure/arm-datafactory.RestServiceLinkedService.tenant'
    package: '@azure/arm-datafactory'
    summary: >-
      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).
    fullName: tenant
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'tenant?: any'
      return:
        description: ''
        type: any
  - name: tokenEndpoint
    uid: '@azure/arm-datafactory.RestServiceLinkedService.tokenEndpoint'
    package: '@azure/arm-datafactory'
    summary: >-
      The token endpoint of the authorization server to acquire access token.
      Type: string (or Expression with resultType string).
    fullName: tokenEndpoint
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'tokenEndpoint?: any'
      return:
        description: ''
        type: any
  - name: type
    uid: '@azure/arm-datafactory.RestServiceLinkedService.type'
    package: '@azure/arm-datafactory'
    summary: >-
      Polymorphic discriminator, which specifies the different types this object
      can be
    fullName: type
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'type: "RestService"'
      return:
        description: ''
        type: '"RestService"'
  - name: url
    uid: '@azure/arm-datafactory.RestServiceLinkedService.url'
    package: '@azure/arm-datafactory'
    summary: >-
      The base URL of the REST service. Type: string (or Expression with
      resultType string).
    fullName: url
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'url: any'
      return:
        description: ''
        type: any
  - name: userName
    uid: '@azure/arm-datafactory.RestServiceLinkedService.userName'
    package: '@azure/arm-datafactory'
    summary: >-
      The user name used in Basic authentication type. Type: string (or
      Expression with resultType string).
    fullName: userName
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'userName?: any'
      return:
        description: ''
        type: any
inheritedProperties:
  - name: annotations
    uid: '@azure/arm-datafactory.RestServiceLinkedService.annotations'
    package: '@azure/arm-datafactory'
    summary: List of tags that can be used for describing the linked service.
    fullName: annotations
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'annotations?: any[]'
      return:
        description: ''
        type: any[]
    inheritanceDescription: >-
      <b>Inherited From</b>
      [LinkedService.annotations](xref:@azure/arm-datafactory.LinkedService.annotations)
  - name: connectVia
    uid: '@azure/arm-datafactory.RestServiceLinkedService.connectVia'
    package: '@azure/arm-datafactory'
    summary: The integration runtime reference.
    fullName: connectVia
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'connectVia?: IntegrationRuntimeReference'
      return:
        description: ''
        type: <xref uid="@azure/arm-datafactory.IntegrationRuntimeReference" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [LinkedService.connectVia](xref:@azure/arm-datafactory.LinkedService.connectVia)
  - name: description
    uid: '@azure/arm-datafactory.RestServiceLinkedService.description'
    package: '@azure/arm-datafactory'
    summary: Linked service description.
    fullName: description
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'description?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [LinkedService.description](xref:@azure/arm-datafactory.LinkedService.description)
  - name: parameters
    uid: '@azure/arm-datafactory.RestServiceLinkedService.parameters'
    package: '@azure/arm-datafactory'
    summary: Parameters for linked service.
    fullName: parameters
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'parameters?: {[propertyName: string]: ParameterSpecification}'
      return:
        description: ''
        type: >-
          {[propertyName: string]: <xref
          uid="@azure/arm-datafactory.ParameterSpecification" />}
    inheritanceDescription: >-
      <b>Inherited From</b>
      [LinkedService.parameters](xref:@azure/arm-datafactory.LinkedService.parameters)
extends: <xref uid="@azure/arm-datafactory.LinkedService" />