CosmosClient Clase

Definición

Espacio de nombres:

Microsoft.Azure.Cosmos

Ensamblado:

Microsoft.Azure.Cosmos.Client.dll

Paquete:

Microsoft.Azure.Cosmos v3.39.0

Source:

CosmosClient.cs

Proporciona una representación lógica del lado cliente de la cuenta de Azure Cosmos DB. Este cliente se puede usar para configurar y ejecutar solicitudes en el servicio de base de datos de Azure Cosmos DB.

CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento eficaces de la conexión. Consulte la guía de rendimiento.

public class CosmosClient : IDisposable

type CosmosClient = class
    interface IDisposable

Public Class CosmosClient
Implements IDisposable

Herencia

Object

CosmosClient

Implementaciones

IDisposable

Ejemplos

En este ejemplo se crea un CosmosClientobjeto , Databasey .Container CosmosClient se crea con el cadena de conexión y se configura para usar la región "Este de EE. UU. 2".

using Microsoft.Azure.Cosmos;

CosmosClient cosmosClient = new CosmosClient(
            "connection-string-from-portal", 
            new CosmosClientOptions()
            {
                ApplicationRegion = Regions.EastUS2,
            });

Database db = await cosmosClient.CreateDatabaseAsync("database-id");
Container container = await db.CreateContainerAsync("container-id");

// Dispose cosmosClient at application exit

En este ejemplo se crea un CosmosClientobjeto , Databasey .Container CosmosClient se crea con AccountEndpoint, AccountKey o ResourceToken y está configurado para usar la región "Este de EE. UU. 2".

using Microsoft.Azure.Cosmos;

CosmosClient cosmosClient = new CosmosClient(
            "account-endpoint-from-portal", 
            "account-key-from-portal", 
            new CosmosClientOptions()
            {
                ApplicationRegion = Regions.EastUS2,
            });

Database db = await cosmosClient.CreateDatabaseAsync("database-id");
Container container = await db.CreateContainerAsync("container-id");

// Dispose cosmosClient at application exit

En este ejemplo se crea un CosmosClientobjeto , Databasey .Container CosmosClient se crea mediante el patrón de generador mediante CosmosClientBuilder.

using Microsoft.Azure.Cosmos;
using Microsoft.Azure.Cosmos.Fluent;

CosmosClient cosmosClient = new CosmosClientBuilder("connection-string-from-portal")
    .WithApplicationRegion("East US 2")
    .Build();

Database db = await cosmosClient.CreateDatabaseAsync("database-id")
Container container = await db.CreateContainerAsync("container-id");

// Dispose cosmosClient at application exit

Comentarios

La referencia no inicializada devuelta no garantiza credenciales ni validaciones de conectividad porque la creación no realiza ninguna llamada de red.

Constructores

CosmosClient()	Creación de una instancia de CosmosClient usada para pruebas ficticias
CosmosClient(String, AzureKeyCredential, CosmosClientOptions)	Crea un nuevo CosmosClient con la cadena de URI del punto de conexión de la cuenta y AzureKeyCredential. AzureKeyCredential permite cambiar o actualizar master-key/ResourceToken mientras CosmosClient sigue en uso. CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento eficaces de la conexión. Consulte la guía de rendimiento.
CosmosClient(String, CosmosClientOptions)	Crea un cosmosClient con el cadena de conexión. CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento eficaces de la conexión. Consulte la guía de rendimiento.
CosmosClient(String, String, CosmosClientOptions)	Crea un nuevo CosmosClient con la cadena de URI del punto de conexión de cuenta y la clave de cuenta. CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento eficaces de la conexión. Consulte la guía de rendimiento.
CosmosClient(String, TokenCredential, CosmosClientOptions)	Crea un cosmosClient con la cadena de URI del punto de conexión de la cuenta y TokenCredential. CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento eficaces de la conexión. Consulte la guía de rendimiento.

Propiedades

ClientOptions	objeto CosmosClientOptions usado para inicializar CosmosClient.
Endpoint	Obtiene el URI del punto de conexión para el servicio Azure Cosmos DB.
ResponseFactory	Generador de respuestas que se usa para crear tipos de respuesta de CosmosClient.

Métodos

CreateAndInitializeAsync(String, AzureKeyCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Crea un nuevo CosmosClient con la cadena de URI del punto de conexión de la cuenta y AzureKeyCredential. AzureKeyCredential permite cambiar o actualizar master-key/ResourceToken mientras CosmosClient sigue en uso. Además de que inicializa el cliente con contenedores proporcionados, es decir, el SDK prepara las memorias caché y las conexiones antes de realizar la primera llamada al servicio. Úselo para obtener una latencia menor durante el inicio de la aplicación. CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento eficaces de la conexión. Consulte la guía de rendimiento.
CreateAndInitializeAsync(String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Crea un cosmosClient con la cadena de URI del punto de conexión de la cuenta y TokenCredential. Además de que inicializa el cliente con contenedores proporcionados, es decir, el SDK prepara las memorias caché y las conexiones antes de realizar la primera llamada al servicio. Úselo para obtener una latencia menor durante el inicio de la aplicación. CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento eficaces de la conexión. Consulte la guía de rendimiento.
CreateAndInitializeAsync(String, String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Crea un cosmosClient con la cadena de URI del punto de conexión de la cuenta y TokenCredential. Además de que inicializa el cliente con contenedores proporcionados, es decir, el SDK prepara las memorias caché y las conexiones antes de realizar la primera llamada al servicio. Úselo para obtener una latencia menor durante el inicio de la aplicación. CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento eficaces de la conexión. Consulte la guía de rendimiento.
CreateAndInitializeAsync(String, TokenCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Crea un cosmosClient con la cadena de URI del punto de conexión de la cuenta y TokenCredential. Además de que inicializa el cliente con contenedores proporcionados, es decir, el SDK prepara las memorias caché y las conexiones antes de realizar la primera llamada al servicio. Úselo para obtener una latencia menor durante el inicio de la aplicación. CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento eficaces de la conexión. Consulte la guía de rendimiento.
CreateDatabaseAsync(String, Nullable<Int32>, RequestOptions, CancellationToken)	Envía una solicitud para crear una base de datos. Una base de datos administra usuarios, permisos y un conjunto de contenedores. Cada cuenta de base de datos de Azure Cosmos DB es capaz de admitir varias bases de datos con nombre independientes, y la base de datos es el contenedor lógico de los datos. Cada base de datos consta de uno o varios contenedores, cada uno de los cuales, a su vez, contiene uno o varios documentos. Dado que las bases de datos son un recurso administrativo, la clave maestra de servicio será necesaria para acceder y completar correctamente cualquier acción mediante las API de usuario.
CreateDatabaseAsync(String, ThroughputProperties, RequestOptions, CancellationToken)	Envía una solicitud para crear una base de datos. Una base de datos administra usuarios, permisos y un conjunto de contenedores. Cada cuenta de base de datos de Azure Cosmos DB es capaz de admitir varias bases de datos con nombre independientes, y la base de datos es el contenedor lógico de los datos. Cada base de datos consta de uno o varios contenedores, cada uno de los cuales, a su vez, contiene uno o varios documentos. Dado que las bases de datos son un recurso administrativo, la clave maestra de servicio será necesaria para acceder y completar correctamente cualquier acción mediante las API de usuario.
CreateDatabaseIfNotExistsAsync(String, Nullable<Int32>, RequestOptions, CancellationToken)	Compruebe si existe una base de datos y, si no es así, créela. Solo se usa el identificador de la base de datos para comprobar si hay una base de datos existente. Otras propiedades de base de datos, como el rendimiento, no se validan y pueden ser diferentes a continuación, las propiedades pasadas. Una base de datos administra usuarios, permisos y un conjunto de contenedores. Cada cuenta de base de datos de Azure Cosmos DB es capaz de admitir varias bases de datos con nombre independientes, y la base de datos es el contenedor lógico de los datos. Cada base de datos consta de uno o varios contenedores, cada uno de los cuales, a su vez, contiene uno o varios documentos. Dado que las bases de datos son un recurso administrativo, la clave maestra de servicio será necesaria para acceder y completar correctamente cualquier acción mediante las API de usuario.
CreateDatabaseIfNotExistsAsync(String, ThroughputProperties, RequestOptions, CancellationToken)	Compruebe si existe una base de datos y, si no es así, créela. Solo se usa el identificador de la base de datos para comprobar si hay una base de datos existente. Otras propiedades de base de datos, como el rendimiento, no se validan y pueden ser diferentes a continuación, las propiedades pasadas. Una base de datos administra usuarios, permisos y un conjunto de contenedores. Cada cuenta de base de datos de Azure Cosmos DB es capaz de admitir varias bases de datos con nombre independientes, y la base de datos es el contenedor lógico de los datos. Cada base de datos consta de uno o varios contenedores, cada uno de los cuales, a su vez, contiene uno o varios documentos. Dado que las bases de datos son un recurso administrativo, la clave maestra de servicio será necesaria para acceder y completar correctamente cualquier acción mediante las API de usuario.
CreateDatabaseStreamAsync(DatabaseProperties, Nullable<Int32>, RequestOptions, CancellationToken)	Envíe una solicitud para crear una base de datos. Una base de datos administra usuarios, permisos y un conjunto de contenedores. Cada cuenta de base de datos de Azure Cosmos DB es capaz de admitir varias bases de datos con nombre independientes, y la base de datos es el contenedor lógico de los datos. Cada base de datos consta de uno o varios contenedores, cada uno de los cuales, a su vez, contiene uno o varios documentos. Dado que las bases de datos son un recurso administrativo, la clave maestra de servicio será necesaria para acceder y completar correctamente cualquier acción mediante las API de usuario.
Dispose()	Eliminación del cliente de Cosmos
Dispose(Boolean)	Eliminación del cliente de Cosmos
GetContainer(String, String)	Devuelve una referencia de proxy a un contenedor.
GetDatabase(String)	Devuelve una referencia de proxy a una base de datos.
GetDatabaseQueryIterator<T>(QueryDefinition, String, QueryRequestOptions)	Este método crea una consulta para las bases de datos en una cuenta de Cosmos DB mediante una instrucción SQL con valores parametrizados. Devuelve un feedIterator. Para obtener más información sobre cómo preparar instrucciones SQL con valores con parámetros, consulte QueryDefinition.
GetDatabaseQueryIterator<T>(String, String, QueryRequestOptions)	Este método crea una consulta para las bases de datos en una cuenta de Cosmos DB mediante una instrucción SQL. Devuelve un feedIterator.
GetDatabaseQueryStreamIterator(QueryDefinition, String, QueryRequestOptions)	Este método crea una consulta para las bases de datos en una cuenta de Cosmos DB mediante una instrucción SQL con valores parametrizados. Devuelve un feedIterator. Para obtener más información sobre cómo preparar instrucciones SQL con valores con parámetros, consulte QueryDefinition.
GetDatabaseQueryStreamIterator(String, String, QueryRequestOptions)	Este método crea una consulta para las bases de datos en una cuenta de Cosmos DB mediante una instrucción SQL. Devuelve un feedIterator.
ReadAccountAsync()	Lee para AccountProperties la cuenta de Azure Cosmos DB.

Consulte también

• CosmosClientBuilder
• CosmosClientOptions