Class: Azure::NetApp::Mgmt::V2020_07_01::AzureNetAppFilesManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_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) ⇒ AzureNetAppFilesManagementClient

Creates initializes a new instance of the AzureNetAppFilesManagementClient 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.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 79

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)
  @net_app_resource = NetAppResource.new(self)
  @accounts = Accounts.new(self)
  @pools = Pools.new(self)
  @volumes = Volumes.new(self)
  @snapshots = Snapshots.new(self)
  @snapshot_policies = SnapshotPolicies.new(self)
  @account_backups = AccountBackups.new(self)
  @backups = Backups.new(self)
  @backup_policies = BackupPolicies.new(self)
  @vaults = Vaults.new(self)
  @api_version = '2020-07-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.



29
30
31
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 29

def accept_language
  @accept_language
end

#account_backups ⇒ AccountBackups (readonly)

Returns account_backups.

Returns:



62
63
64
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 62

def 
  @account_backups
end

#accounts ⇒ Accounts (readonly)

Returns accounts.

Returns:



47
48
49
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 47

def accounts
  @accounts
end

#api_version ⇒ String (readonly)

Returns Version of the API to be used with the client request.

Returns:

  • (String) —

    Version of the API to be used with the client request.



26
27
28
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 26

def api_version
  @api_version
end

#backup_policies ⇒ BackupPolicies (readonly)

Returns backup_policies.

Returns:



68
69
70
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 68

def backup_policies
  @backup_policies
end

#backups ⇒ Backups (readonly)

Returns backups.

Returns:



65
66
67
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 65

def backups
  @backups
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 15

def base_url
  @base_url
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/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 18

def credentials
  @credentials
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



38
39
40
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 38

def generate_client_request_id
  @generate_client_request_id
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



33
34
35
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 33

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#net_app_resource ⇒ NetAppResource (readonly)

Returns net_app_resource.

Returns:



44
45
46
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 44

def net_app_resource
  @net_app_resource
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



41
42
43
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 41

def operations
  @operations
end

#pools ⇒ Pools (readonly)

Returns pools.

Returns:



50
51
52
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 50

def pools
  @pools
end

#snapshot_policies ⇒ SnapshotPolicies (readonly)

Returns snapshot_policies.

Returns:



59
60
61
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 59

def snapshot_policies
  @snapshot_policies
end

#snapshots ⇒ Snapshots (readonly)

Returns snapshots.

Returns:



56
57
58
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 56

def snapshots
  @snapshots
end

#subscription_id ⇒ String

Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Returns:

  • (String) —

    Subscription credentials which uniquely identify



23
24
25
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 23

def subscription_id
  @subscription_id
end

#vaults ⇒ Vaults (readonly)

Returns vaults.

Returns:



71
72
73
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 71

def vaults
  @vaults
end

#volumes ⇒ Volumes (readonly)

Returns volumes.

Returns:



53
54
55
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 53

def volumes
  @volumes
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.



120
121
122
123
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 120

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.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 145

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.



132
133
134
135
136
 
# File 'lib/2020-07-01/generated/azure_mgmt_netapp/azure_net_app_files_management_client.rb', line 132

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