/azure-docs-sdk-dotnet

Permalink
Switch branches/tags
Nothing to show
Find file
azure-docs-sdk-dotnet/xml/Microsoft.Azure.Documents/Resource.xml
Fetching contributors…
Cannot retrieve contributors at this time
Raw Blame History
387 lines (387 sloc) 17.6 KB
<Type Name="Resource" FullName="Microsoft.Azure.Documents.Resource">
<TypeSignature Language="C#" Value="public abstract class Resource : Microsoft.Azure.Documents.JsonSerializable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit Resource extends Microsoft.Azure.Documents.JsonSerializable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.Resource" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Documents.JsonSerializable</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents an abstract resource type in the Azure DocumentDB database service.
All Azure DocumentDB resources, such as <see cref="T:Microsoft.Azure.Documents.Database" />, <see cref="T:Microsoft.Azure.Documents.DocumentCollection" />, and <see cref="T:Microsoft.Azure.Documents.Document" /> extend this abstract type.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Resource ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Resource.#ctor" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Documents.Resource" /> class for the Azure DocumentDB database service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Resource (Microsoft.Azure.Documents.Resource resource);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class Microsoft.Azure.Documents.Resource resource) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Resource.#ctor(Microsoft.Azure.Documents.Resource)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="resource" Type="Microsoft.Azure.Documents.Resource" />
</Parameters>
<Docs>
<param name="resource">To be added.</param>
<summary>
Copy constructor for a <see cref="T:Microsoft.Azure.Documents.Resource" /> used in the Azure DocumentDB database service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AltLink">
<MemberSignature Language="C#" Value="public string AltLink { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string AltLink" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Resource.AltLink" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Newtonsoft.Json.JsonIgnore</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the alt-link associated with the resource from the Azure DocumentDB database service.
</summary>
<value>The alt-link associated with the resource.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ETag">
<MemberSignature Language="C#" Value="public string ETag { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ETag" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Resource.ETag" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Newtonsoft.Json.JsonProperty(PropertyName="_etag")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the entity tag associated with the resource from the Azure DocumentDB database service.
</summary>
<value>
The entity tag associated with the resource.
</value>
<remarks>
ETags are used for concurrency checking when updating resources.
</remarks>
</Docs>
</Member>
<Member MemberName="GetPropertyValue&lt;T&gt;">
<MemberSignature Language="C#" Value="public T GetPropertyValue&lt;T&gt; (string propertyName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance !!T GetPropertyValue&lt;T&gt;(string propertyName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Resource.GetPropertyValue``1(System.String)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="propertyName" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="T">The type of the property.</typeparam>
<param name="propertyName">The name of the property.</param>
<summary>
Gets property value associated with the specified property name from the Azure DocumentDB database service.
</summary>
<returns>The property value.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public virtual string Id { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Id" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Resource.Id" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Newtonsoft.Json.JsonProperty(PropertyName="id")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the Id of the resource in the Azure DocumentDB database service.
</summary>
<value>The Id associated with the resource.</value>
<remarks>
<para>
Every resource within an Azure DocumentDB database account needs to have a unique identifier.
Unlike <see cref="P:Microsoft.Azure.Documents.Resource.ResourceId" />, which is set internally, this Id is settable by the user and is not immutable.
</para>
<para>
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 <see cref="T:Microsoft.Azure.Documents.Client.DocumentClient" /> instance to true.
This will prevent the SDK from generating new Ids.
</para>
<para>
The following characters are restricted and cannot be used in the Id property:
'/', '\\', '?', '#'
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ResourceId">
<MemberSignature Language="C#" Value="public virtual string ResourceId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ResourceId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Resource.ResourceId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Newtonsoft.Json.JsonProperty(PropertyName="_rid")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the Resource Id associated with the resource in the Azure DocumentDB database service.
</summary>
<value>
The Resource Id associated with the resource.
</value>
<remarks>
A Resource Id is the unique, immutable, identifier assigned to each DocumentDB
resource whether that is a database, a collection or a document.
These resource ids are used when building up SelfLinks, a static addressable Uri for each resource within a database account.
</remarks>
</Docs>
</Member>
<Member MemberName="SelfLink">
<MemberSignature Language="C#" Value="public string SelfLink { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SelfLink" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Resource.SelfLink" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Newtonsoft.Json.JsonProperty(PropertyName="_self")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the self-link associated with the resource from the Azure DocumentDB database service.
</summary>
<value>The self-link associated with the resource.</value>
<remarks>
A self-link is a static addressable Uri for each resource within a database account and follows the Azure DocumentDB resource model.
E.g. a self-link for a document could be dbs/db_resourceid/colls/coll_resourceid/documents/doc_resourceid
</remarks>
</Docs>
</Member>
<Member MemberName="SetPropertyValue">
<MemberSignature Language="C#" Value="public void SetPropertyValue (string propertyName, object propertyValue);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetPropertyValue(string propertyName, object propertyValue) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Resource.SetPropertyValue(System.String,System.Object)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="propertyName" Type="System.String" />
<Parameter Name="propertyValue" Type="System.Object" />
</Parameters>
<Docs>
<param name="propertyName">The name of the property.</param>
<param name="propertyValue">The property value.</param>
<summary>
Sets property value associated with the specified property name in the Azure DocumentDB database service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Timestamp">
<MemberSignature Language="C#" Value="public virtual DateTime Timestamp { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime Timestamp" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Resource.Timestamp" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Documents.UnixDateTimeConverter))</AttributeName>
</Attribute>
<Attribute>
<AttributeName>Newtonsoft.Json.JsonProperty(PropertyName="_ts")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the last modified timestamp associated with the resource from the Azure DocumentDB database service.
</summary>
<value>The last modified timestamp associated with the resource.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToByteArray">
<MemberSignature Language="C#" Value="public byte[] ToByteArray ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int8[] ToByteArray() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Resource.ToByteArray" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Serialize to a byte array via SaveTo for the Azure DocumentDB database service.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>