CosmosDBServiceProperties Class

Definition

Services response resource. Please note CosmosDBServiceProperties is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include DataTransferServiceProperties, GraphApiComputeServiceProperties, MaterializedViewsBuilderServiceProperties and SqlDedicatedGatewayServiceProperties.

public class CosmosDBServiceProperties : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CosmosDB.Models.CosmosDBServiceProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CosmosDB.Models.CosmosDBServiceProperties>
type CosmosDBServiceProperties = class
    interface IJsonModel<CosmosDBServiceProperties>
    interface IPersistableModel<CosmosDBServiceProperties>
Public Class CosmosDBServiceProperties
Implements IJsonModel(Of CosmosDBServiceProperties), IPersistableModel(Of CosmosDBServiceProperties)
Inheritance
CosmosDBServiceProperties
Derived
Implements

Constructors

CosmosDBServiceProperties()

Initializes a new instance of CosmosDBServiceProperties.

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" }.
CreatedOn

Time of the last state change (ISO-8601 format).

InstanceCount

Instance count for the service.

InstanceSize

Instance type for the service.

Status

Describes the status of a service.

Explicit Interface Implementations

IJsonModel<CosmosDBServiceProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<CosmosDBServiceProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CosmosDBServiceProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CosmosDBServiceProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<CosmosDBServiceProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to