documentdb

package
Version: v53.3.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 19, 2021 License: MIT Imports: 10 Imported by: 19

Documentation

Overview

Package documentdb implements the Azure ARM Documentdb service API version .

Azure Cosmos DB Database Service Resource Provider REST API

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Documentdb
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type ARMProxyResource

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

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 (ARMResourceProperties) MarshalJSON

func (arp ARMResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ARMResourceProperties.

type AutoUpgradePolicyResource

type AutoUpgradePolicyResource struct {
	// ThroughputPolicy - Represents throughput policy which service must adhere to for auto-upgrade
	ThroughputPolicy *ThroughputPolicyResource `json:"throughputPolicy,omitempty"`
}

AutoUpgradePolicyResource cosmos DB resource auto-upgrade policy

type AzureEntityResource

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.

type BaseClient

type BaseClient struct {
	autorest.Client
	BaseURI         string
	SubscriptionID  string
	SubscriptionID1 string
}

BaseClient is the base client for Documentdb.

func New

func New(subscriptionID string, subscriptionID1 string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string, subscriptionID1 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

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

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 (CassandraKeyspaceCreateUpdateParameters) MarshalJSON

func (ckcup CassandraKeyspaceCreateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CassandraKeyspaceCreateUpdateParameters.

func (*CassandraKeyspaceCreateUpdateParameters) UnmarshalJSON

func (ckcup *CassandraKeyspaceCreateUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CassandraKeyspaceCreateUpdateParameters struct.

type CassandraKeyspaceCreateUpdateProperties

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 *CreateUpdateOptions `json:"options,omitempty"`
}

CassandraKeyspaceCreateUpdateProperties properties to create and update Azure Cosmos DB Cassandra keyspace.

type CassandraKeyspaceGetProperties

type CassandraKeyspaceGetProperties struct {
	Resource *CassandraKeyspaceGetPropertiesResource `json:"resource,omitempty"`
}

CassandraKeyspaceGetProperties the properties of an Azure Cosmos DB Cassandra keyspace

type CassandraKeyspaceGetPropertiesResource

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 (CassandraKeyspaceGetPropertiesResource) MarshalJSON

func (ckgp CassandraKeyspaceGetPropertiesResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CassandraKeyspaceGetPropertiesResource.

type CassandraKeyspaceGetResults

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 (CassandraKeyspaceGetResults) MarshalJSON

func (ckgr CassandraKeyspaceGetResults) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CassandraKeyspaceGetResults.

func (*CassandraKeyspaceGetResults) UnmarshalJSON

func (ckgr *CassandraKeyspaceGetResults) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CassandraKeyspaceGetResults struct.

type CassandraKeyspaceListResult

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

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

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

type CassandraResourcesClient struct {
	BaseClient
}

CassandraResourcesClient is the azure Cosmos DB Database Service Resource Provider REST API

func NewCassandraResourcesClient

func NewCassandraResourcesClient(subscriptionID string, subscriptionID1 string) CassandraResourcesClient

NewCassandraResourcesClient creates an instance of the CassandraResourcesClient client.

func NewCassandraResourcesClientWithBaseURI

func NewCassandraResourcesClientWithBaseURI(baseURI string, subscriptionID string, subscriptionID1 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 (CassandraResourcesClient) CreateUpdateCassandraKeyspace

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 (CassandraResourcesClient) CreateUpdateCassandraKeyspacePreparer

func (client CassandraResourcesClient) CreateUpdateCassandraKeyspacePreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, createUpdateCassandraKeyspaceParameters CassandraKeyspaceCreateUpdateParameters) (*http.Request, error)

CreateUpdateCassandraKeyspacePreparer prepares the CreateUpdateCassandraKeyspace request.

func (CassandraResourcesClient) CreateUpdateCassandraKeyspaceResponder

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 (CassandraResourcesClient) CreateUpdateCassandraKeyspaceSender

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 (CassandraResourcesClient) CreateUpdateCassandraTable

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 (CassandraResourcesClient) CreateUpdateCassandraTablePreparer

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 (CassandraResourcesClient) CreateUpdateCassandraTableResponder

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 (CassandraResourcesClient) CreateUpdateCassandraTableSender

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 (CassandraResourcesClient) DeleteCassandraKeyspace

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 (CassandraResourcesClient) DeleteCassandraKeyspacePreparer

func (client CassandraResourcesClient) DeleteCassandraKeyspacePreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (*http.Request, error)

DeleteCassandraKeyspacePreparer prepares the DeleteCassandraKeyspace request.

func (CassandraResourcesClient) DeleteCassandraKeyspaceResponder

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 (CassandraResourcesClient) DeleteCassandraKeyspaceSender

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 (CassandraResourcesClient) DeleteCassandraTable

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 (CassandraResourcesClient) DeleteCassandraTablePreparer

func (client CassandraResourcesClient) DeleteCassandraTablePreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string) (*http.Request, error)

DeleteCassandraTablePreparer prepares the DeleteCassandraTable request.

func (CassandraResourcesClient) DeleteCassandraTableResponder

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 (CassandraResourcesClient) DeleteCassandraTableSender

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 (CassandraResourcesClient) GetCassandraKeyspace

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 (CassandraResourcesClient) GetCassandraKeyspacePreparer

func (client CassandraResourcesClient) GetCassandraKeyspacePreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (*http.Request, error)

GetCassandraKeyspacePreparer prepares the GetCassandraKeyspace request.

func (CassandraResourcesClient) GetCassandraKeyspaceResponder

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 (CassandraResourcesClient) GetCassandraKeyspaceSender

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 (CassandraResourcesClient) GetCassandraKeyspaceThroughput

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 (CassandraResourcesClient) GetCassandraKeyspaceThroughputPreparer

func (client CassandraResourcesClient) GetCassandraKeyspaceThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (*http.Request, error)

GetCassandraKeyspaceThroughputPreparer prepares the GetCassandraKeyspaceThroughput request.

func (CassandraResourcesClient) GetCassandraKeyspaceThroughputResponder

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 (CassandraResourcesClient) GetCassandraKeyspaceThroughputSender

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 (CassandraResourcesClient) GetCassandraTable

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 (CassandraResourcesClient) GetCassandraTablePreparer

func (client CassandraResourcesClient) GetCassandraTablePreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string) (*http.Request, error)

GetCassandraTablePreparer prepares the GetCassandraTable request.

func (CassandraResourcesClient) GetCassandraTableResponder

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 (CassandraResourcesClient) GetCassandraTableSender

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 (CassandraResourcesClient) GetCassandraTableThroughput

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 (CassandraResourcesClient) GetCassandraTableThroughputPreparer

func (client CassandraResourcesClient) GetCassandraTableThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string) (*http.Request, error)

GetCassandraTableThroughputPreparer prepares the GetCassandraTableThroughput request.

func (CassandraResourcesClient) GetCassandraTableThroughputResponder

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 (CassandraResourcesClient) GetCassandraTableThroughputSender

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 (CassandraResourcesClient) ListCassandraKeyspaces

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 (CassandraResourcesClient) ListCassandraKeyspacesPreparer

func (client CassandraResourcesClient) ListCassandraKeyspacesPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

ListCassandraKeyspacesPreparer prepares the ListCassandraKeyspaces request.

func (CassandraResourcesClient) ListCassandraKeyspacesResponder

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 (CassandraResourcesClient) ListCassandraKeyspacesSender

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 (CassandraResourcesClient) ListCassandraTables

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 (CassandraResourcesClient) ListCassandraTablesPreparer

func (client CassandraResourcesClient) ListCassandraTablesPreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (*http.Request, error)

ListCassandraTablesPreparer prepares the ListCassandraTables request.

func (CassandraResourcesClient) ListCassandraTablesResponder

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 (CassandraResourcesClient) ListCassandraTablesSender

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 (CassandraResourcesClient) UpdateCassandraKeyspaceThroughput

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 (CassandraResourcesClient) UpdateCassandraKeyspaceThroughputPreparer

func (client CassandraResourcesClient) UpdateCassandraKeyspaceThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)

UpdateCassandraKeyspaceThroughputPreparer prepares the UpdateCassandraKeyspaceThroughput request.

func (CassandraResourcesClient) UpdateCassandraKeyspaceThroughputResponder

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 (CassandraResourcesClient) UpdateCassandraKeyspaceThroughputSender

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 (CassandraResourcesClient) UpdateCassandraTableThroughput

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 (CassandraResourcesClient) UpdateCassandraTableThroughputPreparer

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 (CassandraResourcesClient) UpdateCassandraTableThroughputResponder

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 (CassandraResourcesClient) UpdateCassandraTableThroughputSender

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

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.

func (*CassandraResourcesCreateUpdateCassandraKeyspaceFuture) UnmarshalJSON

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CassandraResourcesCreateUpdateCassandraTableFuture

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.

func (*CassandraResourcesCreateUpdateCassandraTableFuture) UnmarshalJSON

func (future *CassandraResourcesCreateUpdateCassandraTableFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CassandraResourcesDeleteCassandraKeyspaceFuture

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.

func (*CassandraResourcesDeleteCassandraKeyspaceFuture) UnmarshalJSON

func (future *CassandraResourcesDeleteCassandraKeyspaceFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CassandraResourcesDeleteCassandraTableFuture

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.

func (*CassandraResourcesDeleteCassandraTableFuture) UnmarshalJSON

func (future *CassandraResourcesDeleteCassandraTableFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CassandraResourcesUpdateCassandraKeyspaceThroughputFuture

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.

func (*CassandraResourcesUpdateCassandraKeyspaceThroughputFuture) UnmarshalJSON

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CassandraResourcesUpdateCassandraTableThroughputFuture

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.

func (*CassandraResourcesUpdateCassandraTableThroughputFuture) UnmarshalJSON

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CassandraSchema

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

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 (CassandraTableCreateUpdateParameters) MarshalJSON

func (ctcup CassandraTableCreateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CassandraTableCreateUpdateParameters.

func (*CassandraTableCreateUpdateParameters) UnmarshalJSON

func (ctcup *CassandraTableCreateUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CassandraTableCreateUpdateParameters struct.

type CassandraTableCreateUpdateProperties

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 *CreateUpdateOptions `json:"options,omitempty"`
}

CassandraTableCreateUpdateProperties properties to create and update Azure Cosmos DB Cassandra table.

type CassandraTableGetProperties

type CassandraTableGetProperties struct {
	Resource *CassandraTableGetPropertiesResource `json:"resource,omitempty"`
}

CassandraTableGetProperties the properties of an Azure Cosmos DB Cassandra table

type CassandraTableGetPropertiesResource

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 (CassandraTableGetPropertiesResource) MarshalJSON

func (ctgp CassandraTableGetPropertiesResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CassandraTableGetPropertiesResource.

type CassandraTableGetResults

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 (CassandraTableGetResults) MarshalJSON

func (ctgr CassandraTableGetResults) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CassandraTableGetResults.

func (*CassandraTableGetResults) UnmarshalJSON

func (ctgr *CassandraTableGetResults) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CassandraTableGetResults struct.

type CassandraTableListResult

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

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

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

type CollectionClient struct {
	BaseClient
}

CollectionClient is the azure Cosmos DB Database Service Resource Provider REST API

func NewCollectionClient

func NewCollectionClient(subscriptionID string, subscriptionID1 string) CollectionClient

NewCollectionClient creates an instance of the CollectionClient client.

func NewCollectionClientWithBaseURI

func NewCollectionClientWithBaseURI(baseURI string, subscriptionID string, subscriptionID1 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 (CollectionClient) ListMetricDefinitions

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 (CollectionClient) ListMetricDefinitionsPreparer

func (client CollectionClient) ListMetricDefinitionsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string) (*http.Request, error)

ListMetricDefinitionsPreparer prepares the ListMetricDefinitions request.

func (CollectionClient) ListMetricDefinitionsResponder

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 (CollectionClient) ListMetricDefinitionsSender

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 (CollectionClient) ListMetrics

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 (CollectionClient) ListMetricsPreparer

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 (CollectionClient) ListMetricsResponder

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.

func (CollectionClient) ListMetricsSender

func (client CollectionClient) 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 (CollectionClient) ListUsages

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 (CollectionClient) ListUsagesPreparer

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 (CollectionClient) ListUsagesResponder

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.

func (CollectionClient) ListUsagesSender

func (client CollectionClient) 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 CollectionPartitionClient

type CollectionPartitionClient struct {
	BaseClient
}

CollectionPartitionClient is the azure Cosmos DB Database Service Resource Provider REST API

func NewCollectionPartitionClient

func NewCollectionPartitionClient(subscriptionID string, subscriptionID1 string) CollectionPartitionClient

NewCollectionPartitionClient creates an instance of the CollectionPartitionClient client.

func NewCollectionPartitionClientWithBaseURI

func NewCollectionPartitionClientWithBaseURI(baseURI string, subscriptionID string, subscriptionID1 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 (CollectionPartitionClient) ListMetrics

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 (CollectionPartitionClient) ListMetricsPreparer

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 (CollectionPartitionClient) ListMetricsResponder

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 (CollectionPartitionClient) ListMetricsSender

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 (CollectionPartitionClient) ListUsages

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 (CollectionPartitionClient) ListUsagesPreparer

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 (CollectionPartitionClient) ListUsagesResponder

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 (CollectionPartitionClient) ListUsagesSender

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

type CollectionPartitionRegionClient struct {
	BaseClient
}

CollectionPartitionRegionClient is the azure Cosmos DB Database Service Resource Provider REST API

func NewCollectionPartitionRegionClient

func NewCollectionPartitionRegionClient(subscriptionID string, subscriptionID1 string) CollectionPartitionRegionClient

NewCollectionPartitionRegionClient creates an instance of the CollectionPartitionRegionClient client.

func NewCollectionPartitionRegionClientWithBaseURI

func NewCollectionPartitionRegionClientWithBaseURI(baseURI string, subscriptionID string, subscriptionID1 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 (CollectionPartitionRegionClient) ListMetrics

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 (CollectionPartitionRegionClient) ListMetricsPreparer

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 (CollectionPartitionRegionClient) ListMetricsResponder

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 (CollectionPartitionRegionClient) ListMetricsSender

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

type CollectionRegionClient struct {
	BaseClient
}

CollectionRegionClient is the azure Cosmos DB Database Service Resource Provider REST API

func NewCollectionRegionClient

func NewCollectionRegionClient(subscriptionID string, subscriptionID1 string) CollectionRegionClient

NewCollectionRegionClient creates an instance of the CollectionRegionClient client.

func NewCollectionRegionClientWithBaseURI

func NewCollectionRegionClientWithBaseURI(baseURI string, subscriptionID string, subscriptionID1 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 (CollectionRegionClient) ListMetrics

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 (CollectionRegionClient) ListMetricsPreparer

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 (CollectionRegionClient) ListMetricsResponder

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.

func (CollectionRegionClient) ListMetricsSender

func (client CollectionRegionClient) 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 Column

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

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 ...

type CompositePathSortOrder

type CompositePathSortOrder string

CompositePathSortOrder enumerates the values for composite path sort order.

const (
	// Ascending ...
	Ascending CompositePathSortOrder = "Ascending"
	// Descending ...
	Descending CompositePathSortOrder = "Descending"
)

func PossibleCompositePathSortOrderValues

func PossibleCompositePathSortOrderValues() []CompositePathSortOrder

PossibleCompositePathSortOrderValues returns an array of possible values for the CompositePathSortOrder const type.

type ConflictResolutionMode

type ConflictResolutionMode string

ConflictResolutionMode enumerates the values for conflict resolution mode.

const (
	// Custom ...
	Custom ConflictResolutionMode = "Custom"
	// LastWriterWins ...
	LastWriterWins ConflictResolutionMode = "LastWriterWins"
)

func PossibleConflictResolutionModeValues

func PossibleConflictResolutionModeValues() []ConflictResolutionMode

PossibleConflictResolutionModeValues returns an array of possible values for the ConflictResolutionMode const type.

type ConflictResolutionPolicy

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.

type ConnectorOffer

type ConnectorOffer string

ConnectorOffer enumerates the values for connector offer.

const (
	// Small ...
	Small ConnectorOffer = "Small"
)

func PossibleConnectorOfferValues

func PossibleConnectorOfferValues() []ConnectorOffer

PossibleConnectorOfferValues returns an array of possible values for the ConnectorOffer const type.

type ConsistencyPolicy

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

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

type CreateUpdateOptions

type CreateUpdateOptions struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]*string `json:""`
	// Throughput - Request Units per second. For example, "throughput": "10000".
	Throughput *string `json:"throughput,omitempty"`
}

CreateUpdateOptions createUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput"

func (CreateUpdateOptions) MarshalJSON

func (cuo CreateUpdateOptions) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreateUpdateOptions.

func (*CreateUpdateOptions) UnmarshalJSON

func (cuo *CreateUpdateOptions) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CreateUpdateOptions struct.

type DataType

type DataType string

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"
)

func PossibleDataTypeValues

func PossibleDataTypeValues() []DataType

PossibleDataTypeValues returns an array of possible values for the DataType const type.

type DatabaseAccountConnectionString

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

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 (DatabaseAccountCreateUpdateParameters) MarshalJSON

func (dacup DatabaseAccountCreateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DatabaseAccountCreateUpdateParameters.

func (*DatabaseAccountCreateUpdateParameters) UnmarshalJSON

func (dacup *DatabaseAccountCreateUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DatabaseAccountCreateUpdateParameters struct.

type DatabaseAccountCreateUpdateProperties

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"`
	// KeyVaultKeyURI - The URI of the key vault
	KeyVaultKeyURI *string `json:"keyVaultKeyUri,omitempty"`
}

DatabaseAccountCreateUpdateProperties properties to create and update Azure Cosmos DB database accounts.

type DatabaseAccountGetProperties

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"`
	// KeyVaultKeyURI - The URI of the key vault
	KeyVaultKeyURI *string `json:"keyVaultKeyUri,omitempty"`
}

DatabaseAccountGetProperties properties for the database account.

func (DatabaseAccountGetProperties) MarshalJSON

func (dagp DatabaseAccountGetProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DatabaseAccountGetProperties.

type DatabaseAccountGetResults

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 (DatabaseAccountGetResults) MarshalJSON

func (dagr DatabaseAccountGetResults) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DatabaseAccountGetResults.

func (*DatabaseAccountGetResults) UnmarshalJSON

func (dagr *DatabaseAccountGetResults) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DatabaseAccountGetResults struct.

type DatabaseAccountKind

type DatabaseAccountKind string

DatabaseAccountKind enumerates the values for database account kind.

const (
	// GlobalDocumentDB ...
	GlobalDocumentDB DatabaseAccountKind = "GlobalDocumentDB"
	// MongoDB ...
	MongoDB DatabaseAccountKind = "MongoDB"
	// Parse ...
	Parse DatabaseAccountKind = "Parse"
)

func PossibleDatabaseAccountKindValues

func PossibleDatabaseAccountKindValues() []DatabaseAccountKind

PossibleDatabaseAccountKindValues returns an array of possible values for the DatabaseAccountKind const type.

type DatabaseAccountListConnectionStringsResult

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

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

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.

type DatabaseAccountOfferType

type DatabaseAccountOfferType string

DatabaseAccountOfferType enumerates the values for database account offer type.

const (
	// Standard ...
	Standard DatabaseAccountOfferType = "Standard"
)

func PossibleDatabaseAccountOfferTypeValues

func PossibleDatabaseAccountOfferTypeValues() []DatabaseAccountOfferType

PossibleDatabaseAccountOfferTypeValues returns an array of possible values for the DatabaseAccountOfferType const type.

type DatabaseAccountRegenerateKeyParameters

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

type DatabaseAccountRegionClient struct {
	BaseClient
}

DatabaseAccountRegionClient is the azure Cosmos DB Database Service Resource Provider REST API

func NewDatabaseAccountRegionClient

func NewDatabaseAccountRegionClient(subscriptionID string, subscriptionID1 string) DatabaseAccountRegionClient

NewDatabaseAccountRegionClient creates an instance of the DatabaseAccountRegionClient client.

func NewDatabaseAccountRegionClientWithBaseURI

func NewDatabaseAccountRegionClientWithBaseURI(baseURI string, subscriptionID string, subscriptionID1 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 (DatabaseAccountRegionClient) ListMetrics

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 (DatabaseAccountRegionClient) ListMetricsPreparer

func (client DatabaseAccountRegionClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, region string, filter string) (*http.Request, error)

ListMetricsPreparer prepares the ListMetrics request.

func (DatabaseAccountRegionClient) ListMetricsResponder

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 (DatabaseAccountRegionClient) ListMetricsSender

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

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 (DatabaseAccountUpdateParameters) MarshalJSON

func (daup DatabaseAccountUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DatabaseAccountUpdateParameters.

func (*DatabaseAccountUpdateParameters) UnmarshalJSON

func (daup *DatabaseAccountUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DatabaseAccountUpdateParameters struct.

type DatabaseAccountUpdateProperties

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"`
	// KeyVaultKeyURI - The URI of the key vault
	KeyVaultKeyURI *string `json:"keyVaultKeyUri,omitempty"`
}

DatabaseAccountUpdateProperties properties to update Azure Cosmos DB database accounts.

type DatabaseAccountsClient

type DatabaseAccountsClient struct {
	BaseClient
}

DatabaseAccountsClient is the azure Cosmos DB Database Service Resource Provider REST API

func NewDatabaseAccountsClient

func NewDatabaseAccountsClient(subscriptionID string, subscriptionID1 string) DatabaseAccountsClient

NewDatabaseAccountsClient creates an instance of the DatabaseAccountsClient client.

func NewDatabaseAccountsClientWithBaseURI

func NewDatabaseAccountsClientWithBaseURI(baseURI string, subscriptionID string, subscriptionID1 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 (DatabaseAccountsClient) CheckNameExists

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 (DatabaseAccountsClient) CheckNameExistsPreparer

func (client DatabaseAccountsClient) CheckNameExistsPreparer(ctx context.Context, accountName string) (*http.Request, error)

CheckNameExistsPreparer prepares the CheckNameExists request.

func (DatabaseAccountsClient) CheckNameExistsResponder

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 (DatabaseAccountsClient) CheckNameExistsSender

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 (DatabaseAccountsClient) CreateOrUpdate

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 (DatabaseAccountsClient) CreateOrUpdatePreparer

func (client DatabaseAccountsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, createUpdateParameters DatabaseAccountCreateUpdateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (DatabaseAccountsClient) CreateOrUpdateResponder

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 (DatabaseAccountsClient) CreateOrUpdateSender

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 (DatabaseAccountsClient) Delete

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 (DatabaseAccountsClient) DeletePreparer

func (client DatabaseAccountsClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (DatabaseAccountsClient) DeleteResponder

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 (DatabaseAccountsClient) DeleteSender

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 (DatabaseAccountsClient) FailoverPriorityChange

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 (DatabaseAccountsClient) FailoverPriorityChangePreparer

func (client DatabaseAccountsClient) FailoverPriorityChangePreparer(ctx context.Context, resourceGroupName string, accountName string, failoverParameters FailoverPolicies) (*http.Request, error)

FailoverPriorityChangePreparer prepares the FailoverPriorityChange request.

func (DatabaseAccountsClient) FailoverPriorityChangeResponder

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 (DatabaseAccountsClient) FailoverPriorityChangeSender

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 (DatabaseAccountsClient) Get

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 (DatabaseAccountsClient) GetPreparer

func (client DatabaseAccountsClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DatabaseAccountsClient) GetReadOnlyKeys

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 (DatabaseAccountsClient) GetReadOnlyKeysPreparer

func (client DatabaseAccountsClient) GetReadOnlyKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

GetReadOnlyKeysPreparer prepares the GetReadOnlyKeys request.

func (DatabaseAccountsClient) GetReadOnlyKeysResponder

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 (DatabaseAccountsClient) GetReadOnlyKeysSender

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 (DatabaseAccountsClient) GetResponder

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.

func (DatabaseAccountsClient) GetSender

func (client DatabaseAccountsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (DatabaseAccountsClient) List

List lists all the Azure Cosmos DB database accounts available under the subscription.

func (DatabaseAccountsClient) ListByResourceGroup

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 (DatabaseAccountsClient) ListByResourceGroupPreparer

func (client DatabaseAccountsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (DatabaseAccountsClient) ListByResourceGroupResponder

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 (DatabaseAccountsClient) ListByResourceGroupSender

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 (DatabaseAccountsClient) ListConnectionStrings

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 (DatabaseAccountsClient) ListConnectionStringsPreparer

func (client DatabaseAccountsClient) ListConnectionStringsPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

ListConnectionStringsPreparer prepares the ListConnectionStrings request.

func (DatabaseAccountsClient) ListConnectionStringsResponder

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 (DatabaseAccountsClient) ListConnectionStringsSender

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 (DatabaseAccountsClient) ListKeys

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 (DatabaseAccountsClient) ListKeysPreparer

func (client DatabaseAccountsClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

ListKeysPreparer prepares the ListKeys request.

func (DatabaseAccountsClient) ListKeysResponder

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.

func (DatabaseAccountsClient) ListKeysSender

func (client DatabaseAccountsClient) ListKeysSender(req *http.Request) (*http.Response, error)

ListKeysSender sends the ListKeys request. The method will close the http.Response Body if it receives an error.

func (DatabaseAccountsClient) ListMetricDefinitions

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 (DatabaseAccountsClient) ListMetricDefinitionsPreparer

func (client DatabaseAccountsClient) ListMetricDefinitionsPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

ListMetricDefinitionsPreparer prepares the ListMetricDefinitions request.

func (DatabaseAccountsClient) ListMetricDefinitionsResponder

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 (DatabaseAccountsClient) ListMetricDefinitionsSender

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 (DatabaseAccountsClient) ListMetrics

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 (DatabaseAccountsClient) ListMetricsPreparer

func (client DatabaseAccountsClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, filter string) (*http.Request, error)

ListMetricsPreparer prepares the ListMetrics request.

func (DatabaseAccountsClient) ListMetricsResponder

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.

func (DatabaseAccountsClient) ListMetricsSender

func (client DatabaseAccountsClient) 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 (DatabaseAccountsClient) ListPreparer

func (client DatabaseAccountsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (DatabaseAccountsClient) ListReadOnlyKeys

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 (DatabaseAccountsClient) ListReadOnlyKeysPreparer

func (client DatabaseAccountsClient) ListReadOnlyKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

ListReadOnlyKeysPreparer prepares the ListReadOnlyKeys request.

func (DatabaseAccountsClient) ListReadOnlyKeysResponder

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 (DatabaseAccountsClient) ListReadOnlyKeysSender

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 (DatabaseAccountsClient) ListResponder

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.

func (DatabaseAccountsClient) ListSender

func (client DatabaseAccountsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (DatabaseAccountsClient) ListUsages

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 (DatabaseAccountsClient) ListUsagesPreparer

func (client DatabaseAccountsClient) ListUsagesPreparer(ctx context.Context, resourceGroupName string, accountName string, filter string) (*http.Request, error)

ListUsagesPreparer prepares the ListUsages request.

func (DatabaseAccountsClient) ListUsagesResponder

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.

func (DatabaseAccountsClient) ListUsagesSender

func (client DatabaseAccountsClient) 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.

func (DatabaseAccountsClient) OfflineRegion

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 (DatabaseAccountsClient) OfflineRegionPreparer

func (client DatabaseAccountsClient) OfflineRegionPreparer(ctx context.Context, resourceGroupName string, accountName string, regionParameterForOffline RegionForOnlineOffline) (*http.Request, error)

OfflineRegionPreparer prepares the OfflineRegion request.

func (DatabaseAccountsClient) OfflineRegionResponder

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 (DatabaseAccountsClient) OfflineRegionSender

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 (DatabaseAccountsClient) OnlineRegion

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 (DatabaseAccountsClient) OnlineRegionPreparer

func (client DatabaseAccountsClient) OnlineRegionPreparer(ctx context.Context, resourceGroupName string, accountName string, regionParameterForOnline RegionForOnlineOffline) (*http.Request, error)

OnlineRegionPreparer prepares the OnlineRegion request.

func (DatabaseAccountsClient) OnlineRegionResponder

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 (DatabaseAccountsClient) OnlineRegionSender

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 (DatabaseAccountsClient) RegenerateKey

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 (DatabaseAccountsClient) RegenerateKeyPreparer

func (client DatabaseAccountsClient) RegenerateKeyPreparer(ctx context.Context, resourceGroupName string, accountName string, keyToRegenerate DatabaseAccountRegenerateKeyParameters) (*http.Request, error)

RegenerateKeyPreparer prepares the RegenerateKey request.

func (DatabaseAccountsClient) RegenerateKeyResponder

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 (DatabaseAccountsClient) RegenerateKeySender

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 (DatabaseAccountsClient) Update

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 (DatabaseAccountsClient) UpdatePreparer

func (client DatabaseAccountsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, updateParameters DatabaseAccountUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (DatabaseAccountsClient) UpdateResponder

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 (DatabaseAccountsClient) UpdateSender

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

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.

func (*DatabaseAccountsCreateOrUpdateFuture) UnmarshalJSON

func (future *DatabaseAccountsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type DatabaseAccountsDeleteFuture

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.

func (*DatabaseAccountsDeleteFuture) UnmarshalJSON

func (future *DatabaseAccountsDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type DatabaseAccountsFailoverPriorityChangeFuture

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.

func (*DatabaseAccountsFailoverPriorityChangeFuture) UnmarshalJSON

func (future *DatabaseAccountsFailoverPriorityChangeFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type DatabaseAccountsListResult

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

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.

func (*DatabaseAccountsOfflineRegionFuture) UnmarshalJSON

func (future *DatabaseAccountsOfflineRegionFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type DatabaseAccountsOnlineRegionFuture

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.

func (*DatabaseAccountsOnlineRegionFuture) UnmarshalJSON

func (future *DatabaseAccountsOnlineRegionFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type DatabaseAccountsRegenerateKeyFuture

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.

func (*DatabaseAccountsRegenerateKeyFuture) UnmarshalJSON

func (future *DatabaseAccountsRegenerateKeyFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type DatabaseAccountsUpdateFuture

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.

func (*DatabaseAccountsUpdateFuture) UnmarshalJSON

func (future *DatabaseAccountsUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type DatabaseClient

type DatabaseClient struct {
	BaseClient
}

DatabaseClient is the azure Cosmos DB Database Service Resource Provider REST API

func NewDatabaseClient

func NewDatabaseClient(subscriptionID string, subscriptionID1 string) DatabaseClient

NewDatabaseClient creates an instance of the DatabaseClient client.

func NewDatabaseClientWithBaseURI

func NewDatabaseClientWithBaseURI(baseURI string, subscriptionID string, subscriptionID1 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 (DatabaseClient) ListMetricDefinitions

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 (DatabaseClient) ListMetricDefinitionsPreparer

func (client DatabaseClient) ListMetricDefinitionsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string) (*http.Request, error)

ListMetricDefinitionsPreparer prepares the ListMetricDefinitions request.

func (DatabaseClient) ListMetricDefinitionsResponder

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 (DatabaseClient) ListMetricDefinitionsSender

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 (DatabaseClient) ListMetrics

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 (DatabaseClient) ListMetricsPreparer

func (client DatabaseClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, filter string) (*http.Request, error)

ListMetricsPreparer prepares the ListMetrics request.

func (DatabaseClient) ListMetricsResponder

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.

func (DatabaseClient) ListMetricsSender

func (client DatabaseClient) 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 (DatabaseClient) ListUsages

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 (DatabaseClient) ListUsagesPreparer

func (client DatabaseClient) ListUsagesPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, filter string) (*http.Request, error)

ListUsagesPreparer prepares the ListUsages request.

func (DatabaseClient) ListUsagesResponder

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.

func (DatabaseClient) ListUsagesSender

func (client DatabaseClient) 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 DefaultConsistencyLevel

type DefaultConsistencyLevel string

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

func PossibleDefaultConsistencyLevelValues() []DefaultConsistencyLevel

PossibleDefaultConsistencyLevelValues returns an array of possible values for the DefaultConsistencyLevel const type.

type ErrorResponse

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

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

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

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

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 (FailoverPolicy) MarshalJSON

func (fp FailoverPolicy) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for FailoverPolicy.

type GremlinDatabaseCreateUpdateParameters

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 (GremlinDatabaseCreateUpdateParameters) MarshalJSON

func (gdcup GremlinDatabaseCreateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GremlinDatabaseCreateUpdateParameters.

func (*GremlinDatabaseCreateUpdateParameters) UnmarshalJSON

func (gdcup *GremlinDatabaseCreateUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for GremlinDatabaseCreateUpdateParameters struct.

type GremlinDatabaseCreateUpdateProperties

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 *CreateUpdateOptions `json:"options,omitempty"`
}

GremlinDatabaseCreateUpdateProperties properties to create and update Azure Cosmos DB Gremlin database.

type GremlinDatabaseGetProperties

type GremlinDatabaseGetProperties struct {
	Resource *GremlinDatabaseGetPropertiesResource `json:"resource,omitempty"`
}

GremlinDatabaseGetProperties the properties of an Azure Cosmos DB SQL database

type GremlinDatabaseGetPropertiesResource

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 (GremlinDatabaseGetPropertiesResource) MarshalJSON

func (gdgp GremlinDatabaseGetPropertiesResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GremlinDatabaseGetPropertiesResource.

type GremlinDatabaseGetResults

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 (GremlinDatabaseGetResults) MarshalJSON

func (gdgr GremlinDatabaseGetResults) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GremlinDatabaseGetResults.

func (*GremlinDatabaseGetResults) UnmarshalJSON

func (gdgr *GremlinDatabaseGetResults) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for GremlinDatabaseGetResults struct.

type GremlinDatabaseListResult

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

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

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 (GremlinGraphCreateUpdateParameters) MarshalJSON

func (ggcup GremlinGraphCreateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GremlinGraphCreateUpdateParameters.

func (*GremlinGraphCreateUpdateParameters) UnmarshalJSON

func (ggcup *GremlinGraphCreateUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for GremlinGraphCreateUpdateParameters struct.

type GremlinGraphCreateUpdateProperties

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 *CreateUpdateOptions `json:"options,omitempty"`
}

GremlinGraphCreateUpdateProperties properties to create and update Azure Cosmos DB Gremlin graph.

type GremlinGraphGetProperties

type GremlinGraphGetProperties struct {
	Resource *GremlinGraphGetPropertiesResource `json:"resource,omitempty"`
}

GremlinGraphGetProperties the properties of an Azure Cosmos DB Gremlin graph

type GremlinGraphGetPropertiesResource

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 (GremlinGraphGetPropertiesResource) MarshalJSON

func (gggp GremlinGraphGetPropertiesResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GremlinGraphGetPropertiesResource.

type GremlinGraphGetResults

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 (GremlinGraphGetResults) MarshalJSON

func (gggr GremlinGraphGetResults) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GremlinGraphGetResults.

func (*GremlinGraphGetResults) UnmarshalJSON

func (gggr *GremlinGraphGetResults) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for GremlinGraphGetResults struct.

type GremlinGraphListResult

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

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

type GremlinResourcesClient struct {
	BaseClient
}

GremlinResourcesClient is the azure Cosmos DB Database Service Resource Provider REST API

func NewGremlinResourcesClient

func NewGremlinResourcesClient(subscriptionID string, subscriptionID1 string) GremlinResourcesClient

NewGremlinResourcesClient creates an instance of the GremlinResourcesClient client.

func NewGremlinResourcesClientWithBaseURI

func NewGremlinResourcesClientWithBaseURI(baseURI string, subscriptionID string, subscriptionID1 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 (GremlinResourcesClient) CreateUpdateGremlinDatabase

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 (GremlinResourcesClient) CreateUpdateGremlinDatabasePreparer

func (client GremlinResourcesClient) CreateUpdateGremlinDatabasePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, createUpdateGremlinDatabaseParameters GremlinDatabaseCreateUpdateParameters) (*http.Request, error)

CreateUpdateGremlinDatabasePreparer prepares the CreateUpdateGremlinDatabase request.

func (GremlinResourcesClient) CreateUpdateGremlinDatabaseResponder

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 (GremlinResourcesClient) CreateUpdateGremlinDatabaseSender

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 (GremlinResourcesClient) CreateUpdateGremlinGraph

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 (GremlinResourcesClient) CreateUpdateGremlinGraphPreparer

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 (GremlinResourcesClient) CreateUpdateGremlinGraphResponder

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 (GremlinResourcesClient) CreateUpdateGremlinGraphSender

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 (GremlinResourcesClient) DeleteGremlinDatabase

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 (GremlinResourcesClient) DeleteGremlinDatabasePreparer

func (client GremlinResourcesClient) DeleteGremlinDatabasePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)

DeleteGremlinDatabasePreparer prepares the DeleteGremlinDatabase request.

func (GremlinResourcesClient) DeleteGremlinDatabaseResponder