DocumentResponse<TDocument> Klasse

Definition

Namespace:

Microsoft.Azure.Documents.Client

Assemblys:

Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Pakete:

Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Stellt die Vorlagenklasse dar, die von Methoden verwendet wird, die einzelne Objekte im Azure Cosmos DB-Dienst zurückgeben.

public sealed class DocumentResponse<TDocument> : Microsoft.Azure.Documents.Client.ResourceResponseBase, Microsoft.Azure.Documents.Client.IDocumentResponse<TDocument>

type DocumentResponse<'Document> = class
    inherit ResourceResponseBase
    interface IDocumentResponse<'Document>
    interface IResourceResponseBase

Public NotInheritable Class DocumentResponse(Of TDocument)
Inherits ResourceResponseBase
Implements IDocumentResponse(Of TDocument)

Typparameter

TDocument

den Dokumenttyp.

Vererbung

Object

ResourceResponseBase

DocumentResponse<TDocument>

Implementiert

IDocumentResponse<TDocument> IResourceResponseBase

Beispiele

Im folgenden Beispiel werden die CustomerName-Eigenschaft, die verwendeten Anforderungseinheiten, die Aktivitäts-ID und der StatusCode aus einem ReadDocumentAsync{Customer}-Aufruf extrahiert.

DocumentResponse<Customer> response = await client.ReadDocumentAsync<Customer>(documentLink);
Console.WriteLine(response.Document.CustomerName);
Console.WriteLine(response.RequestCharge);
Console.WriteLine(response.ActivityId); 
Console.WriteLine(response.StatusCode); // HttpStatusCode.Created or 201

Hinweise

Die Antwort vom typspezifischen Lesen der Dokumentresponse-Ressource(ReadDocumentAsync{TDocument}) gibt die Antwort zurück, die in ein DocumentResponse-Objekt eingeschlossen ist. Dies enthält die Metadaten aus den Antwortheadern des Azure Cosmos DB-Aufrufs, einschließlich der Anforderungseinheiten (RequestCharge), der Aktivitäts-ID, der Kontingente/Nutzung von Ressourcen und des typisierten Dokumentobjekts (TDocument).

Konstruktoren

DocumentResponse<TDocument>()	Konstruktor, der für Mockingzwecke für den Azure Cosmos DB-Dienst verfügbar gemacht wird.
DocumentResponse<TDocument>(TDocument)	Konstruktor, der für Mockingzwecke für den Azure Cosmos DB-Dienst verfügbar gemacht wird.

Eigenschaften

ActivityId	Ruft die Aktivitäts-ID für die Anforderung vom Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
CollectionQuota	Ruft das maximale Kontingent für Sammlungsressourcen in einem Konto aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
CollectionSizeQuota	Ruft die maximale Größe einer Sammlung in KB aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
CollectionSizeUsage	Ruft die aktuelle Größe einer Sammlung in KB aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
CollectionUsage	Ruft die aktuelle Anzahl von Sammlungsressourcen innerhalb des Kontos aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
ContentLocation	Der übergeordnete Speicherort des Inhalts, z. B. dbs/foo/colls/bar im Azure Cosmos DB-Dienst. (Geerbt von ResourceResponseBase)
CurrentResourceQuotaUsage	Ruft die aktuelle Größe dieser Entität aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
DatabaseQuota	Ruft das maximale Kontingent für Datenbankressourcen innerhalb des Kontos aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
DatabaseUsage	Ruft die aktuelle Anzahl von Datenbankressourcen innerhalb des Kontos aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
Document	Ruft das in der Antwort vom Azure Cosmos DB-Dienst zurückgegebene Dokument ab.
DocumentQuota	Ruft die maximale Größe eines Dokuments innerhalb einer Sammlung in KB aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
DocumentUsage	Ruft die aktuelle Größe von Dokumenten in einer Sammlung in KB vom Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
IndexTransformationProgress	Ruft den Fortschritt einer Indextransformation ab, wenn eine vom Azure Cosmos DB-Dienst ausgeführt wird. (Geerbt von ResourceResponseBase)
IsRUPerMinuteUsed	Ruft das Flag ab, das der Antwort vom Azure Cosmos DB-Dienst zugeordnet ist, unabhängig davon, ob diese Anforderung von Anforderungseinheiten(RUs)/Minutenkapazität bereitgestellt wird oder nicht. (Geerbt von ResourceResponseBase)
LazyIndexingProgress	Ruft den Fortschritt der verzögerten Indizierung aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
MaxResourceQuota	Ruft die maximale Größenbegrenzung für diese Entität aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
PermissionQuota	Ruft das maximale Kontingent für Berechtigungsressourcen in einem Konto aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
PermissionUsage	Ruft die aktuelle Anzahl von Berechtigungsressourcen innerhalb des Kontos aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
RequestCharge	Ruft die Anforderungsgebühr für diese Anforderung vom Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
RequestDiagnosticsString	Ruft die Diagnose Informationen für die aktuelle Anforderung an den Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
RequestLatency	Ruft die End-to-End-Anforderungslatenz für die aktuelle Anforderung an den Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
ResponseHeaders	Ruft die Antwortheader vom Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
ResponseStream	Ruft den zugrunde liegenden Stream der Antwort vom Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
SessionToken	Ruft das Sitzungstoken für die Verwendung in sesssion-Konsistenzlesungen aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
StatusCode	Ruft den HTTP-status Code ab, der der Antwort vom Azure Cosmos DB-Dienst zugeordnet ist. (Geerbt von ResourceResponseBase)
StoredProceduresQuota	Ruft das maximale Kontingent gespeicherter Prozeduren für eine Sammlung aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
StoredProceduresUsage	Ruft die aktuelle Anzahl gespeicherter Prozeduren für eine Sammlung aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
TriggersQuota	Ruft das maximale Kontingent von Triggern für eine Sammlung aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
TriggersUsage	Ruft die aktuelle Anzahl von Triggern für eine Sammlung aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
UserDefinedFunctionsQuota	Ruft das maximale Kontingent benutzerdefinierter Funktionen für eine Sammlung aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
UserDefinedFunctionsUsage	Ruft die aktuelle Anzahl benutzerdefinierter Funktionen für eine Sammlung aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
UserQuota	Ruft das maximale Kontingent für Benutzerressourcen in einem Konto aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)
UserUsage	Ruft die aktuelle Anzahl von Benutzerressourcen innerhalb des Kontos aus dem Azure Cosmos DB-Dienst ab. (Geerbt von ResourceResponseBase)

Operatoren

Implicit(DocumentResponse<TDocument> to TDocument)

Gibt das Dokument in der Antwort implizit vom Azure Cosmos DB-Dienst zurück.