CosmosDbMongoDbApiLinkedService.yml

### YamlMime:TSType
name: CosmosDbMongoDbApiLinkedService
uid: '@azure/arm-datafactory.CosmosDbMongoDbApiLinkedService'
package: '@azure/arm-datafactory'
summary: Linked service for CosmosDB (MongoDB API) data source.
fullName: CosmosDbMongoDbApiLinkedService
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: connectionString
    uid: '@azure/arm-datafactory.CosmosDbMongoDbApiLinkedService.connectionString'
    package: '@azure/arm-datafactory'
    summary: >-
      The CosmosDB (MongoDB API) connection string. Type: string, SecureString
      or AzureKeyVaultSecretReference. Type: string, SecureString or
      AzureKeyVaultSecretReference.
    fullName: connectionString
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'connectionString: any'
      return:
        description: ''
        type: any
  - name: database
    uid: '@azure/arm-datafactory.CosmosDbMongoDbApiLinkedService.database'
    package: '@azure/arm-datafactory'
    summary: >-
      The name of the CosmosDB (MongoDB API) database that you want to access.
      Type: string (or Expression with resultType string).
    fullName: database
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'database: any'
      return:
        description: ''
        type: any
  - name: isServerVersionAbove32
    uid: >-
      @azure/arm-datafactory.CosmosDbMongoDbApiLinkedService.isServerVersionAbove32
    package: '@azure/arm-datafactory'
    summary: >-
      Whether the CosmosDB (MongoDB API) server version is higher than 3.2. The
      default value is false. Type: boolean (or Expression with resultType
      boolean).
    fullName: isServerVersionAbove32
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'isServerVersionAbove32?: any'
      return:
        description: ''
        type: any
  - name: type
    uid: '@azure/arm-datafactory.CosmosDbMongoDbApiLinkedService.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: "CosmosDbMongoDbApi"'
      return:
        description: ''
        type: '"CosmosDbMongoDbApi"'
inheritedProperties:
  - name: annotations
    uid: '@azure/arm-datafactory.CosmosDbMongoDbApiLinkedService.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.CosmosDbMongoDbApiLinkedService.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.CosmosDbMongoDbApiLinkedService.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.CosmosDbMongoDbApiLinkedService.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)
  - name: version
    uid: '@azure/arm-datafactory.CosmosDbMongoDbApiLinkedService.version'
    package: '@azure/arm-datafactory'
    summary: Version of the linked service.
    fullName: version
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'version?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [LinkedService.version](xref:@azure/arm-datafactory.LinkedService.version)
extends: <xref uid="@azure/arm-datafactory.LinkedService" />