Class: Azure::Storage::Mgmt::V2021_01_01::StorageManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2021-01-01/generated/azure_mgmt_storage/storage_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) ⇒ StorageManagementClient

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



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 102

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)
  @skus = Skus.new(self)
  @storage_accounts = StorageAccounts.new(self)
  @deleted_accounts = DeletedAccounts.new(self)
  @usages = Usages.new(self)
  @management_policies = ManagementPolicies.new(self)
  @blob_inventory_policies = BlobInventoryPolicies.new(self)
  @private_endpoint_connections = PrivateEndpointConnections.new(self)
  @private_link_resources = PrivateLinkResources.new(self)
  @object_replication_policies_operations = ObjectReplicationPoliciesOperations.new(self)
  @encryption_scopes = EncryptionScopes.new(self)
  @blob_services = BlobServices.new(self)
  @blob_containers = BlobContainers.new(self)
  @file_services = FileServices.new(self)
  @file_shares = FileShares.new(self)
  @queue_services = QueueServices.new(self)
  @queue = Queue.new(self)
  @table_services = TableServices.new(self)
  @table_operations = TableOperations.new(self)
  @api_version = '2021-01-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/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 27

def accept_language
  @accept_language
end

#api_version ⇒ String (readonly)

Returns The API version to use for this operation.

Returns:

  • (String) —

    The API version to use for this operation.



24
25
26
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 24

def api_version
  @api_version
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 15

def base_url
  @base_url
end

#blob_containers ⇒ BlobContainers (readonly)

Returns blob_containers.

Returns:



76
77
78
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 76

def blob_containers
  @blob_containers
end

#blob_inventory_policies ⇒ BlobInventoryPolicies (readonly)

Returns blob_inventory_policies.

Returns:



57
58
59
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 57

def blob_inventory_policies
  @blob_inventory_policies
end

#blob_services ⇒ BlobServices (readonly)

Returns blob_services.

Returns:



73
74
75
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 73

def blob_services
  @blob_services
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/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 18

def credentials
  @credentials
end

#deleted_accounts ⇒ DeletedAccounts (readonly)

Returns deleted_accounts.

Returns:



48
49
50
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 48

def deleted_accounts
  @deleted_accounts
end

#encryption_scopes ⇒ EncryptionScopes (readonly)

Returns encryption_scopes.

Returns:



70
71
72
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 70

def encryption_scopes
  @encryption_scopes
end

#file_services ⇒ FileServices (readonly)

Returns file_services.

Returns:



79
80
81
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 79

def file_services
  @file_services
end

#file_shares ⇒ FileShares (readonly)

Returns file_shares.

Returns:



82
83
84
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 82

def file_shares
  @file_shares
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/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 36

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



31
32
33
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 31

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#management_policies ⇒ ManagementPolicies (readonly)

Returns management_policies.

Returns:



54
55
56
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 54

def management_policies
  @management_policies
end

#object_replication_policies_operations ⇒ ObjectReplicationPoliciesOperations (readonly)

object_replication_policies_operations

Returns:



67
68
69
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 67

def object_replication_policies_operations
  @object_replication_policies_operations
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



39
40
41
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 39

def operations
  @operations
end

#private_endpoint_connections ⇒ PrivateEndpointConnections (readonly)

Returns private_endpoint_connections.

Returns:



60
61
62
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 60

def private_endpoint_connections
  @private_endpoint_connections
end

#private_link_resources ⇒ PrivateLinkResources (readonly)

Returns private_link_resources.

Returns:



63
64
65
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 63

def private_link_resources
  @private_link_resources
end

#queue ⇒ Queue (readonly)

Returns queue.

Returns:



88
89
90
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 88

def queue
  @queue
end

#queue_services ⇒ QueueServices (readonly)

Returns queue_services.

Returns:



85
86
87
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 85

def queue_services
  @queue_services
end

#skus ⇒ Skus (readonly)

Returns skus.

Returns:



42
43
44
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 42

def skus
  @skus
end

#storage_accounts ⇒ StorageAccounts (readonly)

Returns storage_accounts.

Returns:



45
46
47
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 45

def storage_accounts
  @storage_accounts
end

#subscription_id ⇒ String

Returns The ID of the target subscription.

Returns:

  • (String) —

    The ID of the target subscription.



21
22
23
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 21

def subscription_id
  @subscription_id
end

#table_operations ⇒ TableOperations (readonly)

Returns table_operations.

Returns:



94
95
96
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 94

def table_operations
  @table_operations
end

#table_services ⇒ TableServices (readonly)

Returns table_services.

Returns:



91
92
93
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 91

def table_services
  @table_services
end

#usages ⇒ Usages (readonly)

Returns usages.

Returns:



51
52
53
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 51

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



151
152
153
154
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 151

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.



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 176

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.



163
164
165
166
167
 
# File 'lib/2021-01-01/generated/azure_mgmt_storage/storage_management_client.rb', line 163

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