Resource.Id Property

  • Reference

Definition

Namespace:
Microsoft.Azure.Documents
Assemblies:
Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll
Packages:
Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Gets or sets the Id of the resource in the Azure Cosmos DB service.

[Newtonsoft.Json.JsonProperty(PropertyName="id")]
public virtual string Id { get; set; }
[<Newtonsoft.Json.JsonProperty(PropertyName="id")>]
member this.Id : string with get, set
Public Overridable Property Id As String

Property Value

String

The Id associated with the resource.

Attributes
Newtonsoft.Json.JsonPropertyAttribute

Remarks

Every resource within an Azure Cosmos DB database account needs to have a unique identifier. Unlike ResourceId, which is set internally, this Id is settable by the user and is not immutable.

When working with document resources, they too have this settable Id property. If an Id is not supplied by the user the SDK will automatically generate a new GUID and assign its value to this property before persisting the document in the database. You can override this auto Id generation by setting the disableAutomaticIdGeneration parameter on the DocumentClient instance to true. This will prevent the SDK from generating new Ids.

The following characters are restricted and cannot be used in the Id property: '/', '\\', '?', '#'

Applies to