Share via


ServicePrincipalCredential Class

Definition

Service principal credential.

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

Constructors

ServicePrincipalCredential()

Initializes a new instance of ServicePrincipalCredential.

Properties

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 DataFactoryCredential)
Annotations

List of tags that can be used for describing the Credential.

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 DataFactoryCredential)
Description

Credential description.

(Inherited from DataFactoryCredential)
ServicePrincipalId

The app ID of the service principal used to authenticate.

ServicePrincipalKey

The key of the service principal used to authenticate.

Tenant

The ID of the tenant to which the service principal belongs.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from DataFactoryCredential)

Explicit Interface Implementations

IJsonModel<DataFactoryCredential>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from DataFactoryCredential)
IJsonModel<ServicePrincipalCredential>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<ServicePrincipalCredential>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<DataFactoryCredential>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from DataFactoryCredential)
IPersistableModel<ServicePrincipalCredential>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ServicePrincipalCredential>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ServicePrincipalCredential>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to