documentdb

package
v48.2.2 Latest Latest
Warning

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

 Go to latest Published: Nov 27, 2020 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package documentdb implements the Azure ARM Documentdb service API version .

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 APIProperties 

type APIProperties struct {
	// ServerVersion - Describes the ServerVersion of an a MongoDB account. Possible values include: 'ThreeFullStopTwo', 'ThreeFullStopSix'
	ServerVersion ServerVersion `json:"serverVersion,omitempty"`
}

APIProperties ...

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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

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 AutoscaleSettings 

type AutoscaleSettings struct {
	// MaxThroughput - Represents maximum throughput, the resource can scale up to.
	MaxThroughput *int32 `json:"maxThroughput,omitempty"`
}

AutoscaleSettings ...

type AutoscaleSettingsResource 

type AutoscaleSettingsResource struct {
	// MaxThroughput - Represents maximum throughput container can scale up to.
	MaxThroughput *int32 `json:"maxThroughput,omitempty"`
	// AutoUpgradePolicy - Cosmos DB resource auto-upgrade policy
	AutoUpgradePolicy *AutoUpgradePolicyResource `json:"autoUpgradePolicy,omitempty"`
	// TargetMaxThroughput - READ-ONLY; Represents target maximum throughput container can scale up to once offer is no longer in pending state.
	TargetMaxThroughput *int32 `json:"targetMaxThroughput,omitempty"`
}

AutoscaleSettingsResource cosmos DB provisioned throughput settings object

func (AutoscaleSettingsResource) MarshalJSON 

func (asr AutoscaleSettingsResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AutoscaleSettingsResource.

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 BackupPolicy 

type BackupPolicy struct {
	// Type - Possible values include: 'TypeBackupPolicy', 'TypePeriodic', 'TypeContinuous'
	Type Type `json:"type,omitempty"`
}

BackupPolicy the object representing the policy for taking backups on an account.

func (BackupPolicy) AsBackupPolicy 

func (bp BackupPolicy) AsBackupPolicy() (*BackupPolicy, bool)

AsBackupPolicy is the BasicBackupPolicy implementation for BackupPolicy.

func (BackupPolicy) AsBasicBackupPolicy 

func (bp BackupPolicy) AsBasicBackupPolicy() (BasicBackupPolicy, bool)

AsBasicBackupPolicy is the BasicBackupPolicy implementation for BackupPolicy.

func (BackupPolicy) AsContinuousModeBackupPolicy 

func (bp BackupPolicy) AsContinuousModeBackupPolicy() (*ContinuousModeBackupPolicy, bool)

AsContinuousModeBackupPolicy is the BasicBackupPolicy implementation for BackupPolicy.

func (BackupPolicy) AsPeriodicModeBackupPolicy 

func (bp BackupPolicy) AsPeriodicModeBackupPolicy() (*PeriodicModeBackupPolicy, bool)

AsPeriodicModeBackupPolicy is the BasicBackupPolicy implementation for BackupPolicy.

func (BackupPolicy) MarshalJSON 

func (bp BackupPolicy) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for BackupPolicy.

type BaseClient 

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

BaseClient is the base client for Documentdb.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type BasicBackupPolicy 

type BasicBackupPolicy interface {
	AsPeriodicModeBackupPolicy() (*PeriodicModeBackupPolicy, bool)
	AsContinuousModeBackupPolicy() (*ContinuousModeBackupPolicy, bool)
	AsBackupPolicy() (*BackupPolicy, bool)
}

BasicBackupPolicy the object representing the policy for taking backups on an account.

type BasicDatabaseAccountCreateUpdateProperties 

type BasicDatabaseAccountCreateUpdateProperties interface {
	AsDefaultRequestDatabaseAccountCreateUpdateProperties() (*DefaultRequestDatabaseAccountCreateUpdateProperties, bool)
	AsRestoreReqeustDatabaseAccountCreateUpdateProperties() (*RestoreReqeustDatabaseAccountCreateUpdateProperties, bool)
	AsDatabaseAccountCreateUpdateProperties() (*DatabaseAccountCreateUpdateProperties, bool)
}

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

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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

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

CassandraKeyspaceGetProperties the properties of an Azure Cosmos DB Cassandra keyspace

type CassandraKeyspaceGetPropertiesOptions 

type CassandraKeyspaceGetPropertiesOptions struct {
	// Throughput - Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
	Throughput *int32 `json:"throughput,omitempty"`
	// AutoscaleSettings - Specifies the Autoscale settings.
	AutoscaleSettings *AutoscaleSettings `json:"autoscaleSettings,omitempty"`
}

CassandraKeyspaceGetPropertiesOptions ...

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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

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 client for the CassandraResources methods of the Documentdb service.

func NewCassandraResourcesClient 

func NewCassandraResourcesClient(subscriptionID string) CassandraResourcesClient

NewCassandraResourcesClient creates an instance of the CassandraResourcesClient client.

func NewCassandraResourcesClientWithBaseURI 

func NewCassandraResourcesClientWithBaseURI(baseURI string, subscriptionID string) CassandraResourcesClient

NewCassandraResourcesClientWithBaseURI creates an instance of the CassandraResourcesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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.Future
}

CassandraResourcesCreateUpdateCassandraKeyspaceFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CassandraResourcesCreateUpdateCassandraKeyspaceFuture) Result 

func (future *CassandraResourcesCreateUpdateCassandraKeyspaceFuture) Result(client CassandraResourcesClient) (ckgr CassandraKeyspaceGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type CassandraResourcesCreateUpdateCassandraTableFuture 

type CassandraResourcesCreateUpdateCassandraTableFuture struct {
	azure.Future
}

CassandraResourcesCreateUpdateCassandraTableFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CassandraResourcesCreateUpdateCassandraTableFuture) Result 

func (future *CassandraResourcesCreateUpdateCassandraTableFuture) Result(client CassandraResourcesClient) (ctgr CassandraTableGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type CassandraResourcesDeleteCassandraKeyspaceFuture 

type CassandraResourcesDeleteCassandraKeyspaceFuture struct {
	azure.Future
}

CassandraResourcesDeleteCassandraKeyspaceFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CassandraResourcesDeleteCassandraKeyspaceFuture) Result 

func (future *CassandraResourcesDeleteCassandraKeyspaceFuture) Result(client CassandraResourcesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type CassandraResourcesDeleteCassandraTableFuture 

type CassandraResourcesDeleteCassandraTableFuture struct {
	azure.Future
}

CassandraResourcesDeleteCassandraTableFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CassandraResourcesDeleteCassandraTableFuture) Result 

func (future *CassandraResourcesDeleteCassandraTableFuture) Result(client CassandraResourcesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type CassandraResourcesUpdateCassandraKeyspaceThroughputFuture 

type CassandraResourcesUpdateCassandraKeyspaceThroughputFuture struct {
	azure.Future
}

CassandraResourcesUpdateCassandraKeyspaceThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CassandraResourcesUpdateCassandraKeyspaceThroughputFuture) Result 

func (future *CassandraResourcesUpdateCassandraKeyspaceThroughputFuture) Result(client CassandraResourcesClient) (tsgr ThroughputSettingsGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type CassandraResourcesUpdateCassandraTableThroughputFuture 

type CassandraResourcesUpdateCassandraTableThroughputFuture struct {
	azure.Future
}

CassandraResourcesUpdateCassandraTableThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CassandraResourcesUpdateCassandraTableThroughputFuture) Result 

func (future *CassandraResourcesUpdateCassandraTableThroughputFuture) Result(client CassandraResourcesClient) (tsgr ThroughputSettingsGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

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

CassandraTableGetProperties the properties of an Azure Cosmos DB Cassandra table

type CassandraTableGetPropertiesOptions 

type CassandraTableGetPropertiesOptions struct {
	// Throughput - Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
	Throughput *int32 `json:"throughput,omitempty"`
	// AutoscaleSettings - Specifies the Autoscale settings.
	AutoscaleSettings *AutoscaleSettings `json:"autoscaleSettings,omitempty"`
}

CassandraTableGetPropertiesOptions ...

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"`
	// AnalyticalStorageTTL - Analytical TTL.
	AnalyticalStorageTTL *int32 `json:"analyticalStorageTtl,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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

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"`
	// AnalyticalStorageTTL - Analytical TTL.
	AnalyticalStorageTTL *int32 `json:"analyticalStorageTtl,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 client for the Collection methods of the Documentdb service.

func NewCollectionClient 

func NewCollectionClient(subscriptionID string) CollectionClient

NewCollectionClient creates an instance of the CollectionClient client.

func NewCollectionClientWithBaseURI 

func NewCollectionClientWithBaseURI(baseURI string, subscriptionID string) CollectionClient

NewCollectionClientWithBaseURI creates an instance of the CollectionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 client for the CollectionPartition methods of the Documentdb service.

func NewCollectionPartitionClient 

func NewCollectionPartitionClient(subscriptionID string) CollectionPartitionClient

NewCollectionPartitionClient creates an instance of the CollectionPartitionClient client.

func NewCollectionPartitionClientWithBaseURI 

func NewCollectionPartitionClientWithBaseURI(baseURI string, subscriptionID string) CollectionPartitionClient

NewCollectionPartitionClientWithBaseURI creates an instance of the CollectionPartitionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 client for the CollectionPartitionRegion methods of the Documentdb service.

func NewCollectionPartitionRegionClient 

func NewCollectionPartitionRegionClient(subscriptionID string) CollectionPartitionRegionClient

NewCollectionPartitionRegionClient creates an instance of the CollectionPartitionRegionClient client.

func NewCollectionPartitionRegionClientWithBaseURI 

func NewCollectionPartitionRegionClientWithBaseURI(baseURI string, subscriptionID string) CollectionPartitionRegionClient

NewCollectionPartitionRegionClientWithBaseURI creates an instance of the CollectionPartitionRegionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (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 - the name of the resource group. The name is case insensitive. 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 client for the CollectionRegion methods of the Documentdb service.

func NewCollectionRegionClient 

func NewCollectionRegionClient(subscriptionID string) CollectionRegionClient

NewCollectionRegionClient creates an instance of the CollectionRegionClient client.

func NewCollectionRegionClientWithBaseURI 

func NewCollectionRegionClientWithBaseURI(baseURI string, subscriptionID string) CollectionRegionClient

NewCollectionRegionClientWithBaseURI creates an instance of the CollectionRegionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (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 - the name of the resource group. The name is case insensitive. 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 ContinuousModeBackupPolicy 

type ContinuousModeBackupPolicy struct {
	// Type - Possible values include: 'TypeBackupPolicy', 'TypePeriodic', 'TypeContinuous'
	Type Type `json:"type,omitempty"`
}

ContinuousModeBackupPolicy the object representing continuous mode backup policy.

func (ContinuousModeBackupPolicy) AsBackupPolicy 

func (cmbp ContinuousModeBackupPolicy) AsBackupPolicy() (*BackupPolicy, bool)

AsBackupPolicy is the BasicBackupPolicy implementation for ContinuousModeBackupPolicy.

func (ContinuousModeBackupPolicy) AsBasicBackupPolicy 

func (cmbp ContinuousModeBackupPolicy) AsBasicBackupPolicy() (BasicBackupPolicy, bool)

AsBasicBackupPolicy is the BasicBackupPolicy implementation for ContinuousModeBackupPolicy.

func (ContinuousModeBackupPolicy) AsContinuousModeBackupPolicy 

func (cmbp ContinuousModeBackupPolicy) AsContinuousModeBackupPolicy() (*ContinuousModeBackupPolicy, bool)

AsContinuousModeBackupPolicy is the BasicBackupPolicy implementation for ContinuousModeBackupPolicy.

func (ContinuousModeBackupPolicy) AsPeriodicModeBackupPolicy 

func (cmbp ContinuousModeBackupPolicy) AsPeriodicModeBackupPolicy() (*PeriodicModeBackupPolicy, bool)

AsPeriodicModeBackupPolicy is the BasicBackupPolicy implementation for ContinuousModeBackupPolicy.

func (ContinuousModeBackupPolicy) MarshalJSON 

func (cmbp ContinuousModeBackupPolicy) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ContinuousModeBackupPolicy.

type CorsPolicy added in v48.2.1 

type CorsPolicy struct {
	// AllowedOrigins - The origin domains that are permitted to make a request against the service via CORS.
	AllowedOrigins *string `json:"allowedOrigins,omitempty"`
	// AllowedMethods - The methods (HTTP request verbs) that the origin domain may use for a CORS request.
	AllowedMethods *string `json:"allowedMethods,omitempty"`
	// AllowedHeaders - The request headers that the origin domain may specify on the CORS request.
	AllowedHeaders *string `json:"allowedHeaders,omitempty"`
	// ExposedHeaders - The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
	ExposedHeaders *string `json:"exposedHeaders,omitempty"`
	// MaxAgeInSeconds - The maximum amount time that a browser should cache the preflight OPTIONS request.
	MaxAgeInSeconds *int64 `json:"maxAgeInSeconds,omitempty"`
}

CorsPolicy the CORS policy for the Cosmos DB database account.

type CreateMode 

type CreateMode string

CreateMode enumerates the values for create mode. 

const (
	// Default ...
	Default CreateMode = "Default"
	// Restore ...
	Restore CreateMode = "Restore"
)

func PossibleCreateModeValues 

func PossibleCreateModeValues() []CreateMode

PossibleCreateModeValues returns an array of possible values for the CreateMode const type.

type CreateModeBasicDatabaseAccountCreateUpdateProperties 

type CreateModeBasicDatabaseAccountCreateUpdateProperties string

CreateModeBasicDatabaseAccountCreateUpdateProperties enumerates the values for create mode basic database account create update properties. 

const (
	// CreateModeDatabaseAccountCreateUpdateProperties ...
	CreateModeDatabaseAccountCreateUpdateProperties CreateModeBasicDatabaseAccountCreateUpdateProperties = "DatabaseAccountCreateUpdateProperties"
	// CreateModeDefault ...
	CreateModeDefault CreateModeBasicDatabaseAccountCreateUpdateProperties = "Default"
	// CreateModeRestore ...
	CreateModeRestore CreateModeBasicDatabaseAccountCreateUpdateProperties = "Restore"
)

func PossibleCreateModeBasicDatabaseAccountCreateUpdatePropertiesValues 

func PossibleCreateModeBasicDatabaseAccountCreateUpdatePropertiesValues() []CreateModeBasicDatabaseAccountCreateUpdateProperties

PossibleCreateModeBasicDatabaseAccountCreateUpdatePropertiesValues returns an array of possible values for the CreateModeBasicDatabaseAccountCreateUpdateProperties const type.

type CreateUpdateOptions 

type CreateUpdateOptions struct {
	// Throughput - Request Units per second. For example, "throughput": 10000.
	Throughput *int32 `json:"throughput,omitempty"`
	// AutoscaleSettings - Specifies the Autoscale settings.
	AutoscaleSettings *AutoscaleSettings `json:"autoscaleSettings,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"

type CreatedByType 

type CreatedByType string

CreatedByType enumerates the values for created by type. 

const (
	// Application ...
	Application CreatedByType = "Application"
	// Key ...
	Key CreatedByType = "Key"
	// ManagedIdentity ...
	ManagedIdentity CreatedByType = "ManagedIdentity"
	// User ...
	User CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns an array of possible values for the CreatedByType const type.

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"`
	Properties BasicDatabaseAccountCreateUpdateProperties `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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

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"`
	// IPRules - List of IpRules.
	IPRules *[]IPAddressOrRange `json:"ipRules,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"`
	// PublicNetworkAccess - Whether requests from Public Network are allowed. Possible values include: 'Enabled', 'Disabled'
	PublicNetworkAccess PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
	// EnableFreeTier - Flag to indicate whether Free Tier is enabled.
	EnableFreeTier *bool `json:"enableFreeTier,omitempty"`
	// APIProperties - API specific properties. Currently, supported only for MongoDB API.
	APIProperties *APIProperties `json:"apiProperties,omitempty"`
	// EnableAnalyticalStorage - Flag to indicate whether to enable storage analytics.
	EnableAnalyticalStorage *bool `json:"enableAnalyticalStorage,omitempty"`
	// BackupPolicy - The object representing the policy for taking backups on an account.
	BackupPolicy BasicBackupPolicy `json:"backupPolicy,omitempty"`
	// Cors - The CORS policy for the Cosmos DB database account.
	Cors *[]CorsPolicy `json:"cors,omitempty"`
	// CreateMode - Possible values include: 'CreateModeDatabaseAccountCreateUpdateProperties', 'CreateModeDefault', 'CreateModeRestore'
	CreateMode CreateModeBasicDatabaseAccountCreateUpdateProperties `json:"createMode,omitempty"`
}

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

func (DatabaseAccountCreateUpdateProperties) AsBasicDatabaseAccountCreateUpdateProperties 

func (dacup DatabaseAccountCreateUpdateProperties) AsBasicDatabaseAccountCreateUpdateProperties() (BasicDatabaseAccountCreateUpdateProperties, bool)

AsBasicDatabaseAccountCreateUpdateProperties is the BasicDatabaseAccountCreateUpdateProperties implementation for DatabaseAccountCreateUpdateProperties.

func (DatabaseAccountCreateUpdateProperties) AsDatabaseAccountCreateUpdateProperties 

func (dacup DatabaseAccountCreateUpdateProperties) AsDatabaseAccountCreateUpdateProperties() (*DatabaseAccountCreateUpdateProperties, bool)

AsDatabaseAccountCreateUpdateProperties is the BasicDatabaseAccountCreateUpdateProperties implementation for DatabaseAccountCreateUpdateProperties.

func (DatabaseAccountCreateUpdateProperties) AsDefaultRequestDatabaseAccountCreateUpdateProperties 

func (dacup DatabaseAccountCreateUpdateProperties) AsDefaultRequestDatabaseAccountCreateUpdateProperties() (*DefaultRequestDatabaseAccountCreateUpdateProperties, bool)

AsDefaultRequestDatabaseAccountCreateUpdateProperties is the BasicDatabaseAccountCreateUpdateProperties implementation for DatabaseAccountCreateUpdateProperties.

func (DatabaseAccountCreateUpdateProperties) AsRestoreReqeustDatabaseAccountCreateUpdateProperties 

func (dacup DatabaseAccountCreateUpdateProperties) AsRestoreReqeustDatabaseAccountCreateUpdateProperties() (*RestoreReqeustDatabaseAccountCreateUpdateProperties, bool)

AsRestoreReqeustDatabaseAccountCreateUpdateProperties is the BasicDatabaseAccountCreateUpdateProperties implementation for DatabaseAccountCreateUpdateProperties.

func (DatabaseAccountCreateUpdateProperties) MarshalJSON 

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

MarshalJSON is the custom marshaler for DatabaseAccountCreateUpdateProperties.

func (*DatabaseAccountCreateUpdateProperties) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for DatabaseAccountCreateUpdateProperties struct.

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"`
	// IPRules - List of IpRules.
	IPRules *[]IPAddressOrRange `json:"ipRules,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"`
	// PrivateEndpointConnections - READ-ONLY; List of Private Endpoint Connections configured for the Cosmos DB account.
	PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,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"`
	// PublicNetworkAccess - Whether requests from Public Network are allowed. Possible values include: 'Enabled', 'Disabled'
	PublicNetworkAccess PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
	// EnableFreeTier - Flag to indicate whether Free Tier is enabled.
	EnableFreeTier *bool `json:"enableFreeTier,omitempty"`
	// APIProperties - API specific properties.
	APIProperties *APIProperties `json:"apiProperties,omitempty"`
	// EnableAnalyticalStorage - Flag to indicate whether to enable storage analytics.
	EnableAnalyticalStorage *bool `json:"enableAnalyticalStorage,omitempty"`
	// InstanceID - READ-ONLY; A unique identifier assigned to the database account
	InstanceID *string `json:"instanceId,omitempty"`
	// CreateMode - Enum to indicate the mode of account creation. Possible values include: 'Default', 'Restore'
	CreateMode CreateMode `json:"createMode,omitempty"`
	// RestoreParameters - Parameters to indicate the information about the restore.
	RestoreParameters *RestoreParameters `json:"restoreParameters,omitempty"`
	// BackupPolicy - The object representing the policy for taking backups on an account.
	BackupPolicy BasicBackupPolicy `json:"backupPolicy,omitempty"`
	// Cors - The CORS policy for the Cosmos DB database account.
	Cors *[]CorsPolicy `json:"cors,omitempty"`
}

DatabaseAccountGetProperties properties for the database account.

func (DatabaseAccountGetProperties) MarshalJSON 

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

MarshalJSON is the custom marshaler for DatabaseAccountGetProperties.

func (*DatabaseAccountGetProperties) UnmarshalJSON 

func (dagp *DatabaseAccountGetProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DatabaseAccountGetProperties struct.

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"`
	// SystemData - READ-ONLY; The system meta data relating to this resource.
	SystemData *SystemData `json:"systemData,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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

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 client for the DatabaseAccountRegion methods of the Documentdb service.

func NewDatabaseAccountRegionClient 

func NewDatabaseAccountRegionClient(subscriptionID string) DatabaseAccountRegionClient

NewDatabaseAccountRegionClient creates an instance of the DatabaseAccountRegionClient client.

func NewDatabaseAccountRegionClientWithBaseURI 

func NewDatabaseAccountRegionClientWithBaseURI(baseURI string, subscriptionID string) DatabaseAccountRegionClient

NewDatabaseAccountRegionClientWithBaseURI creates an instance of the DatabaseAccountRegionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (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 - the name of the resource group. The name is case insensitive. 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"`
	Identity                         *ManagedServiceIdentity `json:"identity,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"`
	// IPRules - List of IpRules.
	IPRules *[]IPAddressOrRange `json:"ipRules,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"`
	// PublicNetworkAccess - Whether requests from Public Network are allowed. Possible values include: 'Enabled', 'Disabled'
	PublicNetworkAccess PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
	// EnableFreeTier - Flag to indicate whether Free Tier is enabled.
	EnableFreeTier *bool `json:"enableFreeTier,omitempty"`
	// APIProperties - API specific properties. Currently, supported only for MongoDB API.
	APIProperties *APIProperties `json:"apiProperties,omitempty"`
	// EnableAnalyticalStorage - Flag to indicate whether to enable storage analytics.
	EnableAnalyticalStorage *bool `json:"enableAnalyticalStorage,omitempty"`
	// BackupPolicy - The object representing the policy for taking backups on an account.
	BackupPolicy BasicBackupPolicy `json:"backupPolicy,omitempty"`
	// Cors - The CORS policy for the Cosmos DB database account.
	Cors *[]CorsPolicy `json:"cors,omitempty"`
}

DatabaseAccountUpdateProperties properties to update Azure Cosmos DB database accounts.

func (*DatabaseAccountUpdateProperties) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaler for DatabaseAccountUpdateProperties struct.

type DatabaseAccountsClient 

type DatabaseAccountsClient struct {
	BaseClient
}

DatabaseAccountsClient is the client for the DatabaseAccounts methods of the Documentdb service.

func NewDatabaseAccountsClient 

func NewDatabaseAccountsClient(subscriptionID string) DatabaseAccountsClient

NewDatabaseAccountsClient creates an instance of the DatabaseAccountsClient client.

func NewDatabaseAccountsClientWithBaseURI 

func NewDatabaseAccountsClientWithBaseURI(baseURI string, subscriptionID string) DatabaseAccountsClient

NewDatabaseAccountsClientWithBaseURI creates an instance of the DatabaseAccountsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 

func (client DatabaseAccountsClient) List(ctx context.Context) (result DatabaseAccountsListResult, err error)

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

func (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 - the name of the resource group. The name is case insensitive.

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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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.Future
}

DatabaseAccountsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*DatabaseAccountsCreateOrUpdateFuture) Result 

func (future *DatabaseAccountsCreateOrUpdateFuture) Result(client DatabaseAccountsClient) (dagr DatabaseAccountGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type DatabaseAccountsDeleteFuture 

type DatabaseAccountsDeleteFuture struct {
	azure.Future
}

DatabaseAccountsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*DatabaseAccountsDeleteFuture) Result 

func (future *DatabaseAccountsDeleteFuture) Result(client DatabaseAccountsClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type DatabaseAccountsFailoverPriorityChangeFuture 

type DatabaseAccountsFailoverPriorityChangeFuture struct {
	azure.Future
}

DatabaseAccountsFailoverPriorityChangeFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*DatabaseAccountsFailoverPriorityChangeFuture) Result 

func (future *DatabaseAccountsFailoverPriorityChangeFuture) Result(client DatabaseAccountsClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

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

DatabaseAccountsOfflineRegionFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*DatabaseAccountsOfflineRegionFuture) Result 

func (future *DatabaseAccountsOfflineRegionFuture) Result(client DatabaseAccountsClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type DatabaseAccountsOnlineRegionFuture 

type DatabaseAccountsOnlineRegionFuture struct {
	azure.Future
}

DatabaseAccountsOnlineRegionFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*DatabaseAccountsOnlineRegionFuture) Result 

func (future *DatabaseAccountsOnlineRegionFuture) Result(client DatabaseAccountsClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type DatabaseAccountsRegenerateKeyFuture 

type DatabaseAccountsRegenerateKeyFuture struct {
	azure.Future
}

DatabaseAccountsRegenerateKeyFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*DatabaseAccountsRegenerateKeyFuture) Result 

func (future *DatabaseAccountsRegenerateKeyFuture) Result(client DatabaseAccountsClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type DatabaseAccountsUpdateFuture 

type DatabaseAccountsUpdateFuture struct {
	azure.Future
}

DatabaseAccountsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*DatabaseAccountsUpdateFuture) Result 

func (future *DatabaseAccountsUpdateFuture) Result(client DatabaseAccountsClient) (dagr DatabaseAccountGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type DatabaseClient 

type DatabaseClient struct {
	BaseClient
}

DatabaseClient is the client for the Database methods of the Documentdb service.

func NewDatabaseClient 

func NewDatabaseClient(subscriptionID string) DatabaseClient

NewDatabaseClient creates an instance of the DatabaseClient client.

func NewDatabaseClientWithBaseURI 

func NewDatabaseClientWithBaseURI(baseURI string, subscriptionID string) DatabaseClient

NewDatabaseClientWithBaseURI creates an instance of the DatabaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 DatabaseRestoreResource 

type DatabaseRestoreResource struct {
	// DatabaseName - The name of the database to restore.
	DatabaseName *string `json:"databaseName,omitempty"`
	// CollectionNames - The names of the collections to restore.
	CollectionNames *[]string `json:"collectionNames,omitempty"`
}

DatabaseRestoreResource specific Databases to restore.

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 DefaultErrorResponse added in v48.2.1 

type DefaultErrorResponse struct {
	Error *ErrorResponse `json:"error,omitempty"`
}

DefaultErrorResponse an error response from the service.

type DefaultRequestDatabaseAccountCreateUpdateProperties 

type DefaultRequestDatabaseAccountCreateUpdateProperties 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"`
	// IPRules - List of IpRules.
	IPRules *[]IPAddressOrRange `json:"ipRules,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"`
	// PublicNetworkAccess - Whether requests from Public Network are allowed. Possible values include: 'Enabled', 'Disabled'
	PublicNetworkAccess PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
	// EnableFreeTier - Flag to indicate whether Free Tier is enabled.
	EnableFreeTier *bool `json:"enableFreeTier,omitempty"`
	// APIProperties - API specific properties. Currently, supported only for MongoDB API.
	APIProperties *APIProperties `json:"apiProperties,omitempty"`
	// EnableAnalyticalStorage - Flag to indicate whether to enable storage analytics.
	EnableAnalyticalStorage *bool `json:"enableAnalyticalStorage,omitempty"`
	// BackupPolicy - The object representing the policy for taking backups on an account.
	BackupPolicy BasicBackupPolicy `json:"backupPolicy,omitempty"`
	// Cors - The CORS policy for the Cosmos DB database account.
	Cors *[]CorsPolicy `json:"cors,omitempty"`
	// CreateMode - Possible values include: 'CreateModeDatabaseAccountCreateUpdateProperties', 'CreateModeDefault', 'CreateModeRestore'
	CreateMode CreateModeBasicDatabaseAccountCreateUpdateProperties `json:"createMode,omitempty"`
}

DefaultRequestDatabaseAccountCreateUpdateProperties properties for non-restore Azure Cosmos DB database account requests.

func (DefaultRequestDatabaseAccountCreateUpdateProperties) AsBasicDatabaseAccountCreateUpdateProperties 

func (drdacup DefaultRequestDatabaseAccountCreateUpdateProperties) AsBasicDatabaseAccountCreateUpdateProperties() (BasicDatabaseAccountCreateUpdateProperties, bool)

AsBasicDatabaseAccountCreateUpdateProperties is the BasicDatabaseAccountCreateUpdateProperties implementation for DefaultRequestDatabaseAccountCreateUpdateProperties.

func (DefaultRequestDatabaseAccountCreateUpdateProperties) AsDatabaseAccountCreateUpdateProperties 

func (drdacup DefaultRequestDatabaseAccountCreateUpdateProperties) AsDatabaseAccountCreateUpdateProperties() (*DatabaseAccountCreateUpdateProperties, bool)

AsDatabaseAccountCreateUpdateProperties is the BasicDatabaseAccountCreateUpdateProperties implementation for DefaultRequestDatabaseAccountCreateUpdateProperties.

func (DefaultRequestDatabaseAccountCreateUpdateProperties) AsDefaultRequestDatabaseAccountCreateUpdateProperties 

func (drdacup DefaultRequestDatabaseAccountCreateUpdateProperties) AsDefaultRequestDatabaseAccountCreateUpdateProperties() (*DefaultRequestDatabaseAccountCreateUpdateProperties, bool)

AsDefaultRequestDatabaseAccountCreateUpdateProperties is the BasicDatabaseAccountCreateUpdateProperties implementation for DefaultRequestDatabaseAccountCreateUpdateProperties.

func (DefaultRequestDatabaseAccountCreateUpdateProperties) AsRestoreReqeustDatabaseAccountCreateUpdateProperties 

func (drdacup DefaultRequestDatabaseAccountCreateUpdateProperties) AsRestoreReqeustDatabaseAccountCreateUpdateProperties() (*RestoreReqeustDatabaseAccountCreateUpdateProperties, bool)

AsRestoreReqeustDatabaseAccountCreateUpdateProperties is the BasicDatabaseAccountCreateUpdateProperties implementation for DefaultRequestDatabaseAccountCreateUpdateProperties.

func (DefaultRequestDatabaseAccountCreateUpdateProperties) MarshalJSON 

func (drdacup DefaultRequestDatabaseAccountCreateUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DefaultRequestDatabaseAccountCreateUpdateProperties.

func (*DefaultRequestDatabaseAccountCreateUpdateProperties) UnmarshalJSON 

func (drdacup *DefaultRequestDatabaseAccountCreateUpdateProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DefaultRequestDatabaseAccountCreateUpdateProperties struct.

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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

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

GremlinDatabaseGetProperties the properties of an Azure Cosmos DB SQL database

type GremlinDatabaseGetPropertiesOptions 

type GremlinDatabaseGetPropertiesOptions struct {
	// Throughput - Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
	Throughput *int32 `json:"throughput,omitempty"`
	// AutoscaleSettings - Specifies the Autoscale settings.
	AutoscaleSettings *AutoscaleSettings `json:"autoscaleSettings,omitempty"`
}

GremlinDatabaseGetPropertiesOptions ...

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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

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

GremlinGraphGetProperties the properties of an Azure Cosmos DB Gremlin graph

type GremlinGraphGetPropertiesOptions 

type GremlinGraphGetPropertiesOptions struct {
	// Throughput - Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
	Throughput *int32 `json:"throughput,omitempty"`
	// AutoscaleSettings - Specifies the Autoscale settings.
	AutoscaleSettings *AutoscaleSettings `json:"autoscaleSettings,omitempty"`
}

GremlinGraphGetPropertiesOptions ...

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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

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 client for the GremlinResources methods of the Documentdb service.

func NewGremlinResourcesClient 

func NewGremlinResourcesClient(subscriptionID string) GremlinResourcesClient

NewGremlinResourcesClient creates an instance of the GremlinResourcesClient client.

func NewGremlinResourcesClientWithBaseURI 

func NewGremlinResourcesClientWithBaseURI(baseURI string, subscriptionID string) GremlinResourcesClient

NewGremlinResourcesClientWithBaseURI creates an instance of the GremlinResourcesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 - the name of the resource group. The name is case insensitive. 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 

func (client GremlinResourcesClient) DeleteGremlinDatabaseResponder(resp *http.Response) (result autorest.Response, err error)

DeleteGremlinDatabaseResponder handles the response to the DeleteGremlinDatabase request. The method always closes the http.Response Body.

func (GremlinResourcesClient) DeleteGremlinDatabaseSender 

func (client GremlinResourcesClient) DeleteGremlinDatabaseSender(req *http.Request) (future GremlinResourcesDeleteGremlinDatabaseFuture, err error)

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

func (GremlinResourcesClient) DeleteGremlinGraph 

func (client GremlinResourcesClient) DeleteGremlinGraph(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string) (result GremlinResourcesDeleteGremlinGraphFuture, err error)

DeleteGremlinGraph deletes an existing Azure Cosmos DB Gremlin graph. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. graphName - cosmos DB graph name.

func (GremlinResourcesClient) DeleteGremlinGraphPreparer 

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

DeleteGremlinGraphPreparer prepares the DeleteGremlinGraph request.

func (GremlinResourcesClient) DeleteGremlinGraphResponder 

func (client GremlinResourcesClient) DeleteGremlinGraphResponder(resp *http.Response) (result autorest.Response, err error)

DeleteGremlinGraphResponder handles the response to the DeleteGremlinGraph request. The method always closes the http.Response Body.

func (GremlinResourcesClient) DeleteGremlinGraphSender 

func (client GremlinResourcesClient) DeleteGremlinGraphSender(req *http.Request) (future GremlinResourcesDeleteGremlinGraphFuture, err error)

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

func (GremlinResourcesClient) GetGremlinDatabase 

func (client GremlinResourcesClient) GetGremlinDatabase(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result GremlinDatabaseGetResults, err error)

GetGremlinDatabase gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name.

func (GremlinResourcesClient) GetGremlinDatabasePreparer 

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

GetGremlinDatabasePreparer prepares the GetGremlinDatabase request.

func (GremlinResourcesClient) GetGremlinDatabaseResponder 

func (client GremlinResourcesClient) GetGremlinDatabaseResponder(resp *http.Response) (result GremlinDatabaseGetResults, err error)

GetGremlinDatabaseResponder handles the response to the GetGremlinDatabase request. The method always closes the http.Response Body.

func (GremlinResourcesClient) GetGremlinDatabaseSender 

func (client GremlinResourcesClient) GetGremlinDatabaseSender(req *http.Request) (*http.Response, error)

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

func (GremlinResourcesClient) GetGremlinDatabaseThroughput 

func (client GremlinResourcesClient) GetGremlinDatabaseThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result ThroughputSettingsGetResults, err error)

GetGremlinDatabaseThroughput gets the RUs per second of the Gremlin database under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name.

func (GremlinResourcesClient) GetGremlinDatabaseThroughputPreparer 

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

GetGremlinDatabaseThroughputPreparer prepares the GetGremlinDatabaseThroughput request.

func (GremlinResourcesClient) GetGremlinDatabaseThroughputResponder 

func (client GremlinResourcesClient) GetGremlinDatabaseThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)

GetGremlinDatabaseThroughputResponder handles the response to the GetGremlinDatabaseThroughput request. The method always closes the http.Response Body.

func (GremlinResourcesClient) GetGremlinDatabaseThroughputSender 

func (client GremlinResourcesClient) GetGremlinDatabaseThroughputSender(req *http.Request) (*http.Response, error)

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

func (GremlinResourcesClient) GetGremlinGraph 

func (client GremlinResourcesClient) GetGremlinGraph(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string) (result GremlinGraphGetResults, err error)

GetGremlinGraph gets the Gremlin graph under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. graphName - cosmos DB graph name.

func (GremlinResourcesClient) GetGremlinGraphPreparer 

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

GetGremlinGraphPreparer prepares the GetGremlinGraph request.

func (GremlinResourcesClient) GetGremlinGraphResponder 

func (client GremlinResourcesClient) GetGremlinGraphResponder(resp *http.Response) (result GremlinGraphGetResults, err error)

GetGremlinGraphResponder handles the response to the GetGremlinGraph request. The method always closes the http.Response Body.

func (GremlinResourcesClient) GetGremlinGraphSender 

func (client GremlinResourcesClient) GetGremlinGraphSender(req *http.Request) (*http.Response, error)

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

func (GremlinResourcesClient) GetGremlinGraphThroughput 

func (client GremlinResourcesClient) GetGremlinGraphThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string) (result ThroughputSettingsGetResults, err error)

GetGremlinGraphThroughput gets the Gremlin graph throughput under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. graphName - cosmos DB graph name.

func (GremlinResourcesClient) GetGremlinGraphThroughputPreparer 

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

GetGremlinGraphThroughputPreparer prepares the GetGremlinGraphThroughput request.

func (GremlinResourcesClient) GetGremlinGraphThroughputResponder 

func (client GremlinResourcesClient) GetGremlinGraphThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)

GetGremlinGraphThroughputResponder handles the response to the GetGremlinGraphThroughput request. The method always closes the http.Response Body.

func (GremlinResourcesClient) GetGremlinGraphThroughputSender 

func (client GremlinResourcesClient) GetGremlinGraphThroughputSender(req *http.Request) (*http.Response, error)

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

func (GremlinResourcesClient) ListGremlinDatabases 

func (client GremlinResourcesClient) ListGremlinDatabases(ctx context.Context, resourceGroupName string, accountName string) (result GremlinDatabaseListResult, err error)

ListGremlinDatabases lists the Gremlin databases under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.

func (GremlinResourcesClient) ListGremlinDatabasesPreparer 

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

ListGremlinDatabasesPreparer prepares the ListGremlinDatabases request.

func (GremlinResourcesClient) ListGremlinDatabasesResponder 

func (client GremlinResourcesClient) ListGremlinDatabasesResponder(resp *http.Response) (result GremlinDatabaseListResult, err error)

ListGremlinDatabasesResponder handles the response to the ListGremlinDatabases request. The method always closes the http.Response Body.

func (GremlinResourcesClient) ListGremlinDatabasesSender 

func (client GremlinResourcesClient) ListGremlinDatabasesSender(req *http.Request) (*http.Response, error)

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

func (GremlinResourcesClient) ListGremlinGraphs 

func (client GremlinResourcesClient) ListGremlinGraphs(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result GremlinGraphListResult, err error)

ListGremlinGraphs lists the Gremlin graph under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name.

func (GremlinResourcesClient) ListGremlinGraphsPreparer 

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

ListGremlinGraphsPreparer prepares the ListGremlinGraphs request.

func (GremlinResourcesClient) ListGremlinGraphsResponder 

func (client GremlinResourcesClient) ListGremlinGraphsResponder(resp *http.Response) (result GremlinGraphListResult, err error)

ListGremlinGraphsResponder handles the response to the ListGremlinGraphs request. The method always closes the http.Response Body.

func (GremlinResourcesClient) ListGremlinGraphsSender 

func (client GremlinResourcesClient) ListGremlinGraphsSender(req *http.Request) (*http.Response, error)

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

func (GremlinResourcesClient) UpdateGremlinDatabaseThroughput 

func (client GremlinResourcesClient) UpdateGremlinDatabaseThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (result GremlinResourcesUpdateGremlinDatabaseThroughputFuture, err error)

UpdateGremlinDatabaseThroughput update RUs per second of an Azure Cosmos DB Gremlin database Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. updateThroughputParameters - the RUs per second of the parameters to provide for the current Gremlin database.

func (GremlinResourcesClient) UpdateGremlinDatabaseThroughputPreparer 

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

UpdateGremlinDatabaseThroughputPreparer prepares the UpdateGremlinDatabaseThroughput request.

func (GremlinResourcesClient) UpdateGremlinDatabaseThroughputResponder 

func (client GremlinResourcesClient) UpdateGremlinDatabaseThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)

UpdateGremlinDatabaseThroughputResponder handles the response to the UpdateGremlinDatabaseThroughput request. The method always closes the http.Response Body.

func (GremlinResourcesClient) UpdateGremlinDatabaseThroughputSender 

func (client GremlinResourcesClient) UpdateGremlinDatabaseThroughputSender(req *http.Request) (future GremlinResourcesUpdateGremlinDatabaseThroughputFuture, err error)

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

func (GremlinResourcesClient) UpdateGremlinGraphThroughput 

func (client GremlinResourcesClient) UpdateGremlinGraphThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (result GremlinResourcesUpdateGremlinGraphThroughputFuture, err error)

UpdateGremlinGraphThroughput update RUs per second of an Azure Cosmos DB Gremlin graph Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. graphName - cosmos DB graph name. updateThroughputParameters - the RUs per second of the parameters to provide for the current Gremlin graph.

func (GremlinResourcesClient) UpdateGremlinGraphThroughputPreparer 

func (client GremlinResourcesClient) UpdateGremlinGraphThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)

UpdateGremlinGraphThroughputPreparer prepares the UpdateGremlinGraphThroughput request.

func (GremlinResourcesClient) UpdateGremlinGraphThroughputResponder 

func (client GremlinResourcesClient) UpdateGremlinGraphThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)

UpdateGremlinGraphThroughputResponder handles the response to the UpdateGremlinGraphThroughput request. The method always closes the http.Response Body.

func (GremlinResourcesClient) UpdateGremlinGraphThroughputSender 

func (client GremlinResourcesClient) UpdateGremlinGraphThroughputSender(req *http.Request) (future GremlinResourcesUpdateGremlinGraphThroughputFuture, err error)

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

type GremlinResourcesCreateUpdateGremlinDatabaseFuture 

type GremlinResourcesCreateUpdateGremlinDatabaseFuture struct {
	azure.Future
}

GremlinResourcesCreateUpdateGremlinDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*GremlinResourcesCreateUpdateGremlinDatabaseFuture) Result 

func (future *GremlinResourcesCreateUpdateGremlinDatabaseFuture) Result(client GremlinResourcesClient) (gdgr GremlinDatabaseGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type GremlinResourcesCreateUpdateGremlinGraphFuture 

type GremlinResourcesCreateUpdateGremlinGraphFuture struct {
	azure.Future
}

GremlinResourcesCreateUpdateGremlinGraphFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*GremlinResourcesCreateUpdateGremlinGraphFuture) Result 

func (future *GremlinResourcesCreateUpdateGremlinGraphFuture) Result(client GremlinResourcesClient) (gggr GremlinGraphGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type GremlinResourcesDeleteGremlinDatabaseFuture 

type GremlinResourcesDeleteGremlinDatabaseFuture struct {
	azure.Future
}

GremlinResourcesDeleteGremlinDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*GremlinResourcesDeleteGremlinDatabaseFuture) Result 

func (future *GremlinResourcesDeleteGremlinDatabaseFuture) Result(client GremlinResourcesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type GremlinResourcesDeleteGremlinGraphFuture 

type GremlinResourcesDeleteGremlinGraphFuture struct {
	azure.Future
}

GremlinResourcesDeleteGremlinGraphFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*GremlinResourcesDeleteGremlinGraphFuture) Result 

func (future *GremlinResourcesDeleteGremlinGraphFuture) Result(client GremlinResourcesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type GremlinResourcesUpdateGremlinDatabaseThroughputFuture 

type GremlinResourcesUpdateGremlinDatabaseThroughputFuture struct {
	azure.Future
}

GremlinResourcesUpdateGremlinDatabaseThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*GremlinResourcesUpdateGremlinDatabaseThroughputFuture) Result 

func (future *GremlinResourcesUpdateGremlinDatabaseThroughputFuture) Result(client GremlinResourcesClient) (tsgr ThroughputSettingsGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type GremlinResourcesUpdateGremlinGraphThroughputFuture 

type GremlinResourcesUpdateGremlinGraphThroughputFuture struct {
	azure.Future
}

GremlinResourcesUpdateGremlinGraphThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*GremlinResourcesUpdateGremlinGraphThroughputFuture) Result 

func (future *GremlinResourcesUpdateGremlinGraphThroughputFuture) Result(client GremlinResourcesClient) (tsgr ThroughputSettingsGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type IPAddressOrRange 

type IPAddressOrRange struct {
	// IPAddressOrRange - A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.
	IPAddressOrRange *string `json:"ipAddressOrRange,omitempty"`
}

IPAddressOrRange ipAddressOrRange object

type IncludedPath 

type IncludedPath struct {
	// Path - The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
	Path *string `json:"path,omitempty"`
	// Indexes - List of indexes for this path
	Indexes *[]Indexes `json:"indexes,omitempty"`
}

IncludedPath the paths that are included in indexing

type IndexKind 

type IndexKind string

IndexKind enumerates the values for index kind. 

const (
	// Hash ...
	Hash IndexKind = "Hash"
	// Range ...
	Range IndexKind = "Range"
	// Spatial ...
	Spatial IndexKind = "Spatial"
)

func PossibleIndexKindValues 

func PossibleIndexKindValues() []IndexKind

PossibleIndexKindValues returns an array of possible values for the IndexKind const type.

type Indexes 

type Indexes struct {
	// DataType - The datatype for which the indexing behavior is applied to. Possible values include: 'String', 'Number', 'Point', 'Polygon', 'LineString', 'MultiPolygon'
	DataType DataType `json:"dataType,omitempty"`
	// Precision - The precision of the index. -1 is maximum precision.
	Precision *int32 `json:"precision,omitempty"`
	// Kind - Indicates the type of index. Possible values include: 'Hash', 'Range', 'Spatial'
	Kind IndexKind `json:"kind,omitempty"`
}

Indexes the indexes for the path.

type IndexingMode 

type IndexingMode string

IndexingMode enumerates the values for indexing mode. 

const (
	// Consistent ...
	Consistent IndexingMode = "Consistent"
	// Lazy ...
	Lazy IndexingMode = "Lazy"
	// None ...
	None IndexingMode = "None"
)

func PossibleIndexingModeValues 

func PossibleIndexingModeValues() []IndexingMode

PossibleIndexingModeValues returns an array of possible values for the IndexingMode const type.

type IndexingPolicy 

type IndexingPolicy struct {
	// Automatic - Indicates if the indexing policy is automatic
	Automatic *bool `json:"automatic,omitempty"`
	// IndexingMode - Indicates the indexing mode. Possible values include: 'Consistent', 'Lazy', 'None'
	IndexingMode IndexingMode `json:"indexingMode,omitempty"`
	// IncludedPaths - List of paths to include in the indexing
	IncludedPaths *[]IncludedPath `json:"includedPaths,omitempty"`
	// ExcludedPaths - List of paths to exclude from indexing
	ExcludedPaths *[]ExcludedPath `json:"excludedPaths,omitempty"`
	// CompositeIndexes - List of composite path list
	CompositeIndexes *[][]CompositePath `json:"compositeIndexes,omitempty"`
	// SpatialIndexes - List of spatial specifics
	SpatialIndexes *[]SpatialSpec `json:"spatialIndexes,omitempty"`
}

IndexingPolicy cosmos DB indexing policy

type KeyKind 

type KeyKind string

KeyKind enumerates the values for key kind. 

const (
	// Primary ...
	Primary KeyKind = "primary"
	// PrimaryReadonly ...
	PrimaryReadonly KeyKind = "primaryReadonly"
	// Secondary ...
	Secondary KeyKind = "secondary"
	// SecondaryReadonly ...
	SecondaryReadonly KeyKind = "secondaryReadonly"
)

func PossibleKeyKindValues 

func PossibleKeyKindValues() []KeyKind

PossibleKeyKindValues returns an array of possible values for the KeyKind const type.

type Location 

type Location struct {
	// ID - READ-ONLY; The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
	ID *string `json:"id,omitempty"`
	// LocationName - The name of the region.
	LocationName *string `json:"locationName,omitempty"`
	// DocumentEndpoint - READ-ONLY; The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/
	DocumentEndpoint  *string `json:"documentEndpoint,omitempty"`
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// FailoverPriority - The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
	FailoverPriority *int32 `json:"failoverPriority,omitempty"`
	// IsZoneRedundant - Flag to indicate whether or not this region is an AvailabilityZone region
	IsZoneRedundant *bool `json:"isZoneRedundant,omitempty"`
}

Location a region in which the Azure Cosmos DB database account is deployed.

func (Location) MarshalJSON 

func (l Location) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Location.

type ManagedServiceIdentity 

type ManagedServiceIdentity struct {
	// PrincipalID - READ-ONLY; The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
	PrincipalID *string `json:"principalId,omitempty"`
	// TenantID - READ-ONLY; The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
	TenantID *string `json:"tenantId,omitempty"`
	// Type - The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. Possible values include: 'ResourceIdentityTypeSystemAssigned', 'ResourceIdentityTypeUserAssigned', 'ResourceIdentityTypeSystemAssignedUserAssigned', 'ResourceIdentityTypeNone'
	Type ResourceIdentityType `json:"type,omitempty"`
	// UserAssignedIdentities - The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
	UserAssignedIdentities map[string]*ManagedServiceIdentityUserAssignedIdentitiesValue `json:"userAssignedIdentities"`
}

ManagedServiceIdentity identity for the resource.

func (ManagedServiceIdentity) MarshalJSON 

func (msi ManagedServiceIdentity) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ManagedServiceIdentity.

type ManagedServiceIdentityUserAssignedIdentitiesValue added in v48.2.1 

type ManagedServiceIdentityUserAssignedIdentitiesValue struct {
	// PrincipalID - READ-ONLY; The principal id of user assigned identity.
	PrincipalID *string `json:"principalId,omitempty"`
	// ClientID - READ-ONLY; The client id of user assigned identity.
	ClientID *string `json:"clientId,omitempty"`
}

ManagedServiceIdentityUserAssignedIdentitiesValue ...

type Metric 

type Metric struct {
	// StartTime - READ-ONLY; The start time for the metric (ISO-8601 format).
	StartTime *date.Time `json:"startTime,omitempty"`
	// EndTime - READ-ONLY; The end time for the metric (ISO-8601 format).
	EndTime *date.Time `json:"endTime,omitempty"`
	// TimeGrain - READ-ONLY; The time grain to be used to summarize the metric values.
	TimeGrain *string `json:"timeGrain,omitempty"`
	// Unit - The unit of the metric. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond', 'Milliseconds'
	Unit UnitType `json:"unit,omitempty"`
	// Name - READ-ONLY; The name information for the metric.
	Name *MetricName `json:"name,omitempty"`
	// MetricValues - READ-ONLY; The metric values for the specified time window and timestep.
	MetricValues *[]MetricValue `json:"metricValues,omitempty"`
}

Metric metric data

func (Metric) MarshalJSON 

func (mVar Metric) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Metric.

type MetricAvailability 

type MetricAvailability struct {
	// TimeGrain - READ-ONLY; The time grain to be used to summarize the metric values.
	TimeGrain *string `json:"timeGrain,omitempty"`
	// Retention - READ-ONLY; The retention for the metric values.
	Retention *string `json:"retention,omitempty"`
}

MetricAvailability the availability of the metric.

type MetricDefinition 

type MetricDefinition struct {
	// MetricAvailabilities - READ-ONLY; The list of metric availabilities for the account.
	MetricAvailabilities *[]MetricAvailability `json:"metricAvailabilities,omitempty"`
	// PrimaryAggregationType - READ-ONLY; The primary aggregation type of the metric. Possible values include: 'PrimaryAggregationTypeNone', 'PrimaryAggregationTypeAverage', 'PrimaryAggregationTypeTotal', 'PrimaryAggregationTypeMinimum', 'PrimaryAggregationTypeMaximum', 'PrimaryAggregationTypeLast'
	PrimaryAggregationType PrimaryAggregationType `json:"primaryAggregationType,omitempty"`
	// Unit - The unit of the metric. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond', 'Milliseconds'
	Unit UnitType `json:"unit,omitempty"`
	// ResourceURI - READ-ONLY; The resource uri of the database.
	ResourceURI *string `json:"resourceUri,omitempty"`
	// Name - READ-ONLY; The name information for the metric.
	Name *MetricName `json:"name,omitempty"`
}

MetricDefinition the definition of a metric.

func (MetricDefinition) MarshalJSON 

func (md MetricDefinition) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MetricDefinition.

type MetricDefinitionsListResult 

type MetricDefinitionsListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of metric definitions for the account.
	Value *[]MetricDefinition `json:"value,omitempty"`
}

MetricDefinitionsListResult the response to a list metric definitions request.

type MetricListResult 

type MetricListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of metrics for the account.
	Value *[]Metric `json:"value,omitempty"`
}

MetricListResult the response to a list metrics request.

type MetricName 

type MetricName struct {
	// Value - READ-ONLY; The name of the metric.
	Value *string `json:"value,omitempty"`
	// LocalizedValue - READ-ONLY; The friendly name of the metric.
	LocalizedValue *string `json:"localizedValue,omitempty"`
}

MetricName a metric name.

type MetricValue 

type MetricValue struct {
	// Count - READ-ONLY; The number of values for the metric.
	Count *float64 `json:"_count,omitempty"`
	// Average - READ-ONLY; The average value of the metric.
	Average *float64 `json:"average,omitempty"`
	// Maximum - READ-ONLY; The max value of the metric.
	Maximum *float64 `json:"maximum,omitempty"`
	// Minimum - READ-ONLY; The min value of the metric.
	Minimum *float64 `json:"minimum,omitempty"`
	// Timestamp - READ-ONLY; The metric timestamp (ISO-8601 format).
	Timestamp *date.Time `json:"timestamp,omitempty"`
	// Total - READ-ONLY; The total value of the metric.
	Total *float64 `json:"total,omitempty"`
}

MetricValue represents metrics values.

type MongoDBCollectionCreateUpdateParameters 

type MongoDBCollectionCreateUpdateParameters struct {
	// MongoDBCollectionCreateUpdateProperties - Properties to create and update Azure Cosmos DB MongoDB collection.
	*MongoDBCollectionCreateUpdateProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The unique resource identifier of the ARM resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the ARM resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of Azure resource.
	Type *string `json:"type,omitempty"`
	// Location - The location of the resource group to which the resource belongs.
	Location *string                 `json:"location,omitempty"`
	Tags     map[string]*string      `json:"tags"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

MongoDBCollectionCreateUpdateParameters parameters to create and update Cosmos DB MongoDB collection.

func (MongoDBCollectionCreateUpdateParameters) MarshalJSON 

func (mdccup MongoDBCollectionCreateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MongoDBCollectionCreateUpdateParameters.

func (*MongoDBCollectionCreateUpdateParameters) UnmarshalJSON 

func (mdccup *MongoDBCollectionCreateUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for MongoDBCollectionCreateUpdateParameters struct.

type MongoDBCollectionCreateUpdateProperties 

type MongoDBCollectionCreateUpdateProperties struct {
	// Resource - The standard JSON format of a MongoDB collection
	Resource *MongoDBCollectionResource `json:"resource,omitempty"`
	// Options - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
	Options *CreateUpdateOptions `json:"options,omitempty"`
}

MongoDBCollectionCreateUpdateProperties properties to create and update Azure Cosmos DB MongoDB collection.

type MongoDBCollectionGetProperties 

type MongoDBCollectionGetProperties struct {
	Resource *MongoDBCollectionGetPropertiesResource `json:"resource,omitempty"`
	Options  *MongoDBCollectionGetPropertiesOptions  `json:"options,omitempty"`
}

MongoDBCollectionGetProperties the properties of an Azure Cosmos DB MongoDB collection

type MongoDBCollectionGetPropertiesOptions 

type MongoDBCollectionGetPropertiesOptions struct {
	// Throughput - Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
	Throughput *int32 `json:"throughput,omitempty"`
	// AutoscaleSettings - Specifies the Autoscale settings.
	AutoscaleSettings *AutoscaleSettings `json:"autoscaleSettings,omitempty"`
}

MongoDBCollectionGetPropertiesOptions ...

type MongoDBCollectionGetPropertiesResource 

type MongoDBCollectionGetPropertiesResource struct {
	// ID - Name of the Cosmos DB MongoDB collection
	ID *string `json:"id,omitempty"`
	// ShardKey - A key-value pair of shard keys to be applied for the request.
	ShardKey map[string]*string `json:"shardKey"`
	// Indexes - List of index keys
	Indexes *[]MongoIndex `json:"indexes,omitempty"`
	// AnalyticalStorageTTL - Analytical TTL.
	AnalyticalStorageTTL *int32 `json:"analyticalStorageTtl,omitempty"`
	// Rid - READ-ONLY; A system generated property. A unique identifier.
	Rid *string `json:"_rid,omitempty"`
	// Ts - READ-ONLY; A system generated property that denotes the last updated timestamp of the resource.
	Ts interface{} `json:"_ts,omitempty"`
	// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
	Etag *string `json:"_etag,omitempty"`
}

MongoDBCollectionGetPropertiesResource ...

func (MongoDBCollectionGetPropertiesResource) MarshalJSON 

func (mdcgp MongoDBCollectionGetPropertiesResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MongoDBCollectionGetPropertiesResource.

type MongoDBCollectionGetResults 

type MongoDBCollectionGetResults struct {
	autorest.Response `json:"-"`
	// MongoDBCollectionGetProperties - The properties of an Azure Cosmos DB MongoDB collection
	*MongoDBCollectionGetProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The unique resource identifier of the ARM resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the ARM resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of Azure resource.
	Type *string `json:"type,omitempty"`
	// Location - The location of the resource group to which the resource belongs.
	Location *string                 `json:"location,omitempty"`
	Tags     map[string]*string      `json:"tags"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

MongoDBCollectionGetResults an Azure Cosmos DB MongoDB collection.

func (MongoDBCollectionGetResults) MarshalJSON 

func (mdcgr MongoDBCollectionGetResults) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MongoDBCollectionGetResults.

func (*MongoDBCollectionGetResults) UnmarshalJSON 

func (mdcgr *MongoDBCollectionGetResults) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for MongoDBCollectionGetResults struct.

type MongoDBCollectionListResult 

type MongoDBCollectionListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of MongoDB collections and their properties.
	Value *[]MongoDBCollectionGetResults `json:"value,omitempty"`
}

MongoDBCollectionListResult the List operation response, that contains the MongoDB collections and their properties.

type MongoDBCollectionResource 

type MongoDBCollectionResource struct {
	// ID - Name of the Cosmos DB MongoDB collection
	ID *string `json:"id,omitempty"`
	// ShardKey - A key-value pair of shard keys to be applied for the request.
	ShardKey map[string]*string `json:"shardKey"`
	// Indexes - List of index keys
	Indexes *[]MongoIndex `json:"indexes,omitempty"`
	// AnalyticalStorageTTL - Analytical TTL.
	AnalyticalStorageTTL *int32 `json:"analyticalStorageTtl,omitempty"`
}

MongoDBCollectionResource cosmos DB MongoDB collection resource object

func (MongoDBCollectionResource) MarshalJSON 

func (mdcr MongoDBCollectionResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MongoDBCollectionResource.

type MongoDBDatabaseCreateUpdateParameters 

type MongoDBDatabaseCreateUpdateParameters struct {
	// MongoDBDatabaseCreateUpdateProperties - Properties to create and update Azure Cosmos DB MongoDB database.
	*MongoDBDatabaseCreateUpdateProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The unique resource identifier of the ARM resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the ARM resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of Azure resource.
	Type *string `json:"type,omitempty"`
	// Location - The location of the resource group to which the resource belongs.
	Location *string                 `json:"location,omitempty"`
	Tags     map[string]*string      `json:"tags"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

MongoDBDatabaseCreateUpdateParameters parameters to create and update Cosmos DB MongoDB database.

func (MongoDBDatabaseCreateUpdateParameters) MarshalJSON 

func (mddcup MongoDBDatabaseCreateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MongoDBDatabaseCreateUpdateParameters.

func (*MongoDBDatabaseCreateUpdateParameters) UnmarshalJSON 

func (mddcup *MongoDBDatabaseCreateUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for MongoDBDatabaseCreateUpdateParameters struct.

type MongoDBDatabaseCreateUpdateProperties 

type MongoDBDatabaseCreateUpdateProperties struct {
	// Resource - The standard JSON format of a MongoDB database
	Resource *MongoDBDatabaseResource `json:"resource,omitempty"`
	// Options - A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
	Options *CreateUpdateOptions `json:"options,omitempty"`
}

MongoDBDatabaseCreateUpdateProperties properties to create and update Azure Cosmos DB MongoDB database.

type MongoDBDatabaseGetProperties 

type MongoDBDatabaseGetProperties struct {
	Resource *MongoDBDatabaseGetPropertiesResource `json:"resource,omitempty"`
	Options  *MongoDBDatabaseGetPropertiesOptions  `json:"options,omitempty"`
}

MongoDBDatabaseGetProperties the properties of an Azure Cosmos DB MongoDB database

type MongoDBDatabaseGetPropertiesOptions 

type MongoDBDatabaseGetPropertiesOptions struct {
	// Throughput - Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
	Throughput *int32 `json:"throughput,omitempty"`
	// AutoscaleSettings - Specifies the Autoscale settings.
	AutoscaleSettings *AutoscaleSettings `json:"autoscaleSettings,omitempty"`
}

MongoDBDatabaseGetPropertiesOptions ...

type MongoDBDatabaseGetPropertiesResource 

type MongoDBDatabaseGetPropertiesResource struct {
	// ID - Name of the Cosmos DB MongoDB database
	ID *string `json:"id,omitempty"`
	// Rid - READ-ONLY; A system generated property. A unique identifier.
	Rid *string `json:"_rid,omitempty"`
	// Ts - READ-ONLY; A system generated property that denotes the last updated timestamp of the resource.
	Ts interface{} `json:"_ts,omitempty"`
	// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
	Etag *string `json:"_etag,omitempty"`
}

MongoDBDatabaseGetPropertiesResource ...

func (MongoDBDatabaseGetPropertiesResource) MarshalJSON 

func (mddgp MongoDBDatabaseGetPropertiesResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MongoDBDatabaseGetPropertiesResource.

type MongoDBDatabaseGetResults 

type MongoDBDatabaseGetResults struct {
	autorest.Response `json:"-"`
	// MongoDBDatabaseGetProperties - The properties of an Azure Cosmos DB MongoDB database
	*MongoDBDatabaseGetProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The unique resource identifier of the ARM resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the ARM resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of Azure resource.
	Type *string `json:"type,omitempty"`
	// Location - The location of the resource group to which the resource belongs.
	Location *string                 `json:"location,omitempty"`
	Tags     map[string]*string      `json:"tags"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

MongoDBDatabaseGetResults an Azure Cosmos DB MongoDB database.

func (MongoDBDatabaseGetResults) MarshalJSON 

func (mddgr MongoDBDatabaseGetResults) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MongoDBDatabaseGetResults.

func (*MongoDBDatabaseGetResults) UnmarshalJSON 

func (mddgr *MongoDBDatabaseGetResults) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for MongoDBDatabaseGetResults struct.

type MongoDBDatabaseListResult 

type MongoDBDatabaseListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of MongoDB databases and their properties.
	Value *[]MongoDBDatabaseGetResults `json:"value,omitempty"`
}

MongoDBDatabaseListResult the List operation response, that contains the MongoDB databases and their properties.

type MongoDBDatabaseResource 

type MongoDBDatabaseResource struct {
	// ID - Name of the Cosmos DB MongoDB database
	ID *string `json:"id,omitempty"`
}

MongoDBDatabaseResource cosmos DB MongoDB database resource object

type MongoDBResourcesClient 

type MongoDBResourcesClient struct {
	BaseClient
}

MongoDBResourcesClient is the client for the MongoDBResources methods of the Documentdb service.

func NewMongoDBResourcesClient 

func NewMongoDBResourcesClient(subscriptionID string) MongoDBResourcesClient

NewMongoDBResourcesClient creates an instance of the MongoDBResourcesClient client.

func NewMongoDBResourcesClientWithBaseURI 

func NewMongoDBResourcesClientWithBaseURI(baseURI string, subscriptionID string) MongoDBResourcesClient

NewMongoDBResourcesClientWithBaseURI creates an instance of the MongoDBResourcesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (MongoDBResourcesClient) CreateUpdateMongoDBCollection 

func (client MongoDBResourcesClient) CreateUpdateMongoDBCollection(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string, createUpdateMongoDBCollectionParameters MongoDBCollectionCreateUpdateParameters) (result MongoDBResourcesCreateUpdateMongoDBCollectionFuture, err error)

CreateUpdateMongoDBCollection create or update an Azure Cosmos DB MongoDB Collection Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. collectionName - cosmos DB collection name. createUpdateMongoDBCollectionParameters - the parameters to provide for the current MongoDB Collection.

func (MongoDBResourcesClient) CreateUpdateMongoDBCollectionPreparer 

func (client MongoDBResourcesClient) CreateUpdateMongoDBCollectionPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string, createUpdateMongoDBCollectionParameters MongoDBCollectionCreateUpdateParameters) (*http.Request, error)

CreateUpdateMongoDBCollectionPreparer prepares the CreateUpdateMongoDBCollection request.

func (MongoDBResourcesClient) CreateUpdateMongoDBCollectionResponder 

func (client MongoDBResourcesClient) CreateUpdateMongoDBCollectionResponder(resp *http.Response) (result MongoDBCollectionGetResults, err error)

CreateUpdateMongoDBCollectionResponder handles the response to the CreateUpdateMongoDBCollection request. The method always closes the http.Response Body.

func (MongoDBResourcesClient) CreateUpdateMongoDBCollectionSender 

func (client MongoDBResourcesClient) CreateUpdateMongoDBCollectionSender(req *http.Request) (future MongoDBResourcesCreateUpdateMongoDBCollectionFuture, err error)

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

func (MongoDBResourcesClient) CreateUpdateMongoDBDatabase 

func (client MongoDBResourcesClient) CreateUpdateMongoDBDatabase(ctx context.Context, resourceGroupName string, accountName string, databaseName string, createUpdateMongoDBDatabaseParameters MongoDBDatabaseCreateUpdateParameters) (result MongoDBResourcesCreateUpdateMongoDBDatabaseFuture, err error)

CreateUpdateMongoDBDatabase create or updates Azure Cosmos DB MongoDB database Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. createUpdateMongoDBDatabaseParameters - the parameters to provide for the current MongoDB database.

func (MongoDBResourcesClient) CreateUpdateMongoDBDatabasePreparer 

func (client MongoDBResourcesClient) CreateUpdateMongoDBDatabasePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, createUpdateMongoDBDatabaseParameters MongoDBDatabaseCreateUpdateParameters) (*http.Request, error)

CreateUpdateMongoDBDatabasePreparer prepares the CreateUpdateMongoDBDatabase request.

func (MongoDBResourcesClient) CreateUpdateMongoDBDatabaseResponder 

func (client MongoDBResourcesClient) CreateUpdateMongoDBDatabaseResponder(resp *http.Response) (result MongoDBDatabaseGetResults, err error)

CreateUpdateMongoDBDatabaseResponder handles the response to the CreateUpdateMongoDBDatabase request. The method always closes the http.Response Body.

func (MongoDBResourcesClient) CreateUpdateMongoDBDatabaseSender 

func (client MongoDBResourcesClient) CreateUpdateMongoDBDatabaseSender(req *http.Request) (future MongoDBResourcesCreateUpdateMongoDBDatabaseFuture, err error)

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

func (MongoDBResourcesClient) DeleteMongoDBCollection 

func (client MongoDBResourcesClient) DeleteMongoDBCollection(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (result MongoDBResourcesDeleteMongoDBCollectionFuture, err error)

DeleteMongoDBCollection deletes an existing Azure Cosmos DB MongoDB Collection. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. collectionName - cosmos DB collection name.

func (MongoDBResourcesClient) DeleteMongoDBCollectionPreparer 

func (client MongoDBResourcesClient) DeleteMongoDBCollectionPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (*http.Request, error)

DeleteMongoDBCollectionPreparer prepares the DeleteMongoDBCollection request.

func (MongoDBResourcesClient) DeleteMongoDBCollectionResponder 

func (client MongoDBResourcesClient) DeleteMongoDBCollectionResponder(resp *http.Response) (result autorest.Response, err error)

DeleteMongoDBCollectionResponder handles the response to the DeleteMongoDBCollection request. The method always closes the http.Response Body.

func (MongoDBResourcesClient) DeleteMongoDBCollectionSender 

func (client MongoDBResourcesClient) DeleteMongoDBCollectionSender(req *http.Request) (future MongoDBResourcesDeleteMongoDBCollectionFuture, err error)

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

func (MongoDBResourcesClient) DeleteMongoDBDatabase 

func (client MongoDBResourcesClient) DeleteMongoDBDatabase(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result MongoDBResourcesDeleteMongoDBDatabaseFuture, err error)

DeleteMongoDBDatabase deletes an existing Azure Cosmos DB MongoDB database. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name.

func (MongoDBResourcesClient) DeleteMongoDBDatabasePreparer 

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

DeleteMongoDBDatabasePreparer prepares the DeleteMongoDBDatabase request.

func (MongoDBResourcesClient) DeleteMongoDBDatabaseResponder 

func (client MongoDBResourcesClient) DeleteMongoDBDatabaseResponder(resp *http.Response) (result autorest.Response, err error)

DeleteMongoDBDatabaseResponder handles the response to the DeleteMongoDBDatabase request. The method always closes the http.Response Body.

func (MongoDBResourcesClient) DeleteMongoDBDatabaseSender 

func (client MongoDBResourcesClient) DeleteMongoDBDatabaseSender(req *http.Request) (future MongoDBResourcesDeleteMongoDBDatabaseFuture, err error)

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

func (MongoDBResourcesClient) GetMongoDBCollection 

func (client MongoDBResourcesClient) GetMongoDBCollection(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (result MongoDBCollectionGetResults, err error)

GetMongoDBCollection gets the MongoDB collection under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. collectionName - cosmos DB collection name.

func (MongoDBResourcesClient) GetMongoDBCollectionPreparer 

func (client MongoDBResourcesClient) GetMongoDBCollectionPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (*http.Request, error)

GetMongoDBCollectionPreparer prepares the GetMongoDBCollection request.

func (MongoDBResourcesClient) GetMongoDBCollectionResponder 

func (client MongoDBResourcesClient) GetMongoDBCollectionResponder(resp *http.Response) (result MongoDBCollectionGetResults, err error)

GetMongoDBCollectionResponder handles the response to the GetMongoDBCollection request. The method always closes the http.Response Body.

func (MongoDBResourcesClient) GetMongoDBCollectionSender 

func (client MongoDBResourcesClient) GetMongoDBCollectionSender(req *http.Request) (*http.Response, error)

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

func (MongoDBResourcesClient) GetMongoDBCollectionThroughput 

func (client MongoDBResourcesClient) GetMongoDBCollectionThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (result ThroughputSettingsGetResults, err error)

GetMongoDBCollectionThroughput gets the RUs per second of the MongoDB collection under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. collectionName - cosmos DB collection name.

func (MongoDBResourcesClient) GetMongoDBCollectionThroughputPreparer 

func (client MongoDBResourcesClient) GetMongoDBCollectionThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (*http.Request, error)

GetMongoDBCollectionThroughputPreparer prepares the GetMongoDBCollectionThroughput request.

func (MongoDBResourcesClient) GetMongoDBCollectionThroughputResponder 

func (client MongoDBResourcesClient) GetMongoDBCollectionThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)

GetMongoDBCollectionThroughputResponder handles the response to the GetMongoDBCollectionThroughput request. The method always closes the http.Response Body.

func (MongoDBResourcesClient) GetMongoDBCollectionThroughputSender 

func (client MongoDBResourcesClient) GetMongoDBCollectionThroughputSender(req *http.Request) (*http.Response, error)

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

func (MongoDBResourcesClient) GetMongoDBDatabase 

func (client MongoDBResourcesClient) GetMongoDBDatabase(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result MongoDBDatabaseGetResults, err error)

GetMongoDBDatabase gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name.

func (MongoDBResourcesClient) GetMongoDBDatabasePreparer 

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

GetMongoDBDatabasePreparer prepares the GetMongoDBDatabase request.

func (MongoDBResourcesClient) GetMongoDBDatabaseResponder 

func (client MongoDBResourcesClient) GetMongoDBDatabaseResponder(resp *http.Response) (result MongoDBDatabaseGetResults, err error)

GetMongoDBDatabaseResponder handles the response to the GetMongoDBDatabase request. The method always closes the http.Response Body.

func (MongoDBResourcesClient) GetMongoDBDatabaseSender 

func (client MongoDBResourcesClient) GetMongoDBDatabaseSender(req *http.Request) (*http.Response, error)

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

func (MongoDBResourcesClient) GetMongoDBDatabaseThroughput 

func (client MongoDBResourcesClient) GetMongoDBDatabaseThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result ThroughputSettingsGetResults, err error)

GetMongoDBDatabaseThroughput gets the RUs per second of the MongoDB database under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name.

func (MongoDBResourcesClient) GetMongoDBDatabaseThroughputPreparer 

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

GetMongoDBDatabaseThroughputPreparer prepares the GetMongoDBDatabaseThroughput request.

func (MongoDBResourcesClient) GetMongoDBDatabaseThroughputResponder 

func (client MongoDBResourcesClient) GetMongoDBDatabaseThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)

GetMongoDBDatabaseThroughputResponder handles the response to the GetMongoDBDatabaseThroughput request. The method always closes the http.Response Body.

func (MongoDBResourcesClient) GetMongoDBDatabaseThroughputSender 

func (client MongoDBResourcesClient) GetMongoDBDatabaseThroughputSender(req *http.Request) (*http.Response, error)

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

func (MongoDBResourcesClient) ListMongoDBCollections 

func (client MongoDBResourcesClient) ListMongoDBCollections(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result MongoDBCollectionListResult, err error)

ListMongoDBCollections lists the MongoDB collection under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name.

func (MongoDBResourcesClient) ListMongoDBCollectionsPreparer 

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

ListMongoDBCollectionsPreparer prepares the ListMongoDBCollections request.

func (MongoDBResourcesClient) ListMongoDBCollectionsResponder 

func (client MongoDBResourcesClient) ListMongoDBCollectionsResponder(resp *http.Response) (result MongoDBCollectionListResult, err error)

ListMongoDBCollectionsResponder handles the response to the ListMongoDBCollections request. The method always closes the http.Response Body.

func (MongoDBResourcesClient) ListMongoDBCollectionsSender 

func (client MongoDBResourcesClient) ListMongoDBCollectionsSender(req *http.Request) (*http.Response, error)

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

func (MongoDBResourcesClient) ListMongoDBDatabases 

func (client MongoDBResourcesClient) ListMongoDBDatabases(ctx context.Context, resourceGroupName string, accountName string) (result MongoDBDatabaseListResult, err error)

ListMongoDBDatabases lists the MongoDB databases under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.

func (MongoDBResourcesClient) ListMongoDBDatabasesPreparer 

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

ListMongoDBDatabasesPreparer prepares the ListMongoDBDatabases request.

func (MongoDBResourcesClient) ListMongoDBDatabasesResponder 

func (client MongoDBResourcesClient) ListMongoDBDatabasesResponder(resp *http.Response) (result MongoDBDatabaseListResult, err error)

ListMongoDBDatabasesResponder handles the response to the ListMongoDBDatabases request. The method always closes the http.Response Body.

func (MongoDBResourcesClient) ListMongoDBDatabasesSender 

func (client MongoDBResourcesClient) ListMongoDBDatabasesSender(req *http.Request) (*http.Response, error)

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

func (MongoDBResourcesClient) UpdateMongoDBCollectionThroughput 

func (client MongoDBResourcesClient) UpdateMongoDBCollectionThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (result MongoDBResourcesUpdateMongoDBCollectionThroughputFuture, err error)

UpdateMongoDBCollectionThroughput update the RUs per second of an Azure Cosmos DB MongoDB collection Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. collectionName - cosmos DB collection name. updateThroughputParameters - the RUs per second of the parameters to provide for the current MongoDB collection.

func (MongoDBResourcesClient) UpdateMongoDBCollectionThroughputPreparer 

func (client MongoDBResourcesClient) UpdateMongoDBCollectionThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)

UpdateMongoDBCollectionThroughputPreparer prepares the UpdateMongoDBCollectionThroughput request.

func (MongoDBResourcesClient) UpdateMongoDBCollectionThroughputResponder 

func (client MongoDBResourcesClient) UpdateMongoDBCollectionThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)

UpdateMongoDBCollectionThroughputResponder handles the response to the UpdateMongoDBCollectionThroughput request. The method always closes the http.Response Body.

func (MongoDBResourcesClient) UpdateMongoDBCollectionThroughputSender 

func (client MongoDBResourcesClient) UpdateMongoDBCollectionThroughputSender(req *http.Request) (future MongoDBResourcesUpdateMongoDBCollectionThroughputFuture, err error)

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

func (MongoDBResourcesClient) UpdateMongoDBDatabaseThroughput 

func (client MongoDBResourcesClient) UpdateMongoDBDatabaseThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (result MongoDBResourcesUpdateMongoDBDatabaseThroughputFuture, err error)

UpdateMongoDBDatabaseThroughput update RUs per second of the an Azure Cosmos DB MongoDB database Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. updateThroughputParameters - the RUs per second of the parameters to provide for the current MongoDB database.

func (MongoDBResourcesClient) UpdateMongoDBDatabaseThroughputPreparer 

func (client MongoDBResourcesClient) UpdateMongoDBDatabaseThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)

UpdateMongoDBDatabaseThroughputPreparer prepares the UpdateMongoDBDatabaseThroughput request.

func (MongoDBResourcesClient) UpdateMongoDBDatabaseThroughputResponder 

func (client MongoDBResourcesClient) UpdateMongoDBDatabaseThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)

UpdateMongoDBDatabaseThroughputResponder handles the response to the UpdateMongoDBDatabaseThroughput request. The method always closes the http.Response Body.

func (MongoDBResourcesClient) UpdateMongoDBDatabaseThroughputSender 

func (client MongoDBResourcesClient) UpdateMongoDBDatabaseThroughputSender(req *http.Request) (future MongoDBResourcesUpdateMongoDBDatabaseThroughputFuture, err error)

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

type MongoDBResourcesCreateUpdateMongoDBCollectionFuture 

type MongoDBResourcesCreateUpdateMongoDBCollectionFuture struct {
	azure.Future
}

MongoDBResourcesCreateUpdateMongoDBCollectionFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*MongoDBResourcesCreateUpdateMongoDBCollectionFuture) Result 

func (future *MongoDBResourcesCreateUpdateMongoDBCollectionFuture) Result(client MongoDBResourcesClient) (mdcgr MongoDBCollectionGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type MongoDBResourcesCreateUpdateMongoDBDatabaseFuture 

type MongoDBResourcesCreateUpdateMongoDBDatabaseFuture struct {
	azure.Future
}

MongoDBResourcesCreateUpdateMongoDBDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*MongoDBResourcesCreateUpdateMongoDBDatabaseFuture) Result 

func (future *MongoDBResourcesCreateUpdateMongoDBDatabaseFuture) Result(client MongoDBResourcesClient) (mddgr MongoDBDatabaseGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type MongoDBResourcesDeleteMongoDBCollectionFuture 

type MongoDBResourcesDeleteMongoDBCollectionFuture struct {
	azure.Future
}

MongoDBResourcesDeleteMongoDBCollectionFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*MongoDBResourcesDeleteMongoDBCollectionFuture) Result 

func (future *MongoDBResourcesDeleteMongoDBCollectionFuture) Result(client MongoDBResourcesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type MongoDBResourcesDeleteMongoDBDatabaseFuture 

type MongoDBResourcesDeleteMongoDBDatabaseFuture struct {
	azure.Future
}

MongoDBResourcesDeleteMongoDBDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*MongoDBResourcesDeleteMongoDBDatabaseFuture) Result 

func (future *MongoDBResourcesDeleteMongoDBDatabaseFuture) Result(client MongoDBResourcesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type MongoDBResourcesUpdateMongoDBCollectionThroughputFuture 

type MongoDBResourcesUpdateMongoDBCollectionThroughputFuture struct {
	azure.Future
}

MongoDBResourcesUpdateMongoDBCollectionThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*MongoDBResourcesUpdateMongoDBCollectionThroughputFuture) Result 

func (future *MongoDBResourcesUpdateMongoDBCollectionThroughputFuture) Result(client MongoDBResourcesClient) (tsgr ThroughputSettingsGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type MongoDBResourcesUpdateMongoDBDatabaseThroughputFuture 

type MongoDBResourcesUpdateMongoDBDatabaseThroughputFuture struct {
	azure.Future
}

MongoDBResourcesUpdateMongoDBDatabaseThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*MongoDBResourcesUpdateMongoDBDatabaseThroughputFuture) Result 

func (future *MongoDBResourcesUpdateMongoDBDatabaseThroughputFuture) Result(client MongoDBResourcesClient) (tsgr ThroughputSettingsGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type MongoIndex 

type MongoIndex struct {
	// Key - Cosmos DB MongoDB collection index keys
	Key *MongoIndexKeys `json:"key,omitempty"`
	// Options - Cosmos DB MongoDB collection index key options
	Options *MongoIndexOptions `json:"options,omitempty"`
}

MongoIndex cosmos DB MongoDB collection index key

type MongoIndexKeys 

type MongoIndexKeys struct {
	// Keys - List of keys for each MongoDB collection in the Azure Cosmos DB service
	Keys *[]string `json:"keys,omitempty"`
}

MongoIndexKeys cosmos DB MongoDB collection resource object

type MongoIndexOptions 

type MongoIndexOptions struct {
	// ExpireAfterSeconds - Expire after seconds
	ExpireAfterSeconds *int32 `json:"expireAfterSeconds,omitempty"`
	// Unique - Is unique or not
	Unique *bool `json:"unique,omitempty"`
}

MongoIndexOptions cosmos DB MongoDB collection index options

type NotebookWorkspace 

type NotebookWorkspace struct {
	autorest.Response `json:"-"`
	// NotebookWorkspaceProperties - Resource properties.
	*NotebookWorkspaceProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The unique resource identifier of the database account.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the database account.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of Azure resource.
	Type *string `json:"type,omitempty"`
}

NotebookWorkspace a notebook workspace resource

func (NotebookWorkspace) MarshalJSON 

func (nw NotebookWorkspace) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for NotebookWorkspace.

func (*NotebookWorkspace) UnmarshalJSON 

func (nw *NotebookWorkspace) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for NotebookWorkspace struct.

type NotebookWorkspaceConnectionInfoResult 

type NotebookWorkspaceConnectionInfoResult struct {
	autorest.Response `json:"-"`
	// AuthToken - READ-ONLY; Specifies auth token used for connecting to Notebook server (uses token-based auth).
	AuthToken *string `json:"authToken,omitempty"`
	// NotebookServerEndpoint - READ-ONLY; Specifies the endpoint of Notebook server.
	NotebookServerEndpoint *string `json:"notebookServerEndpoint,omitempty"`
}

NotebookWorkspaceConnectionInfoResult the connection info for the given notebook workspace

type NotebookWorkspaceCreateUpdateParameters 

type NotebookWorkspaceCreateUpdateParameters struct {
	// ID - READ-ONLY; The unique resource identifier of the database account.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the database account.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of Azure resource.
	Type *string `json:"type,omitempty"`
}

NotebookWorkspaceCreateUpdateParameters parameters to create a notebook workspace resource

type NotebookWorkspaceListResult 

type NotebookWorkspaceListResult struct {
	autorest.Response `json:"-"`
	// Value - Array of notebook workspace resources
	Value *[]NotebookWorkspace `json:"value,omitempty"`
}

NotebookWorkspaceListResult a list of notebook workspace resources

type NotebookWorkspaceProperties 

type NotebookWorkspaceProperties struct {
	// NotebookServerEndpoint - READ-ONLY; Specifies the endpoint of Notebook server.
	NotebookServerEndpoint *string `json:"notebookServerEndpoint,omitempty"`
	// Status - READ-ONLY; Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.
	Status *string `json:"status,omitempty"`
}

NotebookWorkspaceProperties properties of a notebook workspace resource.

type NotebookWorkspacesClient 

type NotebookWorkspacesClient struct {
	BaseClient
}

NotebookWorkspacesClient is the client for the NotebookWorkspaces methods of the Documentdb service.

func NewNotebookWorkspacesClient 

func NewNotebookWorkspacesClient(subscriptionID string) NotebookWorkspacesClient

NewNotebookWorkspacesClient creates an instance of the NotebookWorkspacesClient client.

func NewNotebookWorkspacesClientWithBaseURI 

func NewNotebookWorkspacesClientWithBaseURI(baseURI string, subscriptionID string) NotebookWorkspacesClient

NewNotebookWorkspacesClientWithBaseURI creates an instance of the NotebookWorkspacesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (NotebookWorkspacesClient) CreateOrUpdate 

func (client NotebookWorkspacesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, notebookCreateUpdateParameters NotebookWorkspaceCreateUpdateParameters) (result NotebookWorkspacesCreateOrUpdateFuture, err error)

CreateOrUpdate creates the notebook workspace for a Cosmos DB account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. notebookCreateUpdateParameters - the notebook workspace to create for the current database account.

func (NotebookWorkspacesClient) CreateOrUpdatePreparer 

func (client NotebookWorkspacesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, notebookCreateUpdateParameters NotebookWorkspaceCreateUpdateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (NotebookWorkspacesClient) CreateOrUpdateResponder 

func (client NotebookWorkspacesClient) CreateOrUpdateResponder(resp *http.Response) (result NotebookWorkspace, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (NotebookWorkspacesClient) CreateOrUpdateSender 

func (client NotebookWorkspacesClient) CreateOrUpdateSender(req *http.Request) (future NotebookWorkspacesCreateOrUpdateFuture, err error)

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

func (NotebookWorkspacesClient) Delete 

func (client NotebookWorkspacesClient) Delete(ctx context.Context, resourceGroupName string, accountName string) (result NotebookWorkspacesDeleteFuture, err error)

Delete deletes the notebook workspace for a Cosmos DB account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.

func (NotebookWorkspacesClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (NotebookWorkspacesClient) DeleteResponder 

func (client NotebookWorkspacesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (NotebookWorkspacesClient) DeleteSender 

func (client NotebookWorkspacesClient) DeleteSender(req *http.Request) (future NotebookWorkspacesDeleteFuture, err error)

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

func (NotebookWorkspacesClient) Get 

func (client NotebookWorkspacesClient) Get(ctx context.Context, resourceGroupName string, accountName string) (result NotebookWorkspace, err error)

Get gets the notebook workspace for a Cosmos DB account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.

func (NotebookWorkspacesClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (NotebookWorkspacesClient) GetResponder 

func (client NotebookWorkspacesClient) GetResponder(resp *http.Response) (result NotebookWorkspace, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (NotebookWorkspacesClient) GetSender 

func (client NotebookWorkspacesClient) 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 (NotebookWorkspacesClient) ListByDatabaseAccount 

func (client NotebookWorkspacesClient) ListByDatabaseAccount(ctx context.Context, resourceGroupName string, accountName string) (result NotebookWorkspaceListResult, err error)

ListByDatabaseAccount gets the notebook workspace resources of an existing Cosmos DB account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.

func (NotebookWorkspacesClient) ListByDatabaseAccountPreparer 

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

ListByDatabaseAccountPreparer prepares the ListByDatabaseAccount request.

func (NotebookWorkspacesClient) ListByDatabaseAccountResponder 

func (client NotebookWorkspacesClient) ListByDatabaseAccountResponder(resp *http.Response) (result NotebookWorkspaceListResult, err error)

ListByDatabaseAccountResponder handles the response to the ListByDatabaseAccount request. The method always closes the http.Response Body.

func (NotebookWorkspacesClient) ListByDatabaseAccountSender 

func (client NotebookWorkspacesClient) ListByDatabaseAccountSender(req *http.Request) (*http.Response, error)

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

func (NotebookWorkspacesClient) ListConnectionInfo 

func (client NotebookWorkspacesClient) ListConnectionInfo(ctx context.Context, resourceGroupName string, accountName string) (result NotebookWorkspaceConnectionInfoResult, err error)

ListConnectionInfo retrieves the connection info for the notebook workspace Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.

func (NotebookWorkspacesClient) ListConnectionInfoPreparer 

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

ListConnectionInfoPreparer prepares the ListConnectionInfo request.

func (NotebookWorkspacesClient) ListConnectionInfoResponder 

func (client NotebookWorkspacesClient) ListConnectionInfoResponder(resp *http.Response) (result NotebookWorkspaceConnectionInfoResult, err error)

ListConnectionInfoResponder handles the response to the ListConnectionInfo request. The method always closes the http.Response Body.

func (NotebookWorkspacesClient) ListConnectionInfoSender 

func (client NotebookWorkspacesClient) ListConnectionInfoSender(req *http.Request) (*http.Response, error)

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

func (NotebookWorkspacesClient) RegenerateAuthToken 

func (client NotebookWorkspacesClient) RegenerateAuthToken(ctx context.Context, resourceGroupName string, accountName string) (result NotebookWorkspacesRegenerateAuthTokenFuture, err error)

RegenerateAuthToken regenerates the auth token for the notebook workspace Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.

func (NotebookWorkspacesClient) RegenerateAuthTokenPreparer 

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

RegenerateAuthTokenPreparer prepares the RegenerateAuthToken request.

func (NotebookWorkspacesClient) RegenerateAuthTokenResponder 

func (client NotebookWorkspacesClient) RegenerateAuthTokenResponder(resp *http.Response) (result autorest.Response, err error)

RegenerateAuthTokenResponder handles the response to the RegenerateAuthToken request. The method always closes the http.Response Body.

func (NotebookWorkspacesClient) RegenerateAuthTokenSender 

func (client NotebookWorkspacesClient) RegenerateAuthTokenSender(req *http.Request) (future NotebookWorkspacesRegenerateAuthTokenFuture, err error)

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

func (NotebookWorkspacesClient) Start 

func (client NotebookWorkspacesClient) Start(ctx context.Context, resourceGroupName string, accountName string) (result NotebookWorkspacesStartFuture, err error)

Start starts the notebook workspace Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.

func (NotebookWorkspacesClient) StartPreparer 

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

StartPreparer prepares the Start request.

func (NotebookWorkspacesClient) StartResponder 

func (client NotebookWorkspacesClient) StartResponder(resp *http.Response) (result autorest.Response, err error)

StartResponder handles the response to the Start request. The method always closes the http.Response Body.

func (NotebookWorkspacesClient) StartSender 

func (client NotebookWorkspacesClient) StartSender(req *http.Request) (future NotebookWorkspacesStartFuture, err error)

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

type NotebookWorkspacesCreateOrUpdateFuture 

type NotebookWorkspacesCreateOrUpdateFuture struct {
	azure.Future
}

NotebookWorkspacesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*NotebookWorkspacesCreateOrUpdateFuture) Result 

func (future *NotebookWorkspacesCreateOrUpdateFuture) Result(client NotebookWorkspacesClient) (nw NotebookWorkspace, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type NotebookWorkspacesDeleteFuture 

type NotebookWorkspacesDeleteFuture struct {
	azure.Future
}

NotebookWorkspacesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*NotebookWorkspacesDeleteFuture) Result 

func (future *NotebookWorkspacesDeleteFuture) Result(client NotebookWorkspacesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type NotebookWorkspacesRegenerateAuthTokenFuture 

type NotebookWorkspacesRegenerateAuthTokenFuture struct {
	azure.Future
}

NotebookWorkspacesRegenerateAuthTokenFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*NotebookWorkspacesRegenerateAuthTokenFuture) Result 

func (future *NotebookWorkspacesRegenerateAuthTokenFuture) Result(client NotebookWorkspacesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type NotebookWorkspacesStartFuture 

type NotebookWorkspacesStartFuture struct {
	azure.Future
}

NotebookWorkspacesStartFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*NotebookWorkspacesStartFuture) Result 

func (future *NotebookWorkspacesStartFuture) Result(client NotebookWorkspacesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type Operation 

type Operation struct {
	// Name - Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`
	// Display - The object that represents the operation.
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation REST API operation

type OperationDisplay 

type OperationDisplay struct {
	// Provider - Service provider: Microsoft.ResourceProvider
	Provider *string `json:"Provider,omitempty"`
	// Resource - Resource on which the operation is performed: Profile, endpoint, etc.
	Resource *string `json:"Resource,omitempty"`
	// Operation - Operation type: Read, write, delete, etc.
	Operation *string `json:"Operation,omitempty"`
	// Description - Description of operation
	Description *string `json:"Description,omitempty"`
}

OperationDisplay the object that represents the operation.

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - List of operations supported by the Resource Provider.
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationListResult result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results.

func (OperationListResult) IsEmpty 

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator 

type OperationListResultIterator struct {
	// contains filtered or unexported fields
}

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator 

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next 

func (iter *OperationListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultIterator) NextWithContext 

func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationListResultIterator) NotDone 

func (iter OperationListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationListResultIterator) Response 

func (iter OperationListResultIterator) Response() OperationListResult

Response returns the raw server response from the last page request.

func (OperationListResultIterator) Value 

func (iter OperationListResultIterator) Value() Operation

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationListResultPage 

type OperationListResultPage struct {
	// contains filtered or unexported fields
}

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage 

func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next 

func (page *OperationListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultPage) NextWithContext 

func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationListResultPage) NotDone 

func (page OperationListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationListResultPage) Response 

func (page OperationListResultPage) Response() OperationListResult

Response returns the raw server response from the last page request.

func (OperationListResultPage) Values 

func (page OperationListResultPage) Values() []Operation

Values returns the slice of values for the current page or nil if there are no values.

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the client for the Operations methods of the Documentdb service.

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List 

func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)

List lists all of the available Cosmos DB Resource Provider operations.

func (OperationsClient) ListComplete 

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender 

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

type OptionsResource 

type OptionsResource struct {
	// Throughput - Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
	Throughput *int32 `json:"throughput,omitempty"`
	// AutoscaleSettings - Specifies the Autoscale settings.
	AutoscaleSettings *AutoscaleSettings `json:"autoscaleSettings,omitempty"`
}

OptionsResource cosmos DB options resource object

type PartitionKeyRangeIDClient 

type PartitionKeyRangeIDClient struct {
	BaseClient
}

PartitionKeyRangeIDClient is the client for the PartitionKeyRangeID methods of the Documentdb service.

func NewPartitionKeyRangeIDClient 

func NewPartitionKeyRangeIDClient(subscriptionID string) PartitionKeyRangeIDClient

NewPartitionKeyRangeIDClient creates an instance of the PartitionKeyRangeIDClient client.

func NewPartitionKeyRangeIDClientWithBaseURI 

func NewPartitionKeyRangeIDClientWithBaseURI(baseURI string, subscriptionID string) PartitionKeyRangeIDClient

NewPartitionKeyRangeIDClientWithBaseURI creates an instance of the PartitionKeyRangeIDClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (PartitionKeyRangeIDClient) ListMetrics 

func (client PartitionKeyRangeIDClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, partitionKeyRangeID string, filter string) (result PartitionMetricListResult, err error)

ListMetrics retrieves the metrics determined by the given filter for the given partition key range id. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseRid - cosmos DB database rid. collectionRid - cosmos DB collection rid. partitionKeyRangeID - partition Key Range Id for which to get data. filter - an OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

func (PartitionKeyRangeIDClient) ListMetricsPreparer 

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

ListMetricsPreparer prepares the ListMetrics request.

func (PartitionKeyRangeIDClient) ListMetricsResponder 

func (client PartitionKeyRangeIDClient) ListMetricsResponder(resp *http.Response) (result PartitionMetricListResult, err error)

ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.

func (PartitionKeyRangeIDClient) ListMetricsSender 

func (client PartitionKeyRangeIDClient) ListMetricsSender(req *http.Request) (*http.Response, error)

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

type PartitionKeyRangeIDRegionClient 

type PartitionKeyRangeIDRegionClient struct {
	BaseClient
}

PartitionKeyRangeIDRegionClient is the client for the PartitionKeyRangeIDRegion methods of the Documentdb service.

func NewPartitionKeyRangeIDRegionClient 

func NewPartitionKeyRangeIDRegionClient(subscriptionID string) PartitionKeyRangeIDRegionClient

NewPartitionKeyRangeIDRegionClient creates an instance of the PartitionKeyRangeIDRegionClient client.

func NewPartitionKeyRangeIDRegionClientWithBaseURI 

func NewPartitionKeyRangeIDRegionClientWithBaseURI(baseURI string, subscriptionID string) PartitionKeyRangeIDRegionClient

NewPartitionKeyRangeIDRegionClientWithBaseURI creates an instance of the PartitionKeyRangeIDRegionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (PartitionKeyRangeIDRegionClient) ListMetrics 

func (client PartitionKeyRangeIDRegionClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, region string, databaseRid string, collectionRid string, partitionKeyRangeID string, filter string) (result PartitionMetricListResult, err error)

ListMetrics retrieves the metrics determined by the given filter for the given partition key range id and region. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. region - cosmos DB region, with spaces between words and each word capitalized. databaseRid - cosmos DB database rid. collectionRid - cosmos DB collection rid. partitionKeyRangeID - partition Key Range Id for which to get data. filter - an OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq.

func (PartitionKeyRangeIDRegionClient) ListMetricsPreparer 

func (client PartitionKeyRangeIDRegionClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, region string, databaseRid string, collectionRid string, partitionKeyRangeID string, filter string) (*http.Request, error)

ListMetricsPreparer prepares the ListMetrics request.

func (PartitionKeyRangeIDRegionClient) ListMetricsResponder 

func (client PartitionKeyRangeIDRegionClient) ListMetricsResponder(resp *http.Response) (result PartitionMetricListResult, err error)

ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.

func (PartitionKeyRangeIDRegionClient) ListMetricsSender 

func (client PartitionKeyRangeIDRegionClient) 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 PartitionKind 

type PartitionKind string

PartitionKind enumerates the values for partition kind. 

const (
	// PartitionKindHash ...
	PartitionKindHash PartitionKind = "Hash"
	// PartitionKindRange ...
	PartitionKindRange PartitionKind = "Range"
)

func PossiblePartitionKindValues 

func PossiblePartitionKindValues() []PartitionKind

PossiblePartitionKindValues returns an array of possible values for the PartitionKind const type.

type PartitionMetric 

type PartitionMetric struct {
	// PartitionID - READ-ONLY; The partition id (GUID identifier) of the metric values.
	PartitionID *string `json:"partitionId,omitempty"`
	// PartitionKeyRangeID - READ-ONLY; The partition key range id (integer identifier) of the metric values.
	PartitionKeyRangeID *string `json:"partitionKeyRangeId,omitempty"`
	// StartTime - READ-ONLY; The start time for the metric (ISO-8601 format).
	StartTime *date.Time `json:"startTime,omitempty"`
	// EndTime - READ-ONLY; The end time for the metric (ISO-8601 format).
	EndTime *date.Time `json:"endTime,omitempty"`
	// TimeGrain - READ-ONLY; The time grain to be used to summarize the metric values.
	TimeGrain *string `json:"timeGrain,omitempty"`
	// Unit - The unit of the metric. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond', 'Milliseconds'
	Unit UnitType `json:"unit,omitempty"`
	// Name - READ-ONLY; The name information for the metric.
	Name *MetricName `json:"name,omitempty"`
	// MetricValues - READ-ONLY; The metric values for the specified time window and timestep.
	MetricValues *[]MetricValue `json:"metricValues,omitempty"`
}

PartitionMetric the metric values for a single partition.

func (PartitionMetric) MarshalJSON 

func (pm PartitionMetric) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PartitionMetric.

type PartitionMetricListResult 

type PartitionMetricListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of partition-level metrics for the account.
	Value *[]PartitionMetric `json:"value,omitempty"`
}

PartitionMetricListResult the response to a list partition metrics request.

type PartitionUsage 

type PartitionUsage struct {
	// PartitionID - READ-ONLY; The partition id (GUID identifier) of the usages.
	PartitionID *string `json:"partitionId,omitempty"`
	// PartitionKeyRangeID - READ-ONLY; The partition key range id (integer identifier) of the usages.
	PartitionKeyRangeID *string `json:"partitionKeyRangeId,omitempty"`
	// Unit - The unit of the metric. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond', 'Milliseconds'
	Unit UnitType `json:"unit,omitempty"`
	// Name - READ-ONLY; The name information for the metric.
	Name *MetricName `json:"name,omitempty"`
	// QuotaPeriod - READ-ONLY; The quota period used to summarize the usage values.
	QuotaPeriod *string `json:"quotaPeriod,omitempty"`
	// Limit - READ-ONLY; Maximum value for this metric
	Limit *int64 `json:"limit,omitempty"`
	// CurrentValue - READ-ONLY; Current value for this metric
	CurrentValue *int64 `json:"currentValue,omitempty"`
}

PartitionUsage the partition level usage data for a usage request.

func (PartitionUsage) MarshalJSON 

func (pu PartitionUsage) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PartitionUsage.

type PartitionUsagesResult 

type PartitionUsagesResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of partition-level usages for the database. A usage is a point in time metric
	Value *[]PartitionUsage `json:"value,omitempty"`
}

PartitionUsagesResult the response to a list partition level usage request.

type PercentileClient 

type PercentileClient struct {
	BaseClient
}

PercentileClient is the client for the Percentile methods of the Documentdb service.

func NewPercentileClient 

func NewPercentileClient(subscriptionID string) PercentileClient

NewPercentileClient creates an instance of the PercentileClient client.

func NewPercentileClientWithBaseURI 

func NewPercentileClientWithBaseURI(baseURI string, subscriptionID string) PercentileClient

NewPercentileClientWithBaseURI creates an instance of the PercentileClient 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 (PercentileClient) ListMetrics 

func (client PercentileClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, filter string) (result PercentileMetricListResult, err error)

ListMetrics retrieves the metrics determined by the given filter for the given database account. This url is only for PBS and Replication Latency data Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. 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 (PercentileClient) ListMetricsPreparer 

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

ListMetricsPreparer prepares the ListMetrics request.

func (PercentileClient) ListMetricsResponder 

func (client PercentileClient) ListMetricsResponder(resp *http.Response) (result PercentileMetricListResult, err error)

ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.

func (PercentileClient) ListMetricsSender 

func (client PercentileClient) 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 PercentileMetric 

type PercentileMetric struct {
	// StartTime - READ-ONLY; The start time for the metric (ISO-8601 format).
	StartTime *date.Time `json:"startTime,omitempty"`
	// EndTime - READ-ONLY; The end time for the metric (ISO-8601 format).
	EndTime *date.Time `json:"endTime,omitempty"`
	// TimeGrain - READ-ONLY; The time grain to be used to summarize the metric values.
	TimeGrain *string `json:"timeGrain,omitempty"`
	// Unit - The unit of the metric. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond', 'Milliseconds'
	Unit UnitType `json:"unit,omitempty"`
	// Name - READ-ONLY; The name information for the metric.
	Name *MetricName `json:"name,omitempty"`
	// MetricValues - READ-ONLY; The percentile metric values for the specified time window and timestep.
	MetricValues *[]PercentileMetricValue `json:"metricValues,omitempty"`
}

PercentileMetric percentile Metric data

func (PercentileMetric) MarshalJSON 

func (pm PercentileMetric) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PercentileMetric.

type PercentileMetricListResult 

type PercentileMetricListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of percentile metrics for the account.
	Value *[]PercentileMetric `json:"value,omitempty"`
}

PercentileMetricListResult the response to a list percentile metrics request.

type PercentileMetricValue 

type PercentileMetricValue struct {
	// P10 - READ-ONLY; The 10th percentile value for the metric.
	P10 *float64 `json:"P10,omitempty"`
	// P25 - READ-ONLY; The 25th percentile value for the metric.
	P25 *float64 `json:"P25,omitempty"`
	// P50 - READ-ONLY; The 50th percentile value for the metric.
	P50 *float64 `json:"P50,omitempty"`
	// P75 - READ-ONLY; The 75th percentile value for the metric.
	P75 *float64 `json:"P75,omitempty"`
	// P90 - READ-ONLY; The 90th percentile value for the metric.
	P90 *float64 `json:"P90,omitempty"`
	// P95 - READ-ONLY; The 95th percentile value for the metric.
	P95 *float64 `json:"P95,omitempty"`
	// P99 - READ-ONLY; The 99th percentile value for the metric.
	P99 *float64 `json:"P99,omitempty"`
	// Count - READ-ONLY; The number of values for the metric.
	Count *float64 `json:"_count,omitempty"`
	// Average - READ-ONLY; The average value of the metric.
	Average *float64 `json:"average,omitempty"`
	// Maximum - READ-ONLY; The max value of the metric.
	Maximum *float64 `json:"maximum,omitempty"`
	// Minimum - READ-ONLY; The min value of the metric.
	Minimum *float64 `json:"minimum,omitempty"`
	// Timestamp - READ-ONLY; The metric timestamp (ISO-8601 format).
	Timestamp *date.Time `json:"timestamp,omitempty"`
	// Total - READ-ONLY; The total value of the metric.
	Total *float64 `json:"total,omitempty"`
}

PercentileMetricValue represents percentile metrics values.

type PercentileSourceTargetClient 

type PercentileSourceTargetClient struct {
	BaseClient
}

PercentileSourceTargetClient is the client for the PercentileSourceTarget methods of the Documentdb service.

func NewPercentileSourceTargetClient 

func NewPercentileSourceTargetClient(subscriptionID string) PercentileSourceTargetClient

NewPercentileSourceTargetClient creates an instance of the PercentileSourceTargetClient client.

func NewPercentileSourceTargetClientWithBaseURI 

func NewPercentileSourceTargetClientWithBaseURI(baseURI string, subscriptionID string) PercentileSourceTargetClient

NewPercentileSourceTargetClientWithBaseURI creates an instance of the PercentileSourceTargetClient 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 (PercentileSourceTargetClient) ListMetrics 

func (client PercentileSourceTargetClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, sourceRegion string, targetRegion string, filter string) (result PercentileMetricListResult, err error)

ListMetrics retrieves the metrics determined by the given filter for the given account, source and target region. This url is only for PBS and Replication Latency data Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. sourceRegion - source region from which data is written. Cosmos DB region, with spaces between words and each word capitalized. targetRegion - target region to which data is written. 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 (PercentileSourceTargetClient) ListMetricsPreparer 

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

ListMetricsPreparer prepares the ListMetrics request.

func (PercentileSourceTargetClient) ListMetricsResponder 

func (client PercentileSourceTargetClient) ListMetricsResponder(resp *http.Response) (result PercentileMetricListResult, err error)

ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.

func (PercentileSourceTargetClient) ListMetricsSender 

func (client PercentileSourceTargetClient) 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 PercentileTargetClient 

type PercentileTargetClient struct {
	BaseClient
}

PercentileTargetClient is the client for the PercentileTarget methods of the Documentdb service.

func NewPercentileTargetClient 

func NewPercentileTargetClient(subscriptionID string) PercentileTargetClient

NewPercentileTargetClient creates an instance of the PercentileTargetClient client.

func NewPercentileTargetClientWithBaseURI 

func NewPercentileTargetClientWithBaseURI(baseURI string, subscriptionID string) PercentileTargetClient

NewPercentileTargetClientWithBaseURI creates an instance of the PercentileTargetClient 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 (PercentileTargetClient) ListMetrics 

func (client PercentileTargetClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, targetRegion string, filter string) (result PercentileMetricListResult, err error)

ListMetrics retrieves the metrics determined by the given filter for the given account target region. This url is only for PBS and Replication Latency data Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. targetRegion - target region to which data is written. 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 (PercentileTargetClient) ListMetricsPreparer 

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

ListMetricsPreparer prepares the ListMetrics request.

func (PercentileTargetClient) ListMetricsResponder 

func (client PercentileTargetClient) ListMetricsResponder(resp *http.Response) (result PercentileMetricListResult, err error)

ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.

func (PercentileTargetClient) ListMetricsSender 

func (client PercentileTargetClient) 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 PeriodicModeBackupPolicy 

type PeriodicModeBackupPolicy struct {
	// PeriodicModeProperties - Configuration values for periodic mode backup
	PeriodicModeProperties *PeriodicModeProperties `json:"periodicModeProperties,omitempty"`
	// Type - Possible values include: 'TypeBackupPolicy', 'TypePeriodic', 'TypeContinuous'
	Type Type `json:"type,omitempty"`
}

PeriodicModeBackupPolicy the object representing periodic mode backup policy.

func (PeriodicModeBackupPolicy) AsBackupPolicy 

func (pmbp PeriodicModeBackupPolicy) AsBackupPolicy() (*BackupPolicy, bool)

AsBackupPolicy is the BasicBackupPolicy implementation for PeriodicModeBackupPolicy.

func (PeriodicModeBackupPolicy) AsBasicBackupPolicy 

func (pmbp PeriodicModeBackupPolicy) AsBasicBackupPolicy() (BasicBackupPolicy, bool)

AsBasicBackupPolicy is the BasicBackupPolicy implementation for PeriodicModeBackupPolicy.

func (PeriodicModeBackupPolicy) AsContinuousModeBackupPolicy 

func (pmbp PeriodicModeBackupPolicy) AsContinuousModeBackupPolicy() (*ContinuousModeBackupPolicy, bool)

AsContinuousModeBackupPolicy is the BasicBackupPolicy implementation for PeriodicModeBackupPolicy.

func (PeriodicModeBackupPolicy) AsPeriodicModeBackupPolicy 

func (pmbp PeriodicModeBackupPolicy) AsPeriodicModeBackupPolicy() (*PeriodicModeBackupPolicy, bool)

AsPeriodicModeBackupPolicy is the BasicBackupPolicy implementation for PeriodicModeBackupPolicy.

func (PeriodicModeBackupPolicy) MarshalJSON 

func (pmbp PeriodicModeBackupPolicy) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PeriodicModeBackupPolicy.

type PeriodicModeProperties 

type PeriodicModeProperties struct {
	// BackupIntervalInMinutes - An integer representing the interval in minutes between two backups
	BackupIntervalInMinutes *int32 `json:"backupIntervalInMinutes,omitempty"`
	// BackupRetentionIntervalInHours - An integer representing the time (in hours) that each backup is retained
	BackupRetentionIntervalInHours *int32 `json:"backupRetentionIntervalInHours,omitempty"`
}

PeriodicModeProperties configuration values for periodic mode backup

type Permission added in v48.2.1 

type Permission struct {
	// DataActions - An array of data actions that are allowed.
	DataActions *[]string `json:"dataActions,omitempty"`
	// NotDataActions - An array of data actions that are denied.
	NotDataActions *[]string `json:"notDataActions,omitempty"`
}

Permission the set of data plane operations permitted through this Role Definition.

type PrimaryAggregationType 

type PrimaryAggregationType string

PrimaryAggregationType enumerates the values for primary aggregation type. 

const (
	// PrimaryAggregationTypeAverage ...
	PrimaryAggregationTypeAverage PrimaryAggregationType = "Average"
	// PrimaryAggregationTypeLast ...
	PrimaryAggregationTypeLast PrimaryAggregationType = "Last"
	// PrimaryAggregationTypeMaximum ...
	PrimaryAggregationTypeMaximum PrimaryAggregationType = "Maximum"
	// PrimaryAggregationTypeMinimum ...
	PrimaryAggregationTypeMinimum PrimaryAggregationType = "Minimum"
	// PrimaryAggregationTypeNone ...
	PrimaryAggregationTypeNone PrimaryAggregationType = "None"
	// PrimaryAggregationTypeTotal ...
	PrimaryAggregationTypeTotal PrimaryAggregationType = "Total"
)

func PossiblePrimaryAggregationTypeValues 

func PossiblePrimaryAggregationTypeValues() []PrimaryAggregationType

PossiblePrimaryAggregationTypeValues returns an array of possible values for the PrimaryAggregationType const type.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	autorest.Response `json:"-"`
	// PrivateEndpointConnectionProperties - Resource properties.
	*PrivateEndpointConnectionProperties `json:"properties,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"`
}

PrivateEndpointConnection a private endpoint connection

func (PrivateEndpointConnection) MarshalJSON 

func (pec PrivateEndpointConnection) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateEndpointConnection.

func (*PrivateEndpointConnection) UnmarshalJSON 

func (pec *PrivateEndpointConnection) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PrivateEndpointConnection struct.

type PrivateEndpointConnectionListResult 

type PrivateEndpointConnectionListResult struct {
	autorest.Response `json:"-"`
	// Value - Array of private endpoint connections
	Value *[]PrivateEndpointConnection `json:"value,omitempty"`
}

PrivateEndpointConnectionListResult a list of private endpoint connections

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// PrivateEndpoint - Private endpoint which the connection belongs to.
	PrivateEndpoint *PrivateEndpointProperty `json:"privateEndpoint,omitempty"`
	// PrivateLinkServiceConnectionState - Connection State of the Private Endpoint Connection.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionStateProperty `json:"privateLinkServiceConnectionState,omitempty"`
	// GroupID - Group id of the private endpoint.
	GroupID *string `json:"groupId,omitempty"`
	// ProvisioningState - Provisioning state of the private endpoint.
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

PrivateEndpointConnectionProperties properties of a private endpoint connection.

type PrivateEndpointConnectionsClient 

type PrivateEndpointConnectionsClient struct {
	BaseClient
}

PrivateEndpointConnectionsClient is the client for the PrivateEndpointConnections methods of the Documentdb service.

func NewPrivateEndpointConnectionsClient 

func NewPrivateEndpointConnectionsClient(subscriptionID string) PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates an instance of the PrivateEndpointConnectionsClient client.

func NewPrivateEndpointConnectionsClientWithBaseURI 

func NewPrivateEndpointConnectionsClientWithBaseURI(baseURI string, subscriptionID string) PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClientWithBaseURI creates an instance of the PrivateEndpointConnectionsClient 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 (PrivateEndpointConnectionsClient) CreateOrUpdate 

func (client PrivateEndpointConnectionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string, parameters PrivateEndpointConnection) (result PrivateEndpointConnectionsCreateOrUpdateFuture, err error)

CreateOrUpdate approve or reject a private endpoint connection with a given name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. privateEndpointConnectionName - the name of the private endpoint connection.

func (PrivateEndpointConnectionsClient) CreateOrUpdatePreparer 

func (client PrivateEndpointConnectionsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string, parameters PrivateEndpointConnection) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (PrivateEndpointConnectionsClient) CreateOrUpdateResponder 

func (client PrivateEndpointConnectionsClient) CreateOrUpdateResponder(resp *http.Response) (result PrivateEndpointConnection, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (PrivateEndpointConnectionsClient) CreateOrUpdateSender 

func (client PrivateEndpointConnectionsClient) CreateOrUpdateSender(req *http.Request) (future PrivateEndpointConnectionsCreateOrUpdateFuture, err error)

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

func (PrivateEndpointConnectionsClient) Delete 

func (client PrivateEndpointConnectionsClient) Delete(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string) (result PrivateEndpointConnectionsDeleteFuture, err error)

Delete deletes a private endpoint connection with a given name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. privateEndpointConnectionName - the name of the private endpoint connection.

func (PrivateEndpointConnectionsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (PrivateEndpointConnectionsClient) DeleteResponder 

func (client PrivateEndpointConnectionsClient) 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 (PrivateEndpointConnectionsClient) DeleteSender 

func (client PrivateEndpointConnectionsClient) DeleteSender(req *http.Request) (future PrivateEndpointConnectionsDeleteFuture, err error)

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

func (PrivateEndpointConnectionsClient) Get 

func (client PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string) (result PrivateEndpointConnection, err error)

Get gets a private endpoint connection. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. privateEndpointConnectionName - the name of the private endpoint connection.

func (PrivateEndpointConnectionsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (PrivateEndpointConnectionsClient) GetResponder 

func (client PrivateEndpointConnectionsClient) GetResponder(resp *http.Response) (result PrivateEndpointConnection, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (PrivateEndpointConnectionsClient) GetSender 

func (client PrivateEndpointConnectionsClient) 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 (PrivateEndpointConnectionsClient) ListByDatabaseAccount 

func (client PrivateEndpointConnectionsClient) ListByDatabaseAccount(ctx context.Context, resourceGroupName string, accountName string) (result PrivateEndpointConnectionListResult, err error)

ListByDatabaseAccount list all private endpoint connections on a Cosmos DB account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.

func (PrivateEndpointConnectionsClient) ListByDatabaseAccountPreparer 

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

ListByDatabaseAccountPreparer prepares the ListByDatabaseAccount request.

func (PrivateEndpointConnectionsClient) ListByDatabaseAccountResponder 

func (client PrivateEndpointConnectionsClient) ListByDatabaseAccountResponder(resp *http.Response) (result PrivateEndpointConnectionListResult, err error)

ListByDatabaseAccountResponder handles the response to the ListByDatabaseAccount request. The method always closes the http.Response Body.

func (PrivateEndpointConnectionsClient) ListByDatabaseAccountSender 

func (client PrivateEndpointConnectionsClient) ListByDatabaseAccountSender(req *http.Request) (*http.Response, error)

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

type PrivateEndpointConnectionsCreateOrUpdateFuture 

type PrivateEndpointConnectionsCreateOrUpdateFuture struct {
	azure.Future
}

PrivateEndpointConnectionsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*PrivateEndpointConnectionsCreateOrUpdateFuture) Result 

func (future *PrivateEndpointConnectionsCreateOrUpdateFuture) Result(client PrivateEndpointConnectionsClient) (pec PrivateEndpointConnection, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type PrivateEndpointConnectionsDeleteFuture 

type PrivateEndpointConnectionsDeleteFuture struct {
	azure.Future
}

PrivateEndpointConnectionsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*PrivateEndpointConnectionsDeleteFuture) Result 

func (future *PrivateEndpointConnectionsDeleteFuture) Result(client PrivateEndpointConnectionsClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type PrivateEndpointProperty 

type PrivateEndpointProperty struct {
	// ID - Resource id of the private endpoint.
	ID *string `json:"id,omitempty"`
}

PrivateEndpointProperty private endpoint which the connection belongs to.

type PrivateLinkResource 

type PrivateLinkResource struct {
	autorest.Response `json:"-"`
	// PrivateLinkResourceProperties - Resource properties.
	*PrivateLinkResourceProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The unique resource identifier of the database account.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the database account.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of Azure resource.
	Type *string `json:"type,omitempty"`
}

PrivateLinkResource a private link resource

func (PrivateLinkResource) MarshalJSON 

func (plr PrivateLinkResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateLinkResource.

func (*PrivateLinkResource) UnmarshalJSON 

func (plr *PrivateLinkResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PrivateLinkResource struct.

type PrivateLinkResourceListResult 

type PrivateLinkResourceListResult struct {
	autorest.Response `json:"-"`
	// Value - Array of private link resources
	Value *[]PrivateLinkResource `json:"value,omitempty"`
}

PrivateLinkResourceListResult a list of private link resources

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	// GroupID - READ-ONLY; The private link resource group id.
	GroupID *string `json:"groupId,omitempty"`
	// RequiredMembers - READ-ONLY; The private link resource required member names.
	RequiredMembers *[]string `json:"requiredMembers,omitempty"`
	// RequiredZoneNames - READ-ONLY; The private link resource required zone names.
	RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}

PrivateLinkResourceProperties properties of a private link resource.

type PrivateLinkResourcesClient 

type PrivateLinkResourcesClient struct {
	BaseClient
}

PrivateLinkResourcesClient is the client for the PrivateLinkResources methods of the Documentdb service.

func NewPrivateLinkResourcesClient 

func NewPrivateLinkResourcesClient(subscriptionID string) PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates an instance of the PrivateLinkResourcesClient client.

func NewPrivateLinkResourcesClientWithBaseURI 

func NewPrivateLinkResourcesClientWithBaseURI(baseURI string, subscriptionID string) PrivateLinkResourcesClient

NewPrivateLinkResourcesClientWithBaseURI creates an instance of the PrivateLinkResourcesClient 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 (PrivateLinkResourcesClient) Get 

func (client PrivateLinkResourcesClient) Get(ctx context.Context, resourceGroupName string, accountName string, groupName string) (result PrivateLinkResource, err error)

Get gets the private link resources that need to be created for a Cosmos DB account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. groupName - the name of the private link resource.

func (PrivateLinkResourcesClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (PrivateLinkResourcesClient) GetResponder 

func (client PrivateLinkResourcesClient) GetResponder(resp *http.Response) (result PrivateLinkResource, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (PrivateLinkResourcesClient) GetSender 

func (client PrivateLinkResourcesClient) 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 (PrivateLinkResourcesClient) ListByDatabaseAccount 

func (client PrivateLinkResourcesClient) ListByDatabaseAccount(ctx context.Context, resourceGroupName string, accountName string) (result PrivateLinkResourceListResult, err error)

ListByDatabaseAccount gets the private link resources that need to be created for a Cosmos DB account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.

func (PrivateLinkResourcesClient) ListByDatabaseAccountPreparer 

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

ListByDatabaseAccountPreparer prepares the ListByDatabaseAccount request.

func (PrivateLinkResourcesClient) ListByDatabaseAccountResponder 

func (client PrivateLinkResourcesClient) ListByDatabaseAccountResponder(resp *http.Response) (result PrivateLinkResourceListResult, err error)

ListByDatabaseAccountResponder handles the response to the ListByDatabaseAccount request. The method always closes the http.Response Body.

func (PrivateLinkResourcesClient) ListByDatabaseAccountSender 

func (client PrivateLinkResourcesClient) ListByDatabaseAccountSender(req *http.Request) (*http.Response, error)

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

type PrivateLinkServiceConnectionStateProperty 

type PrivateLinkServiceConnectionStateProperty struct {
	// Status - The private link service connection status.
	Status *string `json:"status,omitempty"`
	// ActionsRequired - READ-ONLY; Any action that is required beyond basic workflow (approve/ reject/ disconnect)
	ActionsRequired *string `json:"actionsRequired,omitempty"`
	// Description - The private link service connection description.
	Description *string `json:"description,omitempty"`
}

PrivateLinkServiceConnectionStateProperty connection State of the Private Endpoint Connection.

func (PrivateLinkServiceConnectionStateProperty) MarshalJSON 

func (plscsp PrivateLinkServiceConnectionStateProperty) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateLinkServiceConnectionStateProperty.

type ProxyResource 

type ProxyResource struct {
	// 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"`
}

ProxyResource the resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

type PublicNetworkAccess 

type PublicNetworkAccess string

PublicNetworkAccess enumerates the values for public network access. 

const (
	// Disabled ...
	Disabled PublicNetworkAccess = "Disabled"
	// Enabled ...
	Enabled PublicNetworkAccess = "Enabled"
)

func PossiblePublicNetworkAccessValues 

func PossiblePublicNetworkAccessValues() []PublicNetworkAccess

PossiblePublicNetworkAccessValues returns an array of possible values for the PublicNetworkAccess const type.

type RegionForOnlineOffline 

type RegionForOnlineOffline struct {
	// Region - Cosmos DB region, with spaces between words and each word capitalized.
	Region *string `json:"region,omitempty"`
}

RegionForOnlineOffline cosmos DB region to online or offline.

type Resource 

type Resource struct {
	// 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"`
}

Resource common fields that are returned in the response for all Azure Resource Manager resources

type ResourceIdentityType 

type ResourceIdentityType string

ResourceIdentityType enumerates the values for resource identity type. 

const (
	// ResourceIdentityTypeNone ...
	ResourceIdentityTypeNone ResourceIdentityType = "None"
	// ResourceIdentityTypeSystemAssigned ...
	ResourceIdentityTypeSystemAssigned ResourceIdentityType = "SystemAssigned"
	// ResourceIdentityTypeSystemAssignedUserAssigned ...
	ResourceIdentityTypeSystemAssignedUserAssigned ResourceIdentityType = "SystemAssigned,UserAssigned"
	// ResourceIdentityTypeUserAssigned ...
	ResourceIdentityTypeUserAssigned ResourceIdentityType = "UserAssigned"
)

func PossibleResourceIdentityTypeValues 

func PossibleResourceIdentityTypeValues() []ResourceIdentityType

PossibleResourceIdentityTypeValues returns an array of possible values for the ResourceIdentityType const type.

type RestorableDatabaseAccountGetResult 

type RestorableDatabaseAccountGetResult struct {
	autorest.Response `json:"-"`
	// RestorableDatabaseAccountProperties - The properties of a restorable database account.
	*RestorableDatabaseAccountProperties `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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

RestorableDatabaseAccountGetResult a Azure Cosmos DB restorable database account.

func (RestorableDatabaseAccountGetResult) MarshalJSON 

func (rdagr RestorableDatabaseAccountGetResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RestorableDatabaseAccountGetResult.

func (*RestorableDatabaseAccountGetResult) UnmarshalJSON 

func (rdagr *RestorableDatabaseAccountGetResult) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RestorableDatabaseAccountGetResult struct.

type RestorableDatabaseAccountProperties 

type RestorableDatabaseAccountProperties struct {
	// AccountName - The name of the global database account
	AccountName *string `json:"accountName,omitempty"`
	// CreationTime - The creation time of the restorable database account (ISO-8601 format).
	CreationTime *date.Time `json:"creationTime,omitempty"`
	// DeletionTime - The time at which the restorable database account has been deleted (ISO-8601 format).
	DeletionTime *date.Time `json:"deletionTime,omitempty"`
}

RestorableDatabaseAccountProperties the properties of a restorable database account.

type RestorableDatabaseAccountsClient 

type RestorableDatabaseAccountsClient struct {
	BaseClient
}

RestorableDatabaseAccountsClient is the client for the RestorableDatabaseAccounts methods of the Documentdb service.

func NewRestorableDatabaseAccountsClient 

func NewRestorableDatabaseAccountsClient(subscriptionID string) RestorableDatabaseAccountsClient

NewRestorableDatabaseAccountsClient creates an instance of the RestorableDatabaseAccountsClient client.

func NewRestorableDatabaseAccountsClientWithBaseURI 

func NewRestorableDatabaseAccountsClientWithBaseURI(baseURI string, subscriptionID string) RestorableDatabaseAccountsClient

NewRestorableDatabaseAccountsClientWithBaseURI creates an instance of the RestorableDatabaseAccountsClient 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 (RestorableDatabaseAccountsClient) GetByLocation 

func (client RestorableDatabaseAccountsClient) GetByLocation(ctx context.Context, location string, instanceID string) (result RestorableDatabaseAccountGetResult, err error)

GetByLocation retrieves the properties of an existing Azure Cosmos DB restorable database account. Parameters: location - cosmos DB region, with spaces between words and each word capitalized. instanceID - the instanceId GUID of a restorable database account.

func (RestorableDatabaseAccountsClient) GetByLocationPreparer 

func (client RestorableDatabaseAccountsClient) GetByLocationPreparer(ctx context.Context, location string, instanceID string) (*http.Request, error)

GetByLocationPreparer prepares the GetByLocation request.

func (RestorableDatabaseAccountsClient) GetByLocationResponder 

func (client RestorableDatabaseAccountsClient) GetByLocationResponder(resp *http.Response) (result RestorableDatabaseAccountGetResult, err error)

GetByLocationResponder handles the response to the GetByLocation request. The method always closes the http.Response Body.

func (RestorableDatabaseAccountsClient) GetByLocationSender 

func (client RestorableDatabaseAccountsClient) GetByLocationSender(req *http.Request) (*http.Response, error)

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

func (RestorableDatabaseAccountsClient) List 

func (client RestorableDatabaseAccountsClient) List(ctx context.Context) (result RestorableDatabaseAccountsListResult, err error)

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

func (RestorableDatabaseAccountsClient) ListByLocation 

func (client RestorableDatabaseAccountsClient) ListByLocation(ctx context.Context, location string) (result RestorableDatabaseAccountsListResult, err error)

ListByLocation lists all the restorable Azure Cosmos DB database accounts available under the subscription and in a region. Parameters: location - cosmos DB region, with spaces between words and each word capitalized.

func (RestorableDatabaseAccountsClient) ListByLocationPreparer 

func (client RestorableDatabaseAccountsClient) ListByLocationPreparer(ctx context.Context, location string) (*http.Request, error)

ListByLocationPreparer prepares the ListByLocation request.

func (RestorableDatabaseAccountsClient) ListByLocationResponder 

func (client RestorableDatabaseAccountsClient) ListByLocationResponder(resp *http.Response) (result RestorableDatabaseAccountsListResult, err error)

ListByLocationResponder handles the response to the ListByLocation request. The method always closes the http.Response Body.

func (RestorableDatabaseAccountsClient) ListByLocationSender 

func (client RestorableDatabaseAccountsClient) ListByLocationSender(req *http.Request) (*http.Response, error)

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

func (RestorableDatabaseAccountsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (RestorableDatabaseAccountsClient) ListResponder 

func (client RestorableDatabaseAccountsClient) ListResponder(resp *http.Response) (result RestorableDatabaseAccountsListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (RestorableDatabaseAccountsClient) ListSender 

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

type RestorableDatabaseAccountsListResult 

type RestorableDatabaseAccountsListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of restorable database accounts and their properties.
	Value *[]RestorableDatabaseAccountGetResult `json:"value,omitempty"`
}

RestorableDatabaseAccountsListResult the List operation response, that contains the restorable database accounts and their properties.

type RestoreMode 

type RestoreMode string

RestoreMode enumerates the values for restore mode. 

const (
	// PointInTime ...
	PointInTime RestoreMode = "PointInTime"
)

func PossibleRestoreModeValues 

func PossibleRestoreModeValues() []RestoreMode

PossibleRestoreModeValues returns an array of possible values for the RestoreMode const type.

type RestoreParameters 

type RestoreParameters struct {
	// RestoreMode - Describes the mode of the restore. Possible values include: 'PointInTime'
	RestoreMode RestoreMode `json:"restoreMode,omitempty"`
	// RestoreSource - The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
	RestoreSource *string `json:"restoreSource,omitempty"`
	// RestoreTimestampInUtc - Time to which the account has to be restored (ISO-8601 format).
	RestoreTimestampInUtc *date.Time `json:"restoreTimestampInUtc,omitempty"`
	// DatabasesToRestore - List of specific databases to restore.
	DatabasesToRestore *[]DatabaseRestoreResource `json:"databasesToRestore,omitempty"`
}

RestoreParameters parameters to indicate the information about the restore.

type RestoreReqeustDatabaseAccountCreateUpdateProperties 

type RestoreReqeustDatabaseAccountCreateUpdateProperties struct {
	// RestoreParameters - Parameters to indicate the information about the restore.
	RestoreParameters *RestoreParameters `json:"restoreParameters,omitempty"`
	// 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"`
	// IPRules - List of IpRules.
	IPRules *[]IPAddressOrRange `json:"ipRules,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"`
	// PublicNetworkAccess - Whether requests from Public Network are allowed. Possible values include: 'Enabled', 'Disabled'
	PublicNetworkAccess PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
	// EnableFreeTier - Flag to indicate whether Free Tier is enabled.
	EnableFreeTier *bool `json:"enableFreeTier,omitempty"`
	// APIProperties - API specific properties. Currently, supported only for MongoDB API.
	APIProperties *APIProperties `json:"apiProperties,omitempty"`
	// EnableAnalyticalStorage - Flag to indicate whether to enable storage analytics.
	EnableAnalyticalStorage *bool `json:"enableAnalyticalStorage,omitempty"`
	// BackupPolicy - The object representing the policy for taking backups on an account.
	BackupPolicy BasicBackupPolicy `json:"backupPolicy,omitempty"`
	// Cors - The CORS policy for the Cosmos DB database account.
	Cors *[]CorsPolicy `json:"cors,omitempty"`
	// CreateMode - Possible values include: 'CreateModeDatabaseAccountCreateUpdateProperties', 'CreateModeDefault', 'CreateModeRestore'
	CreateMode CreateModeBasicDatabaseAccountCreateUpdateProperties `json:"createMode,omitempty"`
}

RestoreReqeustDatabaseAccountCreateUpdateProperties properties to restore Azure Cosmos DB database account.

func (RestoreReqeustDatabaseAccountCreateUpdateProperties) AsBasicDatabaseAccountCreateUpdateProperties 

func (rrdacup RestoreReqeustDatabaseAccountCreateUpdateProperties) AsBasicDatabaseAccountCreateUpdateProperties() (BasicDatabaseAccountCreateUpdateProperties, bool)

AsBasicDatabaseAccountCreateUpdateProperties is the BasicDatabaseAccountCreateUpdateProperties implementation for RestoreReqeustDatabaseAccountCreateUpdateProperties.

func (RestoreReqeustDatabaseAccountCreateUpdateProperties) AsDatabaseAccountCreateUpdateProperties 

func (rrdacup RestoreReqeustDatabaseAccountCreateUpdateProperties) AsDatabaseAccountCreateUpdateProperties() (*DatabaseAccountCreateUpdateProperties, bool)

AsDatabaseAccountCreateUpdateProperties is the BasicDatabaseAccountCreateUpdateProperties implementation for RestoreReqeustDatabaseAccountCreateUpdateProperties.

func (RestoreReqeustDatabaseAccountCreateUpdateProperties) AsDefaultRequestDatabaseAccountCreateUpdateProperties 

func (rrdacup RestoreReqeustDatabaseAccountCreateUpdateProperties) AsDefaultRequestDatabaseAccountCreateUpdateProperties() (*DefaultRequestDatabaseAccountCreateUpdateProperties, bool)

AsDefaultRequestDatabaseAccountCreateUpdateProperties is the BasicDatabaseAccountCreateUpdateProperties implementation for RestoreReqeustDatabaseAccountCreateUpdateProperties.

func (RestoreReqeustDatabaseAccountCreateUpdateProperties) AsRestoreReqeustDatabaseAccountCreateUpdateProperties 

func (rrdacup RestoreReqeustDatabaseAccountCreateUpdateProperties) AsRestoreReqeustDatabaseAccountCreateUpdateProperties() (*RestoreReqeustDatabaseAccountCreateUpdateProperties, bool)

AsRestoreReqeustDatabaseAccountCreateUpdateProperties is the BasicDatabaseAccountCreateUpdateProperties implementation for RestoreReqeustDatabaseAccountCreateUpdateProperties.

func (RestoreReqeustDatabaseAccountCreateUpdateProperties) MarshalJSON 

func (rrdacup RestoreReqeustDatabaseAccountCreateUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RestoreReqeustDatabaseAccountCreateUpdateProperties.

func (*RestoreReqeustDatabaseAccountCreateUpdateProperties) UnmarshalJSON 

func (rrdacup *RestoreReqeustDatabaseAccountCreateUpdateProperties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RestoreReqeustDatabaseAccountCreateUpdateProperties struct.

type RoleDefinitionType added in v48.2.1 

type RoleDefinitionType string

RoleDefinitionType enumerates the values for role definition type. 

const (
	// BuiltInRole ...
	BuiltInRole RoleDefinitionType = "BuiltInRole"
	// CustomRole ...
	CustomRole RoleDefinitionType = "CustomRole"
)

func PossibleRoleDefinitionTypeValues added in v48.2.1 

func PossibleRoleDefinitionTypeValues() []RoleDefinitionType

PossibleRoleDefinitionTypeValues returns an array of possible values for the RoleDefinitionType const type.

type SQLContainerCreateUpdateParameters 

type SQLContainerCreateUpdateParameters struct {
	// SQLContainerCreateUpdateProperties - Properties to create and update Azure Cosmos DB container.
	*SQLContainerCreateUpdateProperties `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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

SQLContainerCreateUpdateParameters parameters to create and update Cosmos DB container.

func (SQLContainerCreateUpdateParameters) MarshalJSON 

func (sccup SQLContainerCreateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SQLContainerCreateUpdateParameters.

func (*SQLContainerCreateUpdateParameters) UnmarshalJSON 

func (sccup *SQLContainerCreateUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SQLContainerCreateUpdateParameters struct.

type SQLContainerCreateUpdateProperties 

type SQLContainerCreateUpdateProperties struct {
	// Resource - The standard JSON format of a container
	Resource *SQLContainerResource `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"`
}

SQLContainerCreateUpdateProperties properties to create and update Azure Cosmos DB container.

type SQLContainerGetProperties 

type SQLContainerGetProperties struct {
	Resource *SQLContainerGetPropertiesResource `json:"resource,omitempty"`
	Options  *SQLContainerGetPropertiesOptions  `json:"options,omitempty"`
}

SQLContainerGetProperties the properties of an Azure Cosmos DB container

type SQLContainerGetPropertiesOptions 

type SQLContainerGetPropertiesOptions struct {
	// Throughput - Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
	Throughput *int32 `json:"throughput,omitempty"`
	// AutoscaleSettings - Specifies the Autoscale settings.
	AutoscaleSettings *AutoscaleSettings `json:"autoscaleSettings,omitempty"`
}

SQLContainerGetPropertiesOptions ...

type SQLContainerGetPropertiesResource 

type SQLContainerGetPropertiesResource struct {
	// ID - Name of the Cosmos DB SQL container
	ID *string `json:"id,omitempty"`
	// IndexingPolicy - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
	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 container.
	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"`
}

SQLContainerGetPropertiesResource ...

func (SQLContainerGetPropertiesResource) MarshalJSON 

func (scgp SQLContainerGetPropertiesResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SQLContainerGetPropertiesResource.

type SQLContainerGetResults 

type SQLContainerGetResults struct {
	autorest.Response `json:"-"`
	// SQLContainerGetProperties - The properties of an Azure Cosmos DB container
	*SQLContainerGetProperties `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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

SQLContainerGetResults an Azure Cosmos DB container.

func (SQLContainerGetResults) MarshalJSON 

func (scgr SQLContainerGetResults) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SQLContainerGetResults.

func (*SQLContainerGetResults) UnmarshalJSON 

func (scgr *SQLContainerGetResults) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SQLContainerGetResults struct.

type SQLContainerListResult 

type SQLContainerListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of containers and their properties.
	Value *[]SQLContainerGetResults `json:"value,omitempty"`
}

SQLContainerListResult the List operation response, that contains the containers and their properties.

type SQLContainerResource 

type SQLContainerResource struct {
	// ID - Name of the Cosmos DB SQL container
	ID *string `json:"id,omitempty"`
	// IndexingPolicy - The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
	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 container.
	ConflictResolutionPolicy *ConflictResolutionPolicy `json:"conflictResolutionPolicy,omitempty"`
}

SQLContainerResource cosmos DB SQL container resource object

type SQLDatabaseCreateUpdateParameters 

type SQLDatabaseCreateUpdateParameters struct {
	// SQLDatabaseCreateUpdateProperties - Properties to create and update Azure Cosmos DB SQL database.
	*SQLDatabaseCreateUpdateProperties `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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

SQLDatabaseCreateUpdateParameters parameters to create and update Cosmos DB SQL database.

func (SQLDatabaseCreateUpdateParameters) MarshalJSON 

func (sdcup SQLDatabaseCreateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SQLDatabaseCreateUpdateParameters.

func (*SQLDatabaseCreateUpdateParameters) UnmarshalJSON 

func (sdcup *SQLDatabaseCreateUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SQLDatabaseCreateUpdateParameters struct.

type SQLDatabaseCreateUpdateProperties 

type SQLDatabaseCreateUpdateProperties struct {
	// Resource - The standard JSON format of a SQL database
	Resource *SQLDatabaseResource `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"`
}

SQLDatabaseCreateUpdateProperties properties to create and update Azure Cosmos DB SQL database.

type SQLDatabaseGetProperties 

type SQLDatabaseGetProperties struct {
	Resource *SQLDatabaseGetPropertiesResource `json:"resource,omitempty"`
	Options  *SQLDatabaseGetPropertiesOptions  `json:"options,omitempty"`
}

SQLDatabaseGetProperties the properties of an Azure Cosmos DB SQL database

type SQLDatabaseGetPropertiesOptions 

type SQLDatabaseGetPropertiesOptions struct {
	// Throughput - Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
	Throughput *int32 `json:"throughput,omitempty"`
	// AutoscaleSettings - Specifies the Autoscale settings.
	AutoscaleSettings *AutoscaleSettings `json:"autoscaleSettings,omitempty"`
}

SQLDatabaseGetPropertiesOptions ...

type SQLDatabaseGetPropertiesResource 

type SQLDatabaseGetPropertiesResource struct {
	// ID - Name of the Cosmos DB SQL 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"`
	// Colls - A system generated property that specified the addressable path of the collections resource.
	Colls *string `json:"_colls,omitempty"`
	// Users - A system generated property that specifies the addressable path of the users resource.
	Users *string `json:"_users,omitempty"`
}

SQLDatabaseGetPropertiesResource ...

func (SQLDatabaseGetPropertiesResource) MarshalJSON 

func (sdgp SQLDatabaseGetPropertiesResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SQLDatabaseGetPropertiesResource.

type SQLDatabaseGetResults 

type SQLDatabaseGetResults struct {
	autorest.Response `json:"-"`
	// SQLDatabaseGetProperties - The properties of an Azure Cosmos DB SQL database
	*SQLDatabaseGetProperties `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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

SQLDatabaseGetResults an Azure Cosmos DB SQL database.

func (SQLDatabaseGetResults) MarshalJSON 

func (sdgr SQLDatabaseGetResults) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SQLDatabaseGetResults.

func (*SQLDatabaseGetResults) UnmarshalJSON 

func (sdgr *SQLDatabaseGetResults) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SQLDatabaseGetResults struct.

type SQLDatabaseListResult 

type SQLDatabaseListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of SQL databases and their properties.
	Value *[]SQLDatabaseGetResults `json:"value,omitempty"`
}

SQLDatabaseListResult the List operation response, that contains the SQL databases and their properties.

type SQLDatabaseResource 

type SQLDatabaseResource struct {
	// ID - Name of the Cosmos DB SQL database
	ID *string `json:"id,omitempty"`
}

SQLDatabaseResource cosmos DB SQL database resource object

type SQLResourcesClient 

type SQLResourcesClient struct {
	BaseClient
}

SQLResourcesClient is the client for the SQLResources methods of the Documentdb service.

func NewSQLResourcesClient 

func NewSQLResourcesClient(subscriptionID string) SQLResourcesClient

NewSQLResourcesClient creates an instance of the SQLResourcesClient client.

func NewSQLResourcesClientWithBaseURI 

func NewSQLResourcesClientWithBaseURI(baseURI string, subscriptionID string) SQLResourcesClient

NewSQLResourcesClientWithBaseURI creates an instance of the SQLResourcesClient 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 (SQLResourcesClient) CreateUpdateSQLContainer 

func (client SQLResourcesClient) CreateUpdateSQLContainer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, createUpdateSQLContainerParameters SQLContainerCreateUpdateParameters) (result SQLResourcesCreateUpdateSQLContainerFuture, err error)

CreateUpdateSQLContainer create or update an Azure Cosmos DB SQL container Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. containerName - cosmos DB container name. createUpdateSQLContainerParameters - the parameters to provide for the current SQL container.

func (SQLResourcesClient) CreateUpdateSQLContainerPreparer 

func (client SQLResourcesClient) CreateUpdateSQLContainerPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, createUpdateSQLContainerParameters SQLContainerCreateUpdateParameters) (*http.Request, error)

CreateUpdateSQLContainerPreparer prepares the CreateUpdateSQLContainer request.

func (SQLResourcesClient) CreateUpdateSQLContainerResponder 

func (client SQLResourcesClient) CreateUpdateSQLContainerResponder(resp *http.Response) (result SQLContainerGetResults, err error)

CreateUpdateSQLContainerResponder handles the response to the CreateUpdateSQLContainer request. The method always closes the http.Response Body.

func (SQLResourcesClient) CreateUpdateSQLContainerSender 

func (client SQLResourcesClient) CreateUpdateSQLContainerSender(req *http.Request) (future SQLResourcesCreateUpdateSQLContainerFuture, err error)

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

func (SQLResourcesClient) CreateUpdateSQLDatabase 

func (client SQLResourcesClient) CreateUpdateSQLDatabase(ctx context.Context, resourceGroupName string, accountName string, databaseName string, createUpdateSQLDatabaseParameters SQLDatabaseCreateUpdateParameters) (result SQLResourcesCreateUpdateSQLDatabaseFuture, err error)

CreateUpdateSQLDatabase create or update an Azure Cosmos DB SQL database Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. createUpdateSQLDatabaseParameters - the parameters to provide for the current SQL database.

func (SQLResourcesClient) CreateUpdateSQLDatabasePreparer 

func (client SQLResourcesClient) CreateUpdateSQLDatabasePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, createUpdateSQLDatabaseParameters SQLDatabaseCreateUpdateParameters) (*http.Request, error)

CreateUpdateSQLDatabasePreparer prepares the CreateUpdateSQLDatabase request.

func (SQLResourcesClient) CreateUpdateSQLDatabaseResponder 

func (client SQLResourcesClient) CreateUpdateSQLDatabaseResponder(resp *http.Response) (result SQLDatabaseGetResults, err error)

CreateUpdateSQLDatabaseResponder handles the response to the CreateUpdateSQLDatabase request. The method always closes the http.Response Body.

func (SQLResourcesClient) CreateUpdateSQLDatabaseSender 

func (client SQLResourcesClient) CreateUpdateSQLDatabaseSender(req *http.Request) (future SQLResourcesCreateUpdateSQLDatabaseFuture, err error)

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

func (SQLResourcesClient) CreateUpdateSQLRoleAssignment added in v48.2.1 

func (client SQLResourcesClient) CreateUpdateSQLRoleAssignment(ctx context.Context, roleAssignmentID string, resourceGroupName string, accountName string, createUpdateSQLRoleAssignmentParameters SQLRoleAssignmentCreateUpdateParameters) (result SQLResourcesCreateUpdateSQLRoleAssignmentFuture, err error)

CreateUpdateSQLRoleAssignment creates or updates an Azure Cosmos DB SQL Role Assignment. Parameters: roleAssignmentID - the GUID for the Role Assignment. resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. createUpdateSQLRoleAssignmentParameters - the properties required to create or update a Role Assignment.

func (SQLResourcesClient) CreateUpdateSQLRoleAssignmentPreparer added in v48.2.1 

func (client SQLResourcesClient) CreateUpdateSQLRoleAssignmentPreparer(ctx context.Context, roleAssignmentID string, resourceGroupName string, accountName string, createUpdateSQLRoleAssignmentParameters SQLRoleAssignmentCreateUpdateParameters) (*http.Request, error)

CreateUpdateSQLRoleAssignmentPreparer prepares the CreateUpdateSQLRoleAssignment request.

func (SQLResourcesClient) CreateUpdateSQLRoleAssignmentResponder added in v48.2.1 

func (client SQLResourcesClient) CreateUpdateSQLRoleAssignmentResponder(resp *http.Response) (result SQLRoleAssignmentGetResults, err error)

CreateUpdateSQLRoleAssignmentResponder handles the response to the CreateUpdateSQLRoleAssignment request. The method always closes the http.Response Body.

func (SQLResourcesClient) CreateUpdateSQLRoleAssignmentSender added in v48.2.1 

func (client SQLResourcesClient) CreateUpdateSQLRoleAssignmentSender(req *http.Request) (future SQLResourcesCreateUpdateSQLRoleAssignmentFuture, err error)

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

func (SQLResourcesClient) CreateUpdateSQLRoleDefinition added in v48.2.1 

func (client SQLResourcesClient) CreateUpdateSQLRoleDefinition(ctx context.Context, roleDefinitionID string, resourceGroupName string, accountName string, createUpdateSQLRoleDefinitionParameters SQLRoleDefinitionCreateUpdateParameters) (result SQLResourcesCreateUpdateSQLRoleDefinitionFuture, err error)

CreateUpdateSQLRoleDefinition creates or updates an Azure Cosmos DB SQL Role Definition. Parameters: roleDefinitionID - the GUID for the Role Definition. resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. createUpdateSQLRoleDefinitionParameters - the properties required to create or update a Role Definition.

func (SQLResourcesClient) CreateUpdateSQLRoleDefinitionPreparer added in v48.2.1 

func (client SQLResourcesClient) CreateUpdateSQLRoleDefinitionPreparer(ctx context.Context, roleDefinitionID string, resourceGroupName string, accountName string, createUpdateSQLRoleDefinitionParameters SQLRoleDefinitionCreateUpdateParameters) (*http.Request, error)

CreateUpdateSQLRoleDefinitionPreparer prepares the CreateUpdateSQLRoleDefinition request.

func (SQLResourcesClient) CreateUpdateSQLRoleDefinitionResponder added in v48.2.1 

func (client SQLResourcesClient) CreateUpdateSQLRoleDefinitionResponder(resp *http.Response) (result SQLRoleDefinitionGetResults, err error)

CreateUpdateSQLRoleDefinitionResponder handles the response to the CreateUpdateSQLRoleDefinition request. The method always closes the http.Response Body.

func (SQLResourcesClient) CreateUpdateSQLRoleDefinitionSender added in v48.2.1 

func (client SQLResourcesClient) CreateUpdateSQLRoleDefinitionSender(req *http.Request) (future SQLResourcesCreateUpdateSQLRoleDefinitionFuture, err error)

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

func (SQLResourcesClient) CreateUpdateSQLStoredProcedure 

func (client SQLResourcesClient) CreateUpdateSQLStoredProcedure(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, storedProcedureName string, createUpdateSQLStoredProcedureParameters SQLStoredProcedureCreateUpdateParameters) (result SQLResourcesCreateUpdateSQLStoredProcedureFuture, err error)

CreateUpdateSQLStoredProcedure create or update an Azure Cosmos DB SQL storedProcedure Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. containerName - cosmos DB container name. storedProcedureName - cosmos DB storedProcedure name. createUpdateSQLStoredProcedureParameters - the parameters to provide for the current SQL storedProcedure.

func (SQLResourcesClient) CreateUpdateSQLStoredProcedurePreparer 

func (client SQLResourcesClient) CreateUpdateSQLStoredProcedurePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, storedProcedureName string, createUpdateSQLStoredProcedureParameters SQLStoredProcedureCreateUpdateParameters) (*http.Request, error)

CreateUpdateSQLStoredProcedurePreparer prepares the CreateUpdateSQLStoredProcedure request.

func (SQLResourcesClient) CreateUpdateSQLStoredProcedureResponder 

func (client SQLResourcesClient) CreateUpdateSQLStoredProcedureResponder(resp *http.Response) (result SQLStoredProcedureGetResults, err error)

CreateUpdateSQLStoredProcedureResponder handles the response to the CreateUpdateSQLStoredProcedure request. The method always closes the http.Response Body.

func (SQLResourcesClient) CreateUpdateSQLStoredProcedureSender 

func (client SQLResourcesClient) CreateUpdateSQLStoredProcedureSender(req *http.Request) (future SQLResourcesCreateUpdateSQLStoredProcedureFuture, err error)

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

func (SQLResourcesClient) CreateUpdateSQLTrigger 

func (client SQLResourcesClient) CreateUpdateSQLTrigger(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, triggerName string, createUpdateSQLTriggerParameters SQLTriggerCreateUpdateParameters) (result SQLResourcesCreateUpdateSQLTriggerFuture, err error)

CreateUpdateSQLTrigger create or update an Azure Cosmos DB SQL trigger Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. containerName - cosmos DB container name. triggerName - cosmos DB trigger name. createUpdateSQLTriggerParameters - the parameters to provide for the current SQL trigger.

func (SQLResourcesClient) CreateUpdateSQLTriggerPreparer 

func (client SQLResourcesClient) CreateUpdateSQLTriggerPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, triggerName string, createUpdateSQLTriggerParameters SQLTriggerCreateUpdateParameters) (*http.Request, error)

CreateUpdateSQLTriggerPreparer prepares the CreateUpdateSQLTrigger request.

func (SQLResourcesClient) CreateUpdateSQLTriggerResponder 

func (client SQLResourcesClient) CreateUpdateSQLTriggerResponder(resp *http.Response) (result SQLTriggerGetResults, err error)

CreateUpdateSQLTriggerResponder handles the response to the CreateUpdateSQLTrigger request. The method always closes the http.Response Body.

func (SQLResourcesClient) CreateUpdateSQLTriggerSender 

func (client SQLResourcesClient) CreateUpdateSQLTriggerSender(req *http.Request) (future SQLResourcesCreateUpdateSQLTriggerFuture, err error)

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

func (SQLResourcesClient) CreateUpdateSQLUserDefinedFunction 

func (client SQLResourcesClient) CreateUpdateSQLUserDefinedFunction(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, userDefinedFunctionName string, createUpdateSQLUserDefinedFunctionParameters SQLUserDefinedFunctionCreateUpdateParameters) (result SQLResourcesCreateUpdateSQLUserDefinedFunctionFuture, err error)

CreateUpdateSQLUserDefinedFunction create or update an Azure Cosmos DB SQL userDefinedFunction Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. containerName - cosmos DB container name. userDefinedFunctionName - cosmos DB userDefinedFunction name. createUpdateSQLUserDefinedFunctionParameters - the parameters to provide for the current SQL userDefinedFunction.

func (SQLResourcesClient) CreateUpdateSQLUserDefinedFunctionPreparer 

func (client SQLResourcesClient) CreateUpdateSQLUserDefinedFunctionPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, userDefinedFunctionName string, createUpdateSQLUserDefinedFunctionParameters SQLUserDefinedFunctionCreateUpdateParameters) (*http.Request, error)

CreateUpdateSQLUserDefinedFunctionPreparer prepares the CreateUpdateSQLUserDefinedFunction request.

func (SQLResourcesClient) CreateUpdateSQLUserDefinedFunctionResponder 

func (client SQLResourcesClient) CreateUpdateSQLUserDefinedFunctionResponder(resp *http.Response) (result SQLUserDefinedFunctionGetResults, err error)

CreateUpdateSQLUserDefinedFunctionResponder handles the response to the CreateUpdateSQLUserDefinedFunction request. The method always closes the http.Response Body.

func (SQLResourcesClient) CreateUpdateSQLUserDefinedFunctionSender 

func (client SQLResourcesClient) CreateUpdateSQLUserDefinedFunctionSender(req *http.Request) (future SQLResourcesCreateUpdateSQLUserDefinedFunctionFuture, err error)

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

func (SQLResourcesClient) DeleteSQLContainer 

func (client SQLResourcesClient) DeleteSQLContainer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (result SQLResourcesDeleteSQLContainerFuture, err error)

DeleteSQLContainer deletes an existing Azure Cosmos DB SQL container. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. containerName - cosmos DB container name.

func (SQLResourcesClient) DeleteSQLContainerPreparer 

func (client SQLResourcesClient) DeleteSQLContainerPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (*http.Request, error)

DeleteSQLContainerPreparer prepares the DeleteSQLContainer request.

func (SQLResourcesClient) DeleteSQLContainerResponder 

func (client SQLResourcesClient) DeleteSQLContainerResponder(resp *http.Response) (result autorest.Response, err error)

DeleteSQLContainerResponder handles the response to the DeleteSQLContainer request. The method always closes the http.Response Body.

func (SQLResourcesClient) DeleteSQLContainerSender 

func (client SQLResourcesClient) DeleteSQLContainerSender(req *http.Request) (future SQLResourcesDeleteSQLContainerFuture, err error)

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

func (SQLResourcesClient) DeleteSQLDatabase 

func (client SQLResourcesClient) DeleteSQLDatabase(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result SQLResourcesDeleteSQLDatabaseFuture, err error)

DeleteSQLDatabase deletes an existing Azure Cosmos DB SQL database. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name.

func (SQLResourcesClient) DeleteSQLDatabasePreparer 

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

DeleteSQLDatabasePreparer prepares the DeleteSQLDatabase request.

func (SQLResourcesClient) DeleteSQLDatabaseResponder 

func (client SQLResourcesClient) DeleteSQLDatabaseResponder(resp *http.Response) (result autorest.Response, err error)

DeleteSQLDatabaseResponder handles the response to the DeleteSQLDatabase request. The method always closes the http.Response Body.

func (SQLResourcesClient) DeleteSQLDatabaseSender 

func (client SQLResourcesClient) DeleteSQLDatabaseSender(req *http.Request) (future SQLResourcesDeleteSQLDatabaseFuture, err error)

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

func (SQLResourcesClient) DeleteSQLRoleAssignment added in v48.2.1 

func (client SQLResourcesClient) DeleteSQLRoleAssignment(ctx context.Context, roleAssignmentID string, resourceGroupName string, accountName string) (result SQLResourcesDeleteSQLRoleAssignmentFuture, err error)

DeleteSQLRoleAssignment deletes an existing Azure Cosmos DB SQL Role Assignment. Parameters: roleAssignmentID - the GUID for the Role Assignment. resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.

func (SQLResourcesClient) DeleteSQLRoleAssignmentPreparer added in v48.2.1 

func (client SQLResourcesClient) DeleteSQLRoleAssignmentPreparer(ctx context.Context, roleAssignmentID string, resourceGroupName string, accountName string) (*http.Request, error)

DeleteSQLRoleAssignmentPreparer prepares the DeleteSQLRoleAssignment request.

func (SQLResourcesClient) DeleteSQLRoleAssignmentResponder added in v48.2.1 

func (client SQLResourcesClient) DeleteSQLRoleAssignmentResponder(resp *http.Response) (result autorest.Response, err error)

DeleteSQLRoleAssignmentResponder handles the response to the DeleteSQLRoleAssignment request. The method always closes the http.Response Body.

func (SQLResourcesClient) DeleteSQLRoleAssignmentSender added in v48.2.1 

func (client SQLResourcesClient) DeleteSQLRoleAssignmentSender(req *http.Request) (future SQLResourcesDeleteSQLRoleAssignmentFuture, err error)

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

func (SQLResourcesClient) DeleteSQLRoleDefinition added in v48.2.1 

func (client SQLResourcesClient) DeleteSQLRoleDefinition(ctx context.Context, roleDefinitionID string, resourceGroupName string, accountName string) (result SQLResourcesDeleteSQLRoleDefinitionFuture, err error)

DeleteSQLRoleDefinition deletes an existing Azure Cosmos DB SQL Role Definition. Parameters: roleDefinitionID - the GUID for the Role Definition. resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.

func (SQLResourcesClient) DeleteSQLRoleDefinitionPreparer added in v48.2.1 

func (client SQLResourcesClient) DeleteSQLRoleDefinitionPreparer(ctx context.Context, roleDefinitionID string, resourceGroupName string, accountName string) (*http.Request, error)

DeleteSQLRoleDefinitionPreparer prepares the DeleteSQLRoleDefinition request.

func (SQLResourcesClient) DeleteSQLRoleDefinitionResponder added in v48.2.1 

func (client SQLResourcesClient) DeleteSQLRoleDefinitionResponder(resp *http.Response) (result autorest.Response, err error)

DeleteSQLRoleDefinitionResponder handles the response to the DeleteSQLRoleDefinition request. The method always closes the http.Response Body.

func (SQLResourcesClient) DeleteSQLRoleDefinitionSender added in v48.2.1 

func (client SQLResourcesClient) DeleteSQLRoleDefinitionSender(req *http.Request) (future SQLResourcesDeleteSQLRoleDefinitionFuture, err error)

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

func (SQLResourcesClient) DeleteSQLStoredProcedure 

func (client SQLResourcesClient) DeleteSQLStoredProcedure(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, storedProcedureName string) (result SQLResourcesDeleteSQLStoredProcedureFuture, err error)

DeleteSQLStoredProcedure deletes an existing Azure Cosmos DB SQL storedProcedure. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. containerName - cosmos DB container name. storedProcedureName - cosmos DB storedProcedure name.

func (SQLResourcesClient) DeleteSQLStoredProcedurePreparer 

func (client SQLResourcesClient) DeleteSQLStoredProcedurePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, storedProcedureName string) (*http.Request, error)

DeleteSQLStoredProcedurePreparer prepares the DeleteSQLStoredProcedure request.

func (SQLResourcesClient) DeleteSQLStoredProcedureResponder 

func (client SQLResourcesClient) DeleteSQLStoredProcedureResponder(resp *http.Response) (result autorest.Response, err error)

DeleteSQLStoredProcedureResponder handles the response to the DeleteSQLStoredProcedure request. The method always closes the http.Response Body.

func (SQLResourcesClient) DeleteSQLStoredProcedureSender 

func (client SQLResourcesClient) DeleteSQLStoredProcedureSender(req *http.Request) (future SQLResourcesDeleteSQLStoredProcedureFuture, err error)

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

func (SQLResourcesClient) DeleteSQLTrigger 

func (client SQLResourcesClient) DeleteSQLTrigger(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, triggerName string) (result SQLResourcesDeleteSQLTriggerFuture, err error)

DeleteSQLTrigger deletes an existing Azure Cosmos DB SQL trigger. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. containerName - cosmos DB container name. triggerName - cosmos DB trigger name.

func (SQLResourcesClient) DeleteSQLTriggerPreparer 

func (client SQLResourcesClient) DeleteSQLTriggerPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, triggerName string) (*http.Request, error)

DeleteSQLTriggerPreparer prepares the DeleteSQLTrigger request.

func (SQLResourcesClient) DeleteSQLTriggerResponder 

func (client SQLResourcesClient) DeleteSQLTriggerResponder(resp *http.Response) (result autorest.Response, err error)

DeleteSQLTriggerResponder handles the response to the DeleteSQLTrigger request. The method always closes the http.Response Body.

func (SQLResourcesClient) DeleteSQLTriggerSender 

func (client SQLResourcesClient) DeleteSQLTriggerSender(req *http.Request) (future SQLResourcesDeleteSQLTriggerFuture, err error)

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

func (SQLResourcesClient) DeleteSQLUserDefinedFunction 

func (client SQLResourcesClient) DeleteSQLUserDefinedFunction(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, userDefinedFunctionName string) (result SQLResourcesDeleteSQLUserDefinedFunctionFuture, err error)

DeleteSQLUserDefinedFunction deletes an existing Azure Cosmos DB SQL userDefinedFunction. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. containerName - cosmos DB container name. userDefinedFunctionName - cosmos DB userDefinedFunction name.

func (SQLResourcesClient) DeleteSQLUserDefinedFunctionPreparer 

func (client SQLResourcesClient) DeleteSQLUserDefinedFunctionPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, userDefinedFunctionName string) (*http.Request, error)

DeleteSQLUserDefinedFunctionPreparer prepares the DeleteSQLUserDefinedFunction request.

func (SQLResourcesClient) DeleteSQLUserDefinedFunctionResponder 

func (client SQLResourcesClient) DeleteSQLUserDefinedFunctionResponder(resp *http.Response) (result autorest.Response, err error)

DeleteSQLUserDefinedFunctionResponder handles the response to the DeleteSQLUserDefinedFunction request. The method always closes the http.Response Body.

func (SQLResourcesClient) DeleteSQLUserDefinedFunctionSender 

func (client SQLResourcesClient) DeleteSQLUserDefinedFunctionSender(req *http.Request) (future SQLResourcesDeleteSQLUserDefinedFunctionFuture, err error)

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

func (SQLResourcesClient) GetSQLContainer 

func (client SQLResourcesClient) GetSQLContainer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (result SQLContainerGetResults, err error)

GetSQLContainer gets the SQL container under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. containerName - cosmos DB container name.

func (SQLResourcesClient) GetSQLContainerPreparer 

func (client SQLResourcesClient) GetSQLContainerPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (*http.Request, error)

GetSQLContainerPreparer prepares the GetSQLContainer request.

func (SQLResourcesClient) GetSQLContainerResponder 

func (client SQLResourcesClient) GetSQLContainerResponder(resp *http.Response) (result SQLContainerGetResults, err error)

GetSQLContainerResponder handles the response to the GetSQLContainer request. The method always closes the http.Response Body.

func (SQLResourcesClient) GetSQLContainerSender 

func (client SQLResourcesClient) GetSQLContainerSender(req *http.Request) (*http.Response, error)

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

func (SQLResourcesClient) GetSQLContainerThroughput 

func (client SQLResourcesClient) GetSQLContainerThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (result ThroughputSettingsGetResults, err error)

GetSQLContainerThroughput gets the RUs per second of the SQL container under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. containerName - cosmos DB container name.

func (SQLResourcesClient) GetSQLContainerThroughputPreparer 

func (client SQLResourcesClient) GetSQLContainerThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (*http.Request, error)

GetSQLContainerThroughputPreparer prepares the GetSQLContainerThroughput request.

func (SQLResourcesClient) GetSQLContainerThroughputResponder 

func (client SQLResourcesClient) GetSQLContainerThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)

GetSQLContainerThroughputResponder handles the response to the GetSQLContainerThroughput request. The method always closes the http.Response Body.

func (SQLResourcesClient) GetSQLContainerThroughputSender 

func (client SQLResourcesClient) GetSQLContainerThroughputSender(req *http.Request) (*http.Response, error)

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

func (SQLResourcesClient) GetSQLDatabase 

func (client SQLResourcesClient) GetSQLDatabase(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result SQLDatabaseGetResults, err error)

GetSQLDatabase gets the SQL database under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name.

func (SQLResourcesClient) GetSQLDatabasePreparer 

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

GetSQLDatabasePreparer prepares the GetSQLDatabase request.

func (SQLResourcesClient) GetSQLDatabaseResponder 

func (client SQLResourcesClient) GetSQLDatabaseResponder(resp *http.Response) (result SQLDatabaseGetResults, err error)

GetSQLDatabaseResponder handles the response to the GetSQLDatabase request. The method always closes the http.Response Body.

func (SQLResourcesClient) GetSQLDatabaseSender 

func (client SQLResourcesClient) GetSQLDatabaseSender(req *http.Request) (*http.Response, error)

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

func (SQLResourcesClient) GetSQLDatabaseThroughput 

func (client SQLResourcesClient) GetSQLDatabaseThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result ThroughputSettingsGetResults, err error)

GetSQLDatabaseThroughput gets the RUs per second of the SQL database under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name.

func (SQLResourcesClient) GetSQLDatabaseThroughputPreparer 

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

GetSQLDatabaseThroughputPreparer prepares the GetSQLDatabaseThroughput request.

func (SQLResourcesClient) GetSQLDatabaseThroughputResponder 

func (client SQLResourcesClient) GetSQLDatabaseThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)

GetSQLDatabaseThroughputResponder handles the response to the GetSQLDatabaseThroughput request. The method always closes the http.Response Body.

func (SQLResourcesClient) GetSQLDatabaseThroughputSender 

func (client SQLResourcesClient) GetSQLDatabaseThroughputSender(req *http.Request) (*http.Response, error)

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

func (SQLResourcesClient) GetSQLRoleAssignment added in v48.2.1 

func (client SQLResourcesClient) GetSQLRoleAssignment(ctx context.Context, roleAssignmentID string, resourceGroupName string, accountName string) (result SQLRoleAssignmentGetResults, err error)

GetSQLRoleAssignment retrieves the properties of an existing Azure Cosmos DB SQL Role Assignment with the given Id. Parameters: roleAssignmentID - the GUID for the Role Assignment. resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.

func (SQLResourcesClient) GetSQLRoleAssignmentPreparer added in v48.2.1 

func (client SQLResourcesClient) GetSQLRoleAssignmentPreparer(ctx context.Context, roleAssignmentID string, resourceGroupName string, accountName string) (*http.Request, error)

GetSQLRoleAssignmentPreparer prepares the GetSQLRoleAssignment request.

func (SQLResourcesClient) GetSQLRoleAssignmentResponder added in v48.2.1 

func (client SQLResourcesClient) GetSQLRoleAssignmentResponder(resp *http.Response) (result SQLRoleAssignmentGetResults, err error)

GetSQLRoleAssignmentResponder handles the response to the GetSQLRoleAssignment request. The method always closes the http.Response Body.

func (SQLResourcesClient) GetSQLRoleAssignmentSender added in v48.2.1 

func (client SQLResourcesClient) GetSQLRoleAssignmentSender(req *http.Request) (*http.Response, error)

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

func (SQLResourcesClient) GetSQLRoleDefinition added in v48.2.1 

func (client SQLResourcesClient) GetSQLRoleDefinition(ctx context.Context, roleDefinitionID string, resourceGroupName string, accountName string) (result SQLRoleDefinitionGetResults, err error)

GetSQLRoleDefinition retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id. Parameters: roleDefinitionID - the GUID for the Role Definition. resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.

func (SQLResourcesClient) GetSQLRoleDefinitionPreparer added in v48.2.1 

func (client SQLResourcesClient) GetSQLRoleDefinitionPreparer(ctx context.Context, roleDefinitionID string, resourceGroupName string, accountName string) (*http.Request, error)

GetSQLRoleDefinitionPreparer prepares the GetSQLRoleDefinition request.

func (SQLResourcesClient) GetSQLRoleDefinitionResponder added in v48.2.1 

func (client SQLResourcesClient) GetSQLRoleDefinitionResponder(resp *http.Response) (result SQLRoleDefinitionGetResults, err error)

GetSQLRoleDefinitionResponder handles the response to the GetSQLRoleDefinition request. The method always closes the http.Response Body.

func (SQLResourcesClient) GetSQLRoleDefinitionSender added in v48.2.1 

func (client SQLResourcesClient) GetSQLRoleDefinitionSender(req *http.Request) (*http.Response, error)

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

func (SQLResourcesClient) GetSQLStoredProcedure 

func (client SQLResourcesClient) GetSQLStoredProcedure(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, storedProcedureName string) (result SQLStoredProcedureGetResults, err error)

GetSQLStoredProcedure gets the SQL storedProcedure under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. containerName - cosmos DB container name. storedProcedureName - cosmos DB storedProcedure name.

func (SQLResourcesClient) GetSQLStoredProcedurePreparer 

func (client SQLResourcesClient) GetSQLStoredProcedurePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, storedProcedureName string) (*http.Request, error)

GetSQLStoredProcedurePreparer prepares the GetSQLStoredProcedure request.

func (SQLResourcesClient) GetSQLStoredProcedureResponder 

func (client SQLResourcesClient) GetSQLStoredProcedureResponder(resp *http.Response) (result SQLStoredProcedureGetResults, err error)

GetSQLStoredProcedureResponder handles the response to the GetSQLStoredProcedure request. The method always closes the http.Response Body.

func (SQLResourcesClient) GetSQLStoredProcedureSender 

func (client SQLResourcesClient) GetSQLStoredProcedureSender(req *http.Request) (*http.Response, error)

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

func (SQLResourcesClient) GetSQLTrigger 

func (client SQLResourcesClient) GetSQLTrigger(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, triggerName string) (result SQLTriggerGetResults, err error)

GetSQLTrigger gets the SQL trigger under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. containerName - cosmos DB container name. triggerName - cosmos DB trigger name.

func (SQLResourcesClient) GetSQLTriggerPreparer 

func (client SQLResourcesClient) GetSQLTriggerPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, triggerName string) (*http.Request, error)

GetSQLTriggerPreparer prepares the GetSQLTrigger request.

func (SQLResourcesClient) GetSQLTriggerResponder 

func (client SQLResourcesClient) GetSQLTriggerResponder(resp *http.Response) (result SQLTriggerGetResults, err error)

GetSQLTriggerResponder handles the response to the GetSQLTrigger request. The method always closes the http.Response Body.

func (SQLResourcesClient) GetSQLTriggerSender 

func (client SQLResourcesClient) GetSQLTriggerSender(req *http.Request) (*http.Response, error)

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

func (SQLResourcesClient) GetSQLUserDefinedFunction 

func (client SQLResourcesClient) GetSQLUserDefinedFunction(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, userDefinedFunctionName string) (result SQLUserDefinedFunctionGetResults, err error)

GetSQLUserDefinedFunction gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. containerName - cosmos DB container name. userDefinedFunctionName - cosmos DB userDefinedFunction name.

func (SQLResourcesClient) GetSQLUserDefinedFunctionPreparer 

func (client SQLResourcesClient) GetSQLUserDefinedFunctionPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, userDefinedFunctionName string) (*http.Request, error)

GetSQLUserDefinedFunctionPreparer prepares the GetSQLUserDefinedFunction request.

func (SQLResourcesClient) GetSQLUserDefinedFunctionResponder 

func (client SQLResourcesClient) GetSQLUserDefinedFunctionResponder(resp *http.Response) (result SQLUserDefinedFunctionGetResults, err error)

GetSQLUserDefinedFunctionResponder handles the response to the GetSQLUserDefinedFunction request. The method always closes the http.Response Body.

func (SQLResourcesClient) GetSQLUserDefinedFunctionSender 

func (client SQLResourcesClient) GetSQLUserDefinedFunctionSender(req *http.Request) (*http.Response, error)

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

func (SQLResourcesClient) ListSQLContainers 

func (client SQLResourcesClient) ListSQLContainers(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result SQLContainerListResult, err error)

ListSQLContainers lists the SQL container under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name.

func (SQLResourcesClient) ListSQLContainersPreparer 

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

ListSQLContainersPreparer prepares the ListSQLContainers request.

func (SQLResourcesClient) ListSQLContainersResponder 

func (client SQLResourcesClient) ListSQLContainersResponder(resp *http.Response) (result SQLContainerListResult, err error)

ListSQLContainersResponder handles the response to the ListSQLContainers request. The method always closes the http.Response Body.

func (SQLResourcesClient) ListSQLContainersSender 

func (client SQLResourcesClient) ListSQLContainersSender(req *http.Request) (*http.Response, error)

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

func (SQLResourcesClient) ListSQLDatabases 

func (client SQLResourcesClient) ListSQLDatabases(ctx context.Context, resourceGroupName string, accountName string) (result SQLDatabaseListResult, err error)

ListSQLDatabases lists the SQL databases under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.

func (SQLResourcesClient) ListSQLDatabasesPreparer 

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

ListSQLDatabasesPreparer prepares the ListSQLDatabases request.

func (SQLResourcesClient) ListSQLDatabasesResponder 

func (client SQLResourcesClient) ListSQLDatabasesResponder(resp *http.Response) (result SQLDatabaseListResult, err error)

ListSQLDatabasesResponder handles the response to the ListSQLDatabases request. The method always closes the http.Response Body.

func (SQLResourcesClient) ListSQLDatabasesSender 

func (client SQLResourcesClient) ListSQLDatabasesSender(req *http.Request) (*http.Response, error)

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

func (SQLResourcesClient) ListSQLRoleAssignments added in v48.2.1 

func (client SQLResourcesClient) ListSQLRoleAssignments(ctx context.Context, resourceGroupName string, accountName string) (result SQLRoleAssignmentListResult, err error)

ListSQLRoleAssignments retrieves the list of all Azure Cosmos DB SQL Role Assignments. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.

func (SQLResourcesClient) ListSQLRoleAssignmentsPreparer added in v48.2.1 

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

ListSQLRoleAssignmentsPreparer prepares the ListSQLRoleAssignments request.

func (SQLResourcesClient) ListSQLRoleAssignmentsResponder added in v48.2.1 

func (client SQLResourcesClient) ListSQLRoleAssignmentsResponder(resp *http.Response) (result SQLRoleAssignmentListResult, err error)

ListSQLRoleAssignmentsResponder handles the response to the ListSQLRoleAssignments request. The method always closes the http.Response Body.

func (SQLResourcesClient) ListSQLRoleAssignmentsSender added in v48.2.1 

func (client SQLResourcesClient) ListSQLRoleAssignmentsSender(req *http.Request) (*http.Response, error)

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

func (SQLResourcesClient) ListSQLRoleDefinitions added in v48.2.1 

func (client SQLResourcesClient) ListSQLRoleDefinitions(ctx context.Context, resourceGroupName string, accountName string) (result SQLRoleDefinitionListResult, err error)

ListSQLRoleDefinitions retrieves the list of all Azure Cosmos DB SQL Role Definitions. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.

func (SQLResourcesClient) ListSQLRoleDefinitionsPreparer added in v48.2.1 

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

ListSQLRoleDefinitionsPreparer prepares the ListSQLRoleDefinitions request.

func (SQLResourcesClient) ListSQLRoleDefinitionsResponder added in v48.2.1 

func (client SQLResourcesClient) ListSQLRoleDefinitionsResponder(resp *http.Response) (result SQLRoleDefinitionListResult, err error)

ListSQLRoleDefinitionsResponder handles the response to the ListSQLRoleDefinitions request. The method always closes the http.Response Body.

func (SQLResourcesClient) ListSQLRoleDefinitionsSender added in v48.2.1 

func (client SQLResourcesClient) ListSQLRoleDefinitionsSender(req *http.Request) (*http.Response, error)

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

func (SQLResourcesClient) ListSQLStoredProcedures 

func (client SQLResourcesClient) ListSQLStoredProcedures(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (result SQLStoredProcedureListResult, err error)

ListSQLStoredProcedures lists the SQL storedProcedure under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. containerName - cosmos DB container name.

func (SQLResourcesClient) ListSQLStoredProceduresPreparer 

func (client SQLResourcesClient) ListSQLStoredProceduresPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (*http.Request, error)

ListSQLStoredProceduresPreparer prepares the ListSQLStoredProcedures request.

func (SQLResourcesClient) ListSQLStoredProceduresResponder 

func (client SQLResourcesClient) ListSQLStoredProceduresResponder(resp *http.Response) (result SQLStoredProcedureListResult, err error)

ListSQLStoredProceduresResponder handles the response to the ListSQLStoredProcedures request. The method always closes the http.Response Body.

func (SQLResourcesClient) ListSQLStoredProceduresSender 

func (client SQLResourcesClient) ListSQLStoredProceduresSender(req *http.Request) (*http.Response, error)

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

func (SQLResourcesClient) ListSQLTriggers 

func (client SQLResourcesClient) ListSQLTriggers(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (result SQLTriggerListResult, err error)

ListSQLTriggers lists the SQL trigger under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. containerName - cosmos DB container name.

func (SQLResourcesClient) ListSQLTriggersPreparer 

func (client SQLResourcesClient) ListSQLTriggersPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (*http.Request, error)

ListSQLTriggersPreparer prepares the ListSQLTriggers request.

func (SQLResourcesClient) ListSQLTriggersResponder 

func (client SQLResourcesClient) ListSQLTriggersResponder(resp *http.Response) (result SQLTriggerListResult, err error)

ListSQLTriggersResponder handles the response to the ListSQLTriggers request. The method always closes the http.Response Body.

func (SQLResourcesClient) ListSQLTriggersSender 

func (client SQLResourcesClient) ListSQLTriggersSender(req *http.Request) (*http.Response, error)

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

func (SQLResourcesClient) ListSQLUserDefinedFunctions 

func (client SQLResourcesClient) ListSQLUserDefinedFunctions(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (result SQLUserDefinedFunctionListResult, err error)

ListSQLUserDefinedFunctions lists the SQL userDefinedFunction under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. containerName - cosmos DB container name.

func (SQLResourcesClient) ListSQLUserDefinedFunctionsPreparer 

func (client SQLResourcesClient) ListSQLUserDefinedFunctionsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (*http.Request, error)

ListSQLUserDefinedFunctionsPreparer prepares the ListSQLUserDefinedFunctions request.

func (SQLResourcesClient) ListSQLUserDefinedFunctionsResponder 

func (client SQLResourcesClient) ListSQLUserDefinedFunctionsResponder(resp *http.Response) (result SQLUserDefinedFunctionListResult, err error)

ListSQLUserDefinedFunctionsResponder handles the response to the ListSQLUserDefinedFunctions request. The method always closes the http.Response Body.

func (SQLResourcesClient) ListSQLUserDefinedFunctionsSender 

func (client SQLResourcesClient) ListSQLUserDefinedFunctionsSender(req *http.Request) (*http.Response, error)

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

func (SQLResourcesClient) UpdateSQLContainerThroughput 

func (client SQLResourcesClient) UpdateSQLContainerThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (result SQLResourcesUpdateSQLContainerThroughputFuture, err error)

UpdateSQLContainerThroughput update RUs per second of an Azure Cosmos DB SQL container Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. containerName - cosmos DB container name. updateThroughputParameters - the parameters to provide for the RUs per second of the current SQL container.

func (SQLResourcesClient) UpdateSQLContainerThroughputPreparer 

func (client SQLResourcesClient) UpdateSQLContainerThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)

UpdateSQLContainerThroughputPreparer prepares the UpdateSQLContainerThroughput request.

func (SQLResourcesClient) UpdateSQLContainerThroughputResponder 

func (client SQLResourcesClient) UpdateSQLContainerThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)

UpdateSQLContainerThroughputResponder handles the response to the UpdateSQLContainerThroughput request. The method always closes the http.Response Body.

func (SQLResourcesClient) UpdateSQLContainerThroughputSender 

func (client SQLResourcesClient) UpdateSQLContainerThroughputSender(req *http.Request) (future SQLResourcesUpdateSQLContainerThroughputFuture, err error)

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

func (SQLResourcesClient) UpdateSQLDatabaseThroughput 

func (client SQLResourcesClient) UpdateSQLDatabaseThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (result SQLResourcesUpdateSQLDatabaseThroughputFuture, err error)

UpdateSQLDatabaseThroughput update RUs per second of an Azure Cosmos DB SQL database Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name. updateThroughputParameters - the parameters to provide for the RUs per second of the current SQL database.

func (SQLResourcesClient) UpdateSQLDatabaseThroughputPreparer 

func (client SQLResourcesClient) UpdateSQLDatabaseThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)

UpdateSQLDatabaseThroughputPreparer prepares the UpdateSQLDatabaseThroughput request.

func (SQLResourcesClient) UpdateSQLDatabaseThroughputResponder 

func (client SQLResourcesClient) UpdateSQLDatabaseThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)

UpdateSQLDatabaseThroughputResponder handles the response to the UpdateSQLDatabaseThroughput request. The method always closes the http.Response Body.

func (SQLResourcesClient) UpdateSQLDatabaseThroughputSender 

func (client SQLResourcesClient) UpdateSQLDatabaseThroughputSender(req *http.Request) (future SQLResourcesUpdateSQLDatabaseThroughputFuture, err error)

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

type SQLResourcesCreateUpdateSQLContainerFuture 

type SQLResourcesCreateUpdateSQLContainerFuture struct {
	azure.Future
}

SQLResourcesCreateUpdateSQLContainerFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*SQLResourcesCreateUpdateSQLContainerFuture) Result 

func (future *SQLResourcesCreateUpdateSQLContainerFuture) Result(client SQLResourcesClient) (scgr SQLContainerGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SQLResourcesCreateUpdateSQLDatabaseFuture 

type SQLResourcesCreateUpdateSQLDatabaseFuture struct {
	azure.Future
}

SQLResourcesCreateUpdateSQLDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*SQLResourcesCreateUpdateSQLDatabaseFuture) Result 

func (future *SQLResourcesCreateUpdateSQLDatabaseFuture) Result(client SQLResourcesClient) (sdgr SQLDatabaseGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SQLResourcesCreateUpdateSQLRoleAssignmentFuture added in v48.2.1 

type SQLResourcesCreateUpdateSQLRoleAssignmentFuture struct {
	azure.Future
}

SQLResourcesCreateUpdateSQLRoleAssignmentFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*SQLResourcesCreateUpdateSQLRoleAssignmentFuture) Result added in v48.2.1 

func (future *SQLResourcesCreateUpdateSQLRoleAssignmentFuture) Result(client SQLResourcesClient) (sragr SQLRoleAssignmentGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SQLResourcesCreateUpdateSQLRoleDefinitionFuture added in v48.2.1 

type SQLResourcesCreateUpdateSQLRoleDefinitionFuture struct {
	azure.Future
}

SQLResourcesCreateUpdateSQLRoleDefinitionFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*SQLResourcesCreateUpdateSQLRoleDefinitionFuture) Result added in v48.2.1 

func (future *SQLResourcesCreateUpdateSQLRoleDefinitionFuture) Result(client SQLResourcesClient) (srdgr SQLRoleDefinitionGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SQLResourcesCreateUpdateSQLStoredProcedureFuture 

type SQLResourcesCreateUpdateSQLStoredProcedureFuture struct {
	azure.Future
}

SQLResourcesCreateUpdateSQLStoredProcedureFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*SQLResourcesCreateUpdateSQLStoredProcedureFuture) Result 

func (future *SQLResourcesCreateUpdateSQLStoredProcedureFuture) Result(client SQLResourcesClient) (sspgr SQLStoredProcedureGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SQLResourcesCreateUpdateSQLTriggerFuture 

type SQLResourcesCreateUpdateSQLTriggerFuture struct {
	azure.Future
}

SQLResourcesCreateUpdateSQLTriggerFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*SQLResourcesCreateUpdateSQLTriggerFuture) Result 

func (future *SQLResourcesCreateUpdateSQLTriggerFuture) Result(client SQLResourcesClient) (stgr SQLTriggerGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SQLResourcesCreateUpdateSQLUserDefinedFunctionFuture 

type SQLResourcesCreateUpdateSQLUserDefinedFunctionFuture struct {
	azure.Future
}

SQLResourcesCreateUpdateSQLUserDefinedFunctionFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*SQLResourcesCreateUpdateSQLUserDefinedFunctionFuture) Result 

func (future *SQLResourcesCreateUpdateSQLUserDefinedFunctionFuture) Result(client SQLResourcesClient) (sudfgr SQLUserDefinedFunctionGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SQLResourcesDeleteSQLContainerFuture 

type SQLResourcesDeleteSQLContainerFuture struct {
	azure.Future
}

SQLResourcesDeleteSQLContainerFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*SQLResourcesDeleteSQLContainerFuture) Result 

func (future *SQLResourcesDeleteSQLContainerFuture) Result(client SQLResourcesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SQLResourcesDeleteSQLDatabaseFuture 

type SQLResourcesDeleteSQLDatabaseFuture struct {
	azure.Future
}

SQLResourcesDeleteSQLDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*SQLResourcesDeleteSQLDatabaseFuture) Result 

func (future *SQLResourcesDeleteSQLDatabaseFuture) Result(client SQLResourcesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SQLResourcesDeleteSQLRoleAssignmentFuture added in v48.2.1 

type SQLResourcesDeleteSQLRoleAssignmentFuture struct {
	azure.Future
}

SQLResourcesDeleteSQLRoleAssignmentFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*SQLResourcesDeleteSQLRoleAssignmentFuture) Result added in v48.2.1 

func (future *SQLResourcesDeleteSQLRoleAssignmentFuture) Result(client SQLResourcesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SQLResourcesDeleteSQLRoleDefinitionFuture added in v48.2.1 

type SQLResourcesDeleteSQLRoleDefinitionFuture struct {
	azure.Future
}

SQLResourcesDeleteSQLRoleDefinitionFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*SQLResourcesDeleteSQLRoleDefinitionFuture) Result added in v48.2.1 

func (future *SQLResourcesDeleteSQLRoleDefinitionFuture) Result(client SQLResourcesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SQLResourcesDeleteSQLStoredProcedureFuture 

type SQLResourcesDeleteSQLStoredProcedureFuture struct {
	azure.Future
}

SQLResourcesDeleteSQLStoredProcedureFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*SQLResourcesDeleteSQLStoredProcedureFuture) Result 

func (future *SQLResourcesDeleteSQLStoredProcedureFuture) Result(client SQLResourcesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SQLResourcesDeleteSQLTriggerFuture 

type SQLResourcesDeleteSQLTriggerFuture struct {
	azure.Future
}

SQLResourcesDeleteSQLTriggerFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*SQLResourcesDeleteSQLTriggerFuture) Result 

func (future *SQLResourcesDeleteSQLTriggerFuture) Result(client SQLResourcesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SQLResourcesDeleteSQLUserDefinedFunctionFuture 

type SQLResourcesDeleteSQLUserDefinedFunctionFuture struct {
	azure.Future
}

SQLResourcesDeleteSQLUserDefinedFunctionFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*SQLResourcesDeleteSQLUserDefinedFunctionFuture) Result 

func (future *SQLResourcesDeleteSQLUserDefinedFunctionFuture) Result(client SQLResourcesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SQLResourcesUpdateSQLContainerThroughputFuture 

type SQLResourcesUpdateSQLContainerThroughputFuture struct {
	azure.Future
}

SQLResourcesUpdateSQLContainerThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*SQLResourcesUpdateSQLContainerThroughputFuture) Result 

func (future *SQLResourcesUpdateSQLContainerThroughputFuture) Result(client SQLResourcesClient) (tsgr ThroughputSettingsGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SQLResourcesUpdateSQLDatabaseThroughputFuture 

type SQLResourcesUpdateSQLDatabaseThroughputFuture struct {
	azure.Future
}

SQLResourcesUpdateSQLDatabaseThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*SQLResourcesUpdateSQLDatabaseThroughputFuture) Result 

func (future *SQLResourcesUpdateSQLDatabaseThroughputFuture) Result(client SQLResourcesClient) (tsgr ThroughputSettingsGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SQLRoleAssignmentCreateUpdateParameters added in v48.2.1 

type SQLRoleAssignmentCreateUpdateParameters struct {
	// SQLRoleAssignmentResource - Properties to create and update an Azure Cosmos DB SQL Role Assignment.
	*SQLRoleAssignmentResource `json:"properties,omitempty"`
}

SQLRoleAssignmentCreateUpdateParameters parameters to create and update an Azure Cosmos DB SQL Role Assignment.

func (SQLRoleAssignmentCreateUpdateParameters) MarshalJSON added in v48.2.1 

func (sracup SQLRoleAssignmentCreateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SQLRoleAssignmentCreateUpdateParameters.

func (*SQLRoleAssignmentCreateUpdateParameters) UnmarshalJSON added in v48.2.1 

func (sracup *SQLRoleAssignmentCreateUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SQLRoleAssignmentCreateUpdateParameters struct.

type SQLRoleAssignmentGetResults added in v48.2.1 

type SQLRoleAssignmentGetResults struct {
	autorest.Response `json:"-"`
	// SQLRoleAssignmentResource - Properties related to the Role Assignment.
	*SQLRoleAssignmentResource `json:"properties,omitempty"`
	// ID - READ-ONLY; The unique resource identifier of the database account.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the database account.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of Azure resource.
	Type *string `json:"type,omitempty"`
}

SQLRoleAssignmentGetResults an Azure Cosmos DB Role Assignment

func (SQLRoleAssignmentGetResults) MarshalJSON added in v48.2.1 

func (sragr SQLRoleAssignmentGetResults) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SQLRoleAssignmentGetResults.

func (*SQLRoleAssignmentGetResults) UnmarshalJSON added in v48.2.1 

func (sragr *SQLRoleAssignmentGetResults) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SQLRoleAssignmentGetResults struct.

type SQLRoleAssignmentListResult added in v48.2.1 

type SQLRoleAssignmentListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of Role Assignments and their properties
	Value *[]SQLRoleAssignmentGetResults `json:"value,omitempty"`
}

SQLRoleAssignmentListResult the relevant Role Assignments.

type SQLRoleAssignmentResource added in v48.2.1 

type SQLRoleAssignmentResource struct {
	// RoleDefinitionID - The unique identifier for the associated Role Definition.
	RoleDefinitionID *string `json:"roleDefinitionId,omitempty"`
	// Scope - The data plane resource path for which access is being granted through this Role Assignment.
	Scope *string `json:"scope,omitempty"`
	// PrincipalID - The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.
	PrincipalID *string `json:"principalId,omitempty"`
}

SQLRoleAssignmentResource azure Cosmos DB SQL Role Assignment resource object.

type SQLRoleDefinitionCreateUpdateParameters added in v48.2.1 

type SQLRoleDefinitionCreateUpdateParameters struct {
	// SQLRoleDefinitionResource - Properties to create and update an Azure Cosmos DB SQL Role Definition.
	*SQLRoleDefinitionResource `json:"properties,omitempty"`
}

SQLRoleDefinitionCreateUpdateParameters parameters to create and update an Azure Cosmos DB SQL Role Definition.

func (SQLRoleDefinitionCreateUpdateParameters) MarshalJSON added in v48.2.1 

func (srdcup SQLRoleDefinitionCreateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SQLRoleDefinitionCreateUpdateParameters.

func (*SQLRoleDefinitionCreateUpdateParameters) UnmarshalJSON added in v48.2.1 

func (srdcup *SQLRoleDefinitionCreateUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SQLRoleDefinitionCreateUpdateParameters struct.

type SQLRoleDefinitionGetResults added in v48.2.1 

type SQLRoleDefinitionGetResults struct {
	autorest.Response `json:"-"`
	// SQLRoleDefinitionResource - Properties related to the Role Definition.
	*SQLRoleDefinitionResource `json:"properties,omitempty"`
	// ID - READ-ONLY; The unique resource identifier of the database account.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the database account.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of Azure resource.
	Type *string `json:"type,omitempty"`
}

SQLRoleDefinitionGetResults an Azure Cosmos DB SQL Role Definition.

func (SQLRoleDefinitionGetResults) MarshalJSON added in v48.2.1 

func (srdgr SQLRoleDefinitionGetResults) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SQLRoleDefinitionGetResults.

func (*SQLRoleDefinitionGetResults) UnmarshalJSON added in v48.2.1 

func (srdgr *SQLRoleDefinitionGetResults) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SQLRoleDefinitionGetResults struct.

type SQLRoleDefinitionListResult added in v48.2.1 

type SQLRoleDefinitionListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of Role Definitions and their properties.
	Value *[]SQLRoleDefinitionGetResults `json:"value,omitempty"`
}

SQLRoleDefinitionListResult the relevant Role Definitions.

type SQLRoleDefinitionResource added in v48.2.1 

type SQLRoleDefinitionResource struct {
	// RoleName - A user-friendly name for the Role Definition. Must be unique for the database account.
	RoleName *string `json:"roleName,omitempty"`
	// Type - Indicates whether the Role Definition was built-in or user created. Possible values include: 'BuiltInRole', 'CustomRole'
	Type RoleDefinitionType `json:"type,omitempty"`
	// AssignableScopes - A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist.
	AssignableScopes *[]string `json:"assignableScopes,omitempty"`
	// Permissions - The set of operations allowed through this Role Definition.
	Permissions *[]Permission `json:"permissions,omitempty"`
}

SQLRoleDefinitionResource azure Cosmos DB SQL Role Definition resource object.

type SQLStoredProcedureCreateUpdateParameters 

type SQLStoredProcedureCreateUpdateParameters struct {
	// SQLStoredProcedureCreateUpdateProperties - Properties to create and update Azure Cosmos DB storedProcedure.
	*SQLStoredProcedureCreateUpdateProperties `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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

SQLStoredProcedureCreateUpdateParameters parameters to create and update Cosmos DB storedProcedure.

func (SQLStoredProcedureCreateUpdateParameters) MarshalJSON 

func (sspcup SQLStoredProcedureCreateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SQLStoredProcedureCreateUpdateParameters.

func (*SQLStoredProcedureCreateUpdateParameters) UnmarshalJSON 

func (sspcup *SQLStoredProcedureCreateUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SQLStoredProcedureCreateUpdateParameters struct.

type SQLStoredProcedureCreateUpdateProperties 

type SQLStoredProcedureCreateUpdateProperties struct {
	// Resource - The standard JSON format of a storedProcedure
	Resource *SQLStoredProcedureResource `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"`
}

SQLStoredProcedureCreateUpdateProperties properties to create and update Azure Cosmos DB storedProcedure.

type SQLStoredProcedureGetProperties 

type SQLStoredProcedureGetProperties struct {
	Resource *SQLStoredProcedureGetPropertiesResource `json:"resource,omitempty"`
}

SQLStoredProcedureGetProperties the properties of an Azure Cosmos DB StoredProcedure

type SQLStoredProcedureGetPropertiesResource 

type SQLStoredProcedureGetPropertiesResource struct {
	// ID - Name of the Cosmos DB SQL storedProcedure
	ID *string `json:"id,omitempty"`
	// Body - Body of the Stored Procedure
	Body *string `json:"body,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"`
}

SQLStoredProcedureGetPropertiesResource ...

func (SQLStoredProcedureGetPropertiesResource) MarshalJSON 

func (sspgp SQLStoredProcedureGetPropertiesResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SQLStoredProcedureGetPropertiesResource.

type SQLStoredProcedureGetResults 

type SQLStoredProcedureGetResults struct {
	autorest.Response `json:"-"`
	// SQLStoredProcedureGetProperties - The properties of an Azure Cosmos DB storedProcedure
	*SQLStoredProcedureGetProperties `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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

SQLStoredProcedureGetResults an Azure Cosmos DB storedProcedure.

func (SQLStoredProcedureGetResults) MarshalJSON 

func (sspgr SQLStoredProcedureGetResults) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SQLStoredProcedureGetResults.

func (*SQLStoredProcedureGetResults) UnmarshalJSON 

func (sspgr *SQLStoredProcedureGetResults) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SQLStoredProcedureGetResults struct.

type SQLStoredProcedureListResult 

type SQLStoredProcedureListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of storedProcedures and their properties.
	Value *[]SQLStoredProcedureGetResults `json:"value,omitempty"`
}

SQLStoredProcedureListResult the List operation response, that contains the storedProcedures and their properties.

type SQLStoredProcedureResource 

type SQLStoredProcedureResource struct {
	// ID - Name of the Cosmos DB SQL storedProcedure
	ID *string `json:"id,omitempty"`
	// Body - Body of the Stored Procedure
	Body *string `json:"body,omitempty"`
}

SQLStoredProcedureResource cosmos DB SQL storedProcedure resource object

type SQLTriggerCreateUpdateParameters 

type SQLTriggerCreateUpdateParameters struct {
	// SQLTriggerCreateUpdateProperties - Properties to create and update Azure Cosmos DB trigger.
	*SQLTriggerCreateUpdateProperties `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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

SQLTriggerCreateUpdateParameters parameters to create and update Cosmos DB trigger.

func (SQLTriggerCreateUpdateParameters) MarshalJSON 

func (stcup SQLTriggerCreateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SQLTriggerCreateUpdateParameters.

func (*SQLTriggerCreateUpdateParameters) UnmarshalJSON 

func (stcup *SQLTriggerCreateUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SQLTriggerCreateUpdateParameters struct.

type SQLTriggerCreateUpdateProperties 

type SQLTriggerCreateUpdateProperties struct {
	// Resource - The standard JSON format of a trigger
	Resource *SQLTriggerResource `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"`
}

SQLTriggerCreateUpdateProperties properties to create and update Azure Cosmos DB trigger.

type SQLTriggerGetProperties 

type SQLTriggerGetProperties struct {
	Resource *SQLTriggerGetPropertiesResource `json:"resource,omitempty"`
}

SQLTriggerGetProperties the properties of an Azure Cosmos DB trigger

type SQLTriggerGetPropertiesResource 

type SQLTriggerGetPropertiesResource struct {
	// ID - Name of the Cosmos DB SQL trigger
	ID *string `json:"id,omitempty"`
	// Body - Body of the Trigger
	Body *string `json:"body,omitempty"`
	// TriggerType - Type of the Trigger. Possible values include: 'Pre', 'Post'
	TriggerType TriggerType `json:"triggerType,omitempty"`
	// TriggerOperation - The operation the trigger is associated with. Possible values include: 'All', 'Create', 'Update', 'Delete', 'Replace'
	TriggerOperation TriggerOperation `json:"triggerOperation,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"`
}

SQLTriggerGetPropertiesResource ...

func (SQLTriggerGetPropertiesResource) MarshalJSON 

func (stgp SQLTriggerGetPropertiesResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SQLTriggerGetPropertiesResource.

type SQLTriggerGetResults 

type SQLTriggerGetResults struct {
	autorest.Response `json:"-"`
	// SQLTriggerGetProperties - The properties of an Azure Cosmos DB trigger
	*SQLTriggerGetProperties `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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

SQLTriggerGetResults an Azure Cosmos DB trigger.

func (SQLTriggerGetResults) MarshalJSON 

func (stgr SQLTriggerGetResults) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SQLTriggerGetResults.

func (*SQLTriggerGetResults) UnmarshalJSON 

func (stgr *SQLTriggerGetResults) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SQLTriggerGetResults struct.

type SQLTriggerListResult 

type SQLTriggerListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of triggers and their properties.
	Value *[]SQLTriggerGetResults `json:"value,omitempty"`
}

SQLTriggerListResult the List operation response, that contains the triggers and their properties.

type SQLTriggerResource 

type SQLTriggerResource struct {
	// ID - Name of the Cosmos DB SQL trigger
	ID *string `json:"id,omitempty"`
	// Body - Body of the Trigger
	Body *string `json:"body,omitempty"`
	// TriggerType - Type of the Trigger. Possible values include: 'Pre', 'Post'
	TriggerType TriggerType `json:"triggerType,omitempty"`
	// TriggerOperation - The operation the trigger is associated with. Possible values include: 'All', 'Create', 'Update', 'Delete', 'Replace'
	TriggerOperation TriggerOperation `json:"triggerOperation,omitempty"`
}

SQLTriggerResource cosmos DB SQL trigger resource object

type SQLUserDefinedFunctionCreateUpdateParameters 

type SQLUserDefinedFunctionCreateUpdateParameters struct {
	// SQLUserDefinedFunctionCreateUpdateProperties - Properties to create and update Azure Cosmos DB userDefinedFunction.
	*SQLUserDefinedFunctionCreateUpdateProperties `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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

SQLUserDefinedFunctionCreateUpdateParameters parameters to create and update Cosmos DB userDefinedFunction.

func (SQLUserDefinedFunctionCreateUpdateParameters) MarshalJSON 

func (sudfcup SQLUserDefinedFunctionCreateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SQLUserDefinedFunctionCreateUpdateParameters.

func (*SQLUserDefinedFunctionCreateUpdateParameters) UnmarshalJSON 

func (sudfcup *SQLUserDefinedFunctionCreateUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SQLUserDefinedFunctionCreateUpdateParameters struct.

type SQLUserDefinedFunctionCreateUpdateProperties 

type SQLUserDefinedFunctionCreateUpdateProperties struct {
	// Resource - The standard JSON format of a userDefinedFunction
	Resource *SQLUserDefinedFunctionResource `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"`
}

SQLUserDefinedFunctionCreateUpdateProperties properties to create and update Azure Cosmos DB userDefinedFunction.

type SQLUserDefinedFunctionGetProperties 

type SQLUserDefinedFunctionGetProperties struct {
	Resource *SQLUserDefinedFunctionGetPropertiesResource `json:"resource,omitempty"`
}

SQLUserDefinedFunctionGetProperties the properties of an Azure Cosmos DB userDefinedFunction

type SQLUserDefinedFunctionGetPropertiesResource 

type SQLUserDefinedFunctionGetPropertiesResource struct {
	// ID - Name of the Cosmos DB SQL userDefinedFunction
	ID *string `json:"id,omitempty"`
	// Body - Body of the User Defined Function
	Body *string `json:"body,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"`
}

SQLUserDefinedFunctionGetPropertiesResource ...

func (SQLUserDefinedFunctionGetPropertiesResource) MarshalJSON 

func (sudfgp SQLUserDefinedFunctionGetPropertiesResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SQLUserDefinedFunctionGetPropertiesResource.

type SQLUserDefinedFunctionGetResults 

type SQLUserDefinedFunctionGetResults struct {
	autorest.Response `json:"-"`
	// SQLUserDefinedFunctionGetProperties - The properties of an Azure Cosmos DB userDefinedFunction
	*SQLUserDefinedFunctionGetProperties `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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

SQLUserDefinedFunctionGetResults an Azure Cosmos DB userDefinedFunction.

func (SQLUserDefinedFunctionGetResults) MarshalJSON 

func (sudfgr SQLUserDefinedFunctionGetResults) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SQLUserDefinedFunctionGetResults.

func (*SQLUserDefinedFunctionGetResults) UnmarshalJSON 

func (sudfgr *SQLUserDefinedFunctionGetResults) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SQLUserDefinedFunctionGetResults struct.

type SQLUserDefinedFunctionListResult 

type SQLUserDefinedFunctionListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of userDefinedFunctions and their properties.
	Value *[]SQLUserDefinedFunctionGetResults `json:"value,omitempty"`
}

SQLUserDefinedFunctionListResult the List operation response, that contains the userDefinedFunctions and their properties.

type SQLUserDefinedFunctionResource 

type SQLUserDefinedFunctionResource struct {
	// ID - Name of the Cosmos DB SQL userDefinedFunction
	ID *string `json:"id,omitempty"`
	// Body - Body of the User Defined Function
	Body *string `json:"body,omitempty"`
}

SQLUserDefinedFunctionResource cosmos DB SQL userDefinedFunction resource object

type ServerVersion 

type ServerVersion string

ServerVersion enumerates the values for server version. 

const (
	// ThreeFullStopSix ...
	ThreeFullStopSix ServerVersion = "3.6"
	// ThreeFullStopTwo ...
	ThreeFullStopTwo ServerVersion = "3.2"
)

func PossibleServerVersionValues 

func PossibleServerVersionValues() []ServerVersion

PossibleServerVersionValues returns an array of possible values for the ServerVersion const type.

type SpatialSpec 

type SpatialSpec 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"`
	// Types - List of path's spatial type
	Types *[]SpatialType `json:"types,omitempty"`
}

SpatialSpec ...

type SpatialType 

type SpatialType string

SpatialType enumerates the values for spatial type. 

const (
	// SpatialTypeLineString ...
	SpatialTypeLineString SpatialType = "LineString"
	// SpatialTypeMultiPolygon ...
	SpatialTypeMultiPolygon SpatialType = "MultiPolygon"
	// SpatialTypePoint ...
	SpatialTypePoint SpatialType = "Point"
	// SpatialTypePolygon ...
	SpatialTypePolygon SpatialType = "Polygon"
)

func PossibleSpatialTypeValues 

func PossibleSpatialTypeValues() []SpatialType

PossibleSpatialTypeValues returns an array of possible values for the SpatialType const type.

type SystemData 

type SystemData struct {
	// CreatedBy - The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`
	// CreatedByType - The type of identity that created the resource. Possible values include: 'User', 'Application', 'ManagedIdentity', 'Key'
	CreatedByType CreatedByType `json:"createdByType,omitempty"`
	// CreatedAt - The timestamp of resource creation (UTC).
	CreatedAt *date.Time `json:"createdAt,omitempty"`
	// LastModifiedBy - The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
	// LastModifiedByType - The type of identity that last modified the resource. Possible values include: 'User', 'Application', 'ManagedIdentity', 'Key'
	LastModifiedByType CreatedByType `json:"lastModifiedByType,omitempty"`
	// LastModifiedAt - The type of identity that last modified the resource.
	LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"`
}

SystemData metadata pertaining to creation and last modification of the resource.

type TableCreateUpdateParameters 

type TableCreateUpdateParameters struct {
	// TableCreateUpdateProperties - Properties to create and update Azure Cosmos DB Table.
	*TableCreateUpdateProperties `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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

TableCreateUpdateParameters parameters to create and update Cosmos DB Table.

func (TableCreateUpdateParameters) MarshalJSON 

func (tcup TableCreateUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TableCreateUpdateParameters.

func (*TableCreateUpdateParameters) UnmarshalJSON 

func (tcup *TableCreateUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for TableCreateUpdateParameters struct.

type TableCreateUpdateProperties 

type TableCreateUpdateProperties struct {
	// Resource - The standard JSON format of a Table
	Resource *TableResource `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"`
}

TableCreateUpdateProperties properties to create and update Azure Cosmos DB Table.

type TableGetProperties 

type TableGetProperties struct {
	Resource *TableGetPropertiesResource `json:"resource,omitempty"`
	Options  *TableGetPropertiesOptions  `json:"options,omitempty"`
}

TableGetProperties the properties of an Azure Cosmos Table

type TableGetPropertiesOptions 

type TableGetPropertiesOptions struct {
	// Throughput - Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
	Throughput *int32 `json:"throughput,omitempty"`
	// AutoscaleSettings - Specifies the Autoscale settings.
	AutoscaleSettings *AutoscaleSettings `json:"autoscaleSettings,omitempty"`
}

TableGetPropertiesOptions ...

type TableGetPropertiesResource 

type TableGetPropertiesResource struct {
	// ID - Name of the Cosmos DB table
	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"`
}

TableGetPropertiesResource ...

func (TableGetPropertiesResource) MarshalJSON 

func (tgp TableGetPropertiesResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TableGetPropertiesResource.

type TableGetResults 

type TableGetResults struct {
	autorest.Response `json:"-"`
	// TableGetProperties - The properties of an Azure Cosmos DB Table
	*TableGetProperties `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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

TableGetResults an Azure Cosmos DB Table.

func (TableGetResults) MarshalJSON 

func (tgr TableGetResults) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TableGetResults.

func (*TableGetResults) UnmarshalJSON 

func (tgr *TableGetResults) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for TableGetResults struct.

type TableListResult 

type TableListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of Table and their properties.
	Value *[]TableGetResults `json:"value,omitempty"`
}

TableListResult the List operation response, that contains the Table and their properties.

type TableResource 

type TableResource struct {
	// ID - Name of the Cosmos DB table
	ID *string `json:"id,omitempty"`
}

TableResource cosmos DB table resource object

type TableResourcesClient 

type TableResourcesClient struct {
	BaseClient
}

TableResourcesClient is the client for the TableResources methods of the Documentdb service.

func NewTableResourcesClient 

func NewTableResourcesClient(subscriptionID string) TableResourcesClient

NewTableResourcesClient creates an instance of the TableResourcesClient client.

func NewTableResourcesClientWithBaseURI 

func NewTableResourcesClientWithBaseURI(baseURI string, subscriptionID string) TableResourcesClient

NewTableResourcesClientWithBaseURI creates an instance of the TableResourcesClient 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 (TableResourcesClient) CreateUpdateTable 

func (client TableResourcesClient) CreateUpdateTable(ctx context.Context, resourceGroupName string, accountName string, tableName string, createUpdateTableParameters TableCreateUpdateParameters) (result TableResourcesCreateUpdateTableFuture, err error)

CreateUpdateTable create or update an Azure Cosmos DB Table Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. tableName - cosmos DB table name. createUpdateTableParameters - the parameters to provide for the current Table.

func (TableResourcesClient) CreateUpdateTablePreparer 

func (client TableResourcesClient) CreateUpdateTablePreparer(ctx context.Context, resourceGroupName string, accountName string, tableName string, createUpdateTableParameters TableCreateUpdateParameters) (*http.Request, error)

CreateUpdateTablePreparer prepares the CreateUpdateTable request.

func (TableResourcesClient) CreateUpdateTableResponder 

func (client TableResourcesClient) CreateUpdateTableResponder(resp *http.Response) (result TableGetResults, err error)

CreateUpdateTableResponder handles the response to the CreateUpdateTable request. The method always closes the http.Response Body.

func (TableResourcesClient) CreateUpdateTableSender 

func (client TableResourcesClient) CreateUpdateTableSender(req *http.Request) (future TableResourcesCreateUpdateTableFuture, err error)

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

func (TableResourcesClient) DeleteTable 

func (client TableResourcesClient) DeleteTable(ctx context.Context, resourceGroupName string, accountName string, tableName string) (result TableResourcesDeleteTableFuture, err error)

DeleteTable deletes an existing Azure Cosmos DB Table. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. tableName - cosmos DB table name.

func (TableResourcesClient) DeleteTablePreparer 

func (client TableResourcesClient) DeleteTablePreparer(ctx context.Context, resourceGroupName string, accountName string, tableName string) (*http.Request, error)

DeleteTablePreparer prepares the DeleteTable request.

func (TableResourcesClient) DeleteTableResponder 

func (client TableResourcesClient) DeleteTableResponder(resp *http.Response) (result autorest.Response, err error)

DeleteTableResponder handles the response to the DeleteTable request. The method always closes the http.Response Body.

func (TableResourcesClient) DeleteTableSender 

func (client TableResourcesClient) DeleteTableSender(req *http.Request) (future TableResourcesDeleteTableFuture, err error)

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

func (TableResourcesClient) GetTable 

func (client TableResourcesClient) GetTable(ctx context.Context, resourceGroupName string, accountName string, tableName string) (result TableGetResults, err error)

GetTable gets the Tables under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. tableName - cosmos DB table name.

func (TableResourcesClient) GetTablePreparer 

func (client TableResourcesClient) GetTablePreparer(ctx context.Context, resourceGroupName string, accountName string, tableName string) (*http.Request, error)

GetTablePreparer prepares the GetTable request.

func (TableResourcesClient) GetTableResponder 

func (client TableResourcesClient) GetTableResponder(resp *http.Response) (result TableGetResults, err error)

GetTableResponder handles the response to the GetTable request. The method always closes the http.Response Body.

func (TableResourcesClient) GetTableSender 

func (client TableResourcesClient) GetTableSender(req *http.Request) (*http.Response, error)

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

func (TableResourcesClient) GetTableThroughput 

func (client TableResourcesClient) GetTableThroughput(ctx context.Context, resourceGroupName string, accountName string, tableName string) (result ThroughputSettingsGetResults, err error)

GetTableThroughput gets the RUs per second of the Table under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. tableName - cosmos DB table name.

func (TableResourcesClient) GetTableThroughputPreparer 

func (client TableResourcesClient) GetTableThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, tableName string) (*http.Request, error)

GetTableThroughputPreparer prepares the GetTableThroughput request.

func (TableResourcesClient) GetTableThroughputResponder 

func (client TableResourcesClient) GetTableThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)

GetTableThroughputResponder handles the response to the GetTableThroughput request. The method always closes the http.Response Body.

func (TableResourcesClient) GetTableThroughputSender 

func (client TableResourcesClient) GetTableThroughputSender(req *http.Request) (*http.Response, error)

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

func (TableResourcesClient) ListTables 

func (client TableResourcesClient) ListTables(ctx context.Context, resourceGroupName string, accountName string) (result TableListResult, err error)

ListTables lists the Tables under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.

func (TableResourcesClient) ListTablesPreparer 

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

ListTablesPreparer prepares the ListTables request.

func (TableResourcesClient) ListTablesResponder 

func (client TableResourcesClient) ListTablesResponder(resp *http.Response) (result TableListResult, err error)

ListTablesResponder handles the response to the ListTables request. The method always closes the http.Response Body.

func (TableResourcesClient) ListTablesSender 

func (client TableResourcesClient) ListTablesSender(req *http.Request) (*http.Response, error)

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

func (TableResourcesClient) UpdateTableThroughput 

func (client TableResourcesClient) UpdateTableThroughput(ctx context.Context, resourceGroupName string, accountName string, tableName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (result TableResourcesUpdateTableThroughputFuture, err error)

UpdateTableThroughput update RUs per second of an Azure Cosmos DB Table Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. tableName - cosmos DB table name. updateThroughputParameters - the parameters to provide for the RUs per second of the current Table.

func (TableResourcesClient) UpdateTableThroughputPreparer 

func (client TableResourcesClient) UpdateTableThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, tableName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)

UpdateTableThroughputPreparer prepares the UpdateTableThroughput request.

func (TableResourcesClient) UpdateTableThroughputResponder 

func (client TableResourcesClient) UpdateTableThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)

UpdateTableThroughputResponder handles the response to the UpdateTableThroughput request. The method always closes the http.Response Body.

func (TableResourcesClient) UpdateTableThroughputSender 

func (client TableResourcesClient) UpdateTableThroughputSender(req *http.Request) (future TableResourcesUpdateTableThroughputFuture, err error)

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

type TableResourcesCreateUpdateTableFuture 

type TableResourcesCreateUpdateTableFuture struct {
	azure.Future
}

TableResourcesCreateUpdateTableFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*TableResourcesCreateUpdateTableFuture) Result 

func (future *TableResourcesCreateUpdateTableFuture) Result(client TableResourcesClient) (tgr TableGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type TableResourcesDeleteTableFuture 

type TableResourcesDeleteTableFuture struct {
	azure.Future
}

TableResourcesDeleteTableFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*TableResourcesDeleteTableFuture) Result 

func (future *TableResourcesDeleteTableFuture) Result(client TableResourcesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type TableResourcesUpdateTableThroughputFuture 

type TableResourcesUpdateTableThroughputFuture struct {
	azure.Future
}

TableResourcesUpdateTableThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*TableResourcesUpdateTableThroughputFuture) Result 

func (future *TableResourcesUpdateTableThroughputFuture) Result(client TableResourcesClient) (tsgr ThroughputSettingsGetResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ThroughputPolicyResource 

type ThroughputPolicyResource struct {
	// IsEnabled - Determines whether the ThroughputPolicy is active or not
	IsEnabled *bool `json:"isEnabled,omitempty"`
	// IncrementPercent - Represents the percentage by which throughput can increase every time throughput policy kicks in.
	IncrementPercent *int32 `json:"incrementPercent,omitempty"`
}

ThroughputPolicyResource cosmos DB resource throughput policy

type ThroughputSettingsGetProperties 

type ThroughputSettingsGetProperties struct {
	Resource *ThroughputSettingsGetPropertiesResource `json:"resource,omitempty"`
}

ThroughputSettingsGetProperties the properties of an Azure Cosmos DB resource throughput

type ThroughputSettingsGetPropertiesResource 

type ThroughputSettingsGetPropertiesResource struct {
	// Throughput - Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both.
	Throughput *int32 `json:"throughput,omitempty"`
	// AutoscaleSettings - Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both.
	AutoscaleSettings *AutoscaleSettingsResource `json:"autoscaleSettings,omitempty"`
	// MinimumThroughput - READ-ONLY; The minimum throughput of the resource
	MinimumThroughput *string `json:"minimumThroughput,omitempty"`
	// OfferReplacePending - READ-ONLY; The throughput replace is pending
	OfferReplacePending *string `json:"offerReplacePending,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"`
}

ThroughputSettingsGetPropertiesResource ...

func (ThroughputSettingsGetPropertiesResource) MarshalJSON 

func (tsgp ThroughputSettingsGetPropertiesResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ThroughputSettingsGetPropertiesResource.

type ThroughputSettingsGetResults 

type ThroughputSettingsGetResults struct {
	autorest.Response `json:"-"`
	// ThroughputSettingsGetProperties - The properties of an Azure Cosmos DB resource throughput
	*ThroughputSettingsGetProperties `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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

ThroughputSettingsGetResults an Azure Cosmos DB resource throughput.

func (ThroughputSettingsGetResults) MarshalJSON 

func (tsgr ThroughputSettingsGetResults) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ThroughputSettingsGetResults.

func (*ThroughputSettingsGetResults) UnmarshalJSON 

func (tsgr *ThroughputSettingsGetResults) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ThroughputSettingsGetResults struct.

type ThroughputSettingsResource 

type ThroughputSettingsResource struct {
	// Throughput - Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both.
	Throughput *int32 `json:"throughput,omitempty"`
	// AutoscaleSettings - Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both.
	AutoscaleSettings *AutoscaleSettingsResource `json:"autoscaleSettings,omitempty"`
	// MinimumThroughput - READ-ONLY; The minimum throughput of the resource
	MinimumThroughput *string `json:"minimumThroughput,omitempty"`
	// OfferReplacePending - READ-ONLY; The throughput replace is pending
	OfferReplacePending *string `json:"offerReplacePending,omitempty"`
}

ThroughputSettingsResource cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.

func (ThroughputSettingsResource) MarshalJSON 

func (tsr ThroughputSettingsResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ThroughputSettingsResource.

type ThroughputSettingsUpdateParameters 

type ThroughputSettingsUpdateParameters struct {
	// ThroughputSettingsUpdateProperties - Properties to update Azure Cosmos DB resource throughput.
	*ThroughputSettingsUpdateProperties `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"`
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`
}

ThroughputSettingsUpdateParameters parameters to update Cosmos DB resource throughput.

func (ThroughputSettingsUpdateParameters) MarshalJSON 

func (tsup ThroughputSettingsUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ThroughputSettingsUpdateParameters.

func (*ThroughputSettingsUpdateParameters) UnmarshalJSON 

func (tsup *ThroughputSettingsUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ThroughputSettingsUpdateParameters struct.

type ThroughputSettingsUpdateProperties 

type ThroughputSettingsUpdateProperties struct {
	// Resource - The standard JSON format of a resource throughput
	Resource *ThroughputSettingsResource `json:"resource,omitempty"`
}

ThroughputSettingsUpdateProperties properties to update Azure Cosmos DB resource throughput.

type TrackedResource 

type TrackedResource struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,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"`
}

TrackedResource the resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON 

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

type TriggerOperation 

type TriggerOperation string

TriggerOperation enumerates the values for trigger operation. 

const (
	// All ...
	All TriggerOperation = "All"
	// Create ...
	Create TriggerOperation = "Create"
	// Delete ...
	Delete TriggerOperation = "Delete"
	// Replace ...
	Replace TriggerOperation = "Replace"
	// Update ...
	Update TriggerOperation = "Update"
)

func PossibleTriggerOperationValues 

func PossibleTriggerOperationValues() []TriggerOperation

PossibleTriggerOperationValues returns an array of possible values for the TriggerOperation const type.

type TriggerType 

type TriggerType string

TriggerType enumerates the values for trigger type. 

const (
	// Post ...
	Post TriggerType = "Post"
	// Pre ...
	Pre TriggerType = "Pre"
)

func PossibleTriggerTypeValues 

func PossibleTriggerTypeValues() []TriggerType

PossibleTriggerTypeValues returns an array of possible values for the TriggerType const type.

type Type 

type Type string

Type enumerates the values for type. 

const (
	// TypeBackupPolicy ...
	TypeBackupPolicy Type = "BackupPolicy"
	// TypeContinuous ...
	TypeContinuous Type = "Continuous"
	// TypePeriodic ...
	TypePeriodic Type = "Periodic"
)

func PossibleTypeValues 

func PossibleTypeValues() []Type

PossibleTypeValues returns an array of possible values for the Type const type.

type UniqueKey 

type UniqueKey struct {
	// Paths - List of paths must be unique for each document in the Azure Cosmos DB service
	Paths *[]string `json:"paths,omitempty"`
}

UniqueKey the unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

type UniqueKeyPolicy 

type UniqueKeyPolicy struct {
	// UniqueKeys - List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
	UniqueKeys *[]UniqueKey `json:"uniqueKeys,omitempty"`
}

UniqueKeyPolicy the unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

type UnitType 

type UnitType string

UnitType enumerates the values for unit type. 

const (
	// Bytes ...
	Bytes UnitType = "Bytes"
	// BytesPerSecond ...
	BytesPerSecond UnitType = "BytesPerSecond"
	// Count ...
	Count UnitType = "Count"
	// CountPerSecond ...
	CountPerSecond UnitType = "CountPerSecond"
	// Milliseconds ...
	Milliseconds UnitType = "Milliseconds"
	// Percent ...
	Percent UnitType = "Percent"
	// Seconds ...
	Seconds UnitType = "Seconds"
)

func PossibleUnitTypeValues 

func PossibleUnitTypeValues() []UnitType

PossibleUnitTypeValues returns an array of possible values for the UnitType const type.

type Usage 

type Usage struct {
	// Unit - The unit of the metric. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond', 'Milliseconds'
	Unit UnitType `json:"unit,omitempty"`
	// Name - READ-ONLY; The name information for the metric.
	Name *MetricName `json:"name,omitempty"`
	// QuotaPeriod - READ-ONLY; The quota period used to summarize the usage values.
	QuotaPeriod *string `json:"quotaPeriod,omitempty"`
	// Limit - READ-ONLY; Maximum value for this metric
	Limit *int64 `json:"limit,omitempty"`
	// CurrentValue - READ-ONLY; Current value for this metric
	CurrentValue *int64 `json:"currentValue,omitempty"`
}

Usage the usage data for a usage request.

func (Usage) MarshalJSON 

func (u Usage) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Usage.

type UsagesResult 

type UsagesResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The list of usages for the database. A usage is a point in time metric
	Value *[]Usage `json:"value,omitempty"`
}

UsagesResult the response to a list usage request.

type VirtualNetworkRule 

type VirtualNetworkRule struct {
	// ID - Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
	ID *string `json:"id,omitempty"`
	// IgnoreMissingVNetServiceEndpoint - Create firewall rule before the virtual network has vnet service endpoint enabled.
	IgnoreMissingVNetServiceEndpoint *bool `json:"ignoreMissingVNetServiceEndpoint,omitempty"`
}

VirtualNetworkRule virtual Network ACL Rule object

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.