class Azure::Cosmosdb::Mgmt::V2020_03_01::CosmosDBManagementClient

A service client - single point of access to the REST API.

Attributes

accept_language[RW]

@return [String] The preferred language for the response.

api_version[R]

@return [String] The API version to use for this operation.

base_url[RW]

@return [String] the base URI of the service.

cassandra_resources[R]

@return [CassandraResources] cassandra_resources

collection[R]

@return [Collection] collection

collection_partition[R]

@return [CollectionPartition] collection_partition

collection_partition_region[R]

@return [CollectionPartitionRegion] collection_partition_region

collection_region[R]

@return [CollectionRegion] collection_region

credentials[R]

@return Credentials needed for the client to connect to Azure.

database[R]

@return [Database] database

database_account_region[R]

@return [DatabaseAccountRegion] database_account_region

database_accounts[R]

@return [DatabaseAccounts] database_accounts

generate_client_request_id[RW]

@return [Boolean] Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

gremlin_resources[R]

@return [GremlinResources] gremlin_resources

long_running_operation_retry_timeout[RW]

@return [Integer] The retry timeout in seconds for Long Running Operations. Default value is 30.

mongo_dbresources[R]

@return [MongoDBResources] mongo_dbresources

notebook_workspaces[R]

@return [NotebookWorkspaces] notebook_workspaces

operations[R]

@return [Operations] operations

partition_key_range_id[R]

@return [PartitionKeyRangeId] partition_key_range_id

partition_key_range_id_region[R]

@return [PartitionKeyRangeIdRegion] partition_key_range_id_region

percentile[R]

@return [Percentile] percentile

percentile_source_target[R]

@return [PercentileSourceTarget] percentile_source_target

percentile_target[R]

@return [PercentileTarget] percentile_target

sql_resources[R]

@return [SqlResources] sql_resources

subscription_id[RW]

@return [String] The ID of the target subscription.

table_resources[R]

@return [TableResources] table_resources

Public Class Methods

new(credentials = nil, base_url = nil, options = nil) click to toggle source

Creates initializes a new instance of the CosmosDBManagementClient class. @param credentials [MsRest::ServiceClientCredentials] credentials to authorize HTTP requests made by the service client. @param base_url [String] the base URI of the service. @param options [Array] filters to be applied to the HTTP requests.

Calls superclass method
# File lib/2020-03-01/generated/azure_mgmt_cosmosdb/cosmos_dbmanagement_client.rb, line 101
def initialize(credentials = nil, base_url = nil, options = nil)
  super(credentials, options)
  @base_url = base_url || 'https://management.azure.com'

  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
  @credentials = credentials

  @database_accounts = DatabaseAccounts.new(self)
  @operations = Operations.new(self)
  @database = Database.new(self)
  @collection = Collection.new(self)
  @collection_region = CollectionRegion.new(self)
  @database_account_region = DatabaseAccountRegion.new(self)
  @percentile_source_target = PercentileSourceTarget.new(self)
  @percentile_target = PercentileTarget.new(self)
  @percentile = Percentile.new(self)
  @collection_partition_region = CollectionPartitionRegion.new(self)
  @collection_partition = CollectionPartition.new(self)
  @partition_key_range_id = PartitionKeyRangeId.new(self)
  @partition_key_range_id_region = PartitionKeyRangeIdRegion.new(self)
  @sql_resources = SqlResources.new(self)
  @mongo_dbresources = MongoDBResources.new(self)
  @table_resources = TableResources.new(self)
  @cassandra_resources = CassandraResources.new(self)
  @gremlin_resources = GremlinResources.new(self)
  @notebook_workspaces = NotebookWorkspaces.new(self)
  @api_version = '2020-03-01'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Public Instance Methods

make_request(method, path, options = {}) click to toggle source

Makes a request and returns the body of the response. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [Hash{String=>String}] containing the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)
# File lib/2020-03-01/generated/azure_mgmt_cosmosdb/cosmos_dbmanagement_client.rb, line 150
def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end
make_request_async(method, path, options = {}) click to toggle source

Makes a request asynchronously. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [Concurrent::Promise] Promise object which holds the HTTP response.

Calls superclass method
# File lib/2020-03-01/generated/azure_mgmt_cosmosdb/cosmos_dbmanagement_client.rb, line 175
def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end
make_request_with_http_info(method, path, options = {}) click to toggle source

Makes a request and returns the operation response. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [MsRestAzure::AzureOperationResponse] Operation response containing the request, response and status.

# File lib/2020-03-01/generated/azure_mgmt_cosmosdb/cosmos_dbmanagement_client.rb, line 162
def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end

Private Instance Methods

add_telemetry() click to toggle source

Adds telemetry information.

# File lib/2020-03-01/generated/azure_mgmt_cosmosdb/cosmos_dbmanagement_client.rb, line 197
def add_telemetry
    sdk_information = 'azure_mgmt_cosmosdb'
    sdk_information = "#{sdk_information}/0.24.1"
    add_user_agent_information(sdk_information)
end