com.azure.resourcemanager.cosmos.fluent

Interface DatabasesClient

public interface DatabasesClient

An instance of this class provides access to all the operations defined in DatabasesClient.

Method Summary

Modifier and Type	Method and Description
com.azure.core.http.rest.PagedIterable<MetricDefinitionInner>	listMetricDefinitions(String resourceGroupName, String accountName, String databaseRid) Retrieves metric definitions for the given database.
com.azure.core.http.rest.PagedIterable<MetricDefinitionInner>	listMetricDefinitions(String resourceGroupName, String accountName, String databaseRid, com.azure.core.util.Context context) Retrieves metric definitions for the given database.
com.azure.core.http.rest.PagedFlux<MetricDefinitionInner>	listMetricDefinitionsAsync(String resourceGroupName, String accountName, String databaseRid) Retrieves metric definitions for the given database.
com.azure.core.http.rest.PagedIterable<MetricInner>	listMetrics(String resourceGroupName, String accountName, String databaseRid, String filter) Retrieves the metrics determined by the given filter for the given database account and database.
com.azure.core.http.rest.PagedIterable<MetricInner>	listMetrics(String resourceGroupName, String accountName, String databaseRid, String filter, com.azure.core.util.Context context) Retrieves the metrics determined by the given filter for the given database account and database.
com.azure.core.http.rest.PagedFlux<MetricInner>	listMetricsAsync(String resourceGroupName, String accountName, String databaseRid, String filter) Retrieves the metrics determined by the given filter for the given database account and database.
com.azure.core.http.rest.PagedIterable<UsageInner>	listUsages(String resourceGroupName, String accountName, String databaseRid) Retrieves the usages (most recent data) for the given database.
com.azure.core.http.rest.PagedIterable<UsageInner>	listUsages(String resourceGroupName, String accountName, String databaseRid, String filter, com.azure.core.util.Context context) Retrieves the usages (most recent data) for the given database.
com.azure.core.http.rest.PagedFlux<UsageInner>	listUsagesAsync(String resourceGroupName, String accountName, String databaseRid) Retrieves the usages (most recent data) for the given database.
com.azure.core.http.rest.PagedFlux<UsageInner>	listUsagesAsync(String resourceGroupName, String accountName, String databaseRid, String filter) Retrieves the usages (most recent data) for the given database.

Method Detail

listMetricsAsync

com.azure.core.http.rest.PagedFlux<MetricInner> listMetricsAsync(String resourceGroupName,
                                                                 String accountName,
                                                                 String databaseRid,
                                                                 String filter)

Retrieves the metrics determined by the given filter for the given database account and database.

Parameters:

resourceGroupName - Name of an Azure resource group.

accountName - Cosmos DB database account name.

databaseRid - Cosmos DB database rid.

filter - An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

Returns:

the response to a list metrics request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listMetrics

com.azure.core.http.rest.PagedIterable<MetricInner> listMetrics(String resourceGroupName,
                                                                String accountName,
                                                                String databaseRid,
                                                                String filter)

Retrieves the metrics determined by the given filter for the given database account and database.

Parameters:

resourceGroupName - Name of an Azure resource group.

accountName - Cosmos DB database account name.

databaseRid - Cosmos DB database rid.

filter - An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

Returns:

the response to a list metrics request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listMetrics

com.azure.core.http.rest.PagedIterable<MetricInner> listMetrics(String resourceGroupName,
                                                                String accountName,
                                                                String databaseRid,
                                                                String filter,
                                                                com.azure.core.util.Context context)

Retrieves the metrics determined by the given filter for the given database account and database.

Parameters:

resourceGroupName - Name of an Azure resource group.

accountName - Cosmos DB database account name.

databaseRid - Cosmos DB database rid.

filter - An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

context - The context to associate with this operation.

Returns:

the response to a list metrics request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listUsagesAsync

com.azure.core.http.rest.PagedFlux<UsageInner> listUsagesAsync(String resourceGroupName,
                                                               String accountName,
                                                               String databaseRid,
                                                               String filter)

Retrieves the usages (most recent data) for the given database.

Parameters:

resourceGroupName - Name of an Azure resource group.

accountName - Cosmos DB database account name.

databaseRid - Cosmos DB database rid.

filter - An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).

Returns:

the response to a list usage request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listUsagesAsync

com.azure.core.http.rest.PagedFlux<UsageInner> listUsagesAsync(String resourceGroupName,
                                                               String accountName,
                                                               String databaseRid)

Retrieves the usages (most recent data) for the given database.

Parameters:

resourceGroupName - Name of an Azure resource group.

accountName - Cosmos DB database account name.

databaseRid - Cosmos DB database rid.

Returns:

the response to a list usage request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listUsages

com.azure.core.http.rest.PagedIterable<UsageInner> listUsages(String resourceGroupName,
                                                              String accountName,
                                                              String databaseRid,
                                                              String filter,
                                                              com.azure.core.util.Context context)

Retrieves the usages (most recent data) for the given database.

Parameters:

resourceGroupName - Name of an Azure resource group.

accountName - Cosmos DB database account name.

databaseRid - Cosmos DB database rid.

filter - An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).

context - The context to associate with this operation.

Returns:

the response to a list usage request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listUsages

com.azure.core.http.rest.PagedIterable<UsageInner> listUsages(String resourceGroupName,
                                                              String accountName,
                                                              String databaseRid)

Retrieves the usages (most recent data) for the given database.

Parameters:

resourceGroupName - Name of an Azure resource group.

accountName - Cosmos DB database account name.

databaseRid - Cosmos DB database rid.

Returns:

the response to a list usage request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listMetricDefinitionsAsync

com.azure.core.http.rest.PagedFlux<MetricDefinitionInner> listMetricDefinitionsAsync(String resourceGroupName,
                                                                                     String accountName,
                                                                                     String databaseRid)

Retrieves metric definitions for the given database.

Parameters:

resourceGroupName - Name of an Azure resource group.

accountName - Cosmos DB database account name.

databaseRid - Cosmos DB database rid.

Returns:

the response to a list metric definitions request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listMetricDefinitions

com.azure.core.http.rest.PagedIterable<MetricDefinitionInner> listMetricDefinitions(String resourceGroupName,
                                                                                    String accountName,
                                                                                    String databaseRid)

Retrieves metric definitions for the given database.

Parameters:

resourceGroupName - Name of an Azure resource group.

accountName - Cosmos DB database account name.

databaseRid - Cosmos DB database rid.

Returns:

the response to a list metric definitions request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listMetricDefinitions

com.azure.core.http.rest.PagedIterable<MetricDefinitionInner> listMetricDefinitions(String resourceGroupName,
                                                                                    String accountName,
                                                                                    String databaseRid,
                                                                                    com.azure.core.util.Context context)

Retrieves metric definitions for the given database.

Parameters:

resourceGroupName - Name of an Azure resource group.

accountName - Cosmos DB database account name.

databaseRid - Cosmos DB database rid.

context - The context to associate with this operation.

Returns:

the response to a list metric definitions request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.