Class: Azure::ADHybridHealthService::Mgmt::V2014_01_01::ADHybridHealthService

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.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) ⇒ ADHybridHealthService

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 87

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

  @adds_services = AddsServices.new(self)
  @alerts_operations = AlertsOperations.new(self)
  @configuration = Configuration.new(self)
  @dimensions_operations = DimensionsOperations.new(self)
  @adds_service_members_operations = AddsServiceMembersOperations.new(self)
  @ad_domain_service_members = AdDomainServiceMembers.new(self)
  @adds_services_user_preference = AddsServicesUserPreference.new(self)
  @adds_service = AddsService.new(self)
  @adds_services_replication_status = AddsServicesReplicationStatus.new(self)
  @adds_services_service_members = AddsServicesServiceMembers.new(self)
  @operations = Operations.new(self)
  @reports = Reports.new(self)
  @services_operations = ServicesOperations.new(self)
  @service = Service.new(self)
  @service_members_operations = ServiceMembersOperations.new(self)
  @api_version = '2014-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.



25
26
27
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 25

def accept_language
  @accept_language
end

#ad_domain_service_members ⇒ AdDomainServiceMembers (readonly)

Returns ad_domain_service_members.

Returns:



52
53
54
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 52

def ad_domain_service_members
  @ad_domain_service_members
end

#adds_service ⇒ AddsService (readonly)

Returns adds_service.

Returns:



58
59
60
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 58

def adds_service
  @adds_service
end

#adds_service_members_operations ⇒ AddsServiceMembersOperations (readonly)

Returns adds_service_members_operations.

Returns:



49
50
51
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 49

def adds_service_members_operations
  @adds_service_members_operations
end

#adds_services ⇒ AddsServices (readonly)

Returns adds_services.

Returns:



37
38
39
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 37

def adds_services
  @adds_services
end

#adds_services_replication_status ⇒ AddsServicesReplicationStatus (readonly)

Returns adds_services_replication_status.

Returns:



61
62
63
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 61

def adds_services_replication_status
  @adds_services_replication_status
end

#adds_services_service_members ⇒ AddsServicesServiceMembers (readonly)

Returns adds_services_service_members.

Returns:



64
65
66
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 64

def adds_services_service_members
  @adds_services_service_members
end

#adds_services_user_preference ⇒ AddsServicesUserPreference (readonly)

Returns adds_services_user_preference.

Returns:



55
56
57
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 55

def adds_services_user_preference
  @adds_services_user_preference
end

#alerts_operations ⇒ AlertsOperations (readonly)

Returns alerts_operations.

Returns:



40
41
42
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 40

def alerts_operations
  @alerts_operations
end

#api_version ⇒ String (readonly)

request.

Returns:

  • (String) —

    The version of the API to be used with the client



22
23
24
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 22

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/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 15

def base_url
  @base_url
end

#configuration ⇒ Configuration (readonly)

Returns configuration.

Returns:



43
44
45
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 43

def configuration
  @configuration
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/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 18

def credentials
  @credentials
end

#dimensions_operations ⇒ DimensionsOperations (readonly)

Returns dimensions_operations.

Returns:



46
47
48
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 46

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



34
35
36
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 34

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



29
30
31
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 29

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



67
68
69
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 67

def operations
  @operations
end

#reports ⇒ Reports (readonly)

Returns reports.

Returns:



70
71
72
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 70

def reports
  @reports
end

#service ⇒ Service (readonly)

Returns service.

Returns:



76
77
78
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 76

def service
  @service
end

#service_members_operations ⇒ ServiceMembersOperations (readonly)

Returns service_members_operations.

Returns:



79
80
81
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 79

def service_members_operations
  @service_members_operations
end

#services_operations ⇒ ServicesOperations (readonly)

Returns services_operations.

Returns:



73
74
75
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 73

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



132
133
134
135
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 132

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.



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 157

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.



144
145
146
147
148
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adhybrid_health_service.rb', line 144

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