Documentation ¶
Overview ¶
Package documentdb implements the Azure ARM Documentdb service API version 2015-04-08.
Azure DocumentDB Database Service Resource Provider REST API
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type ConsistencyPolicy
- type DatabaseAccount
- type DatabaseAccountConnectionString
- type DatabaseAccountCreateUpdateParameters
- type DatabaseAccountCreateUpdateProperties
- type DatabaseAccountKind
- type DatabaseAccountListConnectionStringsResult
- type DatabaseAccountListKeysResult
- type DatabaseAccountListReadOnlyKeysResult
- type DatabaseAccountOfferType
- type DatabaseAccountPatchParameters
- type DatabaseAccountProperties
- type DatabaseAccountRegenerateKeyParameters
- type DatabaseAccountsClient
- func (client DatabaseAccountsClient) CheckNameExists(accountName string) (result autorest.Response, err error)
- func (client DatabaseAccountsClient) CheckNameExistsPreparer(accountName string) (*http.Request, error)
- func (client DatabaseAccountsClient) CheckNameExistsResponder(resp *http.Response) (result autorest.Response, err error)
- func (client DatabaseAccountsClient) CheckNameExistsSender(req *http.Request) (*http.Response, error)
- func (client DatabaseAccountsClient) CreateOrUpdate(resourceGroupName string, accountName string, ...) (result autorest.Response, err error)
- func (client DatabaseAccountsClient) CreateOrUpdatePreparer(resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client DatabaseAccountsClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, err error)
- func (client DatabaseAccountsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
- func (client DatabaseAccountsClient) Delete(resourceGroupName string, accountName string, cancel <-chan struct{}) (result autorest.Response, err error)
- func (client DatabaseAccountsClient) DeletePreparer(resourceGroupName string, accountName string, cancel <-chan struct{}) (*http.Request, error)
- func (client DatabaseAccountsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client DatabaseAccountsClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client DatabaseAccountsClient) FailoverPriorityChange(resourceGroupName string, accountName string, ...) (result autorest.Response, err error)
- func (client DatabaseAccountsClient) FailoverPriorityChangePreparer(resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client DatabaseAccountsClient) FailoverPriorityChangeResponder(resp *http.Response) (result autorest.Response, err error)
- func (client DatabaseAccountsClient) FailoverPriorityChangeSender(req *http.Request) (*http.Response, error)
- func (client DatabaseAccountsClient) Get(resourceGroupName string, accountName string) (result DatabaseAccount, err error)
- func (client DatabaseAccountsClient) GetPreparer(resourceGroupName string, accountName string) (*http.Request, error)
- func (client DatabaseAccountsClient) GetResponder(resp *http.Response) (result DatabaseAccount, err error)
- func (client DatabaseAccountsClient) GetSender(req *http.Request) (*http.Response, error)
- func (client DatabaseAccountsClient) List() (result DatabaseAccountsListResult, err error)
- func (client DatabaseAccountsClient) ListByResourceGroup(resourceGroupName string) (result DatabaseAccountsListResult, err error)
- func (client DatabaseAccountsClient) ListByResourceGroupPreparer(resourceGroupName string) (*http.Request, error)
- func (client DatabaseAccountsClient) ListByResourceGroupResponder(resp *http.Response) (result DatabaseAccountsListResult, err error)
- func (client DatabaseAccountsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client DatabaseAccountsClient) ListConnectionStrings(resourceGroupName string, accountName string) (result DatabaseAccountListConnectionStringsResult, err error)
- func (client DatabaseAccountsClient) ListConnectionStringsPreparer(resourceGroupName string, accountName string) (*http.Request, error)
- func (client DatabaseAccountsClient) ListConnectionStringsResponder(resp *http.Response) (result DatabaseAccountListConnectionStringsResult, err error)
- func (client DatabaseAccountsClient) ListConnectionStringsSender(req *http.Request) (*http.Response, error)
- func (client DatabaseAccountsClient) ListKeys(resourceGroupName string, accountName string) (result DatabaseAccountListKeysResult, err error)
- func (client DatabaseAccountsClient) ListKeysPreparer(resourceGroupName string, accountName string) (*http.Request, error)
- func (client DatabaseAccountsClient) ListKeysResponder(resp *http.Response) (result DatabaseAccountListKeysResult, err error)
- func (client DatabaseAccountsClient) ListKeysSender(req *http.Request) (*http.Response, error)
- func (client DatabaseAccountsClient) ListPreparer() (*http.Request, error)
- func (client DatabaseAccountsClient) ListReadOnlyKeys(resourceGroupName string, accountName string) (result DatabaseAccountListReadOnlyKeysResult, err error)
- func (client DatabaseAccountsClient) ListReadOnlyKeysPreparer(resourceGroupName string, accountName string) (*http.Request, error)
- func (client DatabaseAccountsClient) ListReadOnlyKeysResponder(resp *http.Response) (result DatabaseAccountListReadOnlyKeysResult, err error)
- func (client DatabaseAccountsClient) ListReadOnlyKeysSender(req *http.Request) (*http.Response, error)
- func (client DatabaseAccountsClient) ListResponder(resp *http.Response) (result DatabaseAccountsListResult, err error)
- func (client DatabaseAccountsClient) ListSender(req *http.Request) (*http.Response, error)
- func (client DatabaseAccountsClient) Patch(resourceGroupName string, accountName string, ...) (result autorest.Response, err error)
- func (client DatabaseAccountsClient) PatchPreparer(resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client DatabaseAccountsClient) PatchResponder(resp *http.Response) (result autorest.Response, err error)
- func (client DatabaseAccountsClient) PatchSender(req *http.Request) (*http.Response, error)
- func (client DatabaseAccountsClient) RegenerateKey(resourceGroupName string, accountName string, ...) (result autorest.Response, err error)
- func (client DatabaseAccountsClient) RegenerateKeyPreparer(resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client DatabaseAccountsClient) RegenerateKeyResponder(resp *http.Response) (result autorest.Response, err error)
- func (client DatabaseAccountsClient) RegenerateKeySender(req *http.Request) (*http.Response, error)
- type DatabaseAccountsListResult
- type DefaultConsistencyLevel
- type FailoverPolicies
- type FailoverPolicy
- type KeyKind
- type Location
- type ManagementClient
- type Resource
Constants ¶
const (
// DefaultBaseURI is the default URI used for the service Documentdb
DefaultBaseURI = "https://management.azure.com"
)
Variables ¶
This section is empty.
Functions ¶
func UserAgent ¶
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version ¶
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
Types ¶
type ConsistencyPolicy ¶
type ConsistencyPolicy struct { DefaultConsistencyLevel DefaultConsistencyLevel `json:"defaultConsistencyLevel,omitempty"` MaxStalenessPrefix *int64 `json:"maxStalenessPrefix,omitempty"` MaxIntervalInSeconds *int32 `json:"maxIntervalInSeconds,omitempty"` }
ConsistencyPolicy is the consistency policy for the DocumentDB database account.
type DatabaseAccount ¶
type DatabaseAccount struct { autorest.Response `json:"-"` ID *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Type *string `json:"type,omitempty"` Location *string `json:"location,omitempty"` Tags *map[string]*string `json:"tags,omitempty"` Kind DatabaseAccountKind `json:"kind,omitempty"` *DatabaseAccountProperties `json:"properties,omitempty"` }
DatabaseAccount is a DocumentDB database account.
type DatabaseAccountConnectionString ¶
type DatabaseAccountConnectionString struct { ConnectionString *string `json:"connectionString,omitempty"` Description *string `json:"description,omitempty"` }
DatabaseAccountConnectionString is connection string for the DocumentDB account
type DatabaseAccountCreateUpdateParameters ¶
type DatabaseAccountCreateUpdateParameters struct { ID *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Type *string `json:"type,omitempty"` Location *string `json:"location,omitempty"` Tags *map[string]*string `json:"tags,omitempty"` Kind DatabaseAccountKind `json:"kind,omitempty"` *DatabaseAccountCreateUpdateProperties `json:"properties,omitempty"` }
DatabaseAccountCreateUpdateParameters is parameters to create and update DocumentDB database accounts.
type DatabaseAccountCreateUpdateProperties ¶
type DatabaseAccountCreateUpdateProperties struct { ConsistencyPolicy *ConsistencyPolicy `json:"consistencyPolicy,omitempty"` Locations *[]Location `json:"locations,omitempty"` DatabaseAccountOfferType *string `json:"databaseAccountOfferType,omitempty"` IPRangeFilter *string `json:"ipRangeFilter,omitempty"` }
DatabaseAccountCreateUpdateProperties is properties to create and update Azure DocumentDB database accounts.
type DatabaseAccountKind ¶
type DatabaseAccountKind string
DatabaseAccountKind enumerates the values for database account kind.
const ( // GlobalDocumentDB specifies the global document db state for database // account kind. GlobalDocumentDB DatabaseAccountKind = "GlobalDocumentDB" // MongoDB specifies the mongo db state for database account kind. MongoDB DatabaseAccountKind = "MongoDB" // Parse specifies the parse state for database account kind. Parse DatabaseAccountKind = "Parse" )
type DatabaseAccountListConnectionStringsResult ¶
type DatabaseAccountListConnectionStringsResult struct { autorest.Response `json:"-"` ConnectionStrings *[]DatabaseAccountConnectionString `json:"connectionStrings,omitempty"` }
DatabaseAccountListConnectionStringsResult is the connection strings for the given database account.
type DatabaseAccountListKeysResult ¶
type DatabaseAccountListKeysResult struct { autorest.Response `json:"-"` PrimaryMasterKey *string `json:"primaryMasterKey,omitempty"` SecondaryMasterKey *string `json:"secondaryMasterKey,omitempty"` *DatabaseAccountListReadOnlyKeysResult `json:"properties,omitempty"` }
DatabaseAccountListKeysResult is the access keys for the given database account.
type DatabaseAccountListReadOnlyKeysResult ¶
type DatabaseAccountListReadOnlyKeysResult struct { autorest.Response `json:"-"` PrimaryReadonlyMasterKey *string `json:"primaryReadonlyMasterKey,omitempty"` SecondaryReadonlyMasterKey *string `json:"secondaryReadonlyMasterKey,omitempty"` }
DatabaseAccountListReadOnlyKeysResult is the read-only access keys for the given database account.
type DatabaseAccountOfferType ¶
type DatabaseAccountOfferType string
DatabaseAccountOfferType enumerates the values for database account offer type.
const ( // Standard specifies the standard state for database account offer type. Standard DatabaseAccountOfferType = "Standard" )
type DatabaseAccountPatchParameters ¶
DatabaseAccountPatchParameters is parameters for patching Azure DocumentDB database account properties.
type DatabaseAccountProperties ¶
type DatabaseAccountProperties struct { ProvisioningState *string `json:"provisioningState,omitempty"` DocumentEndpoint *string `json:"documentEndpoint,omitempty"` DatabaseAccountOfferType DatabaseAccountOfferType `json:"databaseAccountOfferType,omitempty"` IPRangeFilter *string `json:"ipRangeFilter,omitempty"` ConsistencyPolicy *ConsistencyPolicy `json:"consistencyPolicy,omitempty"` WriteLocations *[]Location `json:"writeLocations,omitempty"` ReadLocations *[]Location `json:"readLocations,omitempty"` FailoverPolicies *[]FailoverPolicy `json:"failoverPolicies,omitempty"` }
DatabaseAccountProperties is properties for the database account.
type DatabaseAccountRegenerateKeyParameters ¶
type DatabaseAccountRegenerateKeyParameters struct {
KeyKind KeyKind `json:"keyKind,omitempty"`
}
DatabaseAccountRegenerateKeyParameters is parameters to regenerate the keys within the database account.
type DatabaseAccountsClient ¶
type DatabaseAccountsClient struct {
ManagementClient
}
DatabaseAccountsClient is the azure DocumentDB Database Service Resource Provider REST API
func NewDatabaseAccountsClient ¶
func NewDatabaseAccountsClient(subscriptionID string) DatabaseAccountsClient
NewDatabaseAccountsClient creates an instance of the DatabaseAccountsClient client.
func NewDatabaseAccountsClientWithBaseURI ¶
func NewDatabaseAccountsClientWithBaseURI(baseURI string, subscriptionID string) DatabaseAccountsClient
NewDatabaseAccountsClientWithBaseURI creates an instance of the DatabaseAccountsClient client.
func (DatabaseAccountsClient) CheckNameExists ¶
func (client DatabaseAccountsClient) CheckNameExists(accountName string) (result autorest.Response, err error)
CheckNameExists checks that the Azure DocumentDB 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.
accountName is documentDB database account name.
func (DatabaseAccountsClient) CheckNameExistsPreparer ¶
func (client DatabaseAccountsClient) CheckNameExistsPreparer(accountName string) (*http.Request, error)
CheckNameExistsPreparer prepares the CheckNameExists request.
func (DatabaseAccountsClient) CheckNameExistsResponder ¶
func (client DatabaseAccountsClient) CheckNameExistsResponder(resp *http.Response) (result autorest.Response, err error)
CheckNameExistsResponder handles the response to the CheckNameExists request. The method always closes the http.Response Body.
func (DatabaseAccountsClient) CheckNameExistsSender ¶
func (client DatabaseAccountsClient) CheckNameExistsSender(req *http.Request) (*http.Response, error)
CheckNameExistsSender sends the CheckNameExists request. The method will close the http.Response Body if it receives an error.
func (DatabaseAccountsClient) CreateOrUpdate ¶
func (client DatabaseAccountsClient) CreateOrUpdate(resourceGroupName string, accountName string, createUpdateParameters DatabaseAccountCreateUpdateParameters, cancel <-chan struct{}) (result autorest.Response, err error)
CreateOrUpdate creates or updates an Azure DocumentDB database account. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.
resourceGroupName is name of an Azure resource group. accountName is documentDB database account name. createUpdateParameters is the parameters to provide for the current database account.
func (DatabaseAccountsClient) CreateOrUpdatePreparer ¶
func (client DatabaseAccountsClient) CreateOrUpdatePreparer(resourceGroupName string, accountName string, createUpdateParameters DatabaseAccountCreateUpdateParameters, cancel <-chan struct{}) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (DatabaseAccountsClient) CreateOrUpdateResponder ¶
func (client DatabaseAccountsClient) CreateOrUpdateResponder(resp *http.Response) (result autorest.Response, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (DatabaseAccountsClient) CreateOrUpdateSender ¶
func (client DatabaseAccountsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (DatabaseAccountsClient) Delete ¶
func (client DatabaseAccountsClient) Delete(resourceGroupName string, accountName string, cancel <-chan struct{}) (result autorest.Response, err error)
Delete deletes an existing Azure DocumentDB database account. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.
resourceGroupName is name of an Azure resource group. accountName is documentDB database account name.
func (DatabaseAccountsClient) DeletePreparer ¶
func (client DatabaseAccountsClient) DeletePreparer(resourceGroupName string, accountName string, cancel <-chan struct{}) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (DatabaseAccountsClient) DeleteResponder ¶
func (client DatabaseAccountsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (DatabaseAccountsClient) DeleteSender ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (DatabaseAccountsClient) FailoverPriorityChange ¶
func (client DatabaseAccountsClient) FailoverPriorityChange(resourceGroupName string, accountName string, failoverParameters FailoverPolicies, cancel <-chan struct{}) (result autorest.Response, err error)
FailoverPriorityChange changes the failover priority for the Azure DocumentDB 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. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.
resourceGroupName is name of an Azure resource group. accountName is documentDB database account name. failoverParameters is the new failover policies for the database account.
func (DatabaseAccountsClient) FailoverPriorityChangePreparer ¶
func (client DatabaseAccountsClient) FailoverPriorityChangePreparer(resourceGroupName string, accountName string, failoverParameters FailoverPolicies, cancel <-chan struct{}) (*http.Request, error)
FailoverPriorityChangePreparer prepares the FailoverPriorityChange request.
func (DatabaseAccountsClient) FailoverPriorityChangeResponder ¶
func (client DatabaseAccountsClient) FailoverPriorityChangeResponder(resp *http.Response) (result autorest.Response, err error)
FailoverPriorityChangeResponder handles the response to the FailoverPriorityChange request. The method always closes the http.Response Body.
func (DatabaseAccountsClient) FailoverPriorityChangeSender ¶
func (client DatabaseAccountsClient) FailoverPriorityChangeSender(req *http.Request) (*http.Response, error)
FailoverPriorityChangeSender sends the FailoverPriorityChange request. The method will close the http.Response Body if it receives an error.
func (DatabaseAccountsClient) Get ¶
func (client DatabaseAccountsClient) Get(resourceGroupName string, accountName string) (result DatabaseAccount, err error)
Get retrieves the properties of an existing Azure DocumentDB database account.
resourceGroupName is name of an Azure resource group. accountName is documentDB database account name.
func (DatabaseAccountsClient) GetPreparer ¶
func (client DatabaseAccountsClient) GetPreparer(resourceGroupName string, accountName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (DatabaseAccountsClient) GetResponder ¶
func (client DatabaseAccountsClient) GetResponder(resp *http.Response) (result DatabaseAccount, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (DatabaseAccountsClient) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (DatabaseAccountsClient) List ¶
func (client DatabaseAccountsClient) List() (result DatabaseAccountsListResult, err error)
List lists all the Azure DocumentDB database accounts available under the subscription.
func (DatabaseAccountsClient) ListByResourceGroup ¶
func (client DatabaseAccountsClient) ListByResourceGroup(resourceGroupName string) (result DatabaseAccountsListResult, err error)
ListByResourceGroup lists all the Azure DocumentDB database accounts available under the given resource group.
resourceGroupName is name of an Azure resource group.
func (DatabaseAccountsClient) ListByResourceGroupPreparer ¶
func (client DatabaseAccountsClient) ListByResourceGroupPreparer(resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (DatabaseAccountsClient) ListByResourceGroupResponder ¶
func (client DatabaseAccountsClient) ListByResourceGroupResponder(resp *http.Response) (result DatabaseAccountsListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (DatabaseAccountsClient) ListByResourceGroupSender ¶
func (client DatabaseAccountsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (DatabaseAccountsClient) ListConnectionStrings ¶
func (client DatabaseAccountsClient) ListConnectionStrings(resourceGroupName string, accountName string) (result DatabaseAccountListConnectionStringsResult, err error)
ListConnectionStrings lists the connection strings for the specified Azure DocumentDB database account.
resourceGroupName is name of an Azure resource group. accountName is documentDB database account name.
func (DatabaseAccountsClient) ListConnectionStringsPreparer ¶
func (client DatabaseAccountsClient) ListConnectionStringsPreparer(resourceGroupName string, accountName string) (*http.Request, error)
ListConnectionStringsPreparer prepares the ListConnectionStrings request.
func (DatabaseAccountsClient) ListConnectionStringsResponder ¶
func (client DatabaseAccountsClient) ListConnectionStringsResponder(resp *http.Response) (result DatabaseAccountListConnectionStringsResult, err error)
ListConnectionStringsResponder handles the response to the ListConnectionStrings request. The method always closes the http.Response Body.
func (DatabaseAccountsClient) ListConnectionStringsSender ¶
func (client DatabaseAccountsClient) ListConnectionStringsSender(req *http.Request) (*http.Response, error)
ListConnectionStringsSender sends the ListConnectionStrings request. The method will close the http.Response Body if it receives an error.
func (DatabaseAccountsClient) ListKeys ¶
func (client DatabaseAccountsClient) ListKeys(resourceGroupName string, accountName string) (result DatabaseAccountListKeysResult, err error)
ListKeys lists the access keys for the specified Azure DocumentDB database account.
resourceGroupName is name of an Azure resource group. accountName is documentDB database account name.
func (DatabaseAccountsClient) ListKeysPreparer ¶
func (client DatabaseAccountsClient) ListKeysPreparer(resourceGroupName string, accountName string) (*http.Request, error)
ListKeysPreparer prepares the ListKeys request.
func (DatabaseAccountsClient) ListKeysResponder ¶
func (client DatabaseAccountsClient) ListKeysResponder(resp *http.Response) (result DatabaseAccountListKeysResult, err error)
ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.
func (DatabaseAccountsClient) ListKeysSender ¶
ListKeysSender sends the ListKeys request. The method will close the http.Response Body if it receives an error.
func (DatabaseAccountsClient) ListPreparer ¶
func (client DatabaseAccountsClient) ListPreparer() (*http.Request, error)
ListPreparer prepares the List request.
func (DatabaseAccountsClient) ListReadOnlyKeys ¶
func (client DatabaseAccountsClient) ListReadOnlyKeys(resourceGroupName string, accountName string) (result DatabaseAccountListReadOnlyKeysResult, err error)
ListReadOnlyKeys lists the read-only access keys for the specified Azure DocumentDB database account.
resourceGroupName is name of an Azure resource group. accountName is documentDB database account name.
func (DatabaseAccountsClient) ListReadOnlyKeysPreparer ¶
func (client DatabaseAccountsClient) ListReadOnlyKeysPreparer(resourceGroupName string, accountName string) (*http.Request, error)
ListReadOnlyKeysPreparer prepares the ListReadOnlyKeys request.
func (DatabaseAccountsClient) ListReadOnlyKeysResponder ¶
func (client DatabaseAccountsClient) ListReadOnlyKeysResponder(resp *http.Response) (result DatabaseAccountListReadOnlyKeysResult, err error)
ListReadOnlyKeysResponder handles the response to the ListReadOnlyKeys request. The method always closes the http.Response Body.
func (DatabaseAccountsClient) ListReadOnlyKeysSender ¶
func (client DatabaseAccountsClient) ListReadOnlyKeysSender(req *http.Request) (*http.Response, error)
ListReadOnlyKeysSender sends the ListReadOnlyKeys request. The method will close the http.Response Body if it receives an error.
func (DatabaseAccountsClient) ListResponder ¶
func (client DatabaseAccountsClient) ListResponder(resp *http.Response) (result DatabaseAccountsListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (DatabaseAccountsClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (DatabaseAccountsClient) Patch ¶
func (client DatabaseAccountsClient) Patch(resourceGroupName string, accountName string, updateParameters DatabaseAccountPatchParameters, cancel <-chan struct{}) (result autorest.Response, err error)
Patch patches the properties of an existing Azure DocumentDB database account. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.
resourceGroupName is name of an Azure resource group. accountName is documentDB database account name. updateParameters is the tags parameter to patch for the current database account.
func (DatabaseAccountsClient) PatchPreparer ¶
func (client DatabaseAccountsClient) PatchPreparer(resourceGroupName string, accountName string, updateParameters DatabaseAccountPatchParameters, cancel <-chan struct{}) (*http.Request, error)
PatchPreparer prepares the Patch request.
func (DatabaseAccountsClient) PatchResponder ¶
func (client DatabaseAccountsClient) PatchResponder(resp *http.Response) (result autorest.Response, err error)
PatchResponder handles the response to the Patch request. The method always closes the http.Response Body.
func (DatabaseAccountsClient) PatchSender ¶
PatchSender sends the Patch request. The method will close the http.Response Body if it receives an error.
func (DatabaseAccountsClient) RegenerateKey ¶
func (client DatabaseAccountsClient) RegenerateKey(resourceGroupName string, accountName string, keyToRegenerate DatabaseAccountRegenerateKeyParameters, cancel <-chan struct{}) (result autorest.Response, err error)
RegenerateKey regenerates an access key for the specified Azure DocumentDB database account. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.
resourceGroupName is name of an Azure resource group. accountName is documentDB database account name. keyToRegenerate is the name of the key to regenerate.
func (DatabaseAccountsClient) RegenerateKeyPreparer ¶
func (client DatabaseAccountsClient) RegenerateKeyPreparer(resourceGroupName string, accountName string, keyToRegenerate DatabaseAccountRegenerateKeyParameters, cancel <-chan struct{}) (*http.Request, error)
RegenerateKeyPreparer prepares the RegenerateKey request.
func (DatabaseAccountsClient) RegenerateKeyResponder ¶
func (client DatabaseAccountsClient) RegenerateKeyResponder(resp *http.Response) (result autorest.Response, err error)
RegenerateKeyResponder handles the response to the RegenerateKey request. The method always closes the http.Response Body.
func (DatabaseAccountsClient) RegenerateKeySender ¶
RegenerateKeySender sends the RegenerateKey request. The method will close the http.Response Body if it receives an error.
type DatabaseAccountsListResult ¶
type DatabaseAccountsListResult struct { autorest.Response `json:"-"` Value *[]DatabaseAccount `json:"value,omitempty"` }
DatabaseAccountsListResult is the List operation response, that contains the database accounts and their properties.
type DefaultConsistencyLevel ¶
type DefaultConsistencyLevel string
DefaultConsistencyLevel enumerates the values for default consistency level.
const ( // BoundedStaleness specifies the bounded staleness state for default // consistency level. BoundedStaleness DefaultConsistencyLevel = "BoundedStaleness" // Eventual specifies the eventual state for default consistency level. Eventual DefaultConsistencyLevel = "Eventual" // Session specifies the session state for default consistency level. Session DefaultConsistencyLevel = "Session" // Strong specifies the strong state for default consistency level. Strong DefaultConsistencyLevel = "Strong" )
type FailoverPolicies ¶
type FailoverPolicies struct {
FailoverPolicies *[]FailoverPolicy `json:"failoverPolicies,omitempty"`
}
FailoverPolicies is the list of new failover policies for the failover priority change.
type FailoverPolicy ¶
type FailoverPolicy struct { ID *string `json:"id,omitempty"` LocationName *string `json:"locationName,omitempty"` FailoverPriority *int32 `json:"failoverPriority,omitempty"` }
FailoverPolicy is the failover policy for a given region of a database account.
type KeyKind ¶
type KeyKind string
KeyKind enumerates the values for key kind.
const ( // Primary specifies the primary state for key kind. Primary KeyKind = "primary" // PrimaryReadonly specifies the primary readonly state for key kind. PrimaryReadonly KeyKind = "primaryReadonly" // Secondary specifies the secondary state for key kind. Secondary KeyKind = "secondary" // SecondaryReadonly specifies the secondary readonly state for key kind. SecondaryReadonly KeyKind = "secondaryReadonly" )
type Location ¶
type Location struct { ID *string `json:"id,omitempty"` LocationName *string `json:"locationName,omitempty"` DocumentEndpoint *string `json:"documentEndpoint,omitempty"` ProvisioningState *string `json:"provisioningState,omitempty"` FailoverPriority *int32 `json:"failoverPriority,omitempty"` }
Location is a region in which the Azure DocumentDB database account is deployed.
type ManagementClient ¶
ManagementClient is the base client for Documentdb.
func New ¶
func New(subscriptionID string) ManagementClient
New creates an instance of the ManagementClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient
NewWithBaseURI creates an instance of the ManagementClient client.