Class: Azure::GraphRbac::V1_6::Domains

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/1.6/generated/azure_graph_rbac/domains.rb

Overview

The Graph RBAC Management Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Domains

Creates and initializes a new instance of the Domains class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/1.6/generated/azure_graph_rbac/domains.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ GraphRbacClient (readonly)

Returns reference to the GraphRbacClient.

Returns:



22
23
24
 
# File 'lib/1.6/generated/azure_graph_rbac/domains.rb', line 22

def client
  @client
end

Instance Method Details

#get(domain_name, custom_headers: nil) ⇒ Domain

Gets a specific domain in the current tenant.

will be added to the HTTP request.

Parameters:

  • domain_name (String) —

    name of the domain.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (Domain) —

    operation results.



120
121
122
123
 
# File 'lib/1.6/generated/azure_graph_rbac/domains.rb', line 120

def get(domain_name, custom_headers:nil)
  response = get_async(domain_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(domain_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets a specific domain in the current tenant.

to the HTTP request.

Parameters:

  • domain_name (String) —

    name of the domain.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/1.6/generated/azure_graph_rbac/domains.rb', line 147

def get_async(domain_name, custom_headers:nil)
  fail ArgumentError, 'domain_name is nil' if domain_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.tenant_id is nil' if @client.tenant_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{tenantID}/domains/{domainName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'domainName' => domain_name,'tenantID' => @client.tenant_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::GraphRbac::V1_6::Models::Domain.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_with_http_info(domain_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a specific domain in the current tenant.

will be added to the HTTP request.

Parameters:

  • domain_name (String) —

    name of the domain.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



134
135
136
 
# File 'lib/1.6/generated/azure_graph_rbac/domains.rb', line 134

def get_with_http_info(domain_name, custom_headers:nil)
  get_async(domain_name, custom_headers:custom_headers).value!
end

#list(filter: nil, custom_headers: nil) ⇒ DomainListResult

Gets a list of domains for the current tenant.

will be added to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil) —

    The filter to apply to the operation.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (DomainListResult) —

    operation results.



33
34
35
36
 
# File 'lib/1.6/generated/azure_graph_rbac/domains.rb', line 33

def list(filter:nil, custom_headers:nil)
  response = list_async(filter:filter, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_async(filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets a list of domains for the current tenant.

to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil) —

    The filter to apply to the operation.

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/1.6/generated/azure_graph_rbac/domains.rb', line 60

def list_async(filter:nil, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.tenant_id is nil' if @client.tenant_id.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{tenantID}/domains'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'tenantID' => @client.tenant_id},
      query_params: {'$filter' => filter,'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::GraphRbac::V1_6::Models::DomainListResult.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_with_http_info(filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of domains for the current tenant.

will be added to the HTTP request.

Parameters:

  • filter (String) (defaults to: nil) —

    The filter to apply to the operation.

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



47
48
49
 
# File 'lib/1.6/generated/azure_graph_rbac/domains.rb', line 47

def list_with_http_info(filter:nil, custom_headers:nil)
  list_async(filter:filter, custom_headers:custom_headers).value!
end