import "github.com/Azure/azure-sdk-for-go/services/preview/cosmos-db/mgmt/2019-08-01-preview/documentdb"
Package documentdb implements the Azure ARM Documentdb service API version .
Azure Cosmos DB Database Service Resource Provider REST API
cassandraresources.go client.go collection.go collectionpartition.go collectionpartitionregion.go collectionregion.go database.go databaseaccountregion.go databaseaccounts.go enums.go gremlinresources.go models.go mongodbresources.go notebookworkspaces.go operations.go partitionkeyrangeid.go partitionkeyrangeidregion.go percentile.go percentilesourcetarget.go percentiletarget.go privateendpointconnections.go privatelinkresources.go sqlresources.go tableresources.go version.go
const (
// DefaultBaseURI is the default URI used for the service Documentdb
DefaultBaseURI = "https://management.azure.com"
)UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
type ARMProxyResource struct {
// ID - READ-ONLY; The unique resource identifier of the database account.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the database account.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
}ARMProxyResource the resource model definition for a ARM proxy resource. It will have everything other than required location and tags
type ARMResourceProperties struct {
// ID - READ-ONLY; The unique resource identifier of the ARM resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags map[string]*string `json:"tags"`
}ARMResourceProperties the core properties of ARM resources.
func (arp ARMResourceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ARMResourceProperties.
type AzureEntityResource struct {
// Etag - READ-ONLY; Resource Etag.
Etag *string `json:"etag,omitempty"`
// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the resource
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string `json:"type,omitempty"`
}AzureEntityResource the resource model definition for an Azure Resource Manager resource with an etag.
BaseClient is the base client for Documentdb.
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
type Capability struct {
// Name - Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".
Name *string `json:"name,omitempty"`
}Capability cosmos DB capability object
type CassandraKeyspaceCreateUpdateParameters struct {
// CassandraKeyspaceCreateUpdateProperties - Properties to create and update Azure Cosmos DB Cassandra keyspace.
*CassandraKeyspaceCreateUpdateProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The unique resource identifier of the ARM resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags map[string]*string `json:"tags"`
}CassandraKeyspaceCreateUpdateParameters parameters to create and update Cosmos DB Cassandra keyspace.
func (ckcup CassandraKeyspaceCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CassandraKeyspaceCreateUpdateParameters.
func (ckcup *CassandraKeyspaceCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CassandraKeyspaceCreateUpdateParameters struct.
type CassandraKeyspaceCreateUpdateProperties struct {
// Resource - The standard JSON format of a Cassandra keyspace
Resource *CassandraKeyspaceResource `json:"resource,omitempty"`
// Options - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
Options map[string]*string `json:"options"`
}CassandraKeyspaceCreateUpdateProperties properties to create and update Azure Cosmos DB Cassandra keyspace.
func (ckcup CassandraKeyspaceCreateUpdateProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CassandraKeyspaceCreateUpdateProperties.
type CassandraKeyspaceGetProperties struct {
Resource *CassandraKeyspaceGetPropertiesResource `json:"resource,omitempty"`
}CassandraKeyspaceGetProperties the properties of an Azure Cosmos DB Cassandra keyspace
type CassandraKeyspaceGetPropertiesResource struct {
// ID - Name of the Cosmos DB Cassandra keyspace
ID *string `json:"id,omitempty"`
// Rid - READ-ONLY; A system generated property. A unique identifier.
Rid *string `json:"_rid,omitempty"`
// Ts - READ-ONLY; A system generated property that denotes the last updated timestamp of the resource.
Ts interface{} `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}CassandraKeyspaceGetPropertiesResource ...
func (ckgp CassandraKeyspaceGetPropertiesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CassandraKeyspaceGetPropertiesResource.
type CassandraKeyspaceGetResults struct {
autorest.Response `json:"-"`
// CassandraKeyspaceGetProperties - The properties of an Azure Cosmos DB Cassandra keyspace
*CassandraKeyspaceGetProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The unique resource identifier of the ARM resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags map[string]*string `json:"tags"`
}CassandraKeyspaceGetResults an Azure Cosmos DB Cassandra keyspace.
func (ckgr CassandraKeyspaceGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CassandraKeyspaceGetResults.
func (ckgr *CassandraKeyspaceGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CassandraKeyspaceGetResults struct.
type CassandraKeyspaceListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of Cassandra keyspaces and their properties.
Value *[]CassandraKeyspaceGetResults `json:"value,omitempty"`
}CassandraKeyspaceListResult the List operation response, that contains the Cassandra keyspaces and their properties.
type CassandraKeyspaceResource struct {
// ID - Name of the Cosmos DB Cassandra keyspace
ID *string `json:"id,omitempty"`
}CassandraKeyspaceResource cosmos DB Cassandra keyspace resource object
type CassandraPartitionKey struct {
// Name - Name of the Cosmos DB Cassandra table partition key
Name *string `json:"name,omitempty"`
}CassandraPartitionKey cosmos DB Cassandra table partition key
type CassandraResourcesClient struct {
BaseClient
}CassandraResourcesClient is the azure Cosmos DB Database Service Resource Provider REST API
func NewCassandraResourcesClient(subscriptionID string) CassandraResourcesClient
NewCassandraResourcesClient creates an instance of the CassandraResourcesClient client.
func NewCassandraResourcesClientWithBaseURI(baseURI string, subscriptionID string) CassandraResourcesClient
NewCassandraResourcesClientWithBaseURI creates an instance of the CassandraResourcesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client CassandraResourcesClient) CreateUpdateCassandraKeyspace(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, createUpdateCassandraKeyspaceParameters CassandraKeyspaceCreateUpdateParameters) (result CassandraResourcesCreateUpdateCassandraKeyspaceFuture, err error)
CreateUpdateCassandraKeyspace create or update an Azure Cosmos DB Cassandra keyspace Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. keyspaceName - cosmos DB keyspace name. createUpdateCassandraKeyspaceParameters - the parameters to provide for the current Cassandra keyspace.
func (client CassandraResourcesClient) CreateUpdateCassandraKeyspacePreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, createUpdateCassandraKeyspaceParameters CassandraKeyspaceCreateUpdateParameters) (*http.Request, error)
CreateUpdateCassandraKeyspacePreparer prepares the CreateUpdateCassandraKeyspace request.
func (client CassandraResourcesClient) CreateUpdateCassandraKeyspaceResponder(resp *http.Response) (result CassandraKeyspaceGetResults, err error)
CreateUpdateCassandraKeyspaceResponder handles the response to the CreateUpdateCassandraKeyspace request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) CreateUpdateCassandraKeyspaceSender(req *http.Request) (future CassandraResourcesCreateUpdateCassandraKeyspaceFuture, err error)
CreateUpdateCassandraKeyspaceSender sends the CreateUpdateCassandraKeyspace request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) CreateUpdateCassandraTable(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string, createUpdateCassandraTableParameters CassandraTableCreateUpdateParameters) (result CassandraResourcesCreateUpdateCassandraTableFuture, err error)
CreateUpdateCassandraTable create or update an Azure Cosmos DB Cassandra Table Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. keyspaceName - cosmos DB keyspace name. tableName - cosmos DB table name. createUpdateCassandraTableParameters - the parameters to provide for the current Cassandra Table.
func (client CassandraResourcesClient) CreateUpdateCassandraTablePreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string, createUpdateCassandraTableParameters CassandraTableCreateUpdateParameters) (*http.Request, error)
CreateUpdateCassandraTablePreparer prepares the CreateUpdateCassandraTable request.
func (client CassandraResourcesClient) CreateUpdateCassandraTableResponder(resp *http.Response) (result CassandraTableGetResults, err error)
CreateUpdateCassandraTableResponder handles the response to the CreateUpdateCassandraTable request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) CreateUpdateCassandraTableSender(req *http.Request) (future CassandraResourcesCreateUpdateCassandraTableFuture, err error)
CreateUpdateCassandraTableSender sends the CreateUpdateCassandraTable request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) DeleteCassandraKeyspace(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (result CassandraResourcesDeleteCassandraKeyspaceFuture, err error)
DeleteCassandraKeyspace deletes an existing Azure Cosmos DB Cassandra keyspace. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. keyspaceName - cosmos DB keyspace name.
func (client CassandraResourcesClient) DeleteCassandraKeyspacePreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (*http.Request, error)
DeleteCassandraKeyspacePreparer prepares the DeleteCassandraKeyspace request.
func (client CassandraResourcesClient) DeleteCassandraKeyspaceResponder(resp *http.Response) (result autorest.Response, err error)
DeleteCassandraKeyspaceResponder handles the response to the DeleteCassandraKeyspace request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) DeleteCassandraKeyspaceSender(req *http.Request) (future CassandraResourcesDeleteCassandraKeyspaceFuture, err error)
DeleteCassandraKeyspaceSender sends the DeleteCassandraKeyspace request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) DeleteCassandraTable(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string) (result CassandraResourcesDeleteCassandraTableFuture, err error)
DeleteCassandraTable deletes an existing Azure Cosmos DB Cassandra table. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. keyspaceName - cosmos DB keyspace name. tableName - cosmos DB table name.
func (client CassandraResourcesClient) DeleteCassandraTablePreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string) (*http.Request, error)
DeleteCassandraTablePreparer prepares the DeleteCassandraTable request.
func (client CassandraResourcesClient) DeleteCassandraTableResponder(resp *http.Response) (result autorest.Response, err error)
DeleteCassandraTableResponder handles the response to the DeleteCassandraTable request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) DeleteCassandraTableSender(req *http.Request) (future CassandraResourcesDeleteCassandraTableFuture, err error)
DeleteCassandraTableSender sends the DeleteCassandraTable request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) GetCassandraKeyspace(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (result CassandraKeyspaceGetResults, err error)
GetCassandraKeyspace gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. keyspaceName - cosmos DB keyspace name.
func (client CassandraResourcesClient) GetCassandraKeyspacePreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (*http.Request, error)
GetCassandraKeyspacePreparer prepares the GetCassandraKeyspace request.
func (client CassandraResourcesClient) GetCassandraKeyspaceResponder(resp *http.Response) (result CassandraKeyspaceGetResults, err error)
GetCassandraKeyspaceResponder handles the response to the GetCassandraKeyspace request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) GetCassandraKeyspaceSender(req *http.Request) (*http.Response, error)
GetCassandraKeyspaceSender sends the GetCassandraKeyspace request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) GetCassandraKeyspaceThroughput(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (result ThroughputSettingsGetResults, err error)
GetCassandraKeyspaceThroughput gets the RUs per second of the Cassandra Keyspace under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. keyspaceName - cosmos DB keyspace name.
func (client CassandraResourcesClient) GetCassandraKeyspaceThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (*http.Request, error)
GetCassandraKeyspaceThroughputPreparer prepares the GetCassandraKeyspaceThroughput request.
func (client CassandraResourcesClient) GetCassandraKeyspaceThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
GetCassandraKeyspaceThroughputResponder handles the response to the GetCassandraKeyspaceThroughput request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) GetCassandraKeyspaceThroughputSender(req *http.Request) (*http.Response, error)
GetCassandraKeyspaceThroughputSender sends the GetCassandraKeyspaceThroughput request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) GetCassandraTable(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string) (result CassandraTableGetResults, err error)
GetCassandraTable gets the Cassandra table under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. keyspaceName - cosmos DB keyspace name. tableName - cosmos DB table name.
func (client CassandraResourcesClient) GetCassandraTablePreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string) (*http.Request, error)
GetCassandraTablePreparer prepares the GetCassandraTable request.
func (client CassandraResourcesClient) GetCassandraTableResponder(resp *http.Response) (result CassandraTableGetResults, err error)
GetCassandraTableResponder handles the response to the GetCassandraTable request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) GetCassandraTableSender(req *http.Request) (*http.Response, error)
GetCassandraTableSender sends the GetCassandraTable request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) GetCassandraTableThroughput(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string) (result ThroughputSettingsGetResults, err error)
GetCassandraTableThroughput gets the RUs per second of the Cassandra table under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. keyspaceName - cosmos DB keyspace name. tableName - cosmos DB table name.
func (client CassandraResourcesClient) GetCassandraTableThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string) (*http.Request, error)
GetCassandraTableThroughputPreparer prepares the GetCassandraTableThroughput request.
func (client CassandraResourcesClient) GetCassandraTableThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
GetCassandraTableThroughputResponder handles the response to the GetCassandraTableThroughput request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) GetCassandraTableThroughputSender(req *http.Request) (*http.Response, error)
GetCassandraTableThroughputSender sends the GetCassandraTableThroughput request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) ListCassandraKeyspaces(ctx context.Context, resourceGroupName string, accountName string) (result CassandraKeyspaceListResult, err error)
ListCassandraKeyspaces lists the Cassandra keyspaces under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name.
func (client CassandraResourcesClient) ListCassandraKeyspacesPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListCassandraKeyspacesPreparer prepares the ListCassandraKeyspaces request.
func (client CassandraResourcesClient) ListCassandraKeyspacesResponder(resp *http.Response) (result CassandraKeyspaceListResult, err error)
ListCassandraKeyspacesResponder handles the response to the ListCassandraKeyspaces request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) ListCassandraKeyspacesSender(req *http.Request) (*http.Response, error)
ListCassandraKeyspacesSender sends the ListCassandraKeyspaces request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) ListCassandraTables(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (result CassandraTableListResult, err error)
ListCassandraTables lists the Cassandra table under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. keyspaceName - cosmos DB keyspace name.
func (client CassandraResourcesClient) ListCassandraTablesPreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (*http.Request, error)
ListCassandraTablesPreparer prepares the ListCassandraTables request.
func (client CassandraResourcesClient) ListCassandraTablesResponder(resp *http.Response) (result CassandraTableListResult, err error)
ListCassandraTablesResponder handles the response to the ListCassandraTables request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) ListCassandraTablesSender(req *http.Request) (*http.Response, error)
ListCassandraTablesSender sends the ListCassandraTables request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) UpdateCassandraKeyspaceThroughput(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (result CassandraResourcesUpdateCassandraKeyspaceThroughputFuture, err error)
UpdateCassandraKeyspaceThroughput update RUs per second of an Azure Cosmos DB Cassandra Keyspace Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. keyspaceName - cosmos DB keyspace name. updateThroughputParameters - the RUs per second of the parameters to provide for the current Cassandra Keyspace.
func (client CassandraResourcesClient) UpdateCassandraKeyspaceThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)
UpdateCassandraKeyspaceThroughputPreparer prepares the UpdateCassandraKeyspaceThroughput request.
func (client CassandraResourcesClient) UpdateCassandraKeyspaceThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
UpdateCassandraKeyspaceThroughputResponder handles the response to the UpdateCassandraKeyspaceThroughput request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) UpdateCassandraKeyspaceThroughputSender(req *http.Request) (future CassandraResourcesUpdateCassandraKeyspaceThroughputFuture, err error)
UpdateCassandraKeyspaceThroughputSender sends the UpdateCassandraKeyspaceThroughput request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) UpdateCassandraTableThroughput(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (result CassandraResourcesUpdateCassandraTableThroughputFuture, err error)
UpdateCassandraTableThroughput update RUs per second of an Azure Cosmos DB Cassandra table Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. keyspaceName - cosmos DB keyspace name. tableName - cosmos DB table name. updateThroughputParameters - the RUs per second of the parameters to provide for the current Cassandra table.
func (client CassandraResourcesClient) UpdateCassandraTableThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)
UpdateCassandraTableThroughputPreparer prepares the UpdateCassandraTableThroughput request.
func (client CassandraResourcesClient) UpdateCassandraTableThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
UpdateCassandraTableThroughputResponder handles the response to the UpdateCassandraTableThroughput request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) UpdateCassandraTableThroughputSender(req *http.Request) (future CassandraResourcesUpdateCassandraTableThroughputFuture, err error)
UpdateCassandraTableThroughputSender sends the UpdateCassandraTableThroughput request. The method will close the http.Response Body if it receives an error.
type CassandraResourcesCreateUpdateCassandraKeyspaceFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CassandraResourcesClient) (CassandraKeyspaceGetResults, error)
}CassandraResourcesCreateUpdateCassandraKeyspaceFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CassandraResourcesCreateUpdateCassandraTableFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CassandraResourcesClient) (CassandraTableGetResults, error)
}CassandraResourcesCreateUpdateCassandraTableFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CassandraResourcesDeleteCassandraKeyspaceFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CassandraResourcesClient) (autorest.Response, error)
}CassandraResourcesDeleteCassandraKeyspaceFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CassandraResourcesDeleteCassandraTableFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CassandraResourcesClient) (autorest.Response, error)
}CassandraResourcesDeleteCassandraTableFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CassandraResourcesUpdateCassandraKeyspaceThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CassandraResourcesClient) (ThroughputSettingsGetResults, error)
}CassandraResourcesUpdateCassandraKeyspaceThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CassandraResourcesUpdateCassandraTableThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CassandraResourcesClient) (ThroughputSettingsGetResults, error)
}CassandraResourcesUpdateCassandraTableThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CassandraSchema struct {
// Columns - List of Cassandra table columns.
Columns *[]Column `json:"columns,omitempty"`
// PartitionKeys - List of partition key.
PartitionKeys *[]CassandraPartitionKey `json:"partitionKeys,omitempty"`
// ClusterKeys - List of cluster key.
ClusterKeys *[]ClusterKey `json:"clusterKeys,omitempty"`
}CassandraSchema cosmos DB Cassandra table schema
type CassandraTableCreateUpdateParameters struct {
// CassandraTableCreateUpdateProperties - Properties to create and update Azure Cosmos DB Cassandra table.
*CassandraTableCreateUpdateProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The unique resource identifier of the ARM resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags map[string]*string `json:"tags"`
}CassandraTableCreateUpdateParameters parameters to create and update Cosmos DB Cassandra table.
func (ctcup CassandraTableCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CassandraTableCreateUpdateParameters.
func (ctcup *CassandraTableCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CassandraTableCreateUpdateParameters struct.
type CassandraTableCreateUpdateProperties struct {
// Resource - The standard JSON format of a Cassandra table
Resource *CassandraTableResource `json:"resource,omitempty"`
// Options - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
Options map[string]*string `json:"options"`
}CassandraTableCreateUpdateProperties properties to create and update Azure Cosmos DB Cassandra table.
func (ctcup CassandraTableCreateUpdateProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CassandraTableCreateUpdateProperties.
type CassandraTableGetProperties struct {
Resource *CassandraTableGetPropertiesResource `json:"resource,omitempty"`
}CassandraTableGetProperties the properties of an Azure Cosmos DB Cassandra table
type CassandraTableGetPropertiesResource struct {
// ID - Name of the Cosmos DB Cassandra table
ID *string `json:"id,omitempty"`
// DefaultTTL - Time to live of the Cosmos DB Cassandra table
DefaultTTL *int32 `json:"defaultTtl,omitempty"`
// Schema - Schema of the Cosmos DB Cassandra table
Schema *CassandraSchema `json:"schema,omitempty"`
// Rid - READ-ONLY; A system generated property. A unique identifier.
Rid *string `json:"_rid,omitempty"`
// Ts - READ-ONLY; A system generated property that denotes the last updated timestamp of the resource.
Ts interface{} `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}CassandraTableGetPropertiesResource ...
func (ctgp CassandraTableGetPropertiesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CassandraTableGetPropertiesResource.
type CassandraTableGetResults struct {
autorest.Response `json:"-"`
// CassandraTableGetProperties - The properties of an Azure Cosmos DB Cassandra table
*CassandraTableGetProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The unique resource identifier of the ARM resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags map[string]*string `json:"tags"`
}CassandraTableGetResults an Azure Cosmos DB Cassandra table.
func (ctgr CassandraTableGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CassandraTableGetResults.
func (ctgr *CassandraTableGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CassandraTableGetResults struct.
type CassandraTableListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of Cassandra tables and their properties.
Value *[]CassandraTableGetResults `json:"value,omitempty"`
}CassandraTableListResult the List operation response, that contains the Cassandra tables and their properties.
type CassandraTableResource struct {
// ID - Name of the Cosmos DB Cassandra table
ID *string `json:"id,omitempty"`
// DefaultTTL - Time to live of the Cosmos DB Cassandra table
DefaultTTL *int32 `json:"defaultTtl,omitempty"`
// Schema - Schema of the Cosmos DB Cassandra table
Schema *CassandraSchema `json:"schema,omitempty"`
}CassandraTableResource cosmos DB Cassandra table resource object
type ClusterKey struct {
// Name - Name of the Cosmos DB Cassandra table cluster key
Name *string `json:"name,omitempty"`
// OrderBy - Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc"
OrderBy *string `json:"orderBy,omitempty"`
}ClusterKey cosmos DB Cassandra table cluster key
type CollectionClient struct {
BaseClient
}CollectionClient is the azure Cosmos DB Database Service Resource Provider REST API
func NewCollectionClient(subscriptionID string) CollectionClient
NewCollectionClient creates an instance of the CollectionClient client.
func NewCollectionClientWithBaseURI(baseURI string, subscriptionID string) CollectionClient
NewCollectionClientWithBaseURI creates an instance of the CollectionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client CollectionClient) ListMetricDefinitions(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string) (result MetricDefinitionsListResult, err error)
ListMetricDefinitions retrieves metric definitions for the given collection. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseRid - cosmos DB database rid. collectionRid - cosmos DB collection rid.
func (client CollectionClient) ListMetricDefinitionsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string) (*http.Request, error)
ListMetricDefinitionsPreparer prepares the ListMetricDefinitions request.
func (client CollectionClient) ListMetricDefinitionsResponder(resp *http.Response) (result MetricDefinitionsListResult, err error)
ListMetricDefinitionsResponder handles the response to the ListMetricDefinitions request. The method always closes the http.Response Body.
func (client CollectionClient) ListMetricDefinitionsSender(req *http.Request) (*http.Response, error)
ListMetricDefinitionsSender sends the ListMetricDefinitions request. The method will close the http.Response Body if it receives an error.
func (client CollectionClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, filter string) (result MetricListResult, err error)
ListMetrics retrieves the metrics determined by the given filter for the given database account and collection. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseRid - cosmos DB database rid. collectionRid - cosmos DB collection 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.
func (client CollectionClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client CollectionClient) ListMetricsResponder(resp *http.Response) (result MetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.
ListMetricsSender sends the ListMetrics request. The method will close the http.Response Body if it receives an error.
func (client CollectionClient) ListUsages(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, filter string) (result UsagesResult, err error)
ListUsages retrieves the usages (most recent storage data) for the given collection. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseRid - cosmos DB database rid. collectionRid - cosmos DB collection 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).
func (client CollectionClient) ListUsagesPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, filter string) (*http.Request, error)
ListUsagesPreparer prepares the ListUsages request.
func (client CollectionClient) ListUsagesResponder(resp *http.Response) (result UsagesResult, err error)
ListUsagesResponder handles the response to the ListUsages request. The method always closes the http.Response Body.
ListUsagesSender sends the ListUsages request. The method will close the http.Response Body if it receives an error.
type CollectionPartitionClient struct {
BaseClient
}CollectionPartitionClient is the azure Cosmos DB Database Service Resource Provider REST API
func NewCollectionPartitionClient(subscriptionID string) CollectionPartitionClient
NewCollectionPartitionClient creates an instance of the CollectionPartitionClient client.
func NewCollectionPartitionClientWithBaseURI(baseURI string, subscriptionID string) CollectionPartitionClient
NewCollectionPartitionClientWithBaseURI creates an instance of the CollectionPartitionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client CollectionPartitionClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, filter string) (result PartitionMetricListResult, err error)
ListMetrics retrieves the metrics determined by the given filter for the given collection, split by partition. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseRid - cosmos DB database rid. collectionRid - cosmos DB collection 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.
func (client CollectionPartitionClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client CollectionPartitionClient) ListMetricsResponder(resp *http.Response) (result PartitionMetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.
func (client CollectionPartitionClient) ListMetricsSender(req *http.Request) (*http.Response, error)
ListMetricsSender sends the ListMetrics request. The method will close the http.Response Body if it receives an error.
func (client CollectionPartitionClient) ListUsages(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, filter string) (result PartitionUsagesResult, err error)
ListUsages retrieves the usages (most recent storage data) for the given collection, split by partition. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseRid - cosmos DB database rid. collectionRid - cosmos DB collection 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).
func (client CollectionPartitionClient) ListUsagesPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, filter string) (*http.Request, error)
ListUsagesPreparer prepares the ListUsages request.
func (client CollectionPartitionClient) ListUsagesResponder(resp *http.Response) (result PartitionUsagesResult, err error)
ListUsagesResponder handles the response to the ListUsages request. The method always closes the http.Response Body.
func (client CollectionPartitionClient) ListUsagesSender(req *http.Request) (*http.Response, error)
ListUsagesSender sends the ListUsages request. The method will close the http.Response Body if it receives an error.
type CollectionPartitionRegionClient struct {
BaseClient
}CollectionPartitionRegionClient is the azure Cosmos DB Database Service Resource Provider REST API
func NewCollectionPartitionRegionClient(subscriptionID string) CollectionPartitionRegionClient
NewCollectionPartitionRegionClient creates an instance of the CollectionPartitionRegionClient client.
func NewCollectionPartitionRegionClientWithBaseURI(baseURI string, subscriptionID string) CollectionPartitionRegionClient
NewCollectionPartitionRegionClientWithBaseURI creates an instance of the CollectionPartitionRegionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client CollectionPartitionRegionClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, region string, databaseRid string, collectionRid string, filter string) (result PartitionMetricListResult, err error)
ListMetrics retrieves the metrics determined by the given filter for the given collection and region, split by partition. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. region - cosmos DB region, with spaces between words and each word capitalized. databaseRid - cosmos DB database rid. collectionRid - cosmos DB collection 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.
func (client CollectionPartitionRegionClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, region string, databaseRid string, collectionRid string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client CollectionPartitionRegionClient) ListMetricsResponder(resp *http.Response) (result PartitionMetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.
func (client CollectionPartitionRegionClient) ListMetricsSender(req *http.Request) (*http.Response, error)
ListMetricsSender sends the ListMetrics request. The method will close the http.Response Body if it receives an error.
type CollectionRegionClient struct {
BaseClient
}CollectionRegionClient is the azure Cosmos DB Database Service Resource Provider REST API
func NewCollectionRegionClient(subscriptionID string) CollectionRegionClient
NewCollectionRegionClient creates an instance of the CollectionRegionClient client.
func NewCollectionRegionClientWithBaseURI(baseURI string, subscriptionID string) CollectionRegionClient
NewCollectionRegionClientWithBaseURI creates an instance of the CollectionRegionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client CollectionRegionClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, region string, databaseRid string, collectionRid string, filter string) (result MetricListResult, err error)
ListMetrics retrieves the metrics determined by the given filter for the given database account, collection and region. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. region - cosmos DB region, with spaces between words and each word capitalized. databaseRid - cosmos DB database rid. collectionRid - cosmos DB collection 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.
func (client CollectionRegionClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, region string, databaseRid string, collectionRid string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client CollectionRegionClient) ListMetricsResponder(resp *http.Response) (result MetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.
ListMetricsSender sends the ListMetrics request. The method will close the http.Response Body if it receives an error.
type Column struct {
// Name - Name of the Cosmos DB Cassandra table column
Name *string `json:"name,omitempty"`
// Type - Type of the Cosmos DB Cassandra table column
Type *string `json:"type,omitempty"`
}Column cosmos DB Cassandra table column
type CompositePath struct {
// Path - The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
Path *string `json:"path,omitempty"`
// Order - Sort order for composite paths. Possible values include: 'Ascending', 'Descending'
Order CompositePathSortOrder `json:"order,omitempty"`
}CompositePath ...
CompositePathSortOrder enumerates the values for composite path sort order.
const (
// Ascending ...
Ascending CompositePathSortOrder = "Ascending"
// Descending ...
Descending CompositePathSortOrder = "Descending"
)func PossibleCompositePathSortOrderValues() []CompositePathSortOrder
PossibleCompositePathSortOrderValues returns an array of possible values for the CompositePathSortOrder const type.
ConflictResolutionMode enumerates the values for conflict resolution mode.
const (
// Custom ...
Custom ConflictResolutionMode = "Custom"
// LastWriterWins ...
LastWriterWins ConflictResolutionMode = "LastWriterWins"
)func PossibleConflictResolutionModeValues() []ConflictResolutionMode
PossibleConflictResolutionModeValues returns an array of possible values for the ConflictResolutionMode const type.
type ConflictResolutionPolicy struct {
// Mode - Indicates the conflict resolution mode. Possible values include: 'LastWriterWins', 'Custom'
Mode ConflictResolutionMode `json:"mode,omitempty"`
// ConflictResolutionPath - The conflict resolution path in the case of LastWriterWins mode.
ConflictResolutionPath *string `json:"conflictResolutionPath,omitempty"`
// ConflictResolutionProcedure - The procedure to resolve conflicts in the case of custom mode.
ConflictResolutionProcedure *string `json:"conflictResolutionProcedure,omitempty"`
}ConflictResolutionPolicy the conflict resolution policy for the container.
ConnectorOffer enumerates the values for connector offer.
const (
// Small ...
Small ConnectorOffer = "Small"
)func PossibleConnectorOfferValues() []ConnectorOffer
PossibleConnectorOfferValues returns an array of possible values for the ConnectorOffer const type.
type ConsistencyPolicy struct {
// DefaultConsistencyLevel - The default consistency level and configuration settings of the Cosmos DB account. Possible values include: 'Eventual', 'Session', 'BoundedStaleness', 'Strong', 'ConsistentPrefix'
DefaultConsistencyLevel DefaultConsistencyLevel `json:"defaultConsistencyLevel,omitempty"`
// MaxStalenessPrefix - When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
MaxStalenessPrefix *int64 `json:"maxStalenessPrefix,omitempty"`
// MaxIntervalInSeconds - When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
MaxIntervalInSeconds *int32 `json:"maxIntervalInSeconds,omitempty"`
}ConsistencyPolicy the consistency policy for the Cosmos DB database account.
type ContainerPartitionKey struct {
// Paths - List of paths using which data within the container can be partitioned
Paths *[]string `json:"paths,omitempty"`
// Kind - Indicates the kind of algorithm used for partitioning. Possible values include: 'PartitionKindHash', 'PartitionKindRange'
Kind PartitionKind `json:"kind,omitempty"`
// Version - Indicates the version of the partition key definition
Version *int32 `json:"version,omitempty"`
}ContainerPartitionKey the configuration of the partition key to be used for partitioning data into multiple partitions
DataType enumerates the values for data type.
const (
// LineString ...
LineString DataType = "LineString"
// MultiPolygon ...
MultiPolygon DataType = "MultiPolygon"
// Number ...
Number DataType = "Number"
// Point ...
Point DataType = "Point"
// Polygon ...
Polygon DataType = "Polygon"
// String ...
String DataType = "String"
)PossibleDataTypeValues returns an array of possible values for the DataType const type.
type DatabaseAccountConnectionString struct {
// ConnectionString - READ-ONLY; Value of the connection string
ConnectionString *string `json:"connectionString,omitempty"`
// Description - READ-ONLY; Description of the connection string
Description *string `json:"description,omitempty"`
}DatabaseAccountConnectionString connection string for the Cosmos DB account
type DatabaseAccountCreateUpdateParameters struct {
// Kind - Indicates the type of database account. This can only be set at database account creation. Possible values include: 'GlobalDocumentDB', 'MongoDB', 'Parse'
Kind DatabaseAccountKind `json:"kind,omitempty"`
*DatabaseAccountCreateUpdateProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The unique resource identifier of the ARM resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags map[string]*string `json:"tags"`
}DatabaseAccountCreateUpdateParameters parameters to create and update Cosmos DB database accounts.
func (dacup DatabaseAccountCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DatabaseAccountCreateUpdateParameters.
func (dacup *DatabaseAccountCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DatabaseAccountCreateUpdateParameters struct.
type DatabaseAccountCreateUpdateProperties struct {
// ConsistencyPolicy - The consistency policy for the Cosmos DB account.
ConsistencyPolicy *ConsistencyPolicy `json:"consistencyPolicy,omitempty"`
// Locations - An array that contains the georeplication locations enabled for the Cosmos DB account.
Locations *[]Location `json:"locations,omitempty"`
// DatabaseAccountOfferType - The offer type for the database
DatabaseAccountOfferType *string `json:"databaseAccountOfferType,omitempty"`
// IPRangeFilter - Cosmos DB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
IPRangeFilter *string `json:"ipRangeFilter,omitempty"`
// IsVirtualNetworkFilterEnabled - Flag to indicate whether to enable/disable Virtual Network ACL rules.
IsVirtualNetworkFilterEnabled *bool `json:"isVirtualNetworkFilterEnabled,omitempty"`
// EnableAutomaticFailover - Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
EnableAutomaticFailover *bool `json:"enableAutomaticFailover,omitempty"`
// Capabilities - List of Cosmos DB capabilities for the account
Capabilities *[]Capability `json:"capabilities,omitempty"`
// VirtualNetworkRules - List of Virtual Network ACL rules configured for the Cosmos DB account.
VirtualNetworkRules *[]VirtualNetworkRule `json:"virtualNetworkRules,omitempty"`
// EnableMultipleWriteLocations - Enables the account to write in multiple locations
EnableMultipleWriteLocations *bool `json:"enableMultipleWriteLocations,omitempty"`
// EnableCassandraConnector - Enables the cassandra connector on the Cosmos DB C* account
EnableCassandraConnector *bool `json:"enableCassandraConnector,omitempty"`
// ConnectorOffer - The cassandra connector offer type for the Cosmos DB database C* account. Possible values include: 'Small'
ConnectorOffer ConnectorOffer `json:"connectorOffer,omitempty"`
// DisableKeyBasedMetadataWriteAccess - Disable write operations on metadata resources (databases, containers, throughput) via account keys
DisableKeyBasedMetadataWriteAccess *bool `json:"disableKeyBasedMetadataWriteAccess,omitempty"`
}DatabaseAccountCreateUpdateProperties properties to create and update Azure Cosmos DB database accounts.
type DatabaseAccountGetProperties struct {
ProvisioningState *string `json:"provisioningState,omitempty"`
// DocumentEndpoint - READ-ONLY; The connection endpoint for the Cosmos DB database account.
DocumentEndpoint *string `json:"documentEndpoint,omitempty"`
// DatabaseAccountOfferType - READ-ONLY; The offer type for the Cosmos DB database account. Default value: Standard. Possible values include: 'Standard'
DatabaseAccountOfferType DatabaseAccountOfferType `json:"databaseAccountOfferType,omitempty"`
// IPRangeFilter - Cosmos DB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
IPRangeFilter *string `json:"ipRangeFilter,omitempty"`
// IsVirtualNetworkFilterEnabled - Flag to indicate whether to enable/disable Virtual Network ACL rules.
IsVirtualNetworkFilterEnabled *bool `json:"isVirtualNetworkFilterEnabled,omitempty"`
// EnableAutomaticFailover - Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
EnableAutomaticFailover *bool `json:"enableAutomaticFailover,omitempty"`
// ConsistencyPolicy - The consistency policy for the Cosmos DB database account.
ConsistencyPolicy *ConsistencyPolicy `json:"consistencyPolicy,omitempty"`
// Capabilities - List of Cosmos DB capabilities for the account
Capabilities *[]Capability `json:"capabilities,omitempty"`
// WriteLocations - READ-ONLY; An array that contains the write location for the Cosmos DB account.
WriteLocations *[]Location `json:"writeLocations,omitempty"`
// ReadLocations - READ-ONLY; An array that contains of the read locations enabled for the Cosmos DB account.
ReadLocations *[]Location `json:"readLocations,omitempty"`
// Locations - READ-ONLY; An array that contains all of the locations enabled for the Cosmos DB account.
Locations *[]Location `json:"locations,omitempty"`
// FailoverPolicies - READ-ONLY; An array that contains the regions ordered by their failover priorities.
FailoverPolicies *[]FailoverPolicy `json:"failoverPolicies,omitempty"`
// VirtualNetworkRules - List of Virtual Network ACL rules configured for the Cosmos DB account.
VirtualNetworkRules *[]VirtualNetworkRule `json:"virtualNetworkRules,omitempty"`
// EnableMultipleWriteLocations - Enables the account to write in multiple locations
EnableMultipleWriteLocations *bool `json:"enableMultipleWriteLocations,omitempty"`
// EnableCassandraConnector - Enables the cassandra connector on the Cosmos DB C* account
EnableCassandraConnector *bool `json:"enableCassandraConnector,omitempty"`
// ConnectorOffer - The cassandra connector offer type for the Cosmos DB database C* account. Possible values include: 'Small'
ConnectorOffer ConnectorOffer `json:"connectorOffer,omitempty"`
// DisableKeyBasedMetadataWriteAccess - Disable write operations on metadata resources (databases, containers, throughput) via account keys
DisableKeyBasedMetadataWriteAccess *bool `json:"disableKeyBasedMetadataWriteAccess,omitempty"`
}DatabaseAccountGetProperties properties for the database account.
func (dagp DatabaseAccountGetProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DatabaseAccountGetProperties.
type DatabaseAccountGetResults struct {
autorest.Response `json:"-"`
// Kind - Indicates the type of database account. This can only be set at database account creation. Possible values include: 'GlobalDocumentDB', 'MongoDB', 'Parse'
Kind DatabaseAccountKind `json:"kind,omitempty"`
*DatabaseAccountGetProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The unique resource identifier of the ARM resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags map[string]*string `json:"tags"`
}DatabaseAccountGetResults an Azure Cosmos DB database account.
func (dagr DatabaseAccountGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DatabaseAccountGetResults.
func (dagr *DatabaseAccountGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DatabaseAccountGetResults struct.
DatabaseAccountKind enumerates the values for database account kind.
const (
// GlobalDocumentDB ...
GlobalDocumentDB DatabaseAccountKind = "GlobalDocumentDB"
// MongoDB ...
MongoDB DatabaseAccountKind = "MongoDB"
// Parse ...
Parse DatabaseAccountKind = "Parse"
)func PossibleDatabaseAccountKindValues() []DatabaseAccountKind
PossibleDatabaseAccountKindValues returns an array of possible values for the DatabaseAccountKind const type.
type DatabaseAccountListConnectionStringsResult struct {
autorest.Response `json:"-"`
// ConnectionStrings - An array that contains the connection strings for the Cosmos DB account.
ConnectionStrings *[]DatabaseAccountConnectionString `json:"connectionStrings,omitempty"`
}DatabaseAccountListConnectionStringsResult the connection strings for the given database account.
type DatabaseAccountListKeysResult struct {
autorest.Response `json:"-"`
// PrimaryMasterKey - READ-ONLY; Base 64 encoded value of the primary read-write key.
PrimaryMasterKey *string `json:"primaryMasterKey,omitempty"`
// SecondaryMasterKey - READ-ONLY; Base 64 encoded value of the secondary read-write key.
SecondaryMasterKey *string `json:"secondaryMasterKey,omitempty"`
// PrimaryReadonlyMasterKey - READ-ONLY; Base 64 encoded value of the primary read-only key.
PrimaryReadonlyMasterKey *string `json:"primaryReadonlyMasterKey,omitempty"`
// SecondaryReadonlyMasterKey - READ-ONLY; Base 64 encoded value of the secondary read-only key.
SecondaryReadonlyMasterKey *string `json:"secondaryReadonlyMasterKey,omitempty"`
}DatabaseAccountListKeysResult the access keys for the given database account.
type DatabaseAccountListReadOnlyKeysResult struct {
autorest.Response `json:"-"`
// PrimaryReadonlyMasterKey - READ-ONLY; Base 64 encoded value of the primary read-only key.
PrimaryReadonlyMasterKey *string `json:"primaryReadonlyMasterKey,omitempty"`
// SecondaryReadonlyMasterKey - READ-ONLY; Base 64 encoded value of the secondary read-only key.
SecondaryReadonlyMasterKey *string `json:"secondaryReadonlyMasterKey,omitempty"`
}DatabaseAccountListReadOnlyKeysResult the read-only access keys for the given database account.
DatabaseAccountOfferType enumerates the values for database account offer type.
const (
// Standard ...
Standard DatabaseAccountOfferType = "Standard"
)func PossibleDatabaseAccountOfferTypeValues() []DatabaseAccountOfferType
PossibleDatabaseAccountOfferTypeValues returns an array of possible values for the DatabaseAccountOfferType const type.
type DatabaseAccountRegenerateKeyParameters struct {
// KeyKind - The access key to regenerate. Possible values include: 'Primary', 'Secondary', 'PrimaryReadonly', 'SecondaryReadonly'
KeyKind KeyKind `json:"keyKind,omitempty"`
}DatabaseAccountRegenerateKeyParameters parameters to regenerate the keys within the database account.
type DatabaseAccountRegionClient struct {
BaseClient
}DatabaseAccountRegionClient is the azure Cosmos DB Database Service Resource Provider REST API
func NewDatabaseAccountRegionClient(subscriptionID string) DatabaseAccountRegionClient
NewDatabaseAccountRegionClient creates an instance of the DatabaseAccountRegionClient client.
func NewDatabaseAccountRegionClientWithBaseURI(baseURI string, subscriptionID string) DatabaseAccountRegionClient
NewDatabaseAccountRegionClientWithBaseURI creates an instance of the DatabaseAccountRegionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client DatabaseAccountRegionClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, region string, filter string) (result MetricListResult, err error)
ListMetrics retrieves the metrics determined by the given filter for the given database account and region. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. region - cosmos DB region, with spaces between words and each word capitalized. 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.
func (client DatabaseAccountRegionClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, region string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client DatabaseAccountRegionClient) ListMetricsResponder(resp *http.Response) (result MetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.
func (client DatabaseAccountRegionClient) ListMetricsSender(req *http.Request) (*http.Response, error)
ListMetricsSender sends the ListMetrics request. The method will close the http.Response Body if it receives an error.
type DatabaseAccountUpdateParameters struct {
Tags map[string]*string `json:"tags"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
*DatabaseAccountUpdateProperties `json:"properties,omitempty"`
}DatabaseAccountUpdateParameters parameters for patching Azure Cosmos DB database account properties.
func (daup DatabaseAccountUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DatabaseAccountUpdateParameters.
func (daup *DatabaseAccountUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DatabaseAccountUpdateParameters struct.
type DatabaseAccountUpdateProperties struct {
// ConsistencyPolicy - The consistency policy for the Cosmos DB account.
ConsistencyPolicy *ConsistencyPolicy `json:"consistencyPolicy,omitempty"`
// Locations - An array that contains the georeplication locations enabled for the Cosmos DB account.
Locations *[]Location `json:"locations,omitempty"`
// IPRangeFilter - Cosmos DB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.
IPRangeFilter *string `json:"ipRangeFilter,omitempty"`
// IsVirtualNetworkFilterEnabled - Flag to indicate whether to enable/disable Virtual Network ACL rules.
IsVirtualNetworkFilterEnabled *bool `json:"isVirtualNetworkFilterEnabled,omitempty"`
// EnableAutomaticFailover - Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.
EnableAutomaticFailover *bool `json:"enableAutomaticFailover,omitempty"`
// Capabilities - List of Cosmos DB capabilities for the account
Capabilities *[]Capability `json:"capabilities,omitempty"`
// VirtualNetworkRules - List of Virtual Network ACL rules configured for the Cosmos DB account.
VirtualNetworkRules *[]VirtualNetworkRule `json:"virtualNetworkRules,omitempty"`
// EnableMultipleWriteLocations - Enables the account to write in multiple locations
EnableMultipleWriteLocations *bool `json:"enableMultipleWriteLocations,omitempty"`
// EnableCassandraConnector - Enables the cassandra connector on the Cosmos DB C* account
EnableCassandraConnector *bool `json:"enableCassandraConnector,omitempty"`
// ConnectorOffer - The cassandra connector offer type for the Cosmos DB database C* account. Possible values include: 'Small'
ConnectorOffer ConnectorOffer `json:"connectorOffer,omitempty"`
// DisableKeyBasedMetadataWriteAccess - Disable write operations on metadata resources (databases, containers, throughput) via account keys
DisableKeyBasedMetadataWriteAccess *bool `json:"disableKeyBasedMetadataWriteAccess,omitempty"`
}DatabaseAccountUpdateProperties properties to update Azure Cosmos DB database accounts.
type DatabaseAccountsClient struct {
BaseClient
}DatabaseAccountsClient is the azure Cosmos DB Database Service Resource Provider REST API
func NewDatabaseAccountsClient(subscriptionID string) DatabaseAccountsClient
NewDatabaseAccountsClient creates an instance of the DatabaseAccountsClient client.
func NewDatabaseAccountsClientWithBaseURI(baseURI string, subscriptionID string) DatabaseAccountsClient
NewDatabaseAccountsClientWithBaseURI creates an instance of the DatabaseAccountsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client DatabaseAccountsClient) CheckNameExists(ctx context.Context, accountName string) (result autorest.Response, err error)
CheckNameExists checks that the Azure Cosmos DB account name already exists. A valid account name may contain only lowercase letters, numbers, and the '-' character, and must be between 3 and 50 characters. Parameters: accountName - cosmos DB database account name.
func (client DatabaseAccountsClient) CheckNameExistsPreparer(ctx context.Context, accountName string) (*http.Request, error)
CheckNameExistsPreparer prepares the CheckNameExists request.
func (client DatabaseAccountsClient) CheckNameExistsResponder(resp *http.Response) (result autorest.Response, err error)
CheckNameExistsResponder handles the response to the CheckNameExists request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) CheckNameExistsSender(req *http.Request) (*http.Response, error)
CheckNameExistsSender sends the CheckNameExists request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, createUpdateParameters DatabaseAccountCreateUpdateParameters) (result DatabaseAccountsCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. createUpdateParameters - the parameters to provide for the current database account.
func (client DatabaseAccountsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, createUpdateParameters DatabaseAccountCreateUpdateParameters) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client DatabaseAccountsClient) CreateOrUpdateResponder(resp *http.Response) (result DatabaseAccountGetResults, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) CreateOrUpdateSender(req *http.Request) (future DatabaseAccountsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) Delete(ctx context.Context, resourceGroupName string, accountName string) (result DatabaseAccountsDeleteFuture, err error)
Delete deletes an existing Azure Cosmos DB database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name.
func (client DatabaseAccountsClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client DatabaseAccountsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) DeleteSender(req *http.Request) (future DatabaseAccountsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) FailoverPriorityChange(ctx context.Context, resourceGroupName string, accountName string, failoverParameters FailoverPolicies) (result DatabaseAccountsFailoverPriorityChangeFuture, err error)
FailoverPriorityChange changes the failover priority for the Azure Cosmos DB database account. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. failoverParameters - the new failover policies for the database account.
func (client DatabaseAccountsClient) FailoverPriorityChangePreparer(ctx context.Context, resourceGroupName string, accountName string, failoverParameters FailoverPolicies) (*http.Request, error)
FailoverPriorityChangePreparer prepares the FailoverPriorityChange request.
func (client DatabaseAccountsClient) FailoverPriorityChangeResponder(resp *http.Response) (result autorest.Response, err error)
FailoverPriorityChangeResponder handles the response to the FailoverPriorityChange request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) FailoverPriorityChangeSender(req *http.Request) (future DatabaseAccountsFailoverPriorityChangeFuture, err error)
FailoverPriorityChangeSender sends the FailoverPriorityChange request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) Get(ctx context.Context, resourceGroupName string, accountName string) (result DatabaseAccountGetResults, err error)
Get retrieves the properties of an existing Azure Cosmos DB database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name.
func (client DatabaseAccountsClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client DatabaseAccountsClient) GetReadOnlyKeys(ctx context.Context, resourceGroupName string, accountName string) (result DatabaseAccountListReadOnlyKeysResult, err error)
GetReadOnlyKeys lists the read-only access keys for the specified Azure Cosmos DB database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name.
func (client DatabaseAccountsClient) GetReadOnlyKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
GetReadOnlyKeysPreparer prepares the GetReadOnlyKeys request.
func (client DatabaseAccountsClient) GetReadOnlyKeysResponder(resp *http.Response) (result DatabaseAccountListReadOnlyKeysResult, err error)
GetReadOnlyKeysResponder handles the response to the GetReadOnlyKeys request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) GetReadOnlyKeysSender(req *http.Request) (*http.Response, error)
GetReadOnlyKeysSender sends the GetReadOnlyKeys request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) GetResponder(resp *http.Response) (result DatabaseAccountGetResults, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) List(ctx context.Context) (result DatabaseAccountsListResult, err error)
List lists all the Azure Cosmos DB database accounts available under the subscription.
func (client DatabaseAccountsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result DatabaseAccountsListResult, err error)
ListByResourceGroup lists all the Azure Cosmos DB database accounts available under the given resource group. Parameters: resourceGroupName - name of an Azure resource group.
func (client DatabaseAccountsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client DatabaseAccountsClient) ListByResourceGroupResponder(resp *http.Response) (result DatabaseAccountsListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) ListConnectionStrings(ctx context.Context, resourceGroupName string, accountName string) (result DatabaseAccountListConnectionStringsResult, err error)
ListConnectionStrings lists the connection strings for the specified Azure Cosmos DB database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name.
func (client DatabaseAccountsClient) ListConnectionStringsPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListConnectionStringsPreparer prepares the ListConnectionStrings request.
func (client DatabaseAccountsClient) ListConnectionStringsResponder(resp *http.Response) (result DatabaseAccountListConnectionStringsResult, err error)
ListConnectionStringsResponder handles the response to the ListConnectionStrings request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) ListConnectionStringsSender(req *http.Request) (*http.Response, error)
ListConnectionStringsSender sends the ListConnectionStrings request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) ListKeys(ctx context.Context, resourceGroupName string, accountName string) (result DatabaseAccountListKeysResult, err error)
ListKeys lists the access keys for the specified Azure Cosmos DB database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name.
func (client DatabaseAccountsClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListKeysPreparer prepares the ListKeys request.
func (client DatabaseAccountsClient) ListKeysResponder(resp *http.Response) (result DatabaseAccountListKeysResult, err error)
ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.
ListKeysSender sends the ListKeys request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) ListMetricDefinitions(ctx context.Context, resourceGroupName string, accountName string) (result MetricDefinitionsListResult, err error)
ListMetricDefinitions retrieves metric definitions for the given database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name.
func (client DatabaseAccountsClient) ListMetricDefinitionsPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListMetricDefinitionsPreparer prepares the ListMetricDefinitions request.
func (client DatabaseAccountsClient) ListMetricDefinitionsResponder(resp *http.Response) (result MetricDefinitionsListResult, err error)
ListMetricDefinitionsResponder handles the response to the ListMetricDefinitions request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) ListMetricDefinitionsSender(req *http.Request) (*http.Response, error)
ListMetricDefinitionsSender sends the ListMetricDefinitions request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, filter string) (result MetricListResult, err error)
ListMetrics retrieves the metrics determined by the given filter for the given database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. 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.
func (client DatabaseAccountsClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client DatabaseAccountsClient) ListMetricsResponder(resp *http.Response) (result MetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.
ListMetricsSender sends the ListMetrics request. The method will close the http.Response Body if it receives an error.
ListPreparer prepares the List request.
func (client DatabaseAccountsClient) ListReadOnlyKeys(ctx context.Context, resourceGroupName string, accountName string) (result DatabaseAccountListReadOnlyKeysResult, err error)
ListReadOnlyKeys lists the read-only access keys for the specified Azure Cosmos DB database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name.
func (client DatabaseAccountsClient) ListReadOnlyKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListReadOnlyKeysPreparer prepares the ListReadOnlyKeys request.
func (client DatabaseAccountsClient) ListReadOnlyKeysResponder(resp *http.Response) (result DatabaseAccountListReadOnlyKeysResult, err error)
ListReadOnlyKeysResponder handles the response to the ListReadOnlyKeys request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) ListReadOnlyKeysSender(req *http.Request) (*http.Response, error)
ListReadOnlyKeysSender sends the ListReadOnlyKeys request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) ListResponder(resp *http.Response) (result DatabaseAccountsListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) ListUsages(ctx context.Context, resourceGroupName string, accountName string, filter string) (result UsagesResult, err error)
ListUsages retrieves the usages (most recent data) for the given database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. 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).
func (client DatabaseAccountsClient) ListUsagesPreparer(ctx context.Context, resourceGroupName string, accountName string, filter string) (*http.Request, error)
ListUsagesPreparer prepares the ListUsages request.
func (client DatabaseAccountsClient) ListUsagesResponder(resp *http.Response) (result UsagesResult, err error)
ListUsagesResponder handles the response to the ListUsages request. The method always closes the http.Response Body.
ListUsagesSender sends the ListUsages request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) OfflineRegion(ctx context.Context, resourceGroupName string, accountName string, regionParameterForOffline RegionForOnlineOffline) (result DatabaseAccountsOfflineRegionFuture, err error)
OfflineRegion offline the specified region for the specified Azure Cosmos DB database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. regionParameterForOffline - cosmos DB region to offline for the database account.
func (client DatabaseAccountsClient) OfflineRegionPreparer(ctx context.Context, resourceGroupName string, accountName string, regionParameterForOffline RegionForOnlineOffline) (*http.Request, error)
OfflineRegionPreparer prepares the OfflineRegion request.
func (client DatabaseAccountsClient) OfflineRegionResponder(resp *http.Response) (result autorest.Response, err error)
OfflineRegionResponder handles the response to the OfflineRegion request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) OfflineRegionSender(req *http.Request) (future DatabaseAccountsOfflineRegionFuture, err error)
OfflineRegionSender sends the OfflineRegion request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) OnlineRegion(ctx context.Context, resourceGroupName string, accountName string, regionParameterForOnline RegionForOnlineOffline) (result DatabaseAccountsOnlineRegionFuture, err error)
OnlineRegion online the specified region for the specified Azure Cosmos DB database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. regionParameterForOnline - cosmos DB region to online for the database account.
func (client DatabaseAccountsClient) OnlineRegionPreparer(ctx context.Context, resourceGroupName string, accountName string, regionParameterForOnline RegionForOnlineOffline) (*http.Request, error)
OnlineRegionPreparer prepares the OnlineRegion request.
func (client DatabaseAccountsClient) OnlineRegionResponder(resp *http.Response) (result autorest.Response, err error)
OnlineRegionResponder handles the response to the OnlineRegion request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) OnlineRegionSender(req *http.Request) (future DatabaseAccountsOnlineRegionFuture, err error)
OnlineRegionSender sends the OnlineRegion request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) RegenerateKey(ctx context.Context, resourceGroupName string, accountName string, keyToRegenerate DatabaseAccountRegenerateKeyParameters) (result DatabaseAccountsRegenerateKeyFuture, err error)
RegenerateKey regenerates an access key for the specified Azure Cosmos DB database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. keyToRegenerate - the name of the key to regenerate.
func (client DatabaseAccountsClient) RegenerateKeyPreparer(ctx context.Context, resourceGroupName string, accountName string, keyToRegenerate DatabaseAccountRegenerateKeyParameters) (*http.Request, error)
RegenerateKeyPreparer prepares the RegenerateKey request.
func (client DatabaseAccountsClient) RegenerateKeyResponder(resp *http.Response) (result autorest.Response, err error)
RegenerateKeyResponder handles the response to the RegenerateKey request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) RegenerateKeySender(req *http.Request) (future DatabaseAccountsRegenerateKeyFuture, err error)
RegenerateKeySender sends the RegenerateKey request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) Update(ctx context.Context, resourceGroupName string, accountName string, updateParameters DatabaseAccountUpdateParameters) (result DatabaseAccountsUpdateFuture, err error)
Update updates the properties of an existing Azure Cosmos DB database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. updateParameters - the parameters to provide for the current database account.
func (client DatabaseAccountsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, updateParameters DatabaseAccountUpdateParameters) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client DatabaseAccountsClient) UpdateResponder(resp *http.Response) (result DatabaseAccountGetResults, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) UpdateSender(req *http.Request) (future DatabaseAccountsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type DatabaseAccountsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabaseAccountsClient) (DatabaseAccountGetResults, error)
}DatabaseAccountsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabaseAccountsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabaseAccountsClient) (autorest.Response, error)
}DatabaseAccountsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabaseAccountsFailoverPriorityChangeFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabaseAccountsClient) (autorest.Response, error)
}DatabaseAccountsFailoverPriorityChangeFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabaseAccountsListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of database account and their properties.
Value *[]DatabaseAccountGetResults `json:"value,omitempty"`
}DatabaseAccountsListResult the List operation response, that contains the database accounts and their properties.
type DatabaseAccountsOfflineRegionFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabaseAccountsClient) (autorest.Response, error)
}DatabaseAccountsOfflineRegionFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabaseAccountsOnlineRegionFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabaseAccountsClient) (autorest.Response, error)
}DatabaseAccountsOnlineRegionFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabaseAccountsRegenerateKeyFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabaseAccountsClient) (autorest.Response, error)
}DatabaseAccountsRegenerateKeyFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabaseAccountsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabaseAccountsClient) (DatabaseAccountGetResults, error)
}DatabaseAccountsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabaseClient struct {
BaseClient
}DatabaseClient is the azure Cosmos DB Database Service Resource Provider REST API
func NewDatabaseClient(subscriptionID string) DatabaseClient
NewDatabaseClient creates an instance of the DatabaseClient client.
func NewDatabaseClientWithBaseURI(baseURI string, subscriptionID string) DatabaseClient
NewDatabaseClientWithBaseURI creates an instance of the DatabaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client DatabaseClient) ListMetricDefinitions(ctx context.Context, resourceGroupName string, accountName string, databaseRid string) (result MetricDefinitionsListResult, err error)
ListMetricDefinitions 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.
func (client DatabaseClient) ListMetricDefinitionsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string) (*http.Request, error)
ListMetricDefinitionsPreparer prepares the ListMetricDefinitions request.
func (client DatabaseClient) ListMetricDefinitionsResponder(resp *http.Response) (result MetricDefinitionsListResult, err error)
ListMetricDefinitionsResponder handles the response to the ListMetricDefinitions request. The method always closes the http.Response Body.
func (client DatabaseClient) ListMetricDefinitionsSender(req *http.Request) (*http.Response, error)
ListMetricDefinitionsSender sends the ListMetricDefinitions request. The method will close the http.Response Body if it receives an error.
func (client DatabaseClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, filter string) (result MetricListResult, err error)
ListMetrics 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.
func (client DatabaseClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client DatabaseClient) ListMetricsResponder(resp *http.Response) (result MetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.
ListMetricsSender sends the ListMetrics request. The method will close the http.Response Body if it receives an error.
func (client DatabaseClient) ListUsages(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, filter string) (result UsagesResult, err error)
ListUsages 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).
func (client DatabaseClient) ListUsagesPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, filter string) (*http.Request, error)
ListUsagesPreparer prepares the ListUsages request.
func (client DatabaseClient) ListUsagesResponder(resp *http.Response) (result UsagesResult, err error)
ListUsagesResponder handles the response to the ListUsages request. The method always closes the http.Response Body.
ListUsagesSender sends the ListUsages request. The method will close the http.Response Body if it receives an error.
DefaultConsistencyLevel enumerates the values for default consistency level.
const (
// BoundedStaleness ...
BoundedStaleness DefaultConsistencyLevel = "BoundedStaleness"
// ConsistentPrefix ...
ConsistentPrefix DefaultConsistencyLevel = "ConsistentPrefix"
// Eventual ...
Eventual DefaultConsistencyLevel = "Eventual"
// Session ...
Session DefaultConsistencyLevel = "Session"
// Strong ...
Strong DefaultConsistencyLevel = "Strong"
)func PossibleDefaultConsistencyLevelValues() []DefaultConsistencyLevel
PossibleDefaultConsistencyLevelValues returns an array of possible values for the DefaultConsistencyLevel const type.
type ErrorResponse struct {
// Code - Error code.
Code *string `json:"code,omitempty"`
// Message - Error message indicating why the operation failed.
Message *string `json:"message,omitempty"`
}ErrorResponse error Response.
type ExcludedPath struct {
// Path - The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
Path *string `json:"path,omitempty"`
}ExcludedPath ...
type ExtendedResourceProperties struct {
// Rid - READ-ONLY; A system generated property. A unique identifier.
Rid *string `json:"_rid,omitempty"`
// Ts - READ-ONLY; A system generated property that denotes the last updated timestamp of the resource.
Ts interface{} `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}ExtendedResourceProperties the system generated resource properties associated with SQL databases, SQL containers, Gremlin databases and Gremlin graphs.
type FailoverPolicies struct {
// FailoverPolicies - List of failover policies.
FailoverPolicies *[]FailoverPolicy `json:"failoverPolicies,omitempty"`
}FailoverPolicies the list of new failover policies for the failover priority change.
type FailoverPolicy struct {
// ID - READ-ONLY; The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.
ID *string `json:"id,omitempty"`
// LocationName - The name of the region in which the database account exists.
LocationName *string `json:"locationName,omitempty"`
// FailoverPriority - The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
FailoverPriority *int32 `json:"failoverPriority,omitempty"`
}FailoverPolicy the failover policy for a given region of a database account.
func (fp FailoverPolicy) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FailoverPolicy.
type GremlinDatabaseCreateUpdateParameters struct {
// GremlinDatabaseCreateUpdateProperties - Properties to create and update Azure Cosmos DB Gremlin database.
*GremlinDatabaseCreateUpdateProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The unique resource identifier of the ARM resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags map[string]*string `json:"tags"`
}GremlinDatabaseCreateUpdateParameters parameters to create and update Cosmos DB Gremlin database.
func (gdcup GremlinDatabaseCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GremlinDatabaseCreateUpdateParameters.
func (gdcup *GremlinDatabaseCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GremlinDatabaseCreateUpdateParameters struct.
type GremlinDatabaseCreateUpdateProperties struct {
// Resource - The standard JSON format of a Gremlin database
Resource *GremlinDatabaseResource `json:"resource,omitempty"`
// Options - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
Options map[string]*string `json:"options"`
}GremlinDatabaseCreateUpdateProperties properties to create and update Azure Cosmos DB Gremlin database.
func (gdcup GremlinDatabaseCreateUpdateProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GremlinDatabaseCreateUpdateProperties.
type GremlinDatabaseGetProperties struct {
Resource *GremlinDatabaseGetPropertiesResource `json:"resource,omitempty"`
}GremlinDatabaseGetProperties the properties of an Azure Cosmos DB SQL database
type GremlinDatabaseGetPropertiesResource struct {
// ID - Name of the Cosmos DB Gremlin database
ID *string `json:"id,omitempty"`
// Rid - READ-ONLY; A system generated property. A unique identifier.
Rid *string `json:"_rid,omitempty"`
// Ts - READ-ONLY; A system generated property that denotes the last updated timestamp of the resource.
Ts interface{} `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}GremlinDatabaseGetPropertiesResource ...
func (gdgp GremlinDatabaseGetPropertiesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GremlinDatabaseGetPropertiesResource.
type GremlinDatabaseGetResults struct {
autorest.Response `json:"-"`
// GremlinDatabaseGetProperties - The properties of an Azure Cosmos DB SQL database
*GremlinDatabaseGetProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The unique resource identifier of the ARM resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags map[string]*string `json:"tags"`
}GremlinDatabaseGetResults an Azure Cosmos DB Gremlin database.
func (gdgr GremlinDatabaseGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GremlinDatabaseGetResults.
func (gdgr *GremlinDatabaseGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GremlinDatabaseGetResults struct.
type GremlinDatabaseListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of Gremlin databases and their properties.
Value *[]GremlinDatabaseGetResults `json:"value,omitempty"`
}GremlinDatabaseListResult the List operation response, that contains the Gremlin databases and their properties.
type GremlinDatabaseResource struct {
// ID - Name of the Cosmos DB Gremlin database
ID *string `json:"id,omitempty"`
}GremlinDatabaseResource cosmos DB Gremlin database resource object
type GremlinGraphCreateUpdateParameters struct {
// GremlinGraphCreateUpdateProperties - Properties to create and update Azure Cosmos DB Gremlin graph.
*GremlinGraphCreateUpdateProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The unique resource identifier of the ARM resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags map[string]*string `json:"tags"`
}GremlinGraphCreateUpdateParameters parameters to create and update Cosmos DB Gremlin graph.
func (ggcup GremlinGraphCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GremlinGraphCreateUpdateParameters.
func (ggcup *GremlinGraphCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GremlinGraphCreateUpdateParameters struct.
type GremlinGraphCreateUpdateProperties struct {
// Resource - The standard JSON format of a Gremlin graph
Resource *GremlinGraphResource `json:"resource,omitempty"`
// Options - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
Options map[string]*string `json:"options"`
}GremlinGraphCreateUpdateProperties properties to create and update Azure Cosmos DB Gremlin graph.
func (ggcup GremlinGraphCreateUpdateProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GremlinGraphCreateUpdateProperties.
type GremlinGraphGetProperties struct {
Resource *GremlinGraphGetPropertiesResource `json:"resource,omitempty"`
}GremlinGraphGetProperties the properties of an Azure Cosmos DB Gremlin graph
type GremlinGraphGetPropertiesResource struct {
// ID - Name of the Cosmos DB Gremlin graph
ID *string `json:"id,omitempty"`
// IndexingPolicy - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
IndexingPolicy *IndexingPolicy `json:"indexingPolicy,omitempty"`
// PartitionKey - The configuration of the partition key to be used for partitioning data into multiple partitions
PartitionKey *ContainerPartitionKey `json:"partitionKey,omitempty"`
// DefaultTTL - Default time to live
DefaultTTL *int32 `json:"defaultTtl,omitempty"`
// UniqueKeyPolicy - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
UniqueKeyPolicy *UniqueKeyPolicy `json:"uniqueKeyPolicy,omitempty"`
// ConflictResolutionPolicy - The conflict resolution policy for the graph.
ConflictResolutionPolicy *ConflictResolutionPolicy `json:"conflictResolutionPolicy,omitempty"`
// Rid - READ-ONLY; A system generated property. A unique identifier.
Rid *string `json:"_rid,omitempty"`
// Ts - READ-ONLY; A system generated property that denotes the last updated timestamp of the resource.
Ts interface{} `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}GremlinGraphGetPropertiesResource ...
func (gggp GremlinGraphGetPropertiesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GremlinGraphGetPropertiesResource.
type GremlinGraphGetResults struct {
autorest.Response `json:"-"`
// GremlinGraphGetProperties - The properties of an Azure Cosmos DB Gremlin graph
*GremlinGraphGetProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The unique resource identifier of the ARM resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags map[string]*string `json:"tags"`
}GremlinGraphGetResults an Azure Cosmos DB Gremlin graph.
func (gggr GremlinGraphGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GremlinGraphGetResults.
func (gggr *GremlinGraphGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GremlinGraphGetResults struct.
type GremlinGraphListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of graphs and their properties.
Value *[]GremlinGraphGetResults `json:"value,omitempty"`
}GremlinGraphListResult the List operation response, that contains the graphs and their properties.
type GremlinGraphResource struct {
// ID - Name of the Cosmos DB Gremlin graph
ID *string `json:"id,omitempty"`
// IndexingPolicy - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
IndexingPolicy *IndexingPolicy `json:"indexingPolicy,omitempty"`
// PartitionKey - The configuration of the partition key to be used for partitioning data into multiple partitions
PartitionKey *ContainerPartitionKey `json:"partitionKey,omitempty"`
// DefaultTTL - Default time to live
DefaultTTL *int32 `json:"defaultTtl,omitempty"`
// UniqueKeyPolicy - The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
UniqueKeyPolicy *UniqueKeyPolicy `json:"uniqueKeyPolicy,omitempty"`
// ConflictResolutionPolicy - The conflict resolution policy for the graph.
ConflictResolutionPolicy *ConflictResolutionPolicy `json:"conflictResolutionPolicy,omitempty"`
}GremlinGraphResource cosmos DB Gremlin graph resource object
type GremlinResourcesClient struct {
BaseClient
}GremlinResourcesClient is the azure Cosmos DB Database Service Resource Provider REST API
func NewGremlinResourcesClient(subscriptionID string) GremlinResourcesClient
NewGremlinResourcesClient creates an instance of the GremlinResourcesClient client.
func NewGremlinResourcesClientWithBaseURI(baseURI string, subscriptionID string) GremlinResourcesClient
NewGremlinResourcesClientWithBaseURI creates an instance of the GremlinResourcesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client GremlinResourcesClient) CreateUpdateGremlinDatabase(ctx context.Context, resourceGroupName string, accountName string, databaseName string, createUpdateGremlinDatabaseParameters GremlinDatabaseCreateUpdateParameters) (result GremlinResourcesCreateUpdateGremlinDatabaseFuture, err error)
CreateUpdateGremlinDatabase create or update an Azure Cosmos DB Gremlin database Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name. createUpdateGremlinDatabaseParameters - the parameters to provide for the current Gremlin database.
func (client GremlinResourcesClient) CreateUpdateGremlinDatabasePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, createUpdateGremlinDatabaseParameters GremlinDatabaseCreateUpdateParameters) (*http.Request, error)
CreateUpdateGremlinDatabasePreparer prepares the CreateUpdateGremlinDatabase request.
func (client GremlinResourcesClient) CreateUpdateGremlinDatabaseResponder(resp *http.Response) (result GremlinDatabaseGetResults, err error)
CreateUpdateGremlinDatabaseResponder handles the response to the CreateUpdateGremlinDatabase request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) CreateUpdateGremlinDatabaseSender(req *http.Request) (future GremlinResourcesCreateUpdateGremlinDatabaseFuture, err error)
CreateUpdateGremlinDatabaseSender sends the CreateUpdateGremlinDatabase request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) CreateUpdateGremlinGraph(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string, createUpdateGremlinGraphParameters GremlinGraphCreateUpdateParameters) (result GremlinResourcesCreateUpdateGremlinGraphFuture, err error)
CreateUpdateGremlinGraph create or update an Azure Cosmos DB Gremlin graph Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name. graphName - cosmos DB graph name. createUpdateGremlinGraphParameters - the parameters to provide for the current Gremlin graph.
func (client GremlinResourcesClient) CreateUpdateGremlinGraphPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string, createUpdateGremlinGraphParameters GremlinGraphCreateUpdateParameters) (*http.Request, error)
CreateUpdateGremlinGraphPreparer prepares the CreateUpdateGremlinGraph request.
func (client GremlinResourcesClient) CreateUpdateGremlinGraphResponder(resp *http.Response) (result GremlinGraphGetResults, err error)
CreateUpdateGremlinGraphResponder handles the response to the CreateUpdateGremlinGraph request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) CreateUpdateGremlinGraphSender(req *http.Request) (future GremlinResourcesCreateUpdateGremlinGraphFuture, err error)
CreateUpdateGremlinGraphSender sends the CreateUpdateGremlinGraph request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) DeleteGremlinDatabase(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result GremlinResourcesDeleteGremlinDatabaseFuture, err error)
DeleteGremlinDatabase deletes an existing Azure Cosmos DB Gremlin database. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name.
func (client GremlinResourcesClient) DeleteGremlinDatabasePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
DeleteGremlinDatabasePreparer prepares the DeleteGremlinDatabase request.
func (client GremlinResourcesClient) DeleteGremlinDatabaseResponder(resp *http.Response) (result autorest.Response, err error)
DeleteGremlinDatabaseResponder handles the response to the DeleteGremlinDatabase request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) DeleteGremlinDatabaseSender(req *http.Request) (future GremlinResourcesDeleteGremlinDatabaseFuture, err error)
DeleteGremlinDatabaseSender sends the DeleteGremlinDatabase request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) DeleteGremlinGraph(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string) (result GremlinResourcesDeleteGremlinGraphFuture, err error)
DeleteGremlinGraph deletes an existing Azure Cosmos DB Gremlin graph. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name. graphName - cosmos DB graph name.
func (client GremlinResourcesClient) DeleteGremlinGraphPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string) (*http.Request, error)
DeleteGremlinGraphPreparer prepares the DeleteGremlinGraph request.
func (client GremlinResourcesClient) DeleteGremlinGraphResponder(resp *http.Response) (result autorest.Response, err error)
DeleteGremlinGraphResponder handles the response to the DeleteGremlinGraph request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) DeleteGremlinGraphSender(req *http.Request) (future GremlinResourcesDeleteGremlinGraphFuture, err error)
DeleteGremlinGraphSender sends the DeleteGremlinGraph request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) GetGremlinDatabase(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result GremlinDatabaseGetResults, err error)
GetGremlinDatabase gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name.
func (client GremlinResourcesClient) GetGremlinDatabasePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
GetGremlinDatabasePreparer prepares the GetGremlinDatabase request.
func (client GremlinResourcesClient) GetGremlinDatabaseResponder(resp *http.Response) (result GremlinDatabaseGetResults, err error)
GetGremlinDatabaseResponder handles the response to the GetGremlinDatabase request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) GetGremlinDatabaseSender(req *http.Request) (*http.Response, error)
GetGremlinDatabaseSender sends the GetGremlinDatabase request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) GetGremlinDatabaseThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result ThroughputSettingsGetResults, err error)
GetGremlinDatabaseThroughput gets the RUs per second of the Gremlin database under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name.
func (client GremlinResourcesClient) GetGremlinDatabaseThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
GetGremlinDatabaseThroughputPreparer prepares the GetGremlinDatabaseThroughput request.
func (client GremlinResourcesClient) GetGremlinDatabaseThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
GetGremlinDatabaseThroughputResponder handles the response to the GetGremlinDatabaseThroughput request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) GetGremlinDatabaseThroughputSender(req *http.Request) (*http.Response, error)
GetGremlinDatabaseThroughputSender sends the GetGremlinDatabaseThroughput request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) GetGremlinGraph(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string) (result GremlinGraphGetResults, err error)
GetGremlinGraph gets the Gremlin graph under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name. graphName - cosmos DB graph name.
func (client GremlinResourcesClient) GetGremlinGraphPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string) (*http.Request, error)
GetGremlinGraphPreparer prepares the GetGremlinGraph request.
func (client GremlinResourcesClient) GetGremlinGraphResponder(resp *http.Response) (result GremlinGraphGetResults, err error)
GetGremlinGraphResponder handles the response to the GetGremlinGraph request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) GetGremlinGraphSender(req *http.Request) (*http.Response, error)
GetGremlinGraphSender sends the GetGremlinGraph request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) GetGremlinGraphThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string) (result ThroughputSettingsGetResults, err error)
GetGremlinGraphThroughput gets the Gremlin graph throughput under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name. graphName - cosmos DB graph name.
func (client GremlinResourcesClient) GetGremlinGraphThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string) (*http.Request, error)
GetGremlinGraphThroughputPreparer prepares the GetGremlinGraphThroughput request.
func (client GremlinResourcesClient) GetGremlinGraphThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
GetGremlinGraphThroughputResponder handles the response to the GetGremlinGraphThroughput request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) GetGremlinGraphThroughputSender(req *http.Request) (*http.Response, error)
GetGremlinGraphThroughputSender sends the GetGremlinGraphThroughput request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) ListGremlinDatabases(ctx context.Context, resourceGroupName string, accountName string) (result GremlinDatabaseListResult, err error)
ListGremlinDatabases lists the Gremlin databases under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name.
func (client GremlinResourcesClient) ListGremlinDatabasesPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListGremlinDatabasesPreparer prepares the ListGremlinDatabases request.
func (client GremlinResourcesClient) ListGremlinDatabasesResponder(resp *http.Response) (result GremlinDatabaseListResult, err error)
ListGremlinDatabasesResponder handles the response to the ListGremlinDatabases request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) ListGremlinDatabasesSender(req *http.Request) (*http.Response, error)
ListGremlinDatabasesSender sends the ListGremlinDatabases request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) ListGremlinGraphs(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result GremlinGraphListResult, err error)
ListGremlinGraphs lists the Gremlin graph under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name.
func (client GremlinResourcesClient) ListGremlinGraphsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
ListGremlinGraphsPreparer prepares the ListGremlinGraphs request.
func (client GremlinResourcesClient) ListGremlinGraphsResponder(resp *http.Response) (result GremlinGraphListResult, err error)
ListGremlinGraphsResponder handles the response to the ListGremlinGraphs request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) ListGremlinGraphsSender(req *http.Request) (*http.Response, error)
ListGremlinGraphsSender sends the ListGremlinGraphs request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) UpdateGremlinDatabaseThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (result GremlinResourcesUpdateGremlinDatabaseThroughputFuture, err error)
UpdateGremlinDatabaseThroughput update RUs per second of an Azure Cosmos DB Gremlin database Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name. updateThroughputParameters - the RUs per second of the parameters to provide for the current Gremlin database.
func (client GremlinResourcesClient) UpdateGremlinDatabaseThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)
UpdateGremlinDatabaseThroughputPreparer prepares the UpdateGremlinDatabaseThroughput request.
func (client GremlinResourcesClient) UpdateGremlinDatabaseThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
UpdateGremlinDatabaseThroughputResponder handles the response to the UpdateGremlinDatabaseThroughput request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) UpdateGremlinDatabaseThroughputSender(req *http.Request) (future GremlinResourcesUpdateGremlinDatabaseThroughputFuture, err error)
UpdateGremlinDatabaseThroughputSender sends the UpdateGremlinDatabaseThroughput request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) UpdateGremlinGraphThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (result GremlinResourcesUpdateGremlinGraphThroughputFuture, err error)
UpdateGremlinGraphThroughput update RUs per second of an Azure Cosmos DB Gremlin graph Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name. graphName - cosmos DB graph name. updateThroughputParameters - the RUs per second of the parameters to provide for the current Gremlin graph.
func (client GremlinResourcesClient) UpdateGremlinGraphThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)
UpdateGremlinGraphThroughputPreparer prepares the UpdateGremlinGraphThroughput request.
func (client GremlinResourcesClient) UpdateGremlinGraphThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
UpdateGremlinGraphThroughputResponder handles the response to the UpdateGremlinGraphThroughput request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) UpdateGremlinGraphThroughputSender(req *http.Request) (future GremlinResourcesUpdateGremlinGraphThroughputFuture, err error)
UpdateGremlinGraphThroughputSender sends the UpdateGremlinGraphThroughput request. The method will close the http.Response Body if it receives an error.
type GremlinResourcesCreateUpdateGremlinDatabaseFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GremlinResourcesClient) (GremlinDatabaseGetResults, error)
}GremlinResourcesCreateUpdateGremlinDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GremlinResourcesCreateUpdateGremlinGraphFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GremlinResourcesClient) (GremlinGraphGetResults, error)
}GremlinResourcesCreateUpdateGremlinGraphFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GremlinResourcesDeleteGremlinDatabaseFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GremlinResourcesClient) (autorest.Response, error)
}GremlinResourcesDeleteGremlinDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GremlinResourcesDeleteGremlinGraphFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GremlinResourcesClient) (autorest.Response, error)
}GremlinResourcesDeleteGremlinGraphFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GremlinResourcesUpdateGremlinDatabaseThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GremlinResourcesClient) (ThroughputSettingsGetResults, error)
}GremlinResourcesUpdateGremlinDatabaseThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GremlinResourcesUpdateGremlinGraphThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GremlinResourcesClient) (ThroughputSettingsGetResults, error)
}GremlinResourcesUpdateGremlinGraphThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type IncludedPath struct {
// Path - The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
Path *string `json:"path,omitempty"`
// Indexes - List of indexes for this path
Indexes *[]Indexes `json:"indexes,omitempty"`
}IncludedPath the paths that are included in indexing
IndexKind enumerates the values for index kind.
const (
// Hash ...
Hash IndexKind = "Hash"
// Range ...
Range IndexKind = "Range"
// Spatial ...
Spatial IndexKind = "Spatial"
)PossibleIndexKindValues returns an array of possible values for the IndexKind const type.
type Indexes struct {
// DataType - The datatype for which the indexing behavior is applied to. Possible values include: 'String', 'Number', 'Point', 'Polygon', 'LineString', 'MultiPolygon'
DataType DataType `json:"dataType,omitempty"`
// Precision - The precision of the index. -1 is maximum precision.
Precision *int32 `json:"precision,omitempty"`
// Kind - Indicates the type of index. Possible values include: 'Hash', 'Range', 'Spatial'
Kind IndexKind `json:"kind,omitempty"`
}Indexes the indexes for the path.
IndexingMode enumerates the values for indexing mode.
const (
// Consistent ...
Consistent IndexingMode = "Consistent"
// Lazy ...
Lazy IndexingMode = "Lazy"
// None ...
None IndexingMode = "None"
)func PossibleIndexingModeValues() []IndexingMode
PossibleIndexingModeValues returns an array of possible values for the IndexingMode const type.
type IndexingPolicy struct {
// Automatic - Indicates if the indexing policy is automatic
Automatic *bool `json:"automatic,omitempty"`
// IndexingMode - Indicates the indexing mode. Possible values include: 'Consistent', 'Lazy', 'None'
IndexingMode IndexingMode `json:"indexingMode,omitempty"`
// IncludedPaths - List of paths to include in the indexing
IncludedPaths *[]IncludedPath `json:"includedPaths,omitempty"`
// ExcludedPaths - List of paths to exclude from indexing
ExcludedPaths *[]ExcludedPath `json:"excludedPaths,omitempty"`
// CompositeIndexes - List of composite path list
CompositeIndexes *[][]CompositePath `json:"compositeIndexes,omitempty"`
// SpatialIndexes - List of spatial specifics
SpatialIndexes *[]SpatialSpec `json:"spatialIndexes,omitempty"`
}IndexingPolicy cosmos DB indexing policy
KeyKind enumerates the values for key kind.
const (
// Primary ...
Primary KeyKind = "primary"
// PrimaryReadonly ...
PrimaryReadonly KeyKind = "primaryReadonly"
// Secondary ...
Secondary KeyKind = "secondary"
// SecondaryReadonly ...
SecondaryReadonly KeyKind = "secondaryReadonly"
)PossibleKeyKindValues returns an array of possible values for the KeyKind const type.
type Location struct {
// ID - READ-ONLY; The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
ID *string `json:"id,omitempty"`
// LocationName - The name of the region.
LocationName *string `json:"locationName,omitempty"`
// DocumentEndpoint - READ-ONLY; The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/
DocumentEndpoint *string `json:"documentEndpoint,omitempty"`
ProvisioningState *string `json:"provisioningState,omitempty"`
// FailoverPriority - The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
FailoverPriority *int32 `json:"failoverPriority,omitempty"`
// IsZoneRedundant - Flag to indicate whether or not this region is an AvailabilityZone region
IsZoneRedundant *bool `json:"isZoneRedundant,omitempty"`
}Location a region in which the Azure Cosmos DB database account is deployed.
MarshalJSON is the custom marshaler for Location.
type Metric struct {
// StartTime - READ-ONLY; The start time for the metric (ISO-8601 format).
StartTime *date.Time `json:"startTime,omitempty"`
// EndTime - READ-ONLY; The end time for the metric (ISO-8601 format).
EndTime *date.Time `json:"endTime,omitempty"`
// TimeGrain - READ-ONLY; The time grain to be used to summarize the metric values.
TimeGrain *string `json:"timeGrain,omitempty"`
// Unit - The unit of the metric. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond', 'Milliseconds'
Unit UnitType `json:"unit,omitempty"`
// Name - READ-ONLY; The name information for the metric.
Name *MetricName `json:"name,omitempty"`
// MetricValues - READ-ONLY; The metric values for the specified time window and timestep.
MetricValues *[]MetricValue `json:"metricValues,omitempty"`
}Metric metric data
MarshalJSON is the custom marshaler for Metric.
type MetricAvailability struct {
// TimeGrain - READ-ONLY; The time grain to be used to summarize the metric values.
TimeGrain *string `json:"timeGrain,omitempty"`
// Retention - READ-ONLY; The retention for the metric values.
Retention *string `json:"retention,omitempty"`
}MetricAvailability the availability of the metric.
type MetricDefinition struct {
// MetricAvailabilities - READ-ONLY; The list of metric availabilities for the account.
MetricAvailabilities *[]MetricAvailability `json:"metricAvailabilities,omitempty"`
// PrimaryAggregationType - READ-ONLY; The primary aggregation type of the metric. Possible values include: 'PrimaryAggregationTypeNone', 'PrimaryAggregationTypeAverage', 'PrimaryAggregationTypeTotal', 'PrimaryAggregationTypeMinimum', 'PrimaryAggregationTypeMaximum', 'PrimaryAggregationTypeLast'
PrimaryAggregationType PrimaryAggregationType `json:"primaryAggregationType,omitempty"`
// Unit - The unit of the metric. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond', 'Milliseconds'
Unit UnitType `json:"unit,omitempty"`
// ResourceURI - READ-ONLY; The resource uri of the database.
ResourceURI *string `json:"resourceUri,omitempty"`
// Name - READ-ONLY; The name information for the metric.
Name *MetricName `json:"name,omitempty"`
}MetricDefinition the definition of a metric.
func (md MetricDefinition) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MetricDefinition.
type MetricDefinitionsListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; The list of metric definitions for the account.
Value *[]MetricDefinition `json:"value,omitempty"`
}MetricDefinitionsListResult the response to a list metric definitions request.
type MetricListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; The list of metrics for the account.
Value *[]Metric `json:"value,omitempty"`
}MetricListResult the response to a list metrics request.
type MetricName struct {
// Value - READ-ONLY; The name of the metric.
Value *string `json:"value,omitempty"`
// LocalizedValue - READ-ONLY; The friendly name of the metric.
LocalizedValue *string `json:"localizedValue,omitempty"`
}MetricName a metric name.
type MetricValue struct {
// Count - READ-ONLY; The number of values for the metric.
Count *float64 `json:"_count,omitempty"`
// Average - READ-ONLY; The average value of the metric.
Average *float64 `json:"average,omitempty"`
// Maximum - READ-ONLY; The max value of the metric.
Maximum *float64 `json:"maximum,omitempty"`
// Minimum - READ-ONLY; The min value of the metric.
Minimum *float64 `json:"minimum,omitempty"`
// Timestamp - READ-ONLY; The metric timestamp (ISO-8601 format).
Timestamp *date.Time `json:"timestamp,omitempty"`
// Total - READ-ONLY; The total value of the metric.
Total *float64 `json:"total,omitempty"`
}MetricValue represents metrics values.
type MongoDBCollectionCreateUpdateParameters struct {
// MongoDBCollectionCreateUpdateProperties - Properties to create and update Azure Cosmos DB MongoDB collection.
*MongoDBCollectionCreateUpdateProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The unique resource identifier of the ARM resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags map[string]*string `json:"tags"`
}MongoDBCollectionCreateUpdateParameters parameters to create and update Cosmos DB MongoDB collection.
func (mdccup MongoDBCollectionCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MongoDBCollectionCreateUpdateParameters.
func (mdccup *MongoDBCollectionCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for MongoDBCollectionCreateUpdateParameters struct.
type MongoDBCollectionCreateUpdateProperties struct {
// Resource - The standard JSON format of a MongoDB collection
Resource *MongoDBCollectionResource `json:"resource,omitempty"`
// Options - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
Options map[string]*string `json:"options"`
}MongoDBCollectionCreateUpdateProperties properties to create and update Azure Cosmos DB MongoDB collection.
func (mdccup MongoDBCollectionCreateUpdateProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MongoDBCollectionCreateUpdateProperties.
type MongoDBCollectionGetProperties struct {
Resource *MongoDBCollectionGetPropertiesResource `json:"resource,omitempty"`
}MongoDBCollectionGetProperties the properties of an Azure Cosmos DB MongoDB collection
type MongoDBCollectionGetPropertiesResource struct {
// ID - Name of the Cosmos DB MongoDB collection
ID *string `json:"id,omitempty"`
// ShardKey - A key-value pair of shard keys to be applied for the request.
ShardKey map[string]*string `json:"shardKey"`
// Indexes - List of index keys
Indexes *[]MongoIndex `json:"indexes,omitempty"`
// Rid - READ-ONLY; A system generated property. A unique identifier.
Rid *string `json:"_rid,omitempty"`
// Ts - READ-ONLY; A system generated property that denotes the last updated timestamp of the resource.
Ts interface{} `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}MongoDBCollectionGetPropertiesResource ...
func (mdcgp MongoDBCollectionGetPropertiesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MongoDBCollectionGetPropertiesResource.
type MongoDBCollectionGetResults struct {
autorest.Response `json:"-"`
// MongoDBCollectionGetProperties - The properties of an Azure Cosmos DB MongoDB collection
*MongoDBCollectionGetProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The unique resource identifier of the ARM resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags map[string]*string `json:"tags"`
}MongoDBCollectionGetResults an Azure Cosmos DB MongoDB collection.
func (mdcgr MongoDBCollectionGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MongoDBCollectionGetResults.
func (mdcgr *MongoDBCollectionGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for MongoDBCollectionGetResults struct.
type MongoDBCollectionListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of MongoDB collections and their properties.
Value *[]MongoDBCollectionGetResults `json:"value,omitempty"`
}MongoDBCollectionListResult the List operation response, that contains the MongoDB collections and their properties.
type MongoDBCollectionResource struct {
// ID - Name of the Cosmos DB MongoDB collection
ID *string `json:"id,omitempty"`
// ShardKey - A key-value pair of shard keys to be applied for the request.
ShardKey map[string]*string `json:"shardKey"`
// Indexes - List of index keys
Indexes *[]MongoIndex `json:"indexes,omitempty"`
}MongoDBCollectionResource cosmos DB MongoDB collection resource object
func (mdcr MongoDBCollectionResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MongoDBCollectionResource.
type MongoDBDatabaseCreateUpdateParameters struct {
// MongoDBDatabaseCreateUpdateProperties - Properties to create and update Azure Cosmos DB MongoDB database.
*MongoDBDatabaseCreateUpdateProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The unique resource identifier of the ARM resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags map[string]*string `json:"tags"`
}MongoDBDatabaseCreateUpdateParameters parameters to create and update Cosmos DB MongoDB database.
func (mddcup MongoDBDatabaseCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MongoDBDatabaseCreateUpdateParameters.
func (mddcup *MongoDBDatabaseCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for MongoDBDatabaseCreateUpdateParameters struct.
type MongoDBDatabaseCreateUpdateProperties struct {
// Resource - The standard JSON format of a MongoDB database
Resource *MongoDBDatabaseResource `json:"resource,omitempty"`
// Options - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
Options map[string]*string `json:"options"`
}MongoDBDatabaseCreateUpdateProperties properties to create and update Azure Cosmos DB MongoDB database.
func (mddcup MongoDBDatabaseCreateUpdateProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MongoDBDatabaseCreateUpdateProperties.
type MongoDBDatabaseGetProperties struct {
Resource *MongoDBDatabaseGetPropertiesResource `json:"resource,omitempty"`
}MongoDBDatabaseGetProperties the properties of an Azure Cosmos DB MongoDB database
type MongoDBDatabaseGetPropertiesResource struct {
// ID - Name of the Cosmos DB MongoDB database
ID *string `json:"id,omitempty"`
// Rid - READ-ONLY; A system generated property. A unique identifier.
Rid *string `json:"_rid,omitempty"`
// Ts - READ-ONLY; A system generated property that denotes the last updated timestamp of the resource.
Ts interface{} `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}MongoDBDatabaseGetPropertiesResource ...
func (mddgp MongoDBDatabaseGetPropertiesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MongoDBDatabaseGetPropertiesResource.
type MongoDBDatabaseGetResults struct {
autorest.Response `json:"-"`
// MongoDBDatabaseGetProperties - The properties of an Azure Cosmos DB MongoDB database
*MongoDBDatabaseGetProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The unique resource identifier of the ARM resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags map[string]*string `json:"tags"`
}MongoDBDatabaseGetResults an Azure Cosmos DB MongoDB database.
func (mddgr MongoDBDatabaseGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MongoDBDatabaseGetResults.
func (mddgr *MongoDBDatabaseGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for MongoDBDatabaseGetResults struct.
type MongoDBDatabaseListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of MongoDB databases and their properties.
Value *[]MongoDBDatabaseGetResults `json:"value,omitempty"`
}MongoDBDatabaseListResult the List operation response, that contains the MongoDB databases and their properties.
type MongoDBDatabaseResource struct {
// ID - Name of the Cosmos DB MongoDB database
ID *string `json:"id,omitempty"`
}MongoDBDatabaseResource cosmos DB MongoDB database resource object
type MongoDBResourcesClient struct {
BaseClient
}MongoDBResourcesClient is the azure Cosmos DB Database Service Resource Provider REST API
func NewMongoDBResourcesClient(subscriptionID string) MongoDBResourcesClient
NewMongoDBResourcesClient creates an instance of the MongoDBResourcesClient client.
func NewMongoDBResourcesClientWithBaseURI(baseURI string, subscriptionID string) MongoDBResourcesClient
NewMongoDBResourcesClientWithBaseURI creates an instance of the MongoDBResourcesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client MongoDBResourcesClient) CreateUpdateMongoDBCollection(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string, createUpdateMongoDBCollectionParameters MongoDBCollectionCreateUpdateParameters) (result MongoDBResourcesCreateUpdateMongoDBCollectionFuture, err error)
CreateUpdateMongoDBCollection create or update an Azure Cosmos DB MongoDB Collection Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name. collectionName - cosmos DB collection name. createUpdateMongoDBCollectionParameters - the parameters to provide for the current MongoDB Collection.
func (client MongoDBResourcesClient) CreateUpdateMongoDBCollectionPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string, createUpdateMongoDBCollectionParameters MongoDBCollectionCreateUpdateParameters) (*http.Request, error)
CreateUpdateMongoDBCollectionPreparer prepares the CreateUpdateMongoDBCollection request.
func (client MongoDBResourcesClient) CreateUpdateMongoDBCollectionResponder(resp *http.Response) (result MongoDBCollectionGetResults, err error)
CreateUpdateMongoDBCollectionResponder handles the response to the CreateUpdateMongoDBCollection request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) CreateUpdateMongoDBCollectionSender(req *http.Request) (future MongoDBResourcesCreateUpdateMongoDBCollectionFuture, err error)
CreateUpdateMongoDBCollectionSender sends the CreateUpdateMongoDBCollection request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) CreateUpdateMongoDBDatabase(ctx context.Context, resourceGroupName string, accountName string, databaseName string, createUpdateMongoDBDatabaseParameters MongoDBDatabaseCreateUpdateParameters) (result MongoDBResourcesCreateUpdateMongoDBDatabaseFuture, err error)
CreateUpdateMongoDBDatabase create or updates Azure Cosmos DB MongoDB database Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name. createUpdateMongoDBDatabaseParameters - the parameters to provide for the current MongoDB database.
func (client MongoDBResourcesClient) CreateUpdateMongoDBDatabasePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, createUpdateMongoDBDatabaseParameters MongoDBDatabaseCreateUpdateParameters) (*http.Request, error)
CreateUpdateMongoDBDatabasePreparer prepares the CreateUpdateMongoDBDatabase request.
func (client MongoDBResourcesClient) CreateUpdateMongoDBDatabaseResponder(resp *http.Response) (result MongoDBDatabaseGetResults, err error)
CreateUpdateMongoDBDatabaseResponder handles the response to the CreateUpdateMongoDBDatabase request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) CreateUpdateMongoDBDatabaseSender(req *http.Request) (future MongoDBResourcesCreateUpdateMongoDBDatabaseFuture, err error)
CreateUpdateMongoDBDatabaseSender sends the CreateUpdateMongoDBDatabase request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) DeleteMongoDBCollection(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (result MongoDBResourcesDeleteMongoDBCollectionFuture, err error)
DeleteMongoDBCollection deletes an existing Azure Cosmos DB MongoDB Collection. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name. collectionName - cosmos DB collection name.
func (client MongoDBResourcesClient) DeleteMongoDBCollectionPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (*http.Request, error)
DeleteMongoDBCollectionPreparer prepares the DeleteMongoDBCollection request.
func (client MongoDBResourcesClient) DeleteMongoDBCollectionResponder(resp *http.Response) (result autorest.Response, err error)
DeleteMongoDBCollectionResponder handles the response to the DeleteMongoDBCollection request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) DeleteMongoDBCollectionSender(req *http.Request) (future MongoDBResourcesDeleteMongoDBCollectionFuture, err error)
DeleteMongoDBCollectionSender sends the DeleteMongoDBCollection request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) DeleteMongoDBDatabase(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result MongoDBResourcesDeleteMongoDBDatabaseFuture, err error)
DeleteMongoDBDatabase deletes an existing Azure Cosmos DB MongoDB database. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name.
func (client MongoDBResourcesClient) DeleteMongoDBDatabasePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
DeleteMongoDBDatabasePreparer prepares the DeleteMongoDBDatabase request.
func (client MongoDBResourcesClient) DeleteMongoDBDatabaseResponder(resp *http.Response) (result autorest.Response, err error)
DeleteMongoDBDatabaseResponder handles the response to the DeleteMongoDBDatabase request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) DeleteMongoDBDatabaseSender(req *http.Request) (future MongoDBResourcesDeleteMongoDBDatabaseFuture, err error)
DeleteMongoDBDatabaseSender sends the DeleteMongoDBDatabase request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) GetMongoDBCollection(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (result MongoDBCollectionGetResults, err error)
GetMongoDBCollection gets the MongoDB collection under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name. collectionName - cosmos DB collection name.
func (client MongoDBResourcesClient) GetMongoDBCollectionPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (*http.Request, error)
GetMongoDBCollectionPreparer prepares the GetMongoDBCollection request.
func (client MongoDBResourcesClient) GetMongoDBCollectionResponder(resp *http.Response) (result MongoDBCollectionGetResults, err error)
GetMongoDBCollectionResponder handles the response to the GetMongoDBCollection request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) GetMongoDBCollectionSender(req *http.Request) (*http.Response, error)
GetMongoDBCollectionSender sends the GetMongoDBCollection request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) GetMongoDBCollectionThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (result ThroughputSettingsGetResults, err error)
GetMongoDBCollectionThroughput gets the RUs per second of the MongoDB collection under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name. collectionName - cosmos DB collection name.
func (client MongoDBResourcesClient) GetMongoDBCollectionThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (*http.Request, error)
GetMongoDBCollectionThroughputPreparer prepares the GetMongoDBCollectionThroughput request.
func (client MongoDBResourcesClient) GetMongoDBCollectionThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
GetMongoDBCollectionThroughputResponder handles the response to the GetMongoDBCollectionThroughput request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) GetMongoDBCollectionThroughputSender(req *http.Request) (*http.Response, error)
GetMongoDBCollectionThroughputSender sends the GetMongoDBCollectionThroughput request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) GetMongoDBDatabase(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result MongoDBDatabaseGetResults, err error)
GetMongoDBDatabase gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name.
func (client MongoDBResourcesClient) GetMongoDBDatabasePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
GetMongoDBDatabasePreparer prepares the GetMongoDBDatabase request.
func (client MongoDBResourcesClient) GetMongoDBDatabaseResponder(resp *http.Response) (result MongoDBDatabaseGetResults, err error)
GetMongoDBDatabaseResponder handles the response to the GetMongoDBDatabase request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) GetMongoDBDatabaseSender(req *http.Request) (*http.Response, error)
GetMongoDBDatabaseSender sends the GetMongoDBDatabase request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) GetMongoDBDatabaseThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result ThroughputSettingsGetResults, err error)
GetMongoDBDatabaseThroughput gets the RUs per second of the MongoDB database under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name.
func (client MongoDBResourcesClient) GetMongoDBDatabaseThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
GetMongoDBDatabaseThroughputPreparer prepares the GetMongoDBDatabaseThroughput request.
func (client MongoDBResourcesClient) GetMongoDBDatabaseThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
GetMongoDBDatabaseThroughputResponder handles the response to the GetMongoDBDatabaseThroughput request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) GetMongoDBDatabaseThroughputSender(req *http.Request) (*http.Response, error)
GetMongoDBDatabaseThroughputSender sends the GetMongoDBDatabaseThroughput request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) ListMongoDBCollections(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result MongoDBCollectionListResult, err error)
ListMongoDBCollections lists the MongoDB collection under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name.
func (client MongoDBResourcesClient) ListMongoDBCollectionsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
ListMongoDBCollectionsPreparer prepares the ListMongoDBCollections request.
func (client MongoDBResourcesClient) ListMongoDBCollectionsResponder(resp *http.Response) (result MongoDBCollectionListResult, err error)
ListMongoDBCollectionsResponder handles the response to the ListMongoDBCollections request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) ListMongoDBCollectionsSender(req *http.Request) (*http.Response, error)
ListMongoDBCollectionsSender sends the ListMongoDBCollections request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) ListMongoDBDatabases(ctx context.Context, resourceGroupName string, accountName string) (result MongoDBDatabaseListResult, err error)
ListMongoDBDatabases lists the MongoDB databases under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name.
func (client MongoDBResourcesClient) ListMongoDBDatabasesPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListMongoDBDatabasesPreparer prepares the ListMongoDBDatabases request.
func (client MongoDBResourcesClient) ListMongoDBDatabasesResponder(resp *http.Response) (result MongoDBDatabaseListResult, err error)
ListMongoDBDatabasesResponder handles the response to the ListMongoDBDatabases request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) ListMongoDBDatabasesSender(req *http.Request) (*http.Response, error)
ListMongoDBDatabasesSender sends the ListMongoDBDatabases request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) UpdateMongoDBCollectionThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (result MongoDBResourcesUpdateMongoDBCollectionThroughputFuture, err error)
UpdateMongoDBCollectionThroughput update the RUs per second of an Azure Cosmos DB MongoDB collection Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name. collectionName - cosmos DB collection name. updateThroughputParameters - the RUs per second of the parameters to provide for the current MongoDB collection.
func (client MongoDBResourcesClient) UpdateMongoDBCollectionThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)
UpdateMongoDBCollectionThroughputPreparer prepares the UpdateMongoDBCollectionThroughput request.
func (client MongoDBResourcesClient) UpdateMongoDBCollectionThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
UpdateMongoDBCollectionThroughputResponder handles the response to the UpdateMongoDBCollectionThroughput request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) UpdateMongoDBCollectionThroughputSender(req *http.Request) (future MongoDBResourcesUpdateMongoDBCollectionThroughputFuture, err error)
UpdateMongoDBCollectionThroughputSender sends the UpdateMongoDBCollectionThroughput request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) UpdateMongoDBDatabaseThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (result MongoDBResourcesUpdateMongoDBDatabaseThroughputFuture, err error)
UpdateMongoDBDatabaseThroughput update RUs per second of the an Azure Cosmos DB MongoDB database Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseName - cosmos DB database name. updateThroughputParameters - the RUs per second of the parameters to provide for the current MongoDB database.
func (client MongoDBResourcesClient) UpdateMongoDBDatabaseThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)
UpdateMongoDBDatabaseThroughputPreparer prepares the UpdateMongoDBDatabaseThroughput request.
func (client MongoDBResourcesClient) UpdateMongoDBDatabaseThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
UpdateMongoDBDatabaseThroughputResponder handles the response to the UpdateMongoDBDatabaseThroughput request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) UpdateMongoDBDatabaseThroughputSender(req *http.Request) (future MongoDBResourcesUpdateMongoDBDatabaseThroughputFuture, err error)
UpdateMongoDBDatabaseThroughputSender sends the UpdateMongoDBDatabaseThroughput request. The method will close the http.Response Body if it receives an error.
type MongoDBResourcesCreateUpdateMongoDBCollectionFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(MongoDBResourcesClient) (MongoDBCollectionGetResults, error)
}MongoDBResourcesCreateUpdateMongoDBCollectionFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type MongoDBResourcesCreateUpdateMongoDBDatabaseFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(MongoDBResourcesClient) (MongoDBDatabaseGetResults, error)
}MongoDBResourcesCreateUpdateMongoDBDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type MongoDBResourcesDeleteMongoDBCollectionFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(MongoDBResourcesClient) (autorest.Response, error)
}MongoDBResourcesDeleteMongoDBCollectionFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type MongoDBResourcesDeleteMongoDBDatabaseFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(MongoDBResourcesClient) (autorest.Response, error)
}MongoDBResourcesDeleteMongoDBDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type MongoDBResourcesUpdateMongoDBCollectionThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(MongoDBResourcesClient) (ThroughputSettingsGetResults, error)
}MongoDBResourcesUpdateMongoDBCollectionThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type MongoDBResourcesUpdateMongoDBDatabaseThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(MongoDBResourcesClient) (ThroughputSettingsGetResults, error)
}MongoDBResourcesUpdateMongoDBDatabaseThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type MongoIndex struct {
// Key - Cosmos DB MongoDB collection index keys
Key *MongoIndexKeys `json:"key,omitempty"`
// Options - Cosmos DB MongoDB collection index key options
Options *MongoIndexOptions `json:"options,omitempty"`
}MongoIndex cosmos DB MongoDB collection index key
type MongoIndexKeys struct {
// Keys - List of keys for each MongoDB collection in the Azure Cosmos DB service
Keys *[]string `json:"keys,omitempty"`
}MongoIndexKeys cosmos DB MongoDB collection resource object
type MongoIndexOptions struct {
// ExpireAfterSeconds - Expire after seconds
ExpireAfterSeconds *int32 `json:"expireAfterSeconds,omitempty"`
// Unique - Is unique or not
Unique *bool `json:"unique,omitempty"`
}MongoIndexOptions cosmos DB MongoDB collection index options
type NotebookWorkspace struct {
autorest.Response `json:"-"`
// NotebookWorkspaceProperties - Resource properties.
*NotebookWorkspaceProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The unique resource identifier of the database account.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the database account.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
}NotebookWorkspace a notebook workspace resource
func (nw NotebookWorkspace) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for NotebookWorkspace.
func (nw *NotebookWorkspace) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for NotebookWorkspace struct.
type NotebookWorkspaceConnectionInfoResult struct {
autorest.Response `json:"-"`
// AuthToken - READ-ONLY; Specifies auth token used for connecting to Notebook server (uses token-based auth).
AuthToken *string `json:"authToken,omitempty"`
// NotebookServerEndpoint - READ-ONLY; Specifies the endpoint of Notebook server.
NotebookServerEndpoint *string `json:"notebookServerEndpoint,omitempty"`
}NotebookWorkspaceConnectionInfoResult the connection info for the given notebook workspace
type NotebookWorkspaceCreateUpdateParameters struct {
// ID - READ-ONLY; The unique resource identifier of the database account.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the database account.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
}NotebookWorkspaceCreateUpdateParameters parameters to create a notebook workspace resource
type NotebookWorkspaceListResult struct {
autorest.Response `json:"-"`
// Value - Array of notebook workspace resources
Value *[]NotebookWorkspace `json:"value,omitempty"`
}NotebookWorkspaceListResult a list of notebook workspace resources
type NotebookWorkspaceProperties struct {
// NotebookServerEndpoint - READ-ONLY; Specifies the endpoint of Notebook server.
NotebookServerEndpoint *string `json:"notebookServerEndpoint,omitempty"`
// Status - READ-ONLY; Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.
Status *string `json:"status,omitempty"`
}NotebookWorkspaceProperties properties of a notebook workspace resource.
type NotebookWorkspacesClient struct {
BaseClient
}NotebookWorkspacesClient is the azure Cosmos DB Database Service Resource Provider REST API
func NewNotebookWorkspacesClient(subscriptionID string) NotebookWorkspacesClient
NewNotebookWorkspacesClient creates an instance of the NotebookWorkspacesClient client.
func NewNotebookWorkspacesClientWithBaseURI(baseURI string, subscriptionID string) NotebookWorkspacesClient
NewNotebookWorkspacesClientWithBaseURI creates an instance of the NotebookWorkspacesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client NotebookWorkspacesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, notebookCreateUpdateParameters NotebookWorkspaceCreateUpdateParameters) (result NotebookWorkspacesCreateOrUpdateFuture, err error)
CreateOrUpdate creates the notebook workspace for a Cosmos DB account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. notebookCreateUpdateParameters - the notebook workspace to create for the current database account.
func (client NotebookWorkspacesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, notebookCreateUpdateParameters NotebookWorkspaceCreateUpdateParameters) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client NotebookWorkspacesClient) CreateOrUpdateResponder(resp *http.Response) (result NotebookWorkspace, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client NotebookWorkspacesClient) CreateOrUpdateSender(req *http.Request) (future NotebookWorkspacesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client NotebookWorkspacesClient) Delete(ctx context.Context, resourceGroupName string, accountName string) (result NotebookWorkspacesDeleteFuture, err error)
Delete deletes the notebook workspace for a Cosmos DB account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client NotebookWorkspacesClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client NotebookWorkspacesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client NotebookWorkspacesClient) DeleteSender(req *http.Request) (future NotebookWorkspacesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client NotebookWorkspacesClient) Get(ctx context.Context, resourceGroupName string, accountName string) (result NotebookWorkspace, err error)
Get gets the notebook workspace for a Cosmos DB account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client NotebookWorkspacesClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client NotebookWorkspacesClient) GetResponder(resp *http.Response) (result NotebookWorkspace, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client NotebookWorkspacesClient) ListByDatabaseAccount(ctx context.Context, resourceGroupName string, accountName string) (result NotebookWorkspaceListResult, err error)
ListByDatabaseAccount gets the notebook workspace resources of an existing Cosmos DB account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client NotebookWorkspacesClient) ListByDatabaseAccountPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListByDatabaseAccountPreparer prepares the ListByDatabaseAccount request.
func (client NotebookWorkspacesClient) ListByDatabaseAccountResponder(resp *http.Response) (result NotebookWorkspaceListResult, err error)
ListByDatabaseAccountResponder handles the response to the ListByDatabaseAccount request. The method always closes the http.Response Body.
func (client NotebookWorkspacesClient) ListByDatabaseAccountSender(req *http.Request) (*http.Response, error)
ListByDatabaseAccountSender sends the ListByDatabaseAccount request. The method will close the http.Response Body if it receives an error.
func (client NotebookWorkspacesClient) ListConnectionInfo(ctx context.Context, resourceGroupName string, accountName string) (result NotebookWorkspaceConnectionInfoResult, err error)
ListConnectionInfo retrieves the connection info for the notebook workspace Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client NotebookWorkspacesClient) ListConnectionInfoPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListConnectionInfoPreparer prepares the ListConnectionInfo request.
func (client NotebookWorkspacesClient) ListConnectionInfoResponder(resp *http.Response) (result NotebookWorkspaceConnectionInfoResult, err error)
ListConnectionInfoResponder handles the response to the ListConnectionInfo request. The method always closes the http.Response Body.
func (client NotebookWorkspacesClient) ListConnectionInfoSender(req *http.Request) (*http.Response, error)
ListConnectionInfoSender sends the ListConnectionInfo request. The method will close the http.Response Body if it receives an error.
func (client NotebookWorkspacesClient) RegenerateAuthToken(ctx context.Context, resourceGroupName string, accountName string) (result NotebookWorkspacesRegenerateAuthTokenFuture, err error)
RegenerateAuthToken regenerates the auth token for the notebook workspace Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client NotebookWorkspacesClient) RegenerateAuthTokenPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
RegenerateAuthTokenPreparer prepares the RegenerateAuthToken request.
func (client NotebookWorkspacesClient) RegenerateAuthTokenResponder(resp *http.Response) (result autorest.Response, err error)
RegenerateAuthTokenResponder handles the response to the RegenerateAuthToken request. The method always closes the http.Response Body.
func (client NotebookWorkspacesClient) RegenerateAuthTokenSender(req *http.Request) (future NotebookWorkspacesRegenerateAuthTokenFuture, err error)
RegenerateAuthTokenSender sends the RegenerateAuthToken request. The method will close the http.Response Body if it receives an error.
func (client NotebookWorkspacesClient) Start(ctx context.Context, resourceGroupName string, accountName string) (result NotebookWorkspacesStartFuture, err error)
Start starts the notebook workspace Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client NotebookWorkspacesClient) StartPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
StartPreparer prepares the Start request.
func (client NotebookWorkspacesClient) StartResponder(resp *http.Response) (result autorest.Response, err error)
StartResponder handles the response to the Start request. The method always closes the http.Response Body.
func (client NotebookWorkspacesClient) StartSender(req *http.Request) (future NotebookWorkspacesStartFuture, err error)
StartSender sends the Start request. The method will close the http.Response Body if it receives an error.
type NotebookWorkspacesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(NotebookWorkspacesClient) (NotebookWorkspace, error)
}NotebookWorkspacesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type NotebookWorkspacesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(NotebookWorkspacesClient) (autorest.Response, error)
}NotebookWorkspacesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type NotebookWorkspacesRegenerateAuthTokenFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(NotebookWorkspacesClient) (autorest.Response, error)
}NotebookWorkspacesRegenerateAuthTokenFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type NotebookWorkspacesStartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(NotebookWorkspacesClient) (autorest.Response, error)
}NotebookWorkspacesStartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type Operation struct {
// Name - Operation name: {provider}/{resource}/{operation}
Name *string `json:"name,omitempty"`
// Display - The object that represents the operation.
Display *OperationDisplay `json:"display,omitempty"`
}Operation REST API operation
type OperationDisplay struct {
// Provider - Service provider: Microsoft.ResourceProvider
Provider *string `json:"Provider,omitempty"`
// Resource - Resource on which the operation is performed: Profile, endpoint, etc.
Resource *string `json:"Resource,omitempty"`
// Operation - Operation type: Read, write, delete, etc.
Operation *string `json:"Operation,omitempty"`
// Description - Description of operation
Description *string `json:"Description,omitempty"`
}OperationDisplay the object that represents the operation.
type OperationListResult struct {
autorest.Response `json:"-"`
// Value - List of operations supported by the Resource Provider.
Value *[]Operation `json:"value,omitempty"`
// NextLink - URL to get the next set of operation list results if there are any.
NextLink *string `json:"nextLink,omitempty"`
}OperationListResult result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results.
func (olr OperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type OperationListResultIterator struct {
// contains filtered or unexported fields
}OperationListResultIterator provides access to a complete listing of Operation values.
func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator
Creates a new instance of the OperationListResultIterator type.
func (iter *OperationListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter OperationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OperationListResultIterator) Response() OperationListResult
Response returns the raw server response from the last page request.
func (iter OperationListResultIterator) Value() Operation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type OperationListResultPage struct {
// contains filtered or unexported fields
}OperationListResultPage contains a page of Operation values.
func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage
Creates a new instance of the OperationListResultPage type.
func (page *OperationListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page OperationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OperationListResultPage) Response() OperationListResult
Response returns the raw server response from the last page request.
func (page OperationListResultPage) Values() []Operation
Values returns the slice of values for the current page or nil if there are no values.
type OperationsClient struct {
BaseClient
}OperationsClient is the azure Cosmos DB Database Service Resource Provider REST API
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
List lists all of the available Cosmos DB Resource Provider operations.
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type PartitionKeyRangeIDClient struct {
BaseClient
}PartitionKeyRangeIDClient is the azure Cosmos DB Database Service Resource Provider REST API
func NewPartitionKeyRangeIDClient(subscriptionID string) PartitionKeyRangeIDClient
NewPartitionKeyRangeIDClient creates an instance of the PartitionKeyRangeIDClient client.
func NewPartitionKeyRangeIDClientWithBaseURI(baseURI string, subscriptionID string) PartitionKeyRangeIDClient
NewPartitionKeyRangeIDClientWithBaseURI creates an instance of the PartitionKeyRangeIDClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client PartitionKeyRangeIDClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, partitionKeyRangeID string, filter string) (result PartitionMetricListResult, err error)
ListMetrics retrieves the metrics determined by the given filter for the given partition key range id. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. databaseRid - cosmos DB database rid. collectionRid - cosmos DB collection rid. partitionKeyRangeID - partition Key Range Id for which to get data. 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.
func (client PartitionKeyRangeIDClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, partitionKeyRangeID string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client PartitionKeyRangeIDClient) ListMetricsResponder(resp *http.Response) (result PartitionMetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.
func (client PartitionKeyRangeIDClient) ListMetricsSender(req *http.Request) (*http.Response, error)
ListMetricsSender sends the ListMetrics request. The method will close the http.Response Body if it receives an error.
type PartitionKeyRangeIDRegionClient struct {
BaseClient
}PartitionKeyRangeIDRegionClient is the azure Cosmos DB Database Service Resource Provider REST API
func NewPartitionKeyRangeIDRegionClient(subscriptionID string) PartitionKeyRangeIDRegionClient
NewPartitionKeyRangeIDRegionClient creates an instance of the PartitionKeyRangeIDRegionClient client.
func NewPartitionKeyRangeIDRegionClientWithBaseURI(baseURI string, subscriptionID string) PartitionKeyRangeIDRegionClient
NewPartitionKeyRangeIDRegionClientWithBaseURI creates an instance of the PartitionKeyRangeIDRegionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client PartitionKeyRangeIDRegionClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, region string, databaseRid string, collectionRid string, partitionKeyRangeID string, filter string) (result PartitionMetricListResult, err error)
ListMetrics retrieves the metrics determined by the given filter for the given partition key range id and region. Parameters: resourceGroupName - name of an Azure resource group. accountName - cosmos DB database account name. region - cosmos DB region, with spaces between words and each word capitalized. databaseRid - cosmos DB database rid. collectionRid - cosmos DB collection rid. partitionKeyRangeID - partition Key Range Id for which to get data. 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.
func (client PartitionKeyRangeIDRegionClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, region string, databaseRid string, collectionRid string, partitionKeyRangeID string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client PartitionKeyRangeIDRegionClient) ListMetricsResponder(resp *http.Response) (result PartitionMetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.