class Azure::DataBoxEdge::Mgmt::V2019_08_01::DataBoxEdgeManagementClient
A service client - single point of access to the REST API.
Attributes
@return [String] The preferred language for the response.
@return [Alerts] alerts
@return [String] The API version.
@return [BandwidthSchedules] bandwidth_schedules
@return [String] the base URI of the service.
@return [Containers] containers
@return Credentials needed for the client to connect to Azure
.
@return [Devices] devices
@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.
@return [Jobs] jobs
@return [Integer] The retry timeout in seconds for Long Running Operations
. Default value is 30.
@return [Nodes] nodes
@return [Operations] operations
@return [OperationsStatus] operations_status
@return [Orders] orders
@return [Roles] roles
@return [Skus] skus
@return [StorageAccountCredentials] storage_account_credentials
@return [StorageAccounts] storage_accounts
@return [String] The subscription ID.
@return [Triggers] triggers
@return [Users] users
Public Class Methods
Creates initializes a new instance of the DataBoxEdgeManagementClient
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.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb, line 92 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 @operations = Operations.new(self) @devices = Devices.new(self) @alerts = Alerts.new(self) @bandwidth_schedules = BandwidthSchedules.new(self) @jobs = Jobs.new(self) @nodes = Nodes.new(self) @operations_status = OperationsStatus.new(self) @orders = Orders.new(self) @roles = Roles.new(self) @shares = Shares.new(self) @storage_account_credentials = StorageAccountCredentials.new(self) @storage_accounts = StorageAccounts.new(self) @containers = Containers.new(self) @triggers = Triggers.new(self) @users = Users.new(self) @skus = Skus.new(self) @api_version = '2019-08-01' @accept_language = 'en-US' @long_running_operation_retry_timeout = 30 @generate_client_request_id = true add_telemetry end
Public Instance Methods
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/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb, line 138 def make_request(method, path, options = {}) result = make_request_with_http_info(method, path, options) result.body unless result.nil? end
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.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb, line 163 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
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/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb, line 150 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
Adds telemetry information.
# File lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb, line 185 def add_telemetry sdk_information = 'azure_mgmt_databoxedge' sdk_information = "#{sdk_information}/0.17.0" add_user_agent_information(sdk_information) end