CosmosDBLinkedService Class

Definition

Namespace:

Azure.ResourceManager.DataFactory.Models

Assembly:

Azure.ResourceManager.DataFactory.dll

Package:

Azure.ResourceManager.DataFactory v1.6.0

Source:

CosmosDBLinkedService.cs

Microsoft Azure Cosmos Database (CosmosDB) linked service.

public class CosmosDBLinkedService : Azure.ResourceManager.DataFactory.Models.DataFactoryLinkedServiceProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.CosmosDBLinkedService>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.CosmosDBLinkedService>

type CosmosDBLinkedService = class
    inherit DataFactoryLinkedServiceProperties
    interface IJsonModel<CosmosDBLinkedService>
    interface IPersistableModel<CosmosDBLinkedService>

Public Class CosmosDBLinkedService
Inherits DataFactoryLinkedServiceProperties
Implements IJsonModel(Of CosmosDBLinkedService), IPersistableModel(Of CosmosDBLinkedService)

Inheritance

Object

DataFactoryLinkedServiceProperties

CosmosDBLinkedService

Implements

IJsonModel<CosmosDBLinkedService> IPersistableModel<CosmosDBLinkedService> IPersistableModel<T>

Constructors

CosmosDBLinkedService()

Initializes a new instance of CosmosDBLinkedService.

Properties

AccountEndpoint	The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string).
AccountKey	The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference.
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)
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).
ConnectionMode	The connection mode used to access CosmosDB account. Type: string.
ConnectionString	The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.
ConnectVia	The integration runtime reference. (Inherited from DataFactoryLinkedServiceProperties)
Credential	The credential reference containing authentication information.
Database	The name of the database. Type: string (or Expression with resultType string).
Description	Linked service description. (Inherited from DataFactoryLinkedServiceProperties)
EncryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
LinkedServiceVersion	Version of the linked service. (Inherited from DataFactoryLinkedServiceProperties)
Parameters	Parameters for linked service. (Inherited from DataFactoryLinkedServiceProperties)
ServicePrincipalCredential	The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference.
ServicePrincipalCredentialType	The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string.
ServicePrincipalId	The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string).
Tenant	The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<CosmosDBLinkedService>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<CosmosDBLinkedService>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
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)
IPersistableModel<CosmosDBLinkedService>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<CosmosDBLinkedService>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<CosmosDBLinkedService>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.
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)