Class: Azure::ARM::Subscriptions::SubscriptionClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/azure_mgmt_subscriptions/subscription_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, base_url = nil, options = nil) ⇒ SubscriptionClient

Creates initializes a new instance of the SubscriptionClient class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) —

    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.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/azure_mgmt_subscriptions/subscription_client.rb', line 50

def initialize(credentials, base_url = nil, options = nil)
  super(credentials, options)
  @base_url = base_url || 'https://management.azure.com'

  fail ArgumentError, 'credentials is nil' if credentials.nil?
  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials)
  @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
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.



24
25
26
 
# File 'lib/azure_mgmt_subscriptions/subscription_client.rb', line 24

def accept_language
  @accept_language
end

#api_version ⇒ String (readonly)

Returns Client Api Version.

Returns:

  • (String) —

    Client Api Version.



21
22
23
 
# File 'lib/azure_mgmt_subscriptions/subscription_client.rb', line 21

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/azure_mgmt_subscriptions/subscription_client.rb', line 15

def base_url
  @base_url
end

#credentials ⇒ Object

subscription.

Returns:

  • Subscription credentials which uniquely identify client



18
19
20
 
# File 'lib/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.

Returns:

  • (Boolean) —

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



32
33
34
 
# File 'lib/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.

Returns:

  • (Integer) —

    Gets or sets the retry timeout in seconds for Long



28
29
30
 
# File 'lib/azure_mgmt_subscriptions/subscription_client.rb', line 28

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#subscriptions ⇒ Object (readonly)

Returns subscriptions.

Returns:

  • subscriptions



39
40
41
 
# File 'lib/azure_mgmt_subscriptions/subscription_client.rb', line 39

def subscriptions
  @subscriptions
end

#tenants ⇒ Object (readonly)

Returns tenants.

Returns:

  • tenants



42
43
44
 
# File 'lib/azure_mgmt_subscriptions/subscription_client.rb', line 42

def tenants
  @tenants
end