const (
// DefaultBaseURI is the default URI used for the service Documentdb
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
APIProperties ...
type APIProperties struct {
// ServerVersion - Describes the ServerVersion of an a MongoDB account. Possible values include: 'ThreeFullStopTwo', 'ThreeFullStopSix', 'FourFullStopZero'
ServerVersion ServerVersion `json:"serverVersion,omitempty"`
}
ARMProxyResource the resource model definition for a ARM proxy resource. It will have everything other than required location and tags
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"`
}
func (apr ARMProxyResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ARMProxyResource.
ARMResourceProperties the core properties of ARM resources.
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"`
}
func (arp ARMResourceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ARMResourceProperties.
AutoUpgradePolicyResource cosmos DB resource auto-upgrade policy
type AutoUpgradePolicyResource struct {
// ThroughputPolicy - Represents throughput policy which service must adhere to for auto-upgrade
ThroughputPolicy *ThroughputPolicyResource `json:"throughputPolicy,omitempty"`
}
AutoscaleSettings ...
type AutoscaleSettings struct {
// MaxThroughput - Represents maximum throughput, the resource can scale up to.
MaxThroughput *int32 `json:"maxThroughput,omitempty"`
}
AutoscaleSettingsResource cosmos DB provisioned throughput settings object
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"`
}
func (asr AutoscaleSettingsResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AutoscaleSettingsResource.
AzureEntityResource the resource model definition for an Azure Resource Manager resource with an etag.
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"`
}
func (aer AzureEntityResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AzureEntityResource.
BackupPolicy the object representing the policy for taking backups on an account.
type BackupPolicy struct {
// Type - Possible values include: 'TypeBackupPolicy', 'TypePeriodic', 'TypeContinuous'
Type Type `json:"type,omitempty"`
}
func (bp BackupPolicy) AsBackupPolicy() (*BackupPolicy, bool)
AsBackupPolicy is the BasicBackupPolicy implementation for BackupPolicy.
func (bp BackupPolicy) AsBasicBackupPolicy() (BasicBackupPolicy, bool)
AsBasicBackupPolicy is the BasicBackupPolicy implementation for BackupPolicy.
func (bp BackupPolicy) AsContinuousModeBackupPolicy() (*ContinuousModeBackupPolicy, bool)
AsContinuousModeBackupPolicy is the BasicBackupPolicy implementation for BackupPolicy.
func (bp BackupPolicy) AsPeriodicModeBackupPolicy() (*PeriodicModeBackupPolicy, bool)
AsPeriodicModeBackupPolicy is the BasicBackupPolicy implementation for BackupPolicy.
func (bp BackupPolicy) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for BackupPolicy.
BackupPolicyType enumerates the values for backup policy type.
type BackupPolicyType string
const (
// Continuous ...
Continuous BackupPolicyType = "Continuous"
// Periodic ...
Periodic BackupPolicyType = "Periodic"
)
func PossibleBackupPolicyTypeValues() []BackupPolicyType
PossibleBackupPolicyTypeValues returns an array of possible values for the BackupPolicyType const type.
BaseClient is the base client for Documentdb.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
BasicBackupPolicy the object representing the policy for taking backups on an account.
type BasicBackupPolicy interface {
AsPeriodicModeBackupPolicy() (*PeriodicModeBackupPolicy, bool)
AsContinuousModeBackupPolicy() (*ContinuousModeBackupPolicy, bool)
AsBackupPolicy() (*BackupPolicy, bool)
}
Capability cosmos DB capability object
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"`
}
CassandraKeyspaceCreateUpdateParameters parameters to create and update Cosmos DB Cassandra keyspace.
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"`
}
func (ckcup CassandraKeyspaceCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CassandraKeyspaceCreateUpdateParameters.
func (ckcup *CassandraKeyspaceCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CassandraKeyspaceCreateUpdateParameters struct.
CassandraKeyspaceCreateUpdateProperties properties to create and update Azure Cosmos DB Cassandra keyspace.
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"`
}
CassandraKeyspaceGetProperties the properties of an Azure Cosmos DB Cassandra keyspace
type CassandraKeyspaceGetProperties struct {
Resource *CassandraKeyspaceGetPropertiesResource `json:"resource,omitempty"`
Options *CassandraKeyspaceGetPropertiesOptions `json:"options,omitempty"`
}
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"`
}
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 *float64 `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}
func (ckgp CassandraKeyspaceGetPropertiesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CassandraKeyspaceGetPropertiesResource.
CassandraKeyspaceGetResults an Azure Cosmos DB Cassandra keyspace.
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"`
}
func (ckgr CassandraKeyspaceGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CassandraKeyspaceGetResults.
func (ckgr *CassandraKeyspaceGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CassandraKeyspaceGetResults struct.
CassandraKeyspaceListResult the List operation response, that contains the Cassandra keyspaces and their properties.
type CassandraKeyspaceListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of Cassandra keyspaces and their properties.
Value *[]CassandraKeyspaceGetResults `json:"value,omitempty"`
}
func (cklr CassandraKeyspaceListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CassandraKeyspaceListResult.
CassandraKeyspaceResource cosmos DB Cassandra keyspace resource object
type CassandraKeyspaceResource struct {
// ID - Name of the Cosmos DB Cassandra keyspace
ID *string `json:"id,omitempty"`
}
CassandraPartitionKey cosmos DB Cassandra table partition key
type CassandraPartitionKey struct {
// Name - Name of the Cosmos DB Cassandra table partition key
Name *string `json:"name,omitempty"`
}
CassandraResourcesClient is the azure Cosmos DB Database Service Resource Provider REST API
type CassandraResourcesClient struct {
BaseClient
}
func NewCassandraResourcesClient(subscriptionID string) CassandraResourcesClient
NewCassandraResourcesClient creates an instance of the CassandraResourcesClient client.
func NewCassandraResourcesClientWithBaseURI(baseURI string, subscriptionID string) CassandraResourcesClient
NewCassandraResourcesClientWithBaseURI creates an instance of the CassandraResourcesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client CassandraResourcesClient) CreateUpdateCassandraKeyspace(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, createUpdateCassandraKeyspaceParameters CassandraKeyspaceCreateUpdateParameters) (result CassandraResourcesCreateUpdateCassandraKeyspaceFuture, err error)
CreateUpdateCassandraKeyspace create or update an Azure Cosmos DB Cassandra keyspace Parameters: resourceGroupName - 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 (client CassandraResourcesClient) CreateUpdateCassandraKeyspacePreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, createUpdateCassandraKeyspaceParameters CassandraKeyspaceCreateUpdateParameters) (*http.Request, error)
CreateUpdateCassandraKeyspacePreparer prepares the CreateUpdateCassandraKeyspace request.
func (client CassandraResourcesClient) CreateUpdateCassandraKeyspaceResponder(resp *http.Response) (result CassandraKeyspaceGetResults, err error)
CreateUpdateCassandraKeyspaceResponder handles the response to the CreateUpdateCassandraKeyspace request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) CreateUpdateCassandraKeyspaceSender(req *http.Request) (future CassandraResourcesCreateUpdateCassandraKeyspaceFuture, err error)
CreateUpdateCassandraKeyspaceSender sends the CreateUpdateCassandraKeyspace request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) CreateUpdateCassandraTable(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string, createUpdateCassandraTableParameters CassandraTableCreateUpdateParameters) (result CassandraResourcesCreateUpdateCassandraTableFuture, err error)
CreateUpdateCassandraTable create or update an Azure Cosmos DB Cassandra Table Parameters: resourceGroupName - 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 (client CassandraResourcesClient) CreateUpdateCassandraTablePreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string, createUpdateCassandraTableParameters CassandraTableCreateUpdateParameters) (*http.Request, error)
CreateUpdateCassandraTablePreparer prepares the CreateUpdateCassandraTable request.
func (client CassandraResourcesClient) CreateUpdateCassandraTableResponder(resp *http.Response) (result CassandraTableGetResults, err error)
CreateUpdateCassandraTableResponder handles the response to the CreateUpdateCassandraTable request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) CreateUpdateCassandraTableSender(req *http.Request) (future CassandraResourcesCreateUpdateCassandraTableFuture, err error)
CreateUpdateCassandraTableSender sends the CreateUpdateCassandraTable request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) DeleteCassandraKeyspace(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (result CassandraResourcesDeleteCassandraKeyspaceFuture, err error)
DeleteCassandraKeyspace deletes an existing Azure Cosmos DB Cassandra keyspace. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. keyspaceName - cosmos DB keyspace name.
func (client CassandraResourcesClient) DeleteCassandraKeyspacePreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (*http.Request, error)
DeleteCassandraKeyspacePreparer prepares the DeleteCassandraKeyspace request.
func (client CassandraResourcesClient) DeleteCassandraKeyspaceResponder(resp *http.Response) (result autorest.Response, err error)
DeleteCassandraKeyspaceResponder handles the response to the DeleteCassandraKeyspace request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) DeleteCassandraKeyspaceSender(req *http.Request) (future CassandraResourcesDeleteCassandraKeyspaceFuture, err error)
DeleteCassandraKeyspaceSender sends the DeleteCassandraKeyspace request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) DeleteCassandraTable(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string) (result CassandraResourcesDeleteCassandraTableFuture, err error)
DeleteCassandraTable deletes an existing Azure Cosmos DB Cassandra table. Parameters: resourceGroupName - 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 (client CassandraResourcesClient) DeleteCassandraTablePreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string) (*http.Request, error)
DeleteCassandraTablePreparer prepares the DeleteCassandraTable request.
func (client CassandraResourcesClient) DeleteCassandraTableResponder(resp *http.Response) (result autorest.Response, err error)
DeleteCassandraTableResponder handles the response to the DeleteCassandraTable request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) DeleteCassandraTableSender(req *http.Request) (future CassandraResourcesDeleteCassandraTableFuture, err error)
DeleteCassandraTableSender sends the DeleteCassandraTable request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) GetCassandraKeyspace(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (result CassandraKeyspaceGetResults, err error)
GetCassandraKeyspace gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. keyspaceName - cosmos DB keyspace name.
func (client CassandraResourcesClient) GetCassandraKeyspacePreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (*http.Request, error)
GetCassandraKeyspacePreparer prepares the GetCassandraKeyspace request.
func (client CassandraResourcesClient) GetCassandraKeyspaceResponder(resp *http.Response) (result CassandraKeyspaceGetResults, err error)
GetCassandraKeyspaceResponder handles the response to the GetCassandraKeyspace request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) GetCassandraKeyspaceSender(req *http.Request) (*http.Response, error)
GetCassandraKeyspaceSender sends the GetCassandraKeyspace request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) GetCassandraKeyspaceThroughput(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (result ThroughputSettingsGetResults, err error)
GetCassandraKeyspaceThroughput gets the RUs per second of the Cassandra Keyspace under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. keyspaceName - cosmos DB keyspace name.
func (client CassandraResourcesClient) GetCassandraKeyspaceThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (*http.Request, error)
GetCassandraKeyspaceThroughputPreparer prepares the GetCassandraKeyspaceThroughput request.
func (client CassandraResourcesClient) GetCassandraKeyspaceThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
GetCassandraKeyspaceThroughputResponder handles the response to the GetCassandraKeyspaceThroughput request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) GetCassandraKeyspaceThroughputSender(req *http.Request) (*http.Response, error)
GetCassandraKeyspaceThroughputSender sends the GetCassandraKeyspaceThroughput request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) GetCassandraTable(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string) (result CassandraTableGetResults, err error)
GetCassandraTable gets the Cassandra table under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - 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 (client CassandraResourcesClient) GetCassandraTablePreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string) (*http.Request, error)
GetCassandraTablePreparer prepares the GetCassandraTable request.
func (client CassandraResourcesClient) GetCassandraTableResponder(resp *http.Response) (result CassandraTableGetResults, err error)
GetCassandraTableResponder handles the response to the GetCassandraTable request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) GetCassandraTableSender(req *http.Request) (*http.Response, error)
GetCassandraTableSender sends the GetCassandraTable request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) GetCassandraTableThroughput(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string) (result ThroughputSettingsGetResults, err error)
GetCassandraTableThroughput gets the RUs per second of the Cassandra table under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - 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 (client CassandraResourcesClient) GetCassandraTableThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string) (*http.Request, error)
GetCassandraTableThroughputPreparer prepares the GetCassandraTableThroughput request.
func (client CassandraResourcesClient) GetCassandraTableThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
GetCassandraTableThroughputResponder handles the response to the GetCassandraTableThroughput request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) GetCassandraTableThroughputSender(req *http.Request) (*http.Response, error)
GetCassandraTableThroughputSender sends the GetCassandraTableThroughput request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) ListCassandraKeyspaces(ctx context.Context, resourceGroupName string, accountName string) (result CassandraKeyspaceListResult, err error)
ListCassandraKeyspaces lists the Cassandra keyspaces under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client CassandraResourcesClient) ListCassandraKeyspacesPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListCassandraKeyspacesPreparer prepares the ListCassandraKeyspaces request.
func (client CassandraResourcesClient) ListCassandraKeyspacesResponder(resp *http.Response) (result CassandraKeyspaceListResult, err error)
ListCassandraKeyspacesResponder handles the response to the ListCassandraKeyspaces request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) ListCassandraKeyspacesSender(req *http.Request) (*http.Response, error)
ListCassandraKeyspacesSender sends the ListCassandraKeyspaces request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) ListCassandraTables(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (result CassandraTableListResult, err error)
ListCassandraTables lists the Cassandra table under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. keyspaceName - cosmos DB keyspace name.
func (client CassandraResourcesClient) ListCassandraTablesPreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (*http.Request, error)
ListCassandraTablesPreparer prepares the ListCassandraTables request.
func (client CassandraResourcesClient) ListCassandraTablesResponder(resp *http.Response) (result CassandraTableListResult, err error)
ListCassandraTablesResponder handles the response to the ListCassandraTables request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) ListCassandraTablesSender(req *http.Request) (*http.Response, error)
ListCassandraTablesSender sends the ListCassandraTables request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) MigrateCassandraKeyspaceToAutoscale(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (result CassandraResourcesMigrateCassandraKeyspaceToAutoscaleFuture, err error)
MigrateCassandraKeyspaceToAutoscale migrate an Azure Cosmos DB Cassandra Keyspace from manual throughput to autoscale 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 (client CassandraResourcesClient) MigrateCassandraKeyspaceToAutoscalePreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (*http.Request, error)
MigrateCassandraKeyspaceToAutoscalePreparer prepares the MigrateCassandraKeyspaceToAutoscale request.
func (client CassandraResourcesClient) MigrateCassandraKeyspaceToAutoscaleResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
MigrateCassandraKeyspaceToAutoscaleResponder handles the response to the MigrateCassandraKeyspaceToAutoscale request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) MigrateCassandraKeyspaceToAutoscaleSender(req *http.Request) (future CassandraResourcesMigrateCassandraKeyspaceToAutoscaleFuture, err error)
MigrateCassandraKeyspaceToAutoscaleSender sends the MigrateCassandraKeyspaceToAutoscale request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) MigrateCassandraKeyspaceToManualThroughput(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (result CassandraResourcesMigrateCassandraKeyspaceToManualThroughputFuture, err error)
MigrateCassandraKeyspaceToManualThroughput migrate an Azure Cosmos DB Cassandra Keyspace from autoscale to manual throughput 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 (client CassandraResourcesClient) MigrateCassandraKeyspaceToManualThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string) (*http.Request, error)
MigrateCassandraKeyspaceToManualThroughputPreparer prepares the MigrateCassandraKeyspaceToManualThroughput request.
func (client CassandraResourcesClient) MigrateCassandraKeyspaceToManualThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
MigrateCassandraKeyspaceToManualThroughputResponder handles the response to the MigrateCassandraKeyspaceToManualThroughput request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) MigrateCassandraKeyspaceToManualThroughputSender(req *http.Request) (future CassandraResourcesMigrateCassandraKeyspaceToManualThroughputFuture, err error)
MigrateCassandraKeyspaceToManualThroughputSender sends the MigrateCassandraKeyspaceToManualThroughput request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) MigrateCassandraTableToAutoscale(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string) (result CassandraResourcesMigrateCassandraTableToAutoscaleFuture, err error)
MigrateCassandraTableToAutoscale migrate an Azure Cosmos DB Cassandra table from manual throughput to autoscale 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 (client CassandraResourcesClient) MigrateCassandraTableToAutoscalePreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string) (*http.Request, error)
MigrateCassandraTableToAutoscalePreparer prepares the MigrateCassandraTableToAutoscale request.
func (client CassandraResourcesClient) MigrateCassandraTableToAutoscaleResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
MigrateCassandraTableToAutoscaleResponder handles the response to the MigrateCassandraTableToAutoscale request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) MigrateCassandraTableToAutoscaleSender(req *http.Request) (future CassandraResourcesMigrateCassandraTableToAutoscaleFuture, err error)
MigrateCassandraTableToAutoscaleSender sends the MigrateCassandraTableToAutoscale request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) MigrateCassandraTableToManualThroughput(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string) (result CassandraResourcesMigrateCassandraTableToManualThroughputFuture, err error)
MigrateCassandraTableToManualThroughput migrate an Azure Cosmos DB Cassandra table from autoscale to manual throughput 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 (client CassandraResourcesClient) MigrateCassandraTableToManualThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string) (*http.Request, error)
MigrateCassandraTableToManualThroughputPreparer prepares the MigrateCassandraTableToManualThroughput request.
func (client CassandraResourcesClient) MigrateCassandraTableToManualThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
MigrateCassandraTableToManualThroughputResponder handles the response to the MigrateCassandraTableToManualThroughput request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) MigrateCassandraTableToManualThroughputSender(req *http.Request) (future CassandraResourcesMigrateCassandraTableToManualThroughputFuture, err error)
MigrateCassandraTableToManualThroughputSender sends the MigrateCassandraTableToManualThroughput request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) UpdateCassandraKeyspaceThroughput(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (result CassandraResourcesUpdateCassandraKeyspaceThroughputFuture, err error)
UpdateCassandraKeyspaceThroughput update RUs per second of an Azure Cosmos DB Cassandra Keyspace Parameters: resourceGroupName - 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 (client CassandraResourcesClient) UpdateCassandraKeyspaceThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)
UpdateCassandraKeyspaceThroughputPreparer prepares the UpdateCassandraKeyspaceThroughput request.
func (client CassandraResourcesClient) UpdateCassandraKeyspaceThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
UpdateCassandraKeyspaceThroughputResponder handles the response to the UpdateCassandraKeyspaceThroughput request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) UpdateCassandraKeyspaceThroughputSender(req *http.Request) (future CassandraResourcesUpdateCassandraKeyspaceThroughputFuture, err error)
UpdateCassandraKeyspaceThroughputSender sends the UpdateCassandraKeyspaceThroughput request. The method will close the http.Response Body if it receives an error.
func (client CassandraResourcesClient) UpdateCassandraTableThroughput(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (result CassandraResourcesUpdateCassandraTableThroughputFuture, err error)
UpdateCassandraTableThroughput update RUs per second of an Azure Cosmos DB Cassandra table Parameters: resourceGroupName - 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 (client CassandraResourcesClient) UpdateCassandraTableThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, keyspaceName string, tableName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)
UpdateCassandraTableThroughputPreparer prepares the UpdateCassandraTableThroughput request.
func (client CassandraResourcesClient) UpdateCassandraTableThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
UpdateCassandraTableThroughputResponder handles the response to the UpdateCassandraTableThroughput request. The method always closes the http.Response Body.
func (client CassandraResourcesClient) UpdateCassandraTableThroughputSender(req *http.Request) (future CassandraResourcesUpdateCassandraTableThroughputFuture, err error)
UpdateCassandraTableThroughputSender sends the UpdateCassandraTableThroughput request. The method will close the http.Response Body if it receives an error.
CassandraResourcesCreateUpdateCassandraKeyspaceFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CassandraResourcesCreateUpdateCassandraKeyspaceFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CassandraResourcesClient) (CassandraKeyspaceGetResults, error)
}
func (future *CassandraResourcesCreateUpdateCassandraKeyspaceFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CassandraResourcesCreateUpdateCassandraTableFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CassandraResourcesCreateUpdateCassandraTableFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CassandraResourcesClient) (CassandraTableGetResults, error)
}
func (future *CassandraResourcesCreateUpdateCassandraTableFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CassandraResourcesDeleteCassandraKeyspaceFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CassandraResourcesDeleteCassandraKeyspaceFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CassandraResourcesClient) (autorest.Response, error)
}
func (future *CassandraResourcesDeleteCassandraKeyspaceFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CassandraResourcesDeleteCassandraTableFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CassandraResourcesDeleteCassandraTableFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CassandraResourcesClient) (autorest.Response, error)
}
func (future *CassandraResourcesDeleteCassandraTableFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CassandraResourcesMigrateCassandraKeyspaceToAutoscaleFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CassandraResourcesMigrateCassandraKeyspaceToAutoscaleFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CassandraResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *CassandraResourcesMigrateCassandraKeyspaceToAutoscaleFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CassandraResourcesMigrateCassandraKeyspaceToManualThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CassandraResourcesMigrateCassandraKeyspaceToManualThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CassandraResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *CassandraResourcesMigrateCassandraKeyspaceToManualThroughputFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CassandraResourcesMigrateCassandraTableToAutoscaleFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CassandraResourcesMigrateCassandraTableToAutoscaleFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CassandraResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *CassandraResourcesMigrateCassandraTableToAutoscaleFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CassandraResourcesMigrateCassandraTableToManualThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CassandraResourcesMigrateCassandraTableToManualThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CassandraResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *CassandraResourcesMigrateCassandraTableToManualThroughputFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CassandraResourcesUpdateCassandraKeyspaceThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CassandraResourcesUpdateCassandraKeyspaceThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CassandraResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *CassandraResourcesUpdateCassandraKeyspaceThroughputFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CassandraResourcesUpdateCassandraTableThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CassandraResourcesUpdateCassandraTableThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CassandraResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *CassandraResourcesUpdateCassandraTableThroughputFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CassandraSchema cosmos DB Cassandra table schema
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"`
}
CassandraTableCreateUpdateParameters parameters to create and update Cosmos DB Cassandra table.
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"`
}
func (ctcup CassandraTableCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CassandraTableCreateUpdateParameters.
func (ctcup *CassandraTableCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CassandraTableCreateUpdateParameters struct.
CassandraTableCreateUpdateProperties properties to create and update Azure Cosmos DB Cassandra table.
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"`
}
CassandraTableGetProperties the properties of an Azure Cosmos DB Cassandra table
type CassandraTableGetProperties struct {
Resource *CassandraTableGetPropertiesResource `json:"resource,omitempty"`
Options *CassandraTableGetPropertiesOptions `json:"options,omitempty"`
}
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"`
}
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 *float64 `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}
func (ctgp CassandraTableGetPropertiesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CassandraTableGetPropertiesResource.
CassandraTableGetResults an Azure Cosmos DB Cassandra table.
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"`
}
func (ctgr CassandraTableGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CassandraTableGetResults.
func (ctgr *CassandraTableGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CassandraTableGetResults struct.
CassandraTableListResult the List operation response, that contains the Cassandra tables and their properties.
type CassandraTableListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of Cassandra tables and their properties.
Value *[]CassandraTableGetResults `json:"value,omitempty"`
}
func (ctlr CassandraTableListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CassandraTableListResult.
CassandraTableResource cosmos DB Cassandra table resource object
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"`
}
ClusterKey cosmos DB Cassandra table cluster key
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"`
}
CollectionClient is the azure Cosmos DB Database Service Resource Provider REST API
type CollectionClient struct {
BaseClient
}
func NewCollectionClient(subscriptionID string) CollectionClient
NewCollectionClient creates an instance of the CollectionClient client.
func NewCollectionClientWithBaseURI(baseURI string, subscriptionID string) CollectionClient
NewCollectionClientWithBaseURI creates an instance of the CollectionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client CollectionClient) ListMetricDefinitions(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string) (result MetricDefinitionsListResult, err error)
ListMetricDefinitions retrieves metric definitions for the given collection. Parameters: resourceGroupName - 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 (client CollectionClient) ListMetricDefinitionsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string) (*http.Request, error)
ListMetricDefinitionsPreparer prepares the ListMetricDefinitions request.
func (client CollectionClient) ListMetricDefinitionsResponder(resp *http.Response) (result MetricDefinitionsListResult, err error)
ListMetricDefinitionsResponder handles the response to the ListMetricDefinitions request. The method always closes the http.Response Body.
func (client CollectionClient) ListMetricDefinitionsSender(req *http.Request) (*http.Response, error)
ListMetricDefinitionsSender sends the ListMetricDefinitions request. The method will close the http.Response Body if it receives an error.
func (client CollectionClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, filter string) (result MetricListResult, err error)
ListMetrics retrieves the metrics determined by the given filter for the given database account and collection. Parameters: resourceGroupName - 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 (client CollectionClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client CollectionClient) ListMetricsResponder(resp *http.Response) (result MetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.
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 (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 (client CollectionClient) ListUsagesPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, filter string) (*http.Request, error)
ListUsagesPreparer prepares the ListUsages request.
func (client CollectionClient) ListUsagesResponder(resp *http.Response) (result UsagesResult, err error)
ListUsagesResponder handles the response to the ListUsages request. The method always closes the http.Response Body.
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.
CollectionPartitionClient is the azure Cosmos DB Database Service Resource Provider REST API
type CollectionPartitionClient struct {
BaseClient
}
func NewCollectionPartitionClient(subscriptionID string) CollectionPartitionClient
NewCollectionPartitionClient creates an instance of the CollectionPartitionClient client.
func NewCollectionPartitionClientWithBaseURI(baseURI string, subscriptionID string) CollectionPartitionClient
NewCollectionPartitionClientWithBaseURI creates an instance of the CollectionPartitionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client CollectionPartitionClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, filter string) (result PartitionMetricListResult, err error)
ListMetrics retrieves the metrics determined by the given filter for the given collection, split by partition. Parameters: resourceGroupName - 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 (client CollectionPartitionClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client CollectionPartitionClient) ListMetricsResponder(resp *http.Response) (result PartitionMetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.
func (client CollectionPartitionClient) ListMetricsSender(req *http.Request) (*http.Response, error)
ListMetricsSender sends the ListMetrics request. The method will close the http.Response Body if it receives an error.
func (client CollectionPartitionClient) ListUsages(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, filter string) (result PartitionUsagesResult, err error)
ListUsages retrieves the usages (most recent storage data) for the given collection, split by partition. Parameters: resourceGroupName - 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 (client CollectionPartitionClient) ListUsagesPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, filter string) (*http.Request, error)
ListUsagesPreparer prepares the ListUsages request.
func (client CollectionPartitionClient) ListUsagesResponder(resp *http.Response) (result PartitionUsagesResult, err error)
ListUsagesResponder handles the response to the ListUsages request. The method always closes the http.Response Body.
func (client CollectionPartitionClient) ListUsagesSender(req *http.Request) (*http.Response, error)
ListUsagesSender sends the ListUsages request. The method will close the http.Response Body if it receives an error.
CollectionPartitionRegionClient is the azure Cosmos DB Database Service Resource Provider REST API
type CollectionPartitionRegionClient struct {
BaseClient
}
func NewCollectionPartitionRegionClient(subscriptionID string) CollectionPartitionRegionClient
NewCollectionPartitionRegionClient creates an instance of the CollectionPartitionRegionClient client.
func NewCollectionPartitionRegionClientWithBaseURI(baseURI string, subscriptionID string) CollectionPartitionRegionClient
NewCollectionPartitionRegionClientWithBaseURI creates an instance of the CollectionPartitionRegionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client CollectionPartitionRegionClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, region string, databaseRid string, collectionRid string, filter string) (result PartitionMetricListResult, err error)
ListMetrics retrieves the metrics determined by the given filter for the given collection and region, split by partition. Parameters: resourceGroupName - 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 (client CollectionPartitionRegionClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, region string, databaseRid string, collectionRid string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client CollectionPartitionRegionClient) ListMetricsResponder(resp *http.Response) (result PartitionMetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.
func (client CollectionPartitionRegionClient) ListMetricsSender(req *http.Request) (*http.Response, error)
ListMetricsSender sends the ListMetrics request. The method will close the http.Response Body if it receives an error.
CollectionRegionClient is the azure Cosmos DB Database Service Resource Provider REST API
type CollectionRegionClient struct {
BaseClient
}
func NewCollectionRegionClient(subscriptionID string) CollectionRegionClient
NewCollectionRegionClient creates an instance of the CollectionRegionClient client.
func NewCollectionRegionClientWithBaseURI(baseURI string, subscriptionID string) CollectionRegionClient
NewCollectionRegionClientWithBaseURI creates an instance of the CollectionRegionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client CollectionRegionClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, region string, databaseRid string, collectionRid string, filter string) (result MetricListResult, err error)
ListMetrics retrieves the metrics determined by the given filter for the given database account, collection and region. Parameters: resourceGroupName - 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 (client CollectionRegionClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, region string, databaseRid string, collectionRid string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client CollectionRegionClient) ListMetricsResponder(resp *http.Response) (result MetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.
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.
Column cosmos DB Cassandra table 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"`
}
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"`
}
CompositePathSortOrder enumerates the values for composite path sort order.
type CompositePathSortOrder string
const (
// Ascending ...
Ascending CompositePathSortOrder = "ascending"
// Descending ...
Descending CompositePathSortOrder = "descending"
)
func PossibleCompositePathSortOrderValues() []CompositePathSortOrder
PossibleCompositePathSortOrderValues returns an array of possible values for the CompositePathSortOrder const type.
ConflictResolutionMode enumerates the values for conflict resolution mode.
type ConflictResolutionMode string
const (
// Custom ...
Custom ConflictResolutionMode = "Custom"
// LastWriterWins ...
LastWriterWins ConflictResolutionMode = "LastWriterWins"
)
func PossibleConflictResolutionModeValues() []ConflictResolutionMode
PossibleConflictResolutionModeValues returns an array of possible values for the ConflictResolutionMode const type.
ConflictResolutionPolicy the conflict resolution policy for the container.
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"`
}
ConnectorOffer enumerates the values for connector offer.
type ConnectorOffer string
const (
// Small ...
Small ConnectorOffer = "Small"
)
func PossibleConnectorOfferValues() []ConnectorOffer
PossibleConnectorOfferValues returns an array of possible values for the ConnectorOffer const type.
ConsistencyPolicy the consistency policy for the Cosmos DB database account.
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"`
}
ContainerPartitionKey the configuration of the partition key to be used for partitioning data into multiple partitions
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. For MultiHash, multiple partition keys (upto three maximum) are supported for container create. Possible values include: 'PartitionKindHash', 'PartitionKindRange', 'PartitionKindMultiHash'
Kind PartitionKind `json:"kind,omitempty"`
// Version - Indicates the version of the partition key definition
Version *int32 `json:"version,omitempty"`
// SystemKey - READ-ONLY; Indicates if the container is using a system generated partition key
SystemKey *bool `json:"systemKey,omitempty"`
}
func (cpk ContainerPartitionKey) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ContainerPartitionKey.
ContinuousModeBackupPolicy the object representing continuous mode backup policy.
type ContinuousModeBackupPolicy struct {
// Type - Possible values include: 'TypeBackupPolicy', 'TypePeriodic', 'TypeContinuous'
Type Type `json:"type,omitempty"`
}
func (cmbp ContinuousModeBackupPolicy) AsBackupPolicy() (*BackupPolicy, bool)
AsBackupPolicy is the BasicBackupPolicy implementation for ContinuousModeBackupPolicy.
func (cmbp ContinuousModeBackupPolicy) AsBasicBackupPolicy() (BasicBackupPolicy, bool)
AsBasicBackupPolicy is the BasicBackupPolicy implementation for ContinuousModeBackupPolicy.
func (cmbp ContinuousModeBackupPolicy) AsContinuousModeBackupPolicy() (*ContinuousModeBackupPolicy, bool)
AsContinuousModeBackupPolicy is the BasicBackupPolicy implementation for ContinuousModeBackupPolicy.
func (cmbp ContinuousModeBackupPolicy) AsPeriodicModeBackupPolicy() (*PeriodicModeBackupPolicy, bool)
AsPeriodicModeBackupPolicy is the BasicBackupPolicy implementation for ContinuousModeBackupPolicy.
func (cmbp ContinuousModeBackupPolicy) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ContinuousModeBackupPolicy.
CorsPolicy the CORS policy for the Cosmos DB database account.
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"`
}
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 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"`
}
DataType enumerates the values for data type.
type DataType string
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() []DataType
PossibleDataTypeValues returns an array of possible values for the DataType const type.
DatabaseAccountConnectionString connection string for the Cosmos DB account
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"`
}
func (dacs DatabaseAccountConnectionString) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DatabaseAccountConnectionString.
DatabaseAccountCreateUpdateParameters parameters to create and update Cosmos DB database accounts.
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"`
Identity *ManagedServiceIdentity `json:"identity,omitempty"`
*DatabaseAccountCreateUpdateProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The unique resource identifier of the ARM resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags map[string]*string `json:"tags"`
}
func (dacup DatabaseAccountCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DatabaseAccountCreateUpdateParameters.
func (dacup *DatabaseAccountCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DatabaseAccountCreateUpdateParameters struct.
DatabaseAccountCreateUpdateProperties properties to create and update Azure Cosmos DB database accounts.
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"`
// DefaultIdentity - The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
DefaultIdentity *string `json:"defaultIdentity,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"`
// NetworkACLBypass - Indicates what services are allowed to bypass firewall checks. Possible values include: 'NetworkACLBypassNone', 'NetworkACLBypassAzureServices'
NetworkACLBypass NetworkACLBypass `json:"networkAclBypass,omitempty"`
// NetworkACLBypassResourceIds - An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
NetworkACLBypassResourceIds *[]string `json:"networkAclBypassResourceIds,omitempty"`
}
func (dacup *DatabaseAccountCreateUpdateProperties) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DatabaseAccountCreateUpdateProperties struct.
DatabaseAccountGetProperties properties for the database account.
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"`
// DefaultIdentity - The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
DefaultIdentity *string `json:"defaultIdentity,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"`
// 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"`
// NetworkACLBypass - Indicates what services are allowed to bypass firewall checks. Possible values include: 'NetworkACLBypassNone', 'NetworkACLBypassAzureServices'
NetworkACLBypass NetworkACLBypass `json:"networkAclBypass,omitempty"`
// NetworkACLBypassResourceIds - An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
NetworkACLBypassResourceIds *[]string `json:"networkAclBypassResourceIds,omitempty"`
}
func (dagp DatabaseAccountGetProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DatabaseAccountGetProperties.
func (dagp *DatabaseAccountGetProperties) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DatabaseAccountGetProperties struct.
DatabaseAccountGetResults an Azure Cosmos DB database account.
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"`
Identity *ManagedServiceIdentity `json:"identity,omitempty"`
*DatabaseAccountGetProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The unique resource identifier of the ARM resource.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the ARM resource.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The type of Azure resource.
Type *string `json:"type,omitempty"`
// Location - The location of the resource group to which the resource belongs.
Location *string `json:"location,omitempty"`
Tags map[string]*string `json:"tags"`
}
func (dagr DatabaseAccountGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DatabaseAccountGetResults.
func (dagr *DatabaseAccountGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DatabaseAccountGetResults struct.
DatabaseAccountKind enumerates the values for database account kind.
type DatabaseAccountKind string
const (
// GlobalDocumentDB ...
GlobalDocumentDB DatabaseAccountKind = "GlobalDocumentDB"
// MongoDB ...
MongoDB DatabaseAccountKind = "MongoDB"
// Parse ...
Parse DatabaseAccountKind = "Parse"
)
func PossibleDatabaseAccountKindValues() []DatabaseAccountKind
PossibleDatabaseAccountKindValues returns an array of possible values for the DatabaseAccountKind const type.
DatabaseAccountListConnectionStringsResult the connection strings for the given database account.
type DatabaseAccountListConnectionStringsResult struct {
autorest.Response `json:"-"`
// ConnectionStrings - An array that contains the connection strings for the Cosmos DB account.
ConnectionStrings *[]DatabaseAccountConnectionString `json:"connectionStrings,omitempty"`
}
DatabaseAccountListKeysResult the access keys for the given database account.
type DatabaseAccountListKeysResult struct {
autorest.Response `json:"-"`
// PrimaryMasterKey - READ-ONLY; Base 64 encoded value of the primary read-write key.
PrimaryMasterKey *string `json:"primaryMasterKey,omitempty"`
// SecondaryMasterKey - READ-ONLY; Base 64 encoded value of the secondary read-write key.
SecondaryMasterKey *string `json:"secondaryMasterKey,omitempty"`
// PrimaryReadonlyMasterKey - READ-ONLY; Base 64 encoded value of the primary read-only key.
PrimaryReadonlyMasterKey *string `json:"primaryReadonlyMasterKey,omitempty"`
// SecondaryReadonlyMasterKey - READ-ONLY; Base 64 encoded value of the secondary read-only key.
SecondaryReadonlyMasterKey *string `json:"secondaryReadonlyMasterKey,omitempty"`
}
func (dalkr DatabaseAccountListKeysResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DatabaseAccountListKeysResult.
DatabaseAccountListReadOnlyKeysResult the read-only access keys for the given database account.
type DatabaseAccountListReadOnlyKeysResult struct {
autorest.Response `json:"-"`
// PrimaryReadonlyMasterKey - READ-ONLY; Base 64 encoded value of the primary read-only key.
PrimaryReadonlyMasterKey *string `json:"primaryReadonlyMasterKey,omitempty"`
// SecondaryReadonlyMasterKey - READ-ONLY; Base 64 encoded value of the secondary read-only key.
SecondaryReadonlyMasterKey *string `json:"secondaryReadonlyMasterKey,omitempty"`
}
func (dalrokr DatabaseAccountListReadOnlyKeysResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DatabaseAccountListReadOnlyKeysResult.
DatabaseAccountOfferType enumerates the values for database account offer type.
type DatabaseAccountOfferType string
const (
// Standard ...
Standard DatabaseAccountOfferType = "Standard"
)
func PossibleDatabaseAccountOfferTypeValues() []DatabaseAccountOfferType
PossibleDatabaseAccountOfferTypeValues returns an array of possible values for the DatabaseAccountOfferType const type.
DatabaseAccountRegenerateKeyParameters parameters to regenerate the keys within the database account.
type DatabaseAccountRegenerateKeyParameters struct {
// KeyKind - The access key to regenerate. Possible values include: 'Primary', 'Secondary', 'PrimaryReadonly', 'SecondaryReadonly'
KeyKind KeyKind `json:"keyKind,omitempty"`
}
DatabaseAccountRegionClient is the azure Cosmos DB Database Service Resource Provider REST API
type DatabaseAccountRegionClient struct {
BaseClient
}
func NewDatabaseAccountRegionClient(subscriptionID string) DatabaseAccountRegionClient
NewDatabaseAccountRegionClient creates an instance of the DatabaseAccountRegionClient client.
func NewDatabaseAccountRegionClientWithBaseURI(baseURI string, subscriptionID string) DatabaseAccountRegionClient
NewDatabaseAccountRegionClientWithBaseURI creates an instance of the DatabaseAccountRegionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client DatabaseAccountRegionClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, region string, filter string) (result MetricListResult, err error)
ListMetrics retrieves the metrics determined by the given filter for the given database account and region. Parameters: resourceGroupName - 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 (client DatabaseAccountRegionClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, region string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client DatabaseAccountRegionClient) ListMetricsResponder(resp *http.Response) (result MetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.
func (client DatabaseAccountRegionClient) ListMetricsSender(req *http.Request) (*http.Response, error)
ListMetricsSender sends the ListMetrics request. The method will close the http.Response Body if it receives an error.
DatabaseAccountUpdateParameters parameters for patching Azure Cosmos DB database account properties.
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"`
Identity *ManagedServiceIdentity `json:"identity,omitempty"`
*DatabaseAccountUpdateProperties `json:"properties,omitempty"`
}
func (daup DatabaseAccountUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DatabaseAccountUpdateParameters.
func (daup *DatabaseAccountUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DatabaseAccountUpdateParameters struct.
DatabaseAccountUpdateProperties properties to update Azure Cosmos DB database accounts.
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"`
// DefaultIdentity - The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
DefaultIdentity *string `json:"defaultIdentity,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"`
// NetworkACLBypass - Indicates what services are allowed to bypass firewall checks. Possible values include: 'NetworkACLBypassNone', 'NetworkACLBypassAzureServices'
NetworkACLBypass NetworkACLBypass `json:"networkAclBypass,omitempty"`
// NetworkACLBypassResourceIds - An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
NetworkACLBypassResourceIds *[]string `json:"networkAclBypassResourceIds,omitempty"`
}
func (daup *DatabaseAccountUpdateProperties) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DatabaseAccountUpdateProperties struct.
DatabaseAccountsClient is the azure Cosmos DB Database Service Resource Provider REST API
type DatabaseAccountsClient struct {
BaseClient
}
func NewDatabaseAccountsClient(subscriptionID string) DatabaseAccountsClient
NewDatabaseAccountsClient creates an instance of the DatabaseAccountsClient client.
func NewDatabaseAccountsClientWithBaseURI(baseURI string, subscriptionID string) DatabaseAccountsClient
NewDatabaseAccountsClientWithBaseURI creates an instance of the DatabaseAccountsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client DatabaseAccountsClient) CheckNameExists(ctx context.Context, accountName string) (result autorest.Response, err error)
CheckNameExists checks that the Azure Cosmos DB account name already exists. A valid account name may contain only lowercase letters, numbers, and the '-' character, and must be between 3 and 50 characters. Parameters: accountName - cosmos DB database account name.
func (client DatabaseAccountsClient) CheckNameExistsPreparer(ctx context.Context, accountName string) (*http.Request, error)
CheckNameExistsPreparer prepares the CheckNameExists request.
func (client DatabaseAccountsClient) CheckNameExistsResponder(resp *http.Response) (result autorest.Response, err error)
CheckNameExistsResponder handles the response to the CheckNameExists request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) CheckNameExistsSender(req *http.Request) (*http.Response, error)
CheckNameExistsSender sends the CheckNameExists request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, createUpdateParameters DatabaseAccountCreateUpdateParameters) (result DatabaseAccountsCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates an Azure Cosmos DB database account. The "Update" method is preferred when performing updates on an account. Parameters: resourceGroupName - 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 (client DatabaseAccountsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, createUpdateParameters DatabaseAccountCreateUpdateParameters) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client DatabaseAccountsClient) CreateOrUpdateResponder(resp *http.Response) (result DatabaseAccountGetResults, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) CreateOrUpdateSender(req *http.Request) (future DatabaseAccountsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) Delete(ctx context.Context, resourceGroupName string, accountName string) (result DatabaseAccountsDeleteFuture, err error)
Delete deletes an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client DatabaseAccountsClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client DatabaseAccountsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) DeleteSender(req *http.Request) (future DatabaseAccountsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) FailoverPriorityChange(ctx context.Context, resourceGroupName string, accountName string, failoverParameters FailoverPolicies) (result DatabaseAccountsFailoverPriorityChangeFuture, err error)
FailoverPriorityChange changes the failover priority for the Azure Cosmos DB database account. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists. Parameters: resourceGroupName - 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 (client DatabaseAccountsClient) FailoverPriorityChangePreparer(ctx context.Context, resourceGroupName string, accountName string, failoverParameters FailoverPolicies) (*http.Request, error)
FailoverPriorityChangePreparer prepares the FailoverPriorityChange request.
func (client DatabaseAccountsClient) FailoverPriorityChangeResponder(resp *http.Response) (result autorest.Response, err error)
FailoverPriorityChangeResponder handles the response to the FailoverPriorityChange request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) FailoverPriorityChangeSender(req *http.Request) (future DatabaseAccountsFailoverPriorityChangeFuture, err error)
FailoverPriorityChangeSender sends the FailoverPriorityChange request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) Get(ctx context.Context, resourceGroupName string, accountName string) (result DatabaseAccountGetResults, err error)
Get retrieves the properties of an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client DatabaseAccountsClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client DatabaseAccountsClient) GetReadOnlyKeys(ctx context.Context, resourceGroupName string, accountName string) (result DatabaseAccountListReadOnlyKeysResult, err error)
GetReadOnlyKeys lists the read-only access keys for the specified Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client DatabaseAccountsClient) GetReadOnlyKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
GetReadOnlyKeysPreparer prepares the GetReadOnlyKeys request.
func (client DatabaseAccountsClient) GetReadOnlyKeysResponder(resp *http.Response) (result DatabaseAccountListReadOnlyKeysResult, err error)
GetReadOnlyKeysResponder handles the response to the GetReadOnlyKeys request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) GetReadOnlyKeysSender(req *http.Request) (*http.Response, error)
GetReadOnlyKeysSender sends the GetReadOnlyKeys request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) GetResponder(resp *http.Response) (result DatabaseAccountGetResults, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
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 (client DatabaseAccountsClient) List(ctx context.Context) (result DatabaseAccountsListResult, err error)
List lists all the Azure Cosmos DB database accounts available under the subscription.
func (client DatabaseAccountsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result DatabaseAccountsListResult, err error)
ListByResourceGroup lists all the Azure Cosmos DB database accounts available under the given resource group. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive.
func (client DatabaseAccountsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client DatabaseAccountsClient) ListByResourceGroupResponder(resp *http.Response) (result DatabaseAccountsListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) ListConnectionStrings(ctx context.Context, resourceGroupName string, accountName string) (result DatabaseAccountListConnectionStringsResult, err error)
ListConnectionStrings lists the connection strings for the specified Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client DatabaseAccountsClient) ListConnectionStringsPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListConnectionStringsPreparer prepares the ListConnectionStrings request.
func (client DatabaseAccountsClient) ListConnectionStringsResponder(resp *http.Response) (result DatabaseAccountListConnectionStringsResult, err error)
ListConnectionStringsResponder handles the response to the ListConnectionStrings request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) ListConnectionStringsSender(req *http.Request) (*http.Response, error)
ListConnectionStringsSender sends the ListConnectionStrings request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) ListKeys(ctx context.Context, resourceGroupName string, accountName string) (result DatabaseAccountListKeysResult, err error)
ListKeys lists the access keys for the specified Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client DatabaseAccountsClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListKeysPreparer prepares the ListKeys request.
func (client DatabaseAccountsClient) ListKeysResponder(resp *http.Response) (result DatabaseAccountListKeysResult, err error)
ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.
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 (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 (client DatabaseAccountsClient) ListMetricDefinitionsPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListMetricDefinitionsPreparer prepares the ListMetricDefinitions request.
func (client DatabaseAccountsClient) ListMetricDefinitionsResponder(resp *http.Response) (result MetricDefinitionsListResult, err error)
ListMetricDefinitionsResponder handles the response to the ListMetricDefinitions request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) ListMetricDefinitionsSender(req *http.Request) (*http.Response, error)
ListMetricDefinitionsSender sends the ListMetricDefinitions request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, filter string) (result MetricListResult, err error)
ListMetrics retrieves the metrics determined by the given filter for the given database account. Parameters: resourceGroupName - 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 (client DatabaseAccountsClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client DatabaseAccountsClient) ListMetricsResponder(resp *http.Response) (result MetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.
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 (client DatabaseAccountsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client DatabaseAccountsClient) ListReadOnlyKeys(ctx context.Context, resourceGroupName string, accountName string) (result DatabaseAccountListReadOnlyKeysResult, err error)
ListReadOnlyKeys lists the read-only access keys for the specified Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client DatabaseAccountsClient) ListReadOnlyKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListReadOnlyKeysPreparer prepares the ListReadOnlyKeys request.
func (client DatabaseAccountsClient) ListReadOnlyKeysResponder(resp *http.Response) (result DatabaseAccountListReadOnlyKeysResult, err error)
ListReadOnlyKeysResponder handles the response to the ListReadOnlyKeys request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) ListReadOnlyKeysSender(req *http.Request) (*http.Response, error)
ListReadOnlyKeysSender sends the ListReadOnlyKeys request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) ListResponder(resp *http.Response) (result DatabaseAccountsListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
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 (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 (client DatabaseAccountsClient) ListUsagesPreparer(ctx context.Context, resourceGroupName string, accountName string, filter string) (*http.Request, error)
ListUsagesPreparer prepares the ListUsages request.
func (client DatabaseAccountsClient) ListUsagesResponder(resp *http.Response) (result UsagesResult, err error)
ListUsagesResponder handles the response to the ListUsages request. The method always closes the http.Response Body.
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 (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 (client DatabaseAccountsClient) OfflineRegionPreparer(ctx context.Context, resourceGroupName string, accountName string, regionParameterForOffline RegionForOnlineOffline) (*http.Request, error)
OfflineRegionPreparer prepares the OfflineRegion request.
func (client DatabaseAccountsClient) OfflineRegionResponder(resp *http.Response) (result autorest.Response, err error)
OfflineRegionResponder handles the response to the OfflineRegion request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) OfflineRegionSender(req *http.Request) (future DatabaseAccountsOfflineRegionFuture, err error)
OfflineRegionSender sends the OfflineRegion request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) OnlineRegion(ctx context.Context, resourceGroupName string, accountName string, regionParameterForOnline RegionForOnlineOffline) (result DatabaseAccountsOnlineRegionFuture, err error)
OnlineRegion online the specified region for the specified Azure Cosmos DB database account. Parameters: resourceGroupName - 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 (client DatabaseAccountsClient) OnlineRegionPreparer(ctx context.Context, resourceGroupName string, accountName string, regionParameterForOnline RegionForOnlineOffline) (*http.Request, error)
OnlineRegionPreparer prepares the OnlineRegion request.
func (client DatabaseAccountsClient) OnlineRegionResponder(resp *http.Response) (result autorest.Response, err error)
OnlineRegionResponder handles the response to the OnlineRegion request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) OnlineRegionSender(req *http.Request) (future DatabaseAccountsOnlineRegionFuture, err error)
OnlineRegionSender sends the OnlineRegion request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) RegenerateKey(ctx context.Context, resourceGroupName string, accountName string, keyToRegenerate DatabaseAccountRegenerateKeyParameters) (result DatabaseAccountsRegenerateKeyFuture, err error)
RegenerateKey regenerates an access key for the specified Azure Cosmos DB database account. Parameters: resourceGroupName - 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 (client DatabaseAccountsClient) RegenerateKeyPreparer(ctx context.Context, resourceGroupName string, accountName string, keyToRegenerate DatabaseAccountRegenerateKeyParameters) (*http.Request, error)
RegenerateKeyPreparer prepares the RegenerateKey request.
func (client DatabaseAccountsClient) RegenerateKeyResponder(resp *http.Response) (result autorest.Response, err error)
RegenerateKeyResponder handles the response to the RegenerateKey request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) RegenerateKeySender(req *http.Request) (future DatabaseAccountsRegenerateKeyFuture, err error)
RegenerateKeySender sends the RegenerateKey request. The method will close the http.Response Body if it receives an error.
func (client DatabaseAccountsClient) Update(ctx context.Context, resourceGroupName string, accountName string, updateParameters DatabaseAccountUpdateParameters) (result DatabaseAccountsUpdateFuture, err error)
Update updates the properties of an existing Azure Cosmos DB database account. Parameters: resourceGroupName - 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 (client DatabaseAccountsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, updateParameters DatabaseAccountUpdateParameters) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client DatabaseAccountsClient) UpdateResponder(resp *http.Response) (result DatabaseAccountGetResults, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client DatabaseAccountsClient) UpdateSender(req *http.Request) (future DatabaseAccountsUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
DatabaseAccountsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabaseAccountsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabaseAccountsClient) (DatabaseAccountGetResults, error)
}
func (future *DatabaseAccountsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DatabaseAccountsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabaseAccountsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabaseAccountsClient) (autorest.Response, error)
}
func (future *DatabaseAccountsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DatabaseAccountsFailoverPriorityChangeFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabaseAccountsFailoverPriorityChangeFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabaseAccountsClient) (autorest.Response, error)
}
func (future *DatabaseAccountsFailoverPriorityChangeFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DatabaseAccountsListResult the List operation response, that contains the database accounts and their properties.
type DatabaseAccountsListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of database account and their properties.
Value *[]DatabaseAccountGetResults `json:"value,omitempty"`
}
func (dalr DatabaseAccountsListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DatabaseAccountsListResult.
DatabaseAccountsOfflineRegionFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabaseAccountsOfflineRegionFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabaseAccountsClient) (autorest.Response, error)
}
func (future *DatabaseAccountsOfflineRegionFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DatabaseAccountsOnlineRegionFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabaseAccountsOnlineRegionFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabaseAccountsClient) (autorest.Response, error)
}
func (future *DatabaseAccountsOnlineRegionFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DatabaseAccountsRegenerateKeyFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabaseAccountsRegenerateKeyFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabaseAccountsClient) (autorest.Response, error)
}
func (future *DatabaseAccountsRegenerateKeyFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DatabaseAccountsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DatabaseAccountsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DatabaseAccountsClient) (DatabaseAccountGetResults, error)
}
func (future *DatabaseAccountsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DatabaseClient is the azure Cosmos DB Database Service Resource Provider REST API
type DatabaseClient struct {
BaseClient
}
func NewDatabaseClient(subscriptionID string) DatabaseClient
NewDatabaseClient creates an instance of the DatabaseClient client.
func NewDatabaseClientWithBaseURI(baseURI string, subscriptionID string) DatabaseClient
NewDatabaseClientWithBaseURI creates an instance of the DatabaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client DatabaseClient) ListMetricDefinitions(ctx context.Context, resourceGroupName string, accountName string, databaseRid string) (result MetricDefinitionsListResult, err error)
ListMetricDefinitions retrieves metric definitions for the given database. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseRid - cosmos DB database rid.
func (client DatabaseClient) ListMetricDefinitionsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string) (*http.Request, error)
ListMetricDefinitionsPreparer prepares the ListMetricDefinitions request.
func (client DatabaseClient) ListMetricDefinitionsResponder(resp *http.Response) (result MetricDefinitionsListResult, err error)
ListMetricDefinitionsResponder handles the response to the ListMetricDefinitions request. The method always closes the http.Response Body.
func (client DatabaseClient) ListMetricDefinitionsSender(req *http.Request) (*http.Response, error)
ListMetricDefinitionsSender sends the ListMetricDefinitions request. The method will close the http.Response Body if it receives an error.
func (client DatabaseClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, filter string) (result MetricListResult, err error)
ListMetrics retrieves the metrics determined by the given filter for the given database account and database. Parameters: resourceGroupName - 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 (client DatabaseClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client DatabaseClient) ListMetricsResponder(resp *http.Response) (result MetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.
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 (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 (client DatabaseClient) ListUsagesPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, filter string) (*http.Request, error)
ListUsagesPreparer prepares the ListUsages request.
func (client DatabaseClient) ListUsagesResponder(resp *http.Response) (result UsagesResult, err error)
ListUsagesResponder handles the response to the ListUsages request. The method always closes the http.Response Body.
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.
DefaultConsistencyLevel enumerates the values for default consistency level.
type DefaultConsistencyLevel string
const (
// BoundedStaleness ...
BoundedStaleness DefaultConsistencyLevel = "BoundedStaleness"
// ConsistentPrefix ...
ConsistentPrefix DefaultConsistencyLevel = "ConsistentPrefix"
// Eventual ...
Eventual DefaultConsistencyLevel = "Eventual"
// Session ...
Session DefaultConsistencyLevel = "Session"
// Strong ...
Strong DefaultConsistencyLevel = "Strong"
)
func PossibleDefaultConsistencyLevelValues() []DefaultConsistencyLevel
PossibleDefaultConsistencyLevelValues returns an array of possible values for the DefaultConsistencyLevel const type.
ErrorResponse error Response.
type ErrorResponse struct {
// Code - Error code.
Code *string `json:"code,omitempty"`
// Message - Error message indicating why the operation failed.
Message *string `json:"message,omitempty"`
}
ErrorResponseUpdatedFormat an error response from the service.
type ErrorResponseUpdatedFormat struct {
Error *ErrorResponse `json:"error,omitempty"`
}
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"`
}
ExtendedResourceProperties the system generated resource properties associated with SQL databases, SQL containers, Gremlin databases and Gremlin graphs.
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 *float64 `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}
func (erp ExtendedResourceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ExtendedResourceProperties.
FailoverPolicies the list of new failover policies for the failover priority change.
type FailoverPolicies struct {
// FailoverPolicies - List of failover policies.
FailoverPolicies *[]FailoverPolicy `json:"failoverPolicies,omitempty"`
}
FailoverPolicy the failover policy for a given region of a database account.
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"`
}
func (fp FailoverPolicy) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for FailoverPolicy.
GremlinDatabaseCreateUpdateParameters parameters to create and update Cosmos DB Gremlin database.
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"`
}
func (gdcup GremlinDatabaseCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GremlinDatabaseCreateUpdateParameters.
func (gdcup *GremlinDatabaseCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GremlinDatabaseCreateUpdateParameters struct.
GremlinDatabaseCreateUpdateProperties properties to create and update Azure Cosmos DB Gremlin database.
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"`
}
GremlinDatabaseGetProperties the properties of an Azure Cosmos DB SQL database
type GremlinDatabaseGetProperties struct {
Resource *GremlinDatabaseGetPropertiesResource `json:"resource,omitempty"`
Options *GremlinDatabaseGetPropertiesOptions `json:"options,omitempty"`
}
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"`
}
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 *float64 `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}
func (gdgp GremlinDatabaseGetPropertiesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GremlinDatabaseGetPropertiesResource.
GremlinDatabaseGetResults an Azure Cosmos DB Gremlin database.
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"`
}
func (gdgr GremlinDatabaseGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GremlinDatabaseGetResults.
func (gdgr *GremlinDatabaseGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GremlinDatabaseGetResults struct.
GremlinDatabaseListResult the List operation response, that contains the Gremlin databases and their properties.
type GremlinDatabaseListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of Gremlin databases and their properties.
Value *[]GremlinDatabaseGetResults `json:"value,omitempty"`
}
func (gdlr GremlinDatabaseListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GremlinDatabaseListResult.
GremlinDatabaseResource cosmos DB Gremlin database resource object
type GremlinDatabaseResource struct {
// ID - Name of the Cosmos DB Gremlin database
ID *string `json:"id,omitempty"`
}
GremlinGraphCreateUpdateParameters parameters to create and update Cosmos DB Gremlin graph.
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"`
}
func (ggcup GremlinGraphCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GremlinGraphCreateUpdateParameters.
func (ggcup *GremlinGraphCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GremlinGraphCreateUpdateParameters struct.
GremlinGraphCreateUpdateProperties properties to create and update Azure Cosmos DB Gremlin graph.
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"`
}
GremlinGraphGetProperties the properties of an Azure Cosmos DB Gremlin graph
type GremlinGraphGetProperties struct {
Resource *GremlinGraphGetPropertiesResource `json:"resource,omitempty"`
Options *GremlinGraphGetPropertiesOptions `json:"options,omitempty"`
}
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"`
}
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 *float64 `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}
func (gggp GremlinGraphGetPropertiesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GremlinGraphGetPropertiesResource.
GremlinGraphGetResults an Azure Cosmos DB Gremlin graph.
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"`
}
func (gggr GremlinGraphGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GremlinGraphGetResults.
func (gggr *GremlinGraphGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GremlinGraphGetResults struct.
GremlinGraphListResult the List operation response, that contains the graphs and their properties.
type GremlinGraphListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of graphs and their properties.
Value *[]GremlinGraphGetResults `json:"value,omitempty"`
}
func (gglr GremlinGraphListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GremlinGraphListResult.
GremlinGraphResource cosmos DB Gremlin graph resource object
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"`
}
GremlinResourcesClient is the azure Cosmos DB Database Service Resource Provider REST API
type GremlinResourcesClient struct {
BaseClient
}
func NewGremlinResourcesClient(subscriptionID string) GremlinResourcesClient
NewGremlinResourcesClient creates an instance of the GremlinResourcesClient client.
func NewGremlinResourcesClientWithBaseURI(baseURI string, subscriptionID string) GremlinResourcesClient
NewGremlinResourcesClientWithBaseURI creates an instance of the GremlinResourcesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client GremlinResourcesClient) CreateUpdateGremlinDatabase(ctx context.Context, resourceGroupName string, accountName string, databaseName string, createUpdateGremlinDatabaseParameters GremlinDatabaseCreateUpdateParameters) (result GremlinResourcesCreateUpdateGremlinDatabaseFuture, err error)
CreateUpdateGremlinDatabase create or update an Azure Cosmos DB Gremlin database Parameters: resourceGroupName - 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 (client GremlinResourcesClient) CreateUpdateGremlinDatabasePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, createUpdateGremlinDatabaseParameters GremlinDatabaseCreateUpdateParameters) (*http.Request, error)
CreateUpdateGremlinDatabasePreparer prepares the CreateUpdateGremlinDatabase request.
func (client GremlinResourcesClient) CreateUpdateGremlinDatabaseResponder(resp *http.Response) (result GremlinDatabaseGetResults, err error)
CreateUpdateGremlinDatabaseResponder handles the response to the CreateUpdateGremlinDatabase request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) CreateUpdateGremlinDatabaseSender(req *http.Request) (future GremlinResourcesCreateUpdateGremlinDatabaseFuture, err error)
CreateUpdateGremlinDatabaseSender sends the CreateUpdateGremlinDatabase request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) CreateUpdateGremlinGraph(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string, createUpdateGremlinGraphParameters GremlinGraphCreateUpdateParameters) (result GremlinResourcesCreateUpdateGremlinGraphFuture, err error)
CreateUpdateGremlinGraph create or update an Azure Cosmos DB Gremlin graph Parameters: resourceGroupName - 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 (client GremlinResourcesClient) CreateUpdateGremlinGraphPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string, createUpdateGremlinGraphParameters GremlinGraphCreateUpdateParameters) (*http.Request, error)
CreateUpdateGremlinGraphPreparer prepares the CreateUpdateGremlinGraph request.
func (client GremlinResourcesClient) CreateUpdateGremlinGraphResponder(resp *http.Response) (result GremlinGraphGetResults, err error)
CreateUpdateGremlinGraphResponder handles the response to the CreateUpdateGremlinGraph request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) CreateUpdateGremlinGraphSender(req *http.Request) (future GremlinResourcesCreateUpdateGremlinGraphFuture, err error)
CreateUpdateGremlinGraphSender sends the CreateUpdateGremlinGraph request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) DeleteGremlinDatabase(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result GremlinResourcesDeleteGremlinDatabaseFuture, err error)
DeleteGremlinDatabase deletes an existing Azure Cosmos DB Gremlin database. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name.
func (client GremlinResourcesClient) DeleteGremlinDatabasePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
DeleteGremlinDatabasePreparer prepares the DeleteGremlinDatabase request.
func (client GremlinResourcesClient) DeleteGremlinDatabaseResponder(resp *http.Response) (result autorest.Response, err error)
DeleteGremlinDatabaseResponder handles the response to the DeleteGremlinDatabase request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) DeleteGremlinDatabaseSender(req *http.Request) (future GremlinResourcesDeleteGremlinDatabaseFuture, err error)
DeleteGremlinDatabaseSender sends the DeleteGremlinDatabase request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) DeleteGremlinGraph(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string) (result GremlinResourcesDeleteGremlinGraphFuture, err error)
DeleteGremlinGraph deletes an existing Azure Cosmos DB Gremlin graph. Parameters: resourceGroupName - 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 (client GremlinResourcesClient) DeleteGremlinGraphPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string) (*http.Request, error)
DeleteGremlinGraphPreparer prepares the DeleteGremlinGraph request.
func (client GremlinResourcesClient) DeleteGremlinGraphResponder(resp *http.Response) (result autorest.Response, err error)
DeleteGremlinGraphResponder handles the response to the DeleteGremlinGraph request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) DeleteGremlinGraphSender(req *http.Request) (future GremlinResourcesDeleteGremlinGraphFuture, err error)
DeleteGremlinGraphSender sends the DeleteGremlinGraph request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) GetGremlinDatabase(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result GremlinDatabaseGetResults, err error)
GetGremlinDatabase gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name.
func (client GremlinResourcesClient) GetGremlinDatabasePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
GetGremlinDatabasePreparer prepares the GetGremlinDatabase request.
func (client GremlinResourcesClient) GetGremlinDatabaseResponder(resp *http.Response) (result GremlinDatabaseGetResults, err error)
GetGremlinDatabaseResponder handles the response to the GetGremlinDatabase request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) GetGremlinDatabaseSender(req *http.Request) (*http.Response, error)
GetGremlinDatabaseSender sends the GetGremlinDatabase request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) GetGremlinDatabaseThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result ThroughputSettingsGetResults, err error)
GetGremlinDatabaseThroughput gets the RUs per second of the Gremlin database under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name.
func (client GremlinResourcesClient) GetGremlinDatabaseThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
GetGremlinDatabaseThroughputPreparer prepares the GetGremlinDatabaseThroughput request.
func (client GremlinResourcesClient) GetGremlinDatabaseThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
GetGremlinDatabaseThroughputResponder handles the response to the GetGremlinDatabaseThroughput request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) GetGremlinDatabaseThroughputSender(req *http.Request) (*http.Response, error)
GetGremlinDatabaseThroughputSender sends the GetGremlinDatabaseThroughput request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) GetGremlinGraph(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string) (result GremlinGraphGetResults, err error)
GetGremlinGraph gets the Gremlin graph under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - 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 (client GremlinResourcesClient) GetGremlinGraphPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string) (*http.Request, error)
GetGremlinGraphPreparer prepares the GetGremlinGraph request.
func (client GremlinResourcesClient) GetGremlinGraphResponder(resp *http.Response) (result GremlinGraphGetResults, err error)
GetGremlinGraphResponder handles the response to the GetGremlinGraph request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) GetGremlinGraphSender(req *http.Request) (*http.Response, error)
GetGremlinGraphSender sends the GetGremlinGraph request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) GetGremlinGraphThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string) (result ThroughputSettingsGetResults, err error)
GetGremlinGraphThroughput gets the Gremlin graph throughput under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - 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 (client GremlinResourcesClient) GetGremlinGraphThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string) (*http.Request, error)
GetGremlinGraphThroughputPreparer prepares the GetGremlinGraphThroughput request.
func (client GremlinResourcesClient) GetGremlinGraphThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
GetGremlinGraphThroughputResponder handles the response to the GetGremlinGraphThroughput request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) GetGremlinGraphThroughputSender(req *http.Request) (*http.Response, error)
GetGremlinGraphThroughputSender sends the GetGremlinGraphThroughput request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) ListGremlinDatabases(ctx context.Context, resourceGroupName string, accountName string) (result GremlinDatabaseListResult, err error)
ListGremlinDatabases lists the Gremlin databases under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client GremlinResourcesClient) ListGremlinDatabasesPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListGremlinDatabasesPreparer prepares the ListGremlinDatabases request.
func (client GremlinResourcesClient) ListGremlinDatabasesResponder(resp *http.Response) (result GremlinDatabaseListResult, err error)
ListGremlinDatabasesResponder handles the response to the ListGremlinDatabases request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) ListGremlinDatabasesSender(req *http.Request) (*http.Response, error)
ListGremlinDatabasesSender sends the ListGremlinDatabases request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) ListGremlinGraphs(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result GremlinGraphListResult, err error)
ListGremlinGraphs lists the Gremlin graph under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name.
func (client GremlinResourcesClient) ListGremlinGraphsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
ListGremlinGraphsPreparer prepares the ListGremlinGraphs request.
func (client GremlinResourcesClient) ListGremlinGraphsResponder(resp *http.Response) (result GremlinGraphListResult, err error)
ListGremlinGraphsResponder handles the response to the ListGremlinGraphs request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) ListGremlinGraphsSender(req *http.Request) (*http.Response, error)
ListGremlinGraphsSender sends the ListGremlinGraphs request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) MigrateGremlinDatabaseToAutoscale(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result GremlinResourcesMigrateGremlinDatabaseToAutoscaleFuture, err error)
MigrateGremlinDatabaseToAutoscale migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale 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 (client GremlinResourcesClient) MigrateGremlinDatabaseToAutoscalePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
MigrateGremlinDatabaseToAutoscalePreparer prepares the MigrateGremlinDatabaseToAutoscale request.
func (client GremlinResourcesClient) MigrateGremlinDatabaseToAutoscaleResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
MigrateGremlinDatabaseToAutoscaleResponder handles the response to the MigrateGremlinDatabaseToAutoscale request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) MigrateGremlinDatabaseToAutoscaleSender(req *http.Request) (future GremlinResourcesMigrateGremlinDatabaseToAutoscaleFuture, err error)
MigrateGremlinDatabaseToAutoscaleSender sends the MigrateGremlinDatabaseToAutoscale request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) MigrateGremlinDatabaseToManualThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result GremlinResourcesMigrateGremlinDatabaseToManualThroughputFuture, err error)
MigrateGremlinDatabaseToManualThroughput migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput 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 (client GremlinResourcesClient) MigrateGremlinDatabaseToManualThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
MigrateGremlinDatabaseToManualThroughputPreparer prepares the MigrateGremlinDatabaseToManualThroughput request.
func (client GremlinResourcesClient) MigrateGremlinDatabaseToManualThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
MigrateGremlinDatabaseToManualThroughputResponder handles the response to the MigrateGremlinDatabaseToManualThroughput request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) MigrateGremlinDatabaseToManualThroughputSender(req *http.Request) (future GremlinResourcesMigrateGremlinDatabaseToManualThroughputFuture, err error)
MigrateGremlinDatabaseToManualThroughputSender sends the MigrateGremlinDatabaseToManualThroughput request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) MigrateGremlinGraphToAutoscale(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string) (result GremlinResourcesMigrateGremlinGraphToAutoscaleFuture, err error)
MigrateGremlinGraphToAutoscale migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale 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 (client GremlinResourcesClient) MigrateGremlinGraphToAutoscalePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string) (*http.Request, error)
MigrateGremlinGraphToAutoscalePreparer prepares the MigrateGremlinGraphToAutoscale request.
func (client GremlinResourcesClient) MigrateGremlinGraphToAutoscaleResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
MigrateGremlinGraphToAutoscaleResponder handles the response to the MigrateGremlinGraphToAutoscale request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) MigrateGremlinGraphToAutoscaleSender(req *http.Request) (future GremlinResourcesMigrateGremlinGraphToAutoscaleFuture, err error)
MigrateGremlinGraphToAutoscaleSender sends the MigrateGremlinGraphToAutoscale request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) MigrateGremlinGraphToManualThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string) (result GremlinResourcesMigrateGremlinGraphToManualThroughputFuture, err error)
MigrateGremlinGraphToManualThroughput migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput 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 (client GremlinResourcesClient) MigrateGremlinGraphToManualThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string) (*http.Request, error)
MigrateGremlinGraphToManualThroughputPreparer prepares the MigrateGremlinGraphToManualThroughput request.
func (client GremlinResourcesClient) MigrateGremlinGraphToManualThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
MigrateGremlinGraphToManualThroughputResponder handles the response to the MigrateGremlinGraphToManualThroughput request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) MigrateGremlinGraphToManualThroughputSender(req *http.Request) (future GremlinResourcesMigrateGremlinGraphToManualThroughputFuture, err error)
MigrateGremlinGraphToManualThroughputSender sends the MigrateGremlinGraphToManualThroughput request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) UpdateGremlinDatabaseThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (result GremlinResourcesUpdateGremlinDatabaseThroughputFuture, err error)
UpdateGremlinDatabaseThroughput update RUs per second of an Azure Cosmos DB Gremlin database Parameters: resourceGroupName - 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 (client GremlinResourcesClient) UpdateGremlinDatabaseThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)
UpdateGremlinDatabaseThroughputPreparer prepares the UpdateGremlinDatabaseThroughput request.
func (client GremlinResourcesClient) UpdateGremlinDatabaseThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
UpdateGremlinDatabaseThroughputResponder handles the response to the UpdateGremlinDatabaseThroughput request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) UpdateGremlinDatabaseThroughputSender(req *http.Request) (future GremlinResourcesUpdateGremlinDatabaseThroughputFuture, err error)
UpdateGremlinDatabaseThroughputSender sends the UpdateGremlinDatabaseThroughput request. The method will close the http.Response Body if it receives an error.
func (client GremlinResourcesClient) UpdateGremlinGraphThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (result GremlinResourcesUpdateGremlinGraphThroughputFuture, err error)
UpdateGremlinGraphThroughput update RUs per second of an Azure Cosmos DB Gremlin graph Parameters: resourceGroupName - 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 (client GremlinResourcesClient) UpdateGremlinGraphThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, graphName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)
UpdateGremlinGraphThroughputPreparer prepares the UpdateGremlinGraphThroughput request.
func (client GremlinResourcesClient) UpdateGremlinGraphThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
UpdateGremlinGraphThroughputResponder handles the response to the UpdateGremlinGraphThroughput request. The method always closes the http.Response Body.
func (client GremlinResourcesClient) UpdateGremlinGraphThroughputSender(req *http.Request) (future GremlinResourcesUpdateGremlinGraphThroughputFuture, err error)
UpdateGremlinGraphThroughputSender sends the UpdateGremlinGraphThroughput request. The method will close the http.Response Body if it receives an error.
GremlinResourcesCreateUpdateGremlinDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GremlinResourcesCreateUpdateGremlinDatabaseFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GremlinResourcesClient) (GremlinDatabaseGetResults, error)
}
func (future *GremlinResourcesCreateUpdateGremlinDatabaseFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GremlinResourcesCreateUpdateGremlinGraphFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GremlinResourcesCreateUpdateGremlinGraphFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GremlinResourcesClient) (GremlinGraphGetResults, error)
}
func (future *GremlinResourcesCreateUpdateGremlinGraphFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GremlinResourcesDeleteGremlinDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GremlinResourcesDeleteGremlinDatabaseFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GremlinResourcesClient) (autorest.Response, error)
}
func (future *GremlinResourcesDeleteGremlinDatabaseFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GremlinResourcesDeleteGremlinGraphFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GremlinResourcesDeleteGremlinGraphFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GremlinResourcesClient) (autorest.Response, error)
}
func (future *GremlinResourcesDeleteGremlinGraphFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GremlinResourcesMigrateGremlinDatabaseToAutoscaleFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GremlinResourcesMigrateGremlinDatabaseToAutoscaleFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GremlinResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *GremlinResourcesMigrateGremlinDatabaseToAutoscaleFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GremlinResourcesMigrateGremlinDatabaseToManualThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GremlinResourcesMigrateGremlinDatabaseToManualThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GremlinResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *GremlinResourcesMigrateGremlinDatabaseToManualThroughputFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GremlinResourcesMigrateGremlinGraphToAutoscaleFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GremlinResourcesMigrateGremlinGraphToAutoscaleFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GremlinResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *GremlinResourcesMigrateGremlinGraphToAutoscaleFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GremlinResourcesMigrateGremlinGraphToManualThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GremlinResourcesMigrateGremlinGraphToManualThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GremlinResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *GremlinResourcesMigrateGremlinGraphToManualThroughputFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GremlinResourcesUpdateGremlinDatabaseThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GremlinResourcesUpdateGremlinDatabaseThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GremlinResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *GremlinResourcesUpdateGremlinDatabaseThroughputFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
GremlinResourcesUpdateGremlinGraphThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GremlinResourcesUpdateGremlinGraphThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GremlinResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *GremlinResourcesUpdateGremlinGraphThroughputFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
IPAddressOrRange ipAddressOrRange object
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"`
}
IncludedPath the paths that are included in indexing
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"`
}
IndexKind enumerates the values for index kind.
type IndexKind string
const (
// Hash ...
Hash IndexKind = "Hash"
// Range ...
Range IndexKind = "Range"
// Spatial ...
Spatial IndexKind = "Spatial"
)
func PossibleIndexKindValues() []IndexKind
PossibleIndexKindValues returns an array of possible values for the IndexKind const type.
Indexes the indexes for the path.
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"`
}
IndexingMode enumerates the values for indexing mode.
type IndexingMode string
const (
// Consistent ...
Consistent IndexingMode = "consistent"
// Lazy ...
Lazy IndexingMode = "lazy"
// None ...
None IndexingMode = "none"
)
func PossibleIndexingModeValues() []IndexingMode
PossibleIndexingModeValues returns an array of possible values for the IndexingMode const type.
IndexingPolicy cosmos DB indexing policy
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"`
}
KeyKind enumerates the values for key kind.
type KeyKind string
const (
// Primary ...
Primary KeyKind = "primary"
// PrimaryReadonly ...
PrimaryReadonly KeyKind = "primaryReadonly"
// Secondary ...
Secondary KeyKind = "secondary"
// SecondaryReadonly ...
SecondaryReadonly KeyKind = "secondaryReadonly"
)
func PossibleKeyKindValues() []KeyKind
PossibleKeyKindValues returns an array of possible values for the KeyKind const type.
Location a region in which the Azure Cosmos DB database account is deployed.
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"`
}
func (l Location) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Location.
ManagedServiceIdentity identity for the resource.
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"`
}
func (msi ManagedServiceIdentity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ManagedServiceIdentity.
ManagedServiceIdentityUserAssignedIdentitiesValue ...
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"`
}
func (msiAiv ManagedServiceIdentityUserAssignedIdentitiesValue) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ManagedServiceIdentityUserAssignedIdentitiesValue.
Metric metric data
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"`
}
func (mVar Metric) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Metric.
MetricAvailability the availability of the metric.
type MetricAvailability struct {
// TimeGrain - READ-ONLY; The time grain to be used to summarize the metric values.
TimeGrain *string `json:"timeGrain,omitempty"`
// Retention - READ-ONLY; The retention for the metric values.
Retention *string `json:"retention,omitempty"`
}
func (ma MetricAvailability) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MetricAvailability.
MetricDefinition the definition of a metric.
type MetricDefinition struct {
// MetricAvailabilities - READ-ONLY; The list of metric availabilities for the account.
MetricAvailabilities *[]MetricAvailability `json:"metricAvailabilities,omitempty"`
// PrimaryAggregationType - READ-ONLY; The primary aggregation type of the metric. Possible values include: 'PrimaryAggregationTypeNone', 'PrimaryAggregationTypeAverage', 'PrimaryAggregationTypeTotal', 'PrimaryAggregationTypeMinimum', 'PrimaryAggregationTypeMaximum', 'PrimaryAggregationTypeLast'
PrimaryAggregationType PrimaryAggregationType `json:"primaryAggregationType,omitempty"`
// Unit - The unit of the metric. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond', 'Milliseconds'
Unit UnitType `json:"unit,omitempty"`
// ResourceURI - READ-ONLY; The resource uri of the database.
ResourceURI *string `json:"resourceUri,omitempty"`
// Name - READ-ONLY; The name information for the metric.
Name *MetricName `json:"name,omitempty"`
}
func (md MetricDefinition) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MetricDefinition.
MetricDefinitionsListResult the response to a list metric definitions request.
type MetricDefinitionsListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; The list of metric definitions for the account.
Value *[]MetricDefinition `json:"value,omitempty"`
}
func (mdlr MetricDefinitionsListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MetricDefinitionsListResult.
MetricListResult the response to a list metrics request.
type MetricListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; The list of metrics for the account.
Value *[]Metric `json:"value,omitempty"`
}
func (mlr MetricListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MetricListResult.
MetricName a metric name.
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"`
}
func (mn MetricName) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MetricName.
MetricValue represents metrics values.
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"`
}
func (mv MetricValue) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MetricValue.
MongoDBCollectionCreateUpdateParameters parameters to create and update Cosmos DB MongoDB collection.
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"`
}
func (mdccup MongoDBCollectionCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MongoDBCollectionCreateUpdateParameters.
func (mdccup *MongoDBCollectionCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for MongoDBCollectionCreateUpdateParameters struct.
MongoDBCollectionCreateUpdateProperties properties to create and update Azure Cosmos DB MongoDB collection.
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"`
}
MongoDBCollectionGetProperties the properties of an Azure Cosmos DB MongoDB collection
type MongoDBCollectionGetProperties struct {
Resource *MongoDBCollectionGetPropertiesResource `json:"resource,omitempty"`
Options *MongoDBCollectionGetPropertiesOptions `json:"options,omitempty"`
}
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"`
}
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 *float64 `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}
func (mdcgp MongoDBCollectionGetPropertiesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MongoDBCollectionGetPropertiesResource.
MongoDBCollectionGetResults an Azure Cosmos DB MongoDB collection.
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"`
}
func (mdcgr MongoDBCollectionGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MongoDBCollectionGetResults.
func (mdcgr *MongoDBCollectionGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for MongoDBCollectionGetResults struct.
MongoDBCollectionListResult the List operation response, that contains the MongoDB collections and their properties.
type MongoDBCollectionListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of MongoDB collections and their properties.
Value *[]MongoDBCollectionGetResults `json:"value,omitempty"`
}
func (mdclr MongoDBCollectionListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MongoDBCollectionListResult.
MongoDBCollectionResource cosmos DB MongoDB collection resource object
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"`
}
func (mdcr MongoDBCollectionResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MongoDBCollectionResource.
MongoDBDatabaseCreateUpdateParameters parameters to create and update Cosmos DB MongoDB database.
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"`
}
func (mddcup MongoDBDatabaseCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MongoDBDatabaseCreateUpdateParameters.
func (mddcup *MongoDBDatabaseCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for MongoDBDatabaseCreateUpdateParameters struct.
MongoDBDatabaseCreateUpdateProperties properties to create and update Azure Cosmos DB MongoDB database.
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"`
}
MongoDBDatabaseGetProperties the properties of an Azure Cosmos DB MongoDB database
type MongoDBDatabaseGetProperties struct {
Resource *MongoDBDatabaseGetPropertiesResource `json:"resource,omitempty"`
Options *MongoDBDatabaseGetPropertiesOptions `json:"options,omitempty"`
}
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"`
}
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 *float64 `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}
func (mddgp MongoDBDatabaseGetPropertiesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MongoDBDatabaseGetPropertiesResource.
MongoDBDatabaseGetResults an Azure Cosmos DB MongoDB database.
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"`
}
func (mddgr MongoDBDatabaseGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MongoDBDatabaseGetResults.
func (mddgr *MongoDBDatabaseGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for MongoDBDatabaseGetResults struct.
MongoDBDatabaseListResult the List operation response, that contains the MongoDB databases and their properties.
type MongoDBDatabaseListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of MongoDB databases and their properties.
Value *[]MongoDBDatabaseGetResults `json:"value,omitempty"`
}
func (mddlr MongoDBDatabaseListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for MongoDBDatabaseListResult.
MongoDBDatabaseResource cosmos DB MongoDB database resource object
type MongoDBDatabaseResource struct {
// ID - Name of the Cosmos DB MongoDB database
ID *string `json:"id,omitempty"`
}
MongoDBResourcesClient is the azure Cosmos DB Database Service Resource Provider REST API
type MongoDBResourcesClient struct {
BaseClient
}
func NewMongoDBResourcesClient(subscriptionID string) MongoDBResourcesClient
NewMongoDBResourcesClient creates an instance of the MongoDBResourcesClient client.
func NewMongoDBResourcesClientWithBaseURI(baseURI string, subscriptionID string) MongoDBResourcesClient
NewMongoDBResourcesClientWithBaseURI creates an instance of the MongoDBResourcesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client MongoDBResourcesClient) CreateUpdateMongoDBCollection(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string, createUpdateMongoDBCollectionParameters MongoDBCollectionCreateUpdateParameters) (result MongoDBResourcesCreateUpdateMongoDBCollectionFuture, err error)
CreateUpdateMongoDBCollection create or update an Azure Cosmos DB MongoDB Collection Parameters: resourceGroupName - 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 (client MongoDBResourcesClient) CreateUpdateMongoDBCollectionPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string, createUpdateMongoDBCollectionParameters MongoDBCollectionCreateUpdateParameters) (*http.Request, error)
CreateUpdateMongoDBCollectionPreparer prepares the CreateUpdateMongoDBCollection request.
func (client MongoDBResourcesClient) CreateUpdateMongoDBCollectionResponder(resp *http.Response) (result MongoDBCollectionGetResults, err error)
CreateUpdateMongoDBCollectionResponder handles the response to the CreateUpdateMongoDBCollection request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) CreateUpdateMongoDBCollectionSender(req *http.Request) (future MongoDBResourcesCreateUpdateMongoDBCollectionFuture, err error)
CreateUpdateMongoDBCollectionSender sends the CreateUpdateMongoDBCollection request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) CreateUpdateMongoDBDatabase(ctx context.Context, resourceGroupName string, accountName string, databaseName string, createUpdateMongoDBDatabaseParameters MongoDBDatabaseCreateUpdateParameters) (result MongoDBResourcesCreateUpdateMongoDBDatabaseFuture, err error)
CreateUpdateMongoDBDatabase create or updates Azure Cosmos DB MongoDB database Parameters: resourceGroupName - 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 (client MongoDBResourcesClient) CreateUpdateMongoDBDatabasePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, createUpdateMongoDBDatabaseParameters MongoDBDatabaseCreateUpdateParameters) (*http.Request, error)
CreateUpdateMongoDBDatabasePreparer prepares the CreateUpdateMongoDBDatabase request.
func (client MongoDBResourcesClient) CreateUpdateMongoDBDatabaseResponder(resp *http.Response) (result MongoDBDatabaseGetResults, err error)
CreateUpdateMongoDBDatabaseResponder handles the response to the CreateUpdateMongoDBDatabase request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) CreateUpdateMongoDBDatabaseSender(req *http.Request) (future MongoDBResourcesCreateUpdateMongoDBDatabaseFuture, err error)
CreateUpdateMongoDBDatabaseSender sends the CreateUpdateMongoDBDatabase request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) DeleteMongoDBCollection(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (result MongoDBResourcesDeleteMongoDBCollectionFuture, err error)
DeleteMongoDBCollection deletes an existing Azure Cosmos DB MongoDB Collection. Parameters: resourceGroupName - 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 (client MongoDBResourcesClient) DeleteMongoDBCollectionPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (*http.Request, error)
DeleteMongoDBCollectionPreparer prepares the DeleteMongoDBCollection request.
func (client MongoDBResourcesClient) DeleteMongoDBCollectionResponder(resp *http.Response) (result autorest.Response, err error)
DeleteMongoDBCollectionResponder handles the response to the DeleteMongoDBCollection request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) DeleteMongoDBCollectionSender(req *http.Request) (future MongoDBResourcesDeleteMongoDBCollectionFuture, err error)
DeleteMongoDBCollectionSender sends the DeleteMongoDBCollection request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) DeleteMongoDBDatabase(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result MongoDBResourcesDeleteMongoDBDatabaseFuture, err error)
DeleteMongoDBDatabase deletes an existing Azure Cosmos DB MongoDB database. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name.
func (client MongoDBResourcesClient) DeleteMongoDBDatabasePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
DeleteMongoDBDatabasePreparer prepares the DeleteMongoDBDatabase request.
func (client MongoDBResourcesClient) DeleteMongoDBDatabaseResponder(resp *http.Response) (result autorest.Response, err error)
DeleteMongoDBDatabaseResponder handles the response to the DeleteMongoDBDatabase request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) DeleteMongoDBDatabaseSender(req *http.Request) (future MongoDBResourcesDeleteMongoDBDatabaseFuture, err error)
DeleteMongoDBDatabaseSender sends the DeleteMongoDBDatabase request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) GetMongoDBCollection(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (result MongoDBCollectionGetResults, err error)
GetMongoDBCollection gets the MongoDB collection under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - 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 (client MongoDBResourcesClient) GetMongoDBCollectionPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (*http.Request, error)
GetMongoDBCollectionPreparer prepares the GetMongoDBCollection request.
func (client MongoDBResourcesClient) GetMongoDBCollectionResponder(resp *http.Response) (result MongoDBCollectionGetResults, err error)
GetMongoDBCollectionResponder handles the response to the GetMongoDBCollection request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) GetMongoDBCollectionSender(req *http.Request) (*http.Response, error)
GetMongoDBCollectionSender sends the GetMongoDBCollection request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) GetMongoDBCollectionThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (result ThroughputSettingsGetResults, err error)
GetMongoDBCollectionThroughput gets the RUs per second of the MongoDB collection under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - 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 (client MongoDBResourcesClient) GetMongoDBCollectionThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (*http.Request, error)
GetMongoDBCollectionThroughputPreparer prepares the GetMongoDBCollectionThroughput request.
func (client MongoDBResourcesClient) GetMongoDBCollectionThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
GetMongoDBCollectionThroughputResponder handles the response to the GetMongoDBCollectionThroughput request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) GetMongoDBCollectionThroughputSender(req *http.Request) (*http.Response, error)
GetMongoDBCollectionThroughputSender sends the GetMongoDBCollectionThroughput request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) GetMongoDBDatabase(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result MongoDBDatabaseGetResults, err error)
GetMongoDBDatabase gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name.
func (client MongoDBResourcesClient) GetMongoDBDatabasePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
GetMongoDBDatabasePreparer prepares the GetMongoDBDatabase request.
func (client MongoDBResourcesClient) GetMongoDBDatabaseResponder(resp *http.Response) (result MongoDBDatabaseGetResults, err error)
GetMongoDBDatabaseResponder handles the response to the GetMongoDBDatabase request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) GetMongoDBDatabaseSender(req *http.Request) (*http.Response, error)
GetMongoDBDatabaseSender sends the GetMongoDBDatabase request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) GetMongoDBDatabaseThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result ThroughputSettingsGetResults, err error)
GetMongoDBDatabaseThroughput gets the RUs per second of the MongoDB database under an existing Azure Cosmos DB database account with the provided name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name.
func (client MongoDBResourcesClient) GetMongoDBDatabaseThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
GetMongoDBDatabaseThroughputPreparer prepares the GetMongoDBDatabaseThroughput request.
func (client MongoDBResourcesClient) GetMongoDBDatabaseThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
GetMongoDBDatabaseThroughputResponder handles the response to the GetMongoDBDatabaseThroughput request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) GetMongoDBDatabaseThroughputSender(req *http.Request) (*http.Response, error)
GetMongoDBDatabaseThroughputSender sends the GetMongoDBDatabaseThroughput request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) ListMongoDBCollections(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result MongoDBCollectionListResult, err error)
ListMongoDBCollections lists the MongoDB collection under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. databaseName - cosmos DB database name.
func (client MongoDBResourcesClient) ListMongoDBCollectionsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
ListMongoDBCollectionsPreparer prepares the ListMongoDBCollections request.
func (client MongoDBResourcesClient) ListMongoDBCollectionsResponder(resp *http.Response) (result MongoDBCollectionListResult, err error)
ListMongoDBCollectionsResponder handles the response to the ListMongoDBCollections request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) ListMongoDBCollectionsSender(req *http.Request) (*http.Response, error)
ListMongoDBCollectionsSender sends the ListMongoDBCollections request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) ListMongoDBDatabases(ctx context.Context, resourceGroupName string, accountName string) (result MongoDBDatabaseListResult, err error)
ListMongoDBDatabases lists the MongoDB databases under an existing Azure Cosmos DB database account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client MongoDBResourcesClient) ListMongoDBDatabasesPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListMongoDBDatabasesPreparer prepares the ListMongoDBDatabases request.
func (client MongoDBResourcesClient) ListMongoDBDatabasesResponder(resp *http.Response) (result MongoDBDatabaseListResult, err error)
ListMongoDBDatabasesResponder handles the response to the ListMongoDBDatabases request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) ListMongoDBDatabasesSender(req *http.Request) (*http.Response, error)
ListMongoDBDatabasesSender sends the ListMongoDBDatabases request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) MigrateMongoDBCollectionToAutoscale(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (result MongoDBResourcesMigrateMongoDBCollectionToAutoscaleFuture, err error)
MigrateMongoDBCollectionToAutoscale migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale 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 (client MongoDBResourcesClient) MigrateMongoDBCollectionToAutoscalePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (*http.Request, error)
MigrateMongoDBCollectionToAutoscalePreparer prepares the MigrateMongoDBCollectionToAutoscale request.
func (client MongoDBResourcesClient) MigrateMongoDBCollectionToAutoscaleResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
MigrateMongoDBCollectionToAutoscaleResponder handles the response to the MigrateMongoDBCollectionToAutoscale request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) MigrateMongoDBCollectionToAutoscaleSender(req *http.Request) (future MongoDBResourcesMigrateMongoDBCollectionToAutoscaleFuture, err error)
MigrateMongoDBCollectionToAutoscaleSender sends the MigrateMongoDBCollectionToAutoscale request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) MigrateMongoDBCollectionToManualThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (result MongoDBResourcesMigrateMongoDBCollectionToManualThroughputFuture, err error)
MigrateMongoDBCollectionToManualThroughput migrate an Azure Cosmos DB MongoDB collection from autoscale to manual throughput 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 (client MongoDBResourcesClient) MigrateMongoDBCollectionToManualThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string) (*http.Request, error)
MigrateMongoDBCollectionToManualThroughputPreparer prepares the MigrateMongoDBCollectionToManualThroughput request.
func (client MongoDBResourcesClient) MigrateMongoDBCollectionToManualThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
MigrateMongoDBCollectionToManualThroughputResponder handles the response to the MigrateMongoDBCollectionToManualThroughput request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) MigrateMongoDBCollectionToManualThroughputSender(req *http.Request) (future MongoDBResourcesMigrateMongoDBCollectionToManualThroughputFuture, err error)
MigrateMongoDBCollectionToManualThroughputSender sends the MigrateMongoDBCollectionToManualThroughput request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) MigrateMongoDBDatabaseToAutoscale(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleFuture, err error)
MigrateMongoDBDatabaseToAutoscale migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale 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 (client MongoDBResourcesClient) MigrateMongoDBDatabaseToAutoscalePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
MigrateMongoDBDatabaseToAutoscalePreparer prepares the MigrateMongoDBDatabaseToAutoscale request.
func (client MongoDBResourcesClient) MigrateMongoDBDatabaseToAutoscaleResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
MigrateMongoDBDatabaseToAutoscaleResponder handles the response to the MigrateMongoDBDatabaseToAutoscale request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) MigrateMongoDBDatabaseToAutoscaleSender(req *http.Request) (future MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleFuture, err error)
MigrateMongoDBDatabaseToAutoscaleSender sends the MigrateMongoDBDatabaseToAutoscale request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) MigrateMongoDBDatabaseToManualThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputFuture, err error)
MigrateMongoDBDatabaseToManualThroughput migrate an Azure Cosmos DB MongoDB database from autoscale to manual throughput 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 (client MongoDBResourcesClient) MigrateMongoDBDatabaseToManualThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
MigrateMongoDBDatabaseToManualThroughputPreparer prepares the MigrateMongoDBDatabaseToManualThroughput request.
func (client MongoDBResourcesClient) MigrateMongoDBDatabaseToManualThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
MigrateMongoDBDatabaseToManualThroughputResponder handles the response to the MigrateMongoDBDatabaseToManualThroughput request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) MigrateMongoDBDatabaseToManualThroughputSender(req *http.Request) (future MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputFuture, err error)
MigrateMongoDBDatabaseToManualThroughputSender sends the MigrateMongoDBDatabaseToManualThroughput request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) UpdateMongoDBCollectionThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (result MongoDBResourcesUpdateMongoDBCollectionThroughputFuture, err error)
UpdateMongoDBCollectionThroughput update the RUs per second of an Azure Cosmos DB MongoDB collection Parameters: resourceGroupName - 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 (client MongoDBResourcesClient) UpdateMongoDBCollectionThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, collectionName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)
UpdateMongoDBCollectionThroughputPreparer prepares the UpdateMongoDBCollectionThroughput request.
func (client MongoDBResourcesClient) UpdateMongoDBCollectionThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
UpdateMongoDBCollectionThroughputResponder handles the response to the UpdateMongoDBCollectionThroughput request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) UpdateMongoDBCollectionThroughputSender(req *http.Request) (future MongoDBResourcesUpdateMongoDBCollectionThroughputFuture, err error)
UpdateMongoDBCollectionThroughputSender sends the UpdateMongoDBCollectionThroughput request. The method will close the http.Response Body if it receives an error.
func (client MongoDBResourcesClient) UpdateMongoDBDatabaseThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (result MongoDBResourcesUpdateMongoDBDatabaseThroughputFuture, err error)
UpdateMongoDBDatabaseThroughput update RUs per second of the an Azure Cosmos DB MongoDB database Parameters: resourceGroupName - 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 (client MongoDBResourcesClient) UpdateMongoDBDatabaseThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)
UpdateMongoDBDatabaseThroughputPreparer prepares the UpdateMongoDBDatabaseThroughput request.
func (client MongoDBResourcesClient) UpdateMongoDBDatabaseThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
UpdateMongoDBDatabaseThroughputResponder handles the response to the UpdateMongoDBDatabaseThroughput request. The method always closes the http.Response Body.
func (client MongoDBResourcesClient) UpdateMongoDBDatabaseThroughputSender(req *http.Request) (future MongoDBResourcesUpdateMongoDBDatabaseThroughputFuture, err error)
UpdateMongoDBDatabaseThroughputSender sends the UpdateMongoDBDatabaseThroughput request. The method will close the http.Response Body if it receives an error.
MongoDBResourcesCreateUpdateMongoDBCollectionFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type MongoDBResourcesCreateUpdateMongoDBCollectionFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(MongoDBResourcesClient) (MongoDBCollectionGetResults, error)
}
func (future *MongoDBResourcesCreateUpdateMongoDBCollectionFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
MongoDBResourcesCreateUpdateMongoDBDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type MongoDBResourcesCreateUpdateMongoDBDatabaseFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(MongoDBResourcesClient) (MongoDBDatabaseGetResults, error)
}
func (future *MongoDBResourcesCreateUpdateMongoDBDatabaseFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
MongoDBResourcesDeleteMongoDBCollectionFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type MongoDBResourcesDeleteMongoDBCollectionFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(MongoDBResourcesClient) (autorest.Response, error)
}
func (future *MongoDBResourcesDeleteMongoDBCollectionFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
MongoDBResourcesDeleteMongoDBDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type MongoDBResourcesDeleteMongoDBDatabaseFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(MongoDBResourcesClient) (autorest.Response, error)
}
func (future *MongoDBResourcesDeleteMongoDBDatabaseFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
MongoDBResourcesMigrateMongoDBCollectionToAutoscaleFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type MongoDBResourcesMigrateMongoDBCollectionToAutoscaleFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(MongoDBResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *MongoDBResourcesMigrateMongoDBCollectionToAutoscaleFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
MongoDBResourcesMigrateMongoDBCollectionToManualThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type MongoDBResourcesMigrateMongoDBCollectionToManualThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(MongoDBResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *MongoDBResourcesMigrateMongoDBCollectionToManualThroughputFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(MongoDBResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(MongoDBResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
MongoDBResourcesUpdateMongoDBCollectionThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type MongoDBResourcesUpdateMongoDBCollectionThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(MongoDBResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *MongoDBResourcesUpdateMongoDBCollectionThroughputFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
MongoDBResourcesUpdateMongoDBDatabaseThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type MongoDBResourcesUpdateMongoDBDatabaseThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(MongoDBResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *MongoDBResourcesUpdateMongoDBDatabaseThroughputFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
MongoIndex cosmos DB MongoDB collection index key
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"`
}
MongoIndexKeys cosmos DB MongoDB collection resource object
type MongoIndexKeys struct {
// Keys - List of keys for each MongoDB collection in the Azure Cosmos DB service
Keys *[]string `json:"keys,omitempty"`
}
MongoIndexOptions cosmos DB MongoDB collection index options
type MongoIndexOptions struct {
// ExpireAfterSeconds - Expire after seconds
ExpireAfterSeconds *int32 `json:"expireAfterSeconds,omitempty"`
// Unique - Is unique or not
Unique *bool `json:"unique,omitempty"`
}
NetworkACLBypass enumerates the values for network acl bypass.
type NetworkACLBypass string
const (
// NetworkACLBypassAzureServices ...
NetworkACLBypassAzureServices NetworkACLBypass = "AzureServices"
// NetworkACLBypassNone ...
NetworkACLBypassNone NetworkACLBypass = "None"
)
func PossibleNetworkACLBypassValues() []NetworkACLBypass
PossibleNetworkACLBypassValues returns an array of possible values for the NetworkACLBypass const type.
NotebookWorkspace a notebook workspace resource
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"`
}
func (nw NotebookWorkspace) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for NotebookWorkspace.
func (nw *NotebookWorkspace) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for NotebookWorkspace struct.
NotebookWorkspaceConnectionInfoResult the connection info for the given notebook workspace
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"`
}
func (nwcir NotebookWorkspaceConnectionInfoResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for NotebookWorkspaceConnectionInfoResult.
NotebookWorkspaceCreateUpdateParameters parameters to create a notebook workspace resource
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"`
}
func (nwcup NotebookWorkspaceCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for NotebookWorkspaceCreateUpdateParameters.
NotebookWorkspaceListResult a list of notebook workspace resources
type NotebookWorkspaceListResult struct {
autorest.Response `json:"-"`
// Value - Array of notebook workspace resources
Value *[]NotebookWorkspace `json:"value,omitempty"`
}
NotebookWorkspaceProperties properties of a notebook workspace resource.
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"`
}
func (nwp NotebookWorkspaceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for NotebookWorkspaceProperties.
NotebookWorkspacesClient is the azure Cosmos DB Database Service Resource Provider REST API
type NotebookWorkspacesClient struct {
BaseClient
}
func NewNotebookWorkspacesClient(subscriptionID string) NotebookWorkspacesClient
NewNotebookWorkspacesClient creates an instance of the NotebookWorkspacesClient client.
func NewNotebookWorkspacesClientWithBaseURI(baseURI string, subscriptionID string) NotebookWorkspacesClient
NewNotebookWorkspacesClientWithBaseURI creates an instance of the NotebookWorkspacesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client NotebookWorkspacesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, notebookCreateUpdateParameters NotebookWorkspaceCreateUpdateParameters) (result NotebookWorkspacesCreateOrUpdateFuture, err error)
CreateOrUpdate creates the notebook workspace for a Cosmos DB account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name. notebookCreateUpdateParameters - the notebook workspace to create for the current database account.
func (client NotebookWorkspacesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, notebookCreateUpdateParameters NotebookWorkspaceCreateUpdateParameters) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client NotebookWorkspacesClient) CreateOrUpdateResponder(resp *http.Response) (result NotebookWorkspace, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client NotebookWorkspacesClient) CreateOrUpdateSender(req *http.Request) (future NotebookWorkspacesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client NotebookWorkspacesClient) Delete(ctx context.Context, resourceGroupName string, accountName string) (result NotebookWorkspacesDeleteFuture, err error)
Delete deletes the notebook workspace for a Cosmos DB account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client NotebookWorkspacesClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client NotebookWorkspacesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client NotebookWorkspacesClient) DeleteSender(req *http.Request) (future NotebookWorkspacesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client NotebookWorkspacesClient) Get(ctx context.Context, resourceGroupName string, accountName string) (result NotebookWorkspace, err error)
Get gets the notebook workspace for a Cosmos DB account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client NotebookWorkspacesClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client NotebookWorkspacesClient) GetResponder(resp *http.Response) (result NotebookWorkspace, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
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 (client NotebookWorkspacesClient) ListByDatabaseAccount(ctx context.Context, resourceGroupName string, accountName string) (result NotebookWorkspaceListResult, err error)
ListByDatabaseAccount gets the notebook workspace resources of an existing Cosmos DB account. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client NotebookWorkspacesClient) ListByDatabaseAccountPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListByDatabaseAccountPreparer prepares the ListByDatabaseAccount request.
func (client NotebookWorkspacesClient) ListByDatabaseAccountResponder(resp *http.Response) (result NotebookWorkspaceListResult, err error)
ListByDatabaseAccountResponder handles the response to the ListByDatabaseAccount request. The method always closes the http.Response Body.
func (client NotebookWorkspacesClient) ListByDatabaseAccountSender(req *http.Request) (*http.Response, error)
ListByDatabaseAccountSender sends the ListByDatabaseAccount request. The method will close the http.Response Body if it receives an error.
func (client NotebookWorkspacesClient) ListConnectionInfo(ctx context.Context, resourceGroupName string, accountName string) (result NotebookWorkspaceConnectionInfoResult, err error)
ListConnectionInfo retrieves the connection info for the notebook workspace Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client NotebookWorkspacesClient) ListConnectionInfoPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListConnectionInfoPreparer prepares the ListConnectionInfo request.
func (client NotebookWorkspacesClient) ListConnectionInfoResponder(resp *http.Response) (result NotebookWorkspaceConnectionInfoResult, err error)
ListConnectionInfoResponder handles the response to the ListConnectionInfo request. The method always closes the http.Response Body.
func (client NotebookWorkspacesClient) ListConnectionInfoSender(req *http.Request) (*http.Response, error)
ListConnectionInfoSender sends the ListConnectionInfo request. The method will close the http.Response Body if it receives an error.
func (client NotebookWorkspacesClient) RegenerateAuthToken(ctx context.Context, resourceGroupName string, accountName string) (result NotebookWorkspacesRegenerateAuthTokenFuture, err error)
RegenerateAuthToken regenerates the auth token for the notebook workspace Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client NotebookWorkspacesClient) RegenerateAuthTokenPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
RegenerateAuthTokenPreparer prepares the RegenerateAuthToken request.
func (client NotebookWorkspacesClient) RegenerateAuthTokenResponder(resp *http.Response) (result autorest.Response, err error)
RegenerateAuthTokenResponder handles the response to the RegenerateAuthToken request. The method always closes the http.Response Body.
func (client NotebookWorkspacesClient) RegenerateAuthTokenSender(req *http.Request) (future NotebookWorkspacesRegenerateAuthTokenFuture, err error)
RegenerateAuthTokenSender sends the RegenerateAuthToken request. The method will close the http.Response Body if it receives an error.
func (client NotebookWorkspacesClient) Start(ctx context.Context, resourceGroupName string, accountName string) (result NotebookWorkspacesStartFuture, err error)
Start starts the notebook workspace Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. accountName - cosmos DB database account name.
func (client NotebookWorkspacesClient) StartPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
StartPreparer prepares the Start request.
func (client NotebookWorkspacesClient) StartResponder(resp *http.Response) (result autorest.Response, err error)
StartResponder handles the response to the Start request. The method always closes the http.Response Body.
func (client NotebookWorkspacesClient) StartSender(req *http.Request) (future NotebookWorkspacesStartFuture, err error)
StartSender sends the Start request. The method will close the http.Response Body if it receives an error.
NotebookWorkspacesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type NotebookWorkspacesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(NotebookWorkspacesClient) (NotebookWorkspace, error)
}
func (future *NotebookWorkspacesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
NotebookWorkspacesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type NotebookWorkspacesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(NotebookWorkspacesClient) (autorest.Response, error)
}
func (future *NotebookWorkspacesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
NotebookWorkspacesRegenerateAuthTokenFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type NotebookWorkspacesRegenerateAuthTokenFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(NotebookWorkspacesClient) (autorest.Response, error)
}
func (future *NotebookWorkspacesRegenerateAuthTokenFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
NotebookWorkspacesStartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type NotebookWorkspacesStartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(NotebookWorkspacesClient) (autorest.Response, error)
}
func (future *NotebookWorkspacesStartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
Operation REST API 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"`
}
OperationDisplay the object that represents the operation.
type OperationDisplay struct {
// Provider - Service provider: Microsoft.ResourceProvider
Provider *string `json:"Provider,omitempty"`
// Resource - Resource on which the operation is performed: Profile, endpoint, etc.
Resource *string `json:"Resource,omitempty"`
// Operation - Operation type: Read, write, delete, etc.
Operation *string `json:"Operation,omitempty"`
// Description - Description of operation
Description *string `json:"Description,omitempty"`
}
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.
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"`
}
func (olr OperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
OperationListResultIterator provides access to a complete listing of Operation values.
type OperationListResultIterator struct {
// contains filtered or unexported fields
}
func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator
Creates a new instance of the OperationListResultIterator type.
func (iter *OperationListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter OperationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OperationListResultIterator) Response() OperationListResult
Response returns the raw server response from the last page request.
func (iter OperationListResultIterator) Value() Operation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
OperationListResultPage contains a page of Operation values.
type OperationListResultPage struct {
// contains filtered or unexported fields
}
func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage
Creates a new instance of the OperationListResultPage type.
func (page *OperationListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page OperationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OperationListResultPage) Response() OperationListResult
Response returns the raw server response from the last page request.
func (page OperationListResultPage) Values() []Operation
Values returns the slice of values for the current page or nil if there are no values.
OperationsClient is the azure Cosmos DB Database Service Resource Provider REST API
type OperationsClient struct {
BaseClient
}
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
List lists all of the available Cosmos DB Resource Provider operations.
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
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.
OptionsResource cosmos DB options resource object
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"`
}
PartitionKeyRangeIDClient is the azure Cosmos DB Database Service Resource Provider REST API
type PartitionKeyRangeIDClient struct {
BaseClient
}
func NewPartitionKeyRangeIDClient(subscriptionID string) PartitionKeyRangeIDClient
NewPartitionKeyRangeIDClient creates an instance of the PartitionKeyRangeIDClient client.
func NewPartitionKeyRangeIDClientWithBaseURI(baseURI string, subscriptionID string) PartitionKeyRangeIDClient
NewPartitionKeyRangeIDClientWithBaseURI creates an instance of the PartitionKeyRangeIDClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client PartitionKeyRangeIDClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, partitionKeyRangeID string, filter string) (result PartitionMetricListResult, err error)
ListMetrics retrieves the metrics determined by the given filter for the given partition key range id. Parameters: resourceGroupName - 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 (client PartitionKeyRangeIDClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseRid string, collectionRid string, partitionKeyRangeID string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client PartitionKeyRangeIDClient) ListMetricsResponder(resp *http.Response) (result PartitionMetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.
func (client PartitionKeyRangeIDClient) ListMetricsSender(req *http.Request) (*http.Response, error)
ListMetricsSender sends the ListMetrics request. The method will close the http.Response Body if it receives an error.
PartitionKeyRangeIDRegionClient is the azure Cosmos DB Database Service Resource Provider REST API
type PartitionKeyRangeIDRegionClient struct {
BaseClient
}
func NewPartitionKeyRangeIDRegionClient(subscriptionID string) PartitionKeyRangeIDRegionClient
NewPartitionKeyRangeIDRegionClient creates an instance of the PartitionKeyRangeIDRegionClient client.
func NewPartitionKeyRangeIDRegionClientWithBaseURI(baseURI string, subscriptionID string) PartitionKeyRangeIDRegionClient
NewPartitionKeyRangeIDRegionClientWithBaseURI creates an instance of the PartitionKeyRangeIDRegionClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client PartitionKeyRangeIDRegionClient) ListMetrics(ctx context.Context, resourceGroupName string, accountName string, region string, databaseRid string, collectionRid string, partitionKeyRangeID string, filter string) (result PartitionMetricListResult, err error)
ListMetrics retrieves the metrics determined by the given filter for the given partition key range id and region. Parameters: resourceGroupName - 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 (client PartitionKeyRangeIDRegionClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, region string, databaseRid string, collectionRid string, partitionKeyRangeID string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
func (client PartitionKeyRangeIDRegionClient) ListMetricsResponder(resp *http.Response) (result PartitionMetricListResult, err error)
ListMetricsResponder handles the response to the ListMetrics request. The method always closes the http.Response Body.
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.
PartitionKind enumerates the values for partition kind.
type PartitionKind string
const (
// PartitionKindHash ...
PartitionKindHash PartitionKind = "Hash"
// PartitionKindMultiHash ...
PartitionKindMultiHash PartitionKind = "MultiHash"
// PartitionKindRange ...
PartitionKindRange PartitionKind = "Range"
)
func PossiblePartitionKindValues() []PartitionKind
PossiblePartitionKindValues returns an array of possible values for the PartitionKind const type.
PartitionMetric the metric values for a single partition.
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"`
}
func (pm PartitionMetric) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PartitionMetric.
PartitionMetricListResult the response to a list partition metrics request.
type PartitionMetricListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; The list of partition-level metrics for the account.
Value *[]PartitionMetric `json:"value,omitempty"`
}
func (pmlr PartitionMetricListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PartitionMetricListResult.
PartitionUsage the partition level usage data for a usage request.
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"`
}
func (pu PartitionUsage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PartitionUsage.
PartitionUsagesResult the response to a list partition level usage request.
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"`
}
func (pur PartitionUsagesResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PartitionUsagesResult.
PercentileClient is the azure Cosmos DB Database Service Resource Provider REST API
type PercentileClient struct {
BaseClient
}
func NewPercentileClient(subscriptionID string) PercentileClient
NewPercentileClient creates an instance of the PercentileClient client.
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 (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 (client PercentileClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
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 (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.
PercentileMetric percentile Metric data
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"`
}
func (pm PercentileMetric) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PercentileMetric.
PercentileMetricListResult the response to a list percentile metrics request.
type PercentileMetricListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; The list of percentile metrics for the account.
Value *[]PercentileMetric `json:"value,omitempty"`
}
func (pmlr PercentileMetricListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PercentileMetricListResult.
PercentileMetricValue represents percentile metrics values.
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"`
}
func (pmv PercentileMetricValue) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PercentileMetricValue.
PercentileSourceTargetClient is the azure Cosmos DB Database Service Resource Provider REST API
type PercentileSourceTargetClient struct {
BaseClient
}
func NewPercentileSourceTargetClient(subscriptionID string) PercentileSourceTargetClient
NewPercentileSourceTargetClient creates an instance of the PercentileSourceTargetClient client.
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 (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 (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 (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 (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.
PercentileTargetClient is the azure Cosmos DB Database Service Resource Provider REST API
type PercentileTargetClient struct {
BaseClient
}
func NewPercentileTargetClient(subscriptionID string) PercentileTargetClient
NewPercentileTargetClient creates an instance of the PercentileTargetClient client.
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 (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 (client PercentileTargetClient) ListMetricsPreparer(ctx context.Context, resourceGroupName string, accountName string, targetRegion string, filter string) (*http.Request, error)
ListMetricsPreparer prepares the ListMetrics request.
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 (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.
PeriodicModeBackupPolicy the object representing periodic mode backup policy.
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"`
}
func (pmbp PeriodicModeBackupPolicy) AsBackupPolicy() (*BackupPolicy, bool)
AsBackupPolicy is the BasicBackupPolicy implementation for PeriodicModeBackupPolicy.
func (pmbp PeriodicModeBackupPolicy) AsBasicBackupPolicy() (BasicBackupPolicy, bool)
AsBasicBackupPolicy is the BasicBackupPolicy implementation for PeriodicModeBackupPolicy.
func (pmbp PeriodicModeBackupPolicy) AsContinuousModeBackupPolicy() (*ContinuousModeBackupPolicy, bool)
AsContinuousModeBackupPolicy is the BasicBackupPolicy implementation for PeriodicModeBackupPolicy.
func (pmbp PeriodicModeBackupPolicy) AsPeriodicModeBackupPolicy() (*PeriodicModeBackupPolicy, bool)
AsPeriodicModeBackupPolicy is the BasicBackupPolicy implementation for PeriodicModeBackupPolicy.
func (pmbp PeriodicModeBackupPolicy) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PeriodicModeBackupPolicy.
PeriodicModeProperties configuration values for periodic mode backup
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"`
}
PrimaryAggregationType enumerates the values for primary aggregation type.
type PrimaryAggregationType string
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() []PrimaryAggregationType
PossiblePrimaryAggregationTypeValues returns an array of possible values for the PrimaryAggregationType const type.
PrivateEndpointConnection a private endpoint connection
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"`
}
func (pec PrivateEndpointConnection) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateEndpointConnection.
func (pec *PrivateEndpointConnection) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PrivateEndpointConnection struct.
PrivateEndpointConnectionListResult a list of private endpoint connections
type PrivateEndpointConnectionListResult struct {
autorest.Response `json:"-"`
// Value - Array of private endpoint connections
Value *[]PrivateEndpointConnection `json:"value,omitempty"`
}
PrivateEndpointConnectionProperties properties of a private endpoint connection.
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"`
}
PrivateEndpointConnectionsClient is the azure Cosmos DB Database Service Resource Provider REST API
type PrivateEndpointConnectionsClient struct {
BaseClient
}
func NewPrivateEndpointConnectionsClient(subscriptionID string) PrivateEndpointConnectionsClient
NewPrivateEndpointConnectionsClient creates an instance of the PrivateEndpointConnectionsClient client.
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 (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 (client PrivateEndpointConnectionsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string, parameters PrivateEndpointConnection) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
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 (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 (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 (client PrivateEndpointConnectionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client PrivateEndpointConnectionsClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (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 (client PrivateEndpointConnectionsClient) ListByDatabaseAccountPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListByDatabaseAccountPreparer prepares the ListByDatabaseAccount request.
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 (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.
PrivateEndpointConnectionsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type PrivateEndpointConnectionsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(PrivateEndpointConnectionsClient) (PrivateEndpointConnection, error)
}
func (future *PrivateEndpointConnectionsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
PrivateEndpointConnectionsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type PrivateEndpointConnectionsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(PrivateEndpointConnectionsClient) (autorest.Response, error)
}
func (future *PrivateEndpointConnectionsDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
PrivateEndpointProperty private endpoint which the connection belongs to.
type PrivateEndpointProperty struct {
// ID - Resource id of the private endpoint.
ID *string `json:"id,omitempty"`
}
PrivateLinkResource a private link resource
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"`
}
func (plr PrivateLinkResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateLinkResource.
func (plr *PrivateLinkResource) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PrivateLinkResource struct.
PrivateLinkResourceListResult a list of private link resources
type PrivateLinkResourceListResult struct {
autorest.Response `json:"-"`
// Value - Array of private link resources
Value *[]PrivateLinkResource `json:"value,omitempty"`
}
PrivateLinkResourceProperties properties of a private link resource.
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"`
}
func (plrp PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateLinkResourceProperties.
PrivateLinkResourcesClient is the azure Cosmos DB Database Service Resource Provider REST API
type PrivateLinkResourcesClient struct {
BaseClient
}
func NewPrivateLinkResourcesClient(subscriptionID string) PrivateLinkResourcesClient
NewPrivateLinkResourcesClient creates an instance of the PrivateLinkResourcesClient client.
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 (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 (client PrivateLinkResourcesClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, groupName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (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 (client PrivateLinkResourcesClient) ListByDatabaseAccountPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListByDatabaseAccountPreparer prepares the ListByDatabaseAccount request.
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 (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.
PrivateLinkServiceConnectionStateProperty connection State of the Private Endpoint Connection.
type PrivateLinkServiceConnectionStateProperty struct {
// Status - The private link service connection status.
Status *string `json:"status,omitempty"`
// Description - The private link service connection description.
Description *string `json:"description,omitempty"`
// ActionsRequired - READ-ONLY; Any action that is required beyond basic workflow (approve/ reject/ disconnect)
ActionsRequired *string `json:"actionsRequired,omitempty"`
}
func (plscsp PrivateLinkServiceConnectionStateProperty) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateLinkServiceConnectionStateProperty.
ProxyResource the resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
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"`
}
func (pr ProxyResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProxyResource.
PublicNetworkAccess enumerates the values for public network access.
type PublicNetworkAccess string
const (
// Disabled ...
Disabled PublicNetworkAccess = "Disabled"
// Enabled ...
Enabled PublicNetworkAccess = "Enabled"
)
func PossiblePublicNetworkAccessValues() []PublicNetworkAccess
PossiblePublicNetworkAccessValues returns an array of possible values for the PublicNetworkAccess const type.
RegionForOnlineOffline cosmos DB region to online or offline.
type RegionForOnlineOffline struct {
// Region - Cosmos DB region, with spaces between words and each word capitalized.
Region *string `json:"region,omitempty"`
}
Resource common fields that are returned in the response for all Azure Resource Manager resources
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"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
ResourceIdentityType enumerates the values for resource identity type.
type ResourceIdentityType string
const (
// ResourceIdentityTypeNone ...
ResourceIdentityTypeNone ResourceIdentityType = "None"
// ResourceIdentityTypeSystemAssigned ...
ResourceIdentityTypeSystemAssigned ResourceIdentityType = "SystemAssigned"
// ResourceIdentityTypeSystemAssignedUserAssigned ...
ResourceIdentityTypeSystemAssignedUserAssigned ResourceIdentityType = "SystemAssigned,UserAssigned"
// ResourceIdentityTypeUserAssigned ...
ResourceIdentityTypeUserAssigned ResourceIdentityType = "UserAssigned"
)
func PossibleResourceIdentityTypeValues() []ResourceIdentityType
PossibleResourceIdentityTypeValues returns an array of possible values for the ResourceIdentityType const type.
SQLContainerCreateUpdateParameters parameters to create and update Cosmos DB container.
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"`
}
func (sccup SQLContainerCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLContainerCreateUpdateParameters.
func (sccup *SQLContainerCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SQLContainerCreateUpdateParameters struct.
SQLContainerCreateUpdateProperties properties to create and update Azure Cosmos DB container.
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"`
}
SQLContainerGetProperties the properties of an Azure Cosmos DB container
type SQLContainerGetProperties struct {
Resource *SQLContainerGetPropertiesResource `json:"resource,omitempty"`
Options *SQLContainerGetPropertiesOptions `json:"options,omitempty"`
}
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"`
}
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"`
// AnalyticalStorageTTL - Analytical TTL.
AnalyticalStorageTTL *int64 `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 *float64 `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}
func (scgp SQLContainerGetPropertiesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLContainerGetPropertiesResource.
SQLContainerGetResults an Azure Cosmos DB container.
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"`
}
func (scgr SQLContainerGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLContainerGetResults.
func (scgr *SQLContainerGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SQLContainerGetResults struct.
SQLContainerListResult the List operation response, that contains the containers and their properties.
type SQLContainerListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of containers and their properties.
Value *[]SQLContainerGetResults `json:"value,omitempty"`
}
func (sclr SQLContainerListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLContainerListResult.
SQLContainerResource cosmos DB SQL container resource object
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"`
// AnalyticalStorageTTL - Analytical TTL.
AnalyticalStorageTTL *int64 `json:"analyticalStorageTtl,omitempty"`
}
SQLDatabaseCreateUpdateParameters parameters to create and update Cosmos DB SQL database.
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"`
}
func (sdcup SQLDatabaseCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLDatabaseCreateUpdateParameters.
func (sdcup *SQLDatabaseCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SQLDatabaseCreateUpdateParameters struct.
SQLDatabaseCreateUpdateProperties properties to create and update Azure Cosmos DB SQL database.
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"`
}
SQLDatabaseGetProperties the properties of an Azure Cosmos DB SQL database
type SQLDatabaseGetProperties struct {
Resource *SQLDatabaseGetPropertiesResource `json:"resource,omitempty"`
Options *SQLDatabaseGetPropertiesOptions `json:"options,omitempty"`
}
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"`
}
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 *float64 `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"`
}
func (sdgp SQLDatabaseGetPropertiesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLDatabaseGetPropertiesResource.
SQLDatabaseGetResults an Azure Cosmos DB SQL database.
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"`
}
func (sdgr SQLDatabaseGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLDatabaseGetResults.
func (sdgr *SQLDatabaseGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SQLDatabaseGetResults struct.
SQLDatabaseListResult the List operation response, that contains the SQL databases and their properties.
type SQLDatabaseListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of SQL databases and their properties.
Value *[]SQLDatabaseGetResults `json:"value,omitempty"`
}
func (sdlr SQLDatabaseListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLDatabaseListResult.
SQLDatabaseResource cosmos DB SQL database resource object
type SQLDatabaseResource struct {
// ID - Name of the Cosmos DB SQL database
ID *string `json:"id,omitempty"`
}
SQLResourcesClient is the azure Cosmos DB Database Service Resource Provider REST API
type SQLResourcesClient struct {
BaseClient
}
func NewSQLResourcesClient(subscriptionID string) SQLResourcesClient
NewSQLResourcesClient creates an instance of the SQLResourcesClient client.
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 (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 (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 (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 (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 (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 (client SQLResourcesClient) CreateUpdateSQLDatabasePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, createUpdateSQLDatabaseParameters SQLDatabaseCreateUpdateParameters) (*http.Request, error)
CreateUpdateSQLDatabasePreparer prepares the CreateUpdateSQLDatabase request.
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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (client SQLResourcesClient) DeleteSQLContainerPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (*http.Request, error)
DeleteSQLContainerPreparer prepares the DeleteSQLContainer request.
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 (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 (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 (client SQLResourcesClient) DeleteSQLDatabasePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
DeleteSQLDatabasePreparer prepares the DeleteSQLDatabase request.
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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (client SQLResourcesClient) GetSQLContainerPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (*http.Request, error)
GetSQLContainerPreparer prepares the GetSQLContainer request.
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 (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 (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 (client SQLResourcesClient) GetSQLContainerThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (*http.Request, error)
GetSQLContainerThroughputPreparer prepares the GetSQLContainerThroughput request.
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 (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 (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 (client SQLResourcesClient) GetSQLDatabasePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
GetSQLDatabasePreparer prepares the GetSQLDatabase request.
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 (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 (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 (client SQLResourcesClient) GetSQLDatabaseThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
GetSQLDatabaseThroughputPreparer prepares the GetSQLDatabaseThroughput request.
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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (client SQLResourcesClient) ListSQLContainersPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
ListSQLContainersPreparer prepares the ListSQLContainers request.
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 (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 (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 (client SQLResourcesClient) ListSQLDatabasesPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListSQLDatabasesPreparer prepares the ListSQLDatabases request.
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 (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 (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 (client SQLResourcesClient) ListSQLStoredProceduresPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (*http.Request, error)
ListSQLStoredProceduresPreparer prepares the ListSQLStoredProcedures request.
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 (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 (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 (client SQLResourcesClient) ListSQLTriggersPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (*http.Request, error)
ListSQLTriggersPreparer prepares the ListSQLTriggers request.
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 (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 (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 (client SQLResourcesClient) ListSQLUserDefinedFunctionsPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (*http.Request, error)
ListSQLUserDefinedFunctionsPreparer prepares the ListSQLUserDefinedFunctions request.
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 (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 (client SQLResourcesClient) MigrateSQLContainerToAutoscale(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (result SQLResourcesMigrateSQLContainerToAutoscaleFuture, err error)
MigrateSQLContainerToAutoscale migrate an Azure Cosmos DB SQL container from manual throughput to autoscale 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 (client SQLResourcesClient) MigrateSQLContainerToAutoscalePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (*http.Request, error)
MigrateSQLContainerToAutoscalePreparer prepares the MigrateSQLContainerToAutoscale request.
func (client SQLResourcesClient) MigrateSQLContainerToAutoscaleResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
MigrateSQLContainerToAutoscaleResponder handles the response to the MigrateSQLContainerToAutoscale request. The method always closes the http.Response Body.
func (client SQLResourcesClient) MigrateSQLContainerToAutoscaleSender(req *http.Request) (future SQLResourcesMigrateSQLContainerToAutoscaleFuture, err error)
MigrateSQLContainerToAutoscaleSender sends the MigrateSQLContainerToAutoscale request. The method will close the http.Response Body if it receives an error.
func (client SQLResourcesClient) MigrateSQLContainerToManualThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (result SQLResourcesMigrateSQLContainerToManualThroughputFuture, err error)
MigrateSQLContainerToManualThroughput migrate an Azure Cosmos DB SQL container from autoscale to manual throughput 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 (client SQLResourcesClient) MigrateSQLContainerToManualThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, containerName string) (*http.Request, error)
MigrateSQLContainerToManualThroughputPreparer prepares the MigrateSQLContainerToManualThroughput request.
func (client SQLResourcesClient) MigrateSQLContainerToManualThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
MigrateSQLContainerToManualThroughputResponder handles the response to the MigrateSQLContainerToManualThroughput request. The method always closes the http.Response Body.
func (client SQLResourcesClient) MigrateSQLContainerToManualThroughputSender(req *http.Request) (future SQLResourcesMigrateSQLContainerToManualThroughputFuture, err error)
MigrateSQLContainerToManualThroughputSender sends the MigrateSQLContainerToManualThroughput request. The method will close the http.Response Body if it receives an error.
func (client SQLResourcesClient) MigrateSQLDatabaseToAutoscale(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result SQLResourcesMigrateSQLDatabaseToAutoscaleFuture, err error)
MigrateSQLDatabaseToAutoscale migrate an Azure Cosmos DB SQL database from manual throughput to autoscale 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 (client SQLResourcesClient) MigrateSQLDatabaseToAutoscalePreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
MigrateSQLDatabaseToAutoscalePreparer prepares the MigrateSQLDatabaseToAutoscale request.
func (client SQLResourcesClient) MigrateSQLDatabaseToAutoscaleResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
MigrateSQLDatabaseToAutoscaleResponder handles the response to the MigrateSQLDatabaseToAutoscale request. The method always closes the http.Response Body.
func (client SQLResourcesClient) MigrateSQLDatabaseToAutoscaleSender(req *http.Request) (future SQLResourcesMigrateSQLDatabaseToAutoscaleFuture, err error)
MigrateSQLDatabaseToAutoscaleSender sends the MigrateSQLDatabaseToAutoscale request. The method will close the http.Response Body if it receives an error.
func (client SQLResourcesClient) MigrateSQLDatabaseToManualThroughput(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (result SQLResourcesMigrateSQLDatabaseToManualThroughputFuture, err error)
MigrateSQLDatabaseToManualThroughput migrate an Azure Cosmos DB SQL database from autoscale to manual throughput 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 (client SQLResourcesClient) MigrateSQLDatabaseToManualThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string) (*http.Request, error)
MigrateSQLDatabaseToManualThroughputPreparer prepares the MigrateSQLDatabaseToManualThroughput request.
func (client SQLResourcesClient) MigrateSQLDatabaseToManualThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
MigrateSQLDatabaseToManualThroughputResponder handles the response to the MigrateSQLDatabaseToManualThroughput request. The method always closes the http.Response Body.
func (client SQLResourcesClient) MigrateSQLDatabaseToManualThroughputSender(req *http.Request) (future SQLResourcesMigrateSQLDatabaseToManualThroughputFuture, err error)
MigrateSQLDatabaseToManualThroughputSender sends the MigrateSQLDatabaseToManualThroughput request. The method will close the http.Response Body if it receives an error.
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 (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 (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 (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 (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 (client SQLResourcesClient) UpdateSQLDatabaseThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, databaseName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)
UpdateSQLDatabaseThroughputPreparer prepares the UpdateSQLDatabaseThroughput request.
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 (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.
SQLResourcesCreateUpdateSQLContainerFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SQLResourcesCreateUpdateSQLContainerFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SQLResourcesClient) (SQLContainerGetResults, error)
}
func (future *SQLResourcesCreateUpdateSQLContainerFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SQLResourcesCreateUpdateSQLDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SQLResourcesCreateUpdateSQLDatabaseFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SQLResourcesClient) (SQLDatabaseGetResults, error)
}
func (future *SQLResourcesCreateUpdateSQLDatabaseFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SQLResourcesCreateUpdateSQLStoredProcedureFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SQLResourcesCreateUpdateSQLStoredProcedureFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SQLResourcesClient) (SQLStoredProcedureGetResults, error)
}
func (future *SQLResourcesCreateUpdateSQLStoredProcedureFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SQLResourcesCreateUpdateSQLTriggerFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SQLResourcesCreateUpdateSQLTriggerFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SQLResourcesClient) (SQLTriggerGetResults, error)
}
func (future *SQLResourcesCreateUpdateSQLTriggerFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SQLResourcesCreateUpdateSQLUserDefinedFunctionFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SQLResourcesCreateUpdateSQLUserDefinedFunctionFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SQLResourcesClient) (SQLUserDefinedFunctionGetResults, error)
}
func (future *SQLResourcesCreateUpdateSQLUserDefinedFunctionFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SQLResourcesDeleteSQLContainerFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SQLResourcesDeleteSQLContainerFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SQLResourcesClient) (autorest.Response, error)
}
func (future *SQLResourcesDeleteSQLContainerFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SQLResourcesDeleteSQLDatabaseFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SQLResourcesDeleteSQLDatabaseFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SQLResourcesClient) (autorest.Response, error)
}
func (future *SQLResourcesDeleteSQLDatabaseFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SQLResourcesDeleteSQLStoredProcedureFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SQLResourcesDeleteSQLStoredProcedureFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SQLResourcesClient) (autorest.Response, error)
}
func (future *SQLResourcesDeleteSQLStoredProcedureFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SQLResourcesDeleteSQLTriggerFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SQLResourcesDeleteSQLTriggerFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SQLResourcesClient) (autorest.Response, error)
}
func (future *SQLResourcesDeleteSQLTriggerFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SQLResourcesDeleteSQLUserDefinedFunctionFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SQLResourcesDeleteSQLUserDefinedFunctionFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SQLResourcesClient) (autorest.Response, error)
}
func (future *SQLResourcesDeleteSQLUserDefinedFunctionFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SQLResourcesMigrateSQLContainerToAutoscaleFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SQLResourcesMigrateSQLContainerToAutoscaleFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SQLResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *SQLResourcesMigrateSQLContainerToAutoscaleFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SQLResourcesMigrateSQLContainerToManualThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SQLResourcesMigrateSQLContainerToManualThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SQLResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *SQLResourcesMigrateSQLContainerToManualThroughputFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SQLResourcesMigrateSQLDatabaseToAutoscaleFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SQLResourcesMigrateSQLDatabaseToAutoscaleFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SQLResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *SQLResourcesMigrateSQLDatabaseToAutoscaleFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SQLResourcesMigrateSQLDatabaseToManualThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SQLResourcesMigrateSQLDatabaseToManualThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SQLResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *SQLResourcesMigrateSQLDatabaseToManualThroughputFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SQLResourcesUpdateSQLContainerThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SQLResourcesUpdateSQLContainerThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SQLResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *SQLResourcesUpdateSQLContainerThroughputFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SQLResourcesUpdateSQLDatabaseThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SQLResourcesUpdateSQLDatabaseThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SQLResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *SQLResourcesUpdateSQLDatabaseThroughputFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SQLStoredProcedureCreateUpdateParameters parameters to create and update Cosmos DB storedProcedure.
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"`
}
func (sspcup SQLStoredProcedureCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLStoredProcedureCreateUpdateParameters.
func (sspcup *SQLStoredProcedureCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SQLStoredProcedureCreateUpdateParameters struct.
SQLStoredProcedureCreateUpdateProperties properties to create and update Azure Cosmos DB storedProcedure.
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"`
}
SQLStoredProcedureGetProperties the properties of an Azure Cosmos DB StoredProcedure
type SQLStoredProcedureGetProperties struct {
Resource *SQLStoredProcedureGetPropertiesResource `json:"resource,omitempty"`
}
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 *float64 `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}
func (sspgp SQLStoredProcedureGetPropertiesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLStoredProcedureGetPropertiesResource.
SQLStoredProcedureGetResults an Azure Cosmos DB storedProcedure.
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"`
}
func (sspgr SQLStoredProcedureGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLStoredProcedureGetResults.
func (sspgr *SQLStoredProcedureGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SQLStoredProcedureGetResults struct.
SQLStoredProcedureListResult the List operation response, that contains the storedProcedures and their properties.
type SQLStoredProcedureListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of storedProcedures and their properties.
Value *[]SQLStoredProcedureGetResults `json:"value,omitempty"`
}
func (ssplr SQLStoredProcedureListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLStoredProcedureListResult.
SQLStoredProcedureResource cosmos DB SQL storedProcedure resource object
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"`
}
SQLTriggerCreateUpdateParameters parameters to create and update Cosmos DB trigger.
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"`
}
func (stcup SQLTriggerCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLTriggerCreateUpdateParameters.
func (stcup *SQLTriggerCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SQLTriggerCreateUpdateParameters struct.
SQLTriggerCreateUpdateProperties properties to create and update Azure Cosmos DB trigger.
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"`
}
SQLTriggerGetProperties the properties of an Azure Cosmos DB trigger
type SQLTriggerGetProperties struct {
Resource *SQLTriggerGetPropertiesResource `json:"resource,omitempty"`
}
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 *float64 `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}
func (stgp SQLTriggerGetPropertiesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLTriggerGetPropertiesResource.
SQLTriggerGetResults an Azure Cosmos DB trigger.
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"`
}
func (stgr SQLTriggerGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLTriggerGetResults.
func (stgr *SQLTriggerGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SQLTriggerGetResults struct.
SQLTriggerListResult the List operation response, that contains the triggers and their properties.
type SQLTriggerListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of triggers and their properties.
Value *[]SQLTriggerGetResults `json:"value,omitempty"`
}
func (stlr SQLTriggerListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLTriggerListResult.
SQLTriggerResource cosmos DB SQL trigger resource object
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"`
}
SQLUserDefinedFunctionCreateUpdateParameters parameters to create and update Cosmos DB userDefinedFunction.
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"`
}
func (sudfcup SQLUserDefinedFunctionCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLUserDefinedFunctionCreateUpdateParameters.
func (sudfcup *SQLUserDefinedFunctionCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SQLUserDefinedFunctionCreateUpdateParameters struct.
SQLUserDefinedFunctionCreateUpdateProperties properties to create and update Azure Cosmos DB userDefinedFunction.
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"`
}
SQLUserDefinedFunctionGetProperties the properties of an Azure Cosmos DB userDefinedFunction
type SQLUserDefinedFunctionGetProperties struct {
Resource *SQLUserDefinedFunctionGetPropertiesResource `json:"resource,omitempty"`
}
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 *float64 `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}
func (sudfgp SQLUserDefinedFunctionGetPropertiesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLUserDefinedFunctionGetPropertiesResource.
SQLUserDefinedFunctionGetResults an Azure Cosmos DB userDefinedFunction.
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"`
}
func (sudfgr SQLUserDefinedFunctionGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLUserDefinedFunctionGetResults.
func (sudfgr *SQLUserDefinedFunctionGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for SQLUserDefinedFunctionGetResults struct.
SQLUserDefinedFunctionListResult the List operation response, that contains the userDefinedFunctions and their properties.
type SQLUserDefinedFunctionListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of userDefinedFunctions and their properties.
Value *[]SQLUserDefinedFunctionGetResults `json:"value,omitempty"`
}
func (sudflr SQLUserDefinedFunctionListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SQLUserDefinedFunctionListResult.
SQLUserDefinedFunctionResource cosmos DB SQL userDefinedFunction resource object
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"`
}
ServerVersion enumerates the values for server version.
type ServerVersion string
const (
// FourFullStopZero ...
FourFullStopZero ServerVersion = "4.0"
// ThreeFullStopSix ...
ThreeFullStopSix ServerVersion = "3.6"
// ThreeFullStopTwo ...
ThreeFullStopTwo ServerVersion = "3.2"
)
func PossibleServerVersionValues() []ServerVersion
PossibleServerVersionValues returns an array of possible values for the ServerVersion const 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"`
}
SpatialType enumerates the values for spatial type.
type SpatialType string
const (
// SpatialTypeLineString ...
SpatialTypeLineString SpatialType = "LineString"
// SpatialTypeMultiPolygon ...
SpatialTypeMultiPolygon SpatialType = "MultiPolygon"
// SpatialTypePoint ...
SpatialTypePoint SpatialType = "Point"
// SpatialTypePolygon ...
SpatialTypePolygon SpatialType = "Polygon"
)
func PossibleSpatialTypeValues() []SpatialType
PossibleSpatialTypeValues returns an array of possible values for the SpatialType const type.
TableCreateUpdateParameters parameters to create and update Cosmos DB Table.
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"`
}
func (tcup TableCreateUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TableCreateUpdateParameters.
func (tcup *TableCreateUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for TableCreateUpdateParameters struct.
TableCreateUpdateProperties properties to create and update Azure Cosmos DB Table.
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"`
}
TableGetProperties the properties of an Azure Cosmos Table
type TableGetProperties struct {
Resource *TableGetPropertiesResource `json:"resource,omitempty"`
Options *TableGetPropertiesOptions `json:"options,omitempty"`
}
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"`
}
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 *float64 `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}
func (tgp TableGetPropertiesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TableGetPropertiesResource.
TableGetResults an Azure Cosmos DB Table.
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"`
}
func (tgr TableGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TableGetResults.
func (tgr *TableGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for TableGetResults struct.
TableListResult the List operation response, that contains the Table and their properties.
type TableListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; List of Table and their properties.
Value *[]TableGetResults `json:"value,omitempty"`
}
func (tlr TableListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TableListResult.
TableResource cosmos DB table resource object
type TableResource struct {
// ID - Name of the Cosmos DB table
ID *string `json:"id,omitempty"`
}
TableResourcesClient is the azure Cosmos DB Database Service Resource Provider REST API
type TableResourcesClient struct {
BaseClient
}
func NewTableResourcesClient(subscriptionID string) TableResourcesClient
NewTableResourcesClient creates an instance of the TableResourcesClient client.
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 (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 (client TableResourcesClient) CreateUpdateTablePreparer(ctx context.Context, resourceGroupName string, accountName string, tableName string, createUpdateTableParameters TableCreateUpdateParameters) (*http.Request, error)
CreateUpdateTablePreparer prepares the CreateUpdateTable request.
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 (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 (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 (client TableResourcesClient) DeleteTablePreparer(ctx context.Context, resourceGroupName string, accountName string, tableName string) (*http.Request, error)
DeleteTablePreparer prepares the DeleteTable request.
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 (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 (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 (client TableResourcesClient) GetTablePreparer(ctx context.Context, resourceGroupName string, accountName string, tableName string) (*http.Request, error)
GetTablePreparer prepares the GetTable request.
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 (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 (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 (client TableResourcesClient) GetTableThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, tableName string) (*http.Request, error)
GetTableThroughputPreparer prepares the GetTableThroughput request.
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 (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 (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 (client TableResourcesClient) ListTablesPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListTablesPreparer prepares the ListTables request.
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 (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 (client TableResourcesClient) MigrateTableToAutoscale(ctx context.Context, resourceGroupName string, accountName string, tableName string) (result TableResourcesMigrateTableToAutoscaleFuture, err error)
MigrateTableToAutoscale migrate an Azure Cosmos DB Table from manual throughput to autoscale 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 (client TableResourcesClient) MigrateTableToAutoscalePreparer(ctx context.Context, resourceGroupName string, accountName string, tableName string) (*http.Request, error)
MigrateTableToAutoscalePreparer prepares the MigrateTableToAutoscale request.
func (client TableResourcesClient) MigrateTableToAutoscaleResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
MigrateTableToAutoscaleResponder handles the response to the MigrateTableToAutoscale request. The method always closes the http.Response Body.
func (client TableResourcesClient) MigrateTableToAutoscaleSender(req *http.Request) (future TableResourcesMigrateTableToAutoscaleFuture, err error)
MigrateTableToAutoscaleSender sends the MigrateTableToAutoscale request. The method will close the http.Response Body if it receives an error.
func (client TableResourcesClient) MigrateTableToManualThroughput(ctx context.Context, resourceGroupName string, accountName string, tableName string) (result TableResourcesMigrateTableToManualThroughputFuture, err error)
MigrateTableToManualThroughput migrate an Azure Cosmos DB Table from autoscale to manual throughput 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 (client TableResourcesClient) MigrateTableToManualThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, tableName string) (*http.Request, error)
MigrateTableToManualThroughputPreparer prepares the MigrateTableToManualThroughput request.
func (client TableResourcesClient) MigrateTableToManualThroughputResponder(resp *http.Response) (result ThroughputSettingsGetResults, err error)
MigrateTableToManualThroughputResponder handles the response to the MigrateTableToManualThroughput request. The method always closes the http.Response Body.
func (client TableResourcesClient) MigrateTableToManualThroughputSender(req *http.Request) (future TableResourcesMigrateTableToManualThroughputFuture, err error)
MigrateTableToManualThroughputSender sends the MigrateTableToManualThroughput request. The method will close the http.Response Body if it receives an error.
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 (client TableResourcesClient) UpdateTableThroughputPreparer(ctx context.Context, resourceGroupName string, accountName string, tableName string, updateThroughputParameters ThroughputSettingsUpdateParameters) (*http.Request, error)
UpdateTableThroughputPreparer prepares the UpdateTableThroughput request.
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 (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.
TableResourcesCreateUpdateTableFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type TableResourcesCreateUpdateTableFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(TableResourcesClient) (TableGetResults, error)
}
func (future *TableResourcesCreateUpdateTableFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
TableResourcesDeleteTableFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type TableResourcesDeleteTableFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(TableResourcesClient) (autorest.Response, error)
}
func (future *TableResourcesDeleteTableFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
TableResourcesMigrateTableToAutoscaleFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type TableResourcesMigrateTableToAutoscaleFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(TableResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *TableResourcesMigrateTableToAutoscaleFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
TableResourcesMigrateTableToManualThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type TableResourcesMigrateTableToManualThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(TableResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *TableResourcesMigrateTableToManualThroughputFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
TableResourcesUpdateTableThroughputFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type TableResourcesUpdateTableThroughputFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(TableResourcesClient) (ThroughputSettingsGetResults, error)
}
func (future *TableResourcesUpdateTableThroughputFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ThroughputPolicyResource cosmos DB resource throughput policy
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"`
}
ThroughputSettingsGetProperties the properties of an Azure Cosmos DB resource throughput
type ThroughputSettingsGetProperties struct {
Resource *ThroughputSettingsGetPropertiesResource `json:"resource,omitempty"`
}
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 *float64 `json:"_ts,omitempty"`
// Etag - READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string `json:"_etag,omitempty"`
}
func (tsgp ThroughputSettingsGetPropertiesResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ThroughputSettingsGetPropertiesResource.
ThroughputSettingsGetResults an Azure Cosmos DB resource throughput.
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"`
}
func (tsgr ThroughputSettingsGetResults) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ThroughputSettingsGetResults.
func (tsgr *ThroughputSettingsGetResults) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ThroughputSettingsGetResults struct.
ThroughputSettingsResource cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.
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"`
}
func (tsr ThroughputSettingsResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ThroughputSettingsResource.
ThroughputSettingsUpdateParameters parameters to update Cosmos DB resource throughput.
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"`
}
func (tsup ThroughputSettingsUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ThroughputSettingsUpdateParameters.
func (tsup *ThroughputSettingsUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ThroughputSettingsUpdateParameters struct.
ThroughputSettingsUpdateProperties properties to update Azure Cosmos DB resource throughput.
type ThroughputSettingsUpdateProperties struct {
// Resource - The standard JSON format of a resource throughput
Resource *ThroughputSettingsResource `json:"resource,omitempty"`
}
TrackedResource the resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
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"`
}
func (tr TrackedResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TrackedResource.
TriggerOperation enumerates the values for trigger operation.
type TriggerOperation string
const (
// All ...
All TriggerOperation = "All"
// Create ...
Create TriggerOperation = "Create"
// Delete ...
Delete TriggerOperation = "Delete"
// Replace ...
Replace TriggerOperation = "Replace"
// Update ...
Update TriggerOperation = "Update"
)
func PossibleTriggerOperationValues() []TriggerOperation
PossibleTriggerOperationValues returns an array of possible values for the TriggerOperation const type.
TriggerType enumerates the values for trigger type.
type TriggerType string
const (
// Post ...
Post TriggerType = "Post"
// Pre ...
Pre TriggerType = "Pre"
)
func PossibleTriggerTypeValues() []TriggerType
PossibleTriggerTypeValues returns an array of possible values for the TriggerType const type.
Type enumerates the values for type.
type Type string
const (
// TypeBackupPolicy ...
TypeBackupPolicy Type = "BackupPolicy"
// TypeContinuous ...
TypeContinuous Type = "Continuous"
// TypePeriodic ...
TypePeriodic Type = "Periodic"
)
func PossibleTypeValues() []Type
PossibleTypeValues returns an array of possible values for the Type const type.
UniqueKey the unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
type UniqueKey struct {
// Paths - List of paths must be unique for each document in the Azure Cosmos DB service
Paths *[]string `json:"paths,omitempty"`
}
UniqueKeyPolicy the unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
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"`
}
UnitType enumerates the values for unit type.
type UnitType string
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() []UnitType
PossibleUnitTypeValues returns an array of possible values for the UnitType const type.
Usage the usage data for a usage request.
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"`
}
func (u Usage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Usage.
UsagesResult the response to a list usage request.
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"`
}
func (ur UsagesResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UsagesResult.
VirtualNetworkRule virtual Network ACL Rule object
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"`
}
| Name | Synopsis |
|---|---|
| .. | |
| documentdbapi | Deprecated: Please note, this package has been deprecated. |