Class: Azure::ARM::Resources::ResourceManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/generated/azure_mgmt_resources/resource_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) ⇒ ResourceManagementClient

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/generated/azure_mgmt_resources/resource_management_client.rb', line 61

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

  @deployments = Deployments.new(self)
  @providers = Providers.new(self)
  @resource_groups = ResourceGroups.new(self)
  @resources = Resources.new(self)
  @tags = Tags.new(self)
  @deployment_operations = DeploymentOperations.new(self)
  @api_version = '2016-09-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 Gets or sets the preferred language for the response.

Returns:

  • (String) —

    Gets or sets the preferred language for the response.



27
28
29
 
# File 'lib/generated/azure_mgmt_resources/resource_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/generated/azure_mgmt_resources/resource_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/generated/azure_mgmt_resources/resource_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/generated/azure_mgmt_resources/resource_management_client.rb', line 18

def credentials
  @credentials
end

#deployment_operations ⇒ DeploymentOperations (readonly)

Returns deployment_operations.

Returns:



53
54
55
 
# File 'lib/generated/azure_mgmt_resources/resource_management_client.rb', line 53

def deployment_operations
  @deployment_operations
end

#deployments ⇒ Deployments (readonly)

Returns deployments.

Returns:



38
39
40
 
# File 'lib/generated/azure_mgmt_resources/resource_management_client.rb', line 38

def deployments
  @deployments
end

#generate_client_request_id ⇒ Boolean

is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    When set to true a unique x-ms-client-request-id value



35
36
37
 
# File 'lib/generated/azure_mgmt_resources/resource_management_client.rb', line 35

def generate_client_request_id
  @generate_client_request_id
end

#long_running_operation_retry_timeout ⇒ Integer

Running Operations. Default value is 30.

Returns:

  • (Integer) —

    Gets or sets the retry timeout in seconds for Long



31
32
33
 
# File 'lib/generated/azure_mgmt_resources/resource_management_client.rb', line 31

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#providers ⇒ Providers (readonly)

Returns providers.

Returns:



41
42
43
 
# File 'lib/generated/azure_mgmt_resources/resource_management_client.rb', line 41

def providers
  @providers
end

#resource_groups ⇒ ResourceGroups (readonly)

Returns resource_groups.

Returns:



44
45
46
 
# File 'lib/generated/azure_mgmt_resources/resource_management_client.rb', line 44

def resource_groups
  @resource_groups
end

#resources ⇒ Resources (readonly)

Returns resources.

Returns:



47
48
49
 
# File 'lib/generated/azure_mgmt_resources/resource_management_client.rb', line 47

def resources
  @resources
end

#subscription_id ⇒ String

Returns The ID of the target subscription.

Returns:

  • (String) —

    The ID of the target subscription.



21
22
23
 
# File 'lib/generated/azure_mgmt_resources/resource_management_client.rb', line 21

def subscription_id
  @subscription_id
end

#tags ⇒ Tags (readonly)

Returns tags.

Returns:



50
51
52
 
# File 'lib/generated/azure_mgmt_resources/resource_management_client.rb', line 50

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



97
98
99
100
 
# File 'lib/generated/azure_mgmt_resources/resource_management_client.rb', line 97

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.



122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/generated/azure_mgmt_resources/resource_management_client.rb', line 122

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

  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.



109
110
111
112
113
 
# File 'lib/generated/azure_mgmt_resources/resource_management_client.rb', line 109

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