Class: Azure::Subscriptions::Mgmt::V2015_11_01::SubscriptionClient
- Inherits:
-
MsRestAzure::AzureServiceClient
- Object
- MsRestAzure::AzureServiceClient
- Azure::Subscriptions::Mgmt::V2015_11_01::SubscriptionClient
- Includes:
- MsRestAzure, MsRestAzure::Serialization
- Defined in:
- lib/2015-11-01/generated/azure_mgmt_subscriptions/subscription_client.rb
Overview
A service client - single point of access to the REST API.
Instance Attribute Summary collapse
-
#accept_language ⇒ String
Gets or sets the preferred language for the response.
-
#api_version ⇒ String
readonly
Client Api Version.
-
#base_url ⇒ String
The base URI of the service.
-
#credentials ⇒ Object
readonly
Credentials needed for the client to connect to Azure.
-
#generate_client_request_id ⇒ Boolean
is generated and included in each request.
-
#long_running_operation_retry_timeout ⇒ Integer
Running Operations.
-
#subscriptions ⇒ Subscriptions
readonly
Subscriptions.
-
#tenants ⇒ Tenants
readonly
Tenants.
Instance Method Summary collapse
-
#initialize(credentials = nil, base_url = nil, options = nil) ⇒ SubscriptionClient
constructor
Creates initializes a new instance of the SubscriptionClient class.
-
#make_request(method, path, options = {}) ⇒ Hash{String=>String}
Makes a request and returns the body of the response.
-
#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise
Makes a request asynchronously.
-
#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse
Makes a request and returns the operation response.
Constructor Details
#initialize(credentials = nil, base_url = nil, options = nil) ⇒ SubscriptionClient
Creates initializes a new instance of the SubscriptionClient class.
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscription_client.rb', line 46 def initialize(credentials = nil, base_url = nil, = nil) super(credentials, ) @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 @subscriptions = Subscriptions.new(self) @tenants = Tenants.new(self) @api_version = '2015-11-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.
24 25 26 |
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscription_client.rb', line 24 def accept_language @accept_language end |
#api_version ⇒ String (readonly)
Returns Client Api Version.
21 22 23 |
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscription_client.rb', line 21 def api_version @api_version end |
#base_url ⇒ String
Returns the base URI of the service.
15 16 17 |
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscription_client.rb', line 15 def base_url @base_url end |
#credentials ⇒ Object (readonly)
Returns Credentials needed for the client to connect to Azure.
18 19 20 |
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscription_client.rb', line 18 def credentials @credentials end |
#generate_client_request_id ⇒ Boolean
is generated and included in each request. Default is true.
32 33 34 |
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscription_client.rb', line 32 def generate_client_request_id @generate_client_request_id end |
#long_running_operation_retry_timeout ⇒ Integer
Running Operations. Default value is 30.
28 29 30 |
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscription_client.rb', line 28 def long_running_operation_retry_timeout @long_running_operation_retry_timeout end |
#subscriptions ⇒ Subscriptions (readonly)
Returns subscriptions.
35 36 37 |
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscription_client.rb', line 35 def subscriptions @subscriptions end |
#tenants ⇒ Tenants (readonly)
Returns tenants.
38 39 40 |
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscription_client.rb', line 38 def tenants @tenants 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"
= {
body: request_content,
query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, )
78 79 80 81 |
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscription_client.rb', line 78 def make_request(method, path, = {}) result = make_request_with_http_info(method, path, ) result.body unless result.nil? end |
#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise
Makes a request asynchronously.
103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscription_client.rb', line 103 def make_request_async(method, path, = {}) fail ArgumentError, 'method is nil' if method.nil? fail ArgumentError, 'path is nil' if path.nil? request_url = [:base_url] || @base_url request_headers = @request_headers request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil? .merge!({headers: request_headers.merge([:headers] || {})}) .merge!({credentials: @credentials}) unless @credentials.nil? super(request_url, method, path, ) end |
#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse
Makes a request and returns the operation response.
90 91 92 93 94 |
# File 'lib/2015-11-01/generated/azure_mgmt_subscriptions/subscription_client.rb', line 90 def make_request_with_http_info(method, path, = {}) result = make_request_async(method, path, ).value! result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body) result end |