Class: Azure::DataBoxEdge::Mgmt::V2019_08_01::DataBoxEdgeManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, base_url = nil, options = nil) ⇒ DataBoxEdgeManagementClient

Creates initializes a new instance of the DataBoxEdgeManagementClient class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) (defaults to: nil) —

    credentials to authorize HTTP requests made by the service client.

  • base_url (String) (defaults to: nil) —

    the base URI of the service.

  • options (Array) (defaults to: nil) —

    filters to be applied to the HTTP requests.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# 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

Instance Attribute Details

#accept_language ⇒ String

Returns The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



27
28
29
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 27

def accept_language
  @accept_language
end

#alerts ⇒ Alerts (readonly)

Returns alerts.

Returns:



45
46
47
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 45

def alerts
  @alerts
end

#api_version ⇒ String (readonly)

Returns The API version.

Returns:

  • (String) —

    The API version.



21
22
23
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 21

def api_version
  @api_version
end

#bandwidth_schedules ⇒ BandwidthSchedules (readonly)

Returns bandwidth_schedules.

Returns:



48
49
50
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 48

def bandwidth_schedules
  @bandwidth_schedules
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 15

def base_url
  @base_url
end

#containers ⇒ Containers (readonly)

Returns containers.

Returns:



75
76
77
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 75

def containers
  @containers
end

#credentials ⇒ Object (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.



18
19
20
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 18

def credentials
  @credentials
end

#devices ⇒ Devices (readonly)

Returns devices.

Returns:



42
43
44
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 42

def devices
  @devices
end

#generate_client_request_id ⇒ Boolean

generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    Whether a unique x-ms-client-request-id should be



36
37
38
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 36

def generate_client_request_id
  @generate_client_request_id
end

#jobs ⇒ Jobs (readonly)

Returns jobs.

Returns:



51
52
53
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 51

def jobs
  @jobs
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



31
32
33
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 31

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#nodes ⇒ Nodes (readonly)

Returns nodes.

Returns:



54
55
56
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 54

def nodes
  @nodes
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



39
40
41
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 39

def operations
  @operations
end

#operations_status ⇒ OperationsStatus (readonly)

Returns operations_status.

Returns:



57
58
59
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 57

def operations_status
  @operations_status
end

#orders ⇒ Orders (readonly)

Returns orders.

Returns:



60
61
62
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 60

def orders
  @orders
end

#roles ⇒ Roles (readonly)

Returns roles.

Returns:



63
64
65
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 63

def roles
  @roles
end

#shares ⇒ Shares (readonly)

Returns shares.

Returns:



66
67
68
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 66

def shares
  @shares
end

#skus ⇒ Skus (readonly)

Returns skus.

Returns:



84
85
86
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 84

def skus
  @skus
end

#storage_account_credentials ⇒ StorageAccountCredentials (readonly)

Returns storage_account_credentials.

Returns:



69
70
71
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 69

def 
  @storage_account_credentials
end

#storage_accounts ⇒ StorageAccounts (readonly)

Returns storage_accounts.

Returns:



72
73
74
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 72

def storage_accounts
  @storage_accounts
end

#subscription_id ⇒ String

Returns The subscription ID.

Returns:

  • (String) —

    The subscription ID.



24
25
26
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 24

def subscription_id
  @subscription_id
end

#triggers ⇒ Triggers (readonly)

Returns triggers.

Returns:



78
79
80
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 78

def triggers
  @triggers
end

#users ⇒ Users (readonly)

Returns users.

Returns:



81
82
83
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/data_box_edge_management_client.rb', line 81

def users
  @users
end

Instance Method Details

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

Makes a request and returns 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)

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {}) —

    specifying any request options like :body.

Returns:

  • (Hash{String=>String}) —

    containing the body of the response.



138
139
140
141
 
# 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

#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise

Makes a request asynchronously.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {}) —

    specifying any request options like :body.

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# 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

#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse

Makes a request and returns the operation response.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {}) —

    specifying any request options like :body.

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    Operation response containing the request, response and status.



150
151
152
153
154
 
# 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