Class: Azure::Relay::Mgmt::V2017_04_01::WCFRelays

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb

Overview

Use these API to manage Azure Relay resources through Azure Resource Manager.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ WCFRelays

Creates and initializes a new instance of the WCFRelays class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ RelayManagementClient (readonly)

Returns reference to the RelayManagementClient.

Returns:



23
24
25
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 23

def client
  @client
end

Instance Method Details

#create_or_update(resource_group_name, namespace_name, relay_name, parameters, custom_headers: nil) ⇒ WcfRelay

Creates or updates a WCF relay. This operation is idempotent.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

  • parameters (WcfRelay) —

    Parameters supplied to create a WCF relay.

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

    A hash of custom headers that

Returns:

  • (WcfRelay) —

    operation results.



137
138
139
140
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 137

def create_or_update(resource_group_name, namespace_name, relay_name, parameters, custom_headers:nil)
  response = create_or_update_async(resource_group_name, namespace_name, relay_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, namespace_name, relay_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates a WCF relay. This operation is idempotent.

Azure subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

  • parameters (WcfRelay) —

    Parameters supplied to create a WCF relay.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 172

def create_or_update_async(resource_group_name, namespace_name, relay_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'namespace_name is nil' if namespace_name.nil?
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MaxLength': '50'" if !namespace_name.nil? && namespace_name.length > 50
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MinLength': '6'" if !namespace_name.nil? && namespace_name.length < 6
  fail ArgumentError, 'relay_name is nil' if relay_name.nil?
  fail ArgumentError, "'relay_name' should satisfy the constraint - 'MinLength': '1'" if !relay_name.nil? && relay_name.length < 1
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_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?

  # Serialize Request
  request_mapper = Azure::Relay::Mgmt::V2017_04_01::Models::WcfRelay.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'namespaceName' => namespace_name,'relayName' => relay_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, 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 MsRest::HttpOperationError.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::Relay::Mgmt::V2017_04_01::Models::WcfRelay.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

#create_or_update_authorization_rule(resource_group_name, namespace_name, relay_name, authorization_rule_name, parameters, custom_headers: nil) ⇒ AuthorizationRule

Creates or updates an authorization rule for a WCF relay.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

  • authorization_rule_name (String) —

    The authorization rule name.

  • parameters (AuthorizationRule) —

    The authorization rule parameters.

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

    A hash of custom headers that

Returns:

  • (AuthorizationRule) —

    operation results.



554
555
556
557
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 554

def create_or_update_authorization_rule(resource_group_name, namespace_name, relay_name, authorization_rule_name, parameters, custom_headers:nil)
  response = create_or_update_authorization_rule_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_authorization_rule_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates an authorization rule for a WCF relay.

Azure subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

  • authorization_rule_name (String) —

    The authorization rule name.

  • parameters (AuthorizationRule) —

    The authorization rule parameters.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 591

def create_or_update_authorization_rule_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'namespace_name is nil' if namespace_name.nil?
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MaxLength': '50'" if !namespace_name.nil? && namespace_name.length > 50
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MinLength': '6'" if !namespace_name.nil? && namespace_name.length < 6
  fail ArgumentError, 'relay_name is nil' if relay_name.nil?
  fail ArgumentError, "'relay_name' should satisfy the constraint - 'MinLength': '1'" if !relay_name.nil? && relay_name.length < 1
  fail ArgumentError, 'authorization_rule_name is nil' if authorization_rule_name.nil?
  fail ArgumentError, "'authorization_rule_name' should satisfy the constraint - 'MinLength': '1'" if !authorization_rule_name.nil? && authorization_rule_name.length < 1
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_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?

  # Serialize Request
  request_mapper = Azure::Relay::Mgmt::V2017_04_01::Models::AuthorizationRule.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'namespaceName' => namespace_name,'relayName' => relay_name,'authorizationRuleName' => authorization_rule_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, 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 MsRest::HttpOperationError.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::Relay::Mgmt::V2017_04_01::Models::AuthorizationRule.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

#create_or_update_authorization_rule_with_http_info(resource_group_name, namespace_name, relay_name, authorization_rule_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates an authorization rule for a WCF relay.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

  • authorization_rule_name (String) —

    The authorization rule name.

  • parameters (AuthorizationRule) —

    The authorization rule parameters.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



573
574
575
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 573

def create_or_update_authorization_rule_with_http_info(resource_group_name, namespace_name, relay_name, authorization_rule_name, parameters, custom_headers:nil)
  create_or_update_authorization_rule_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, parameters, custom_headers:custom_headers).value!
end

#create_or_update_with_http_info(resource_group_name, namespace_name, relay_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a WCF relay. This operation is idempotent.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

  • parameters (WcfRelay) —

    Parameters supplied to create a WCF relay.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



155
156
157
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 155

def create_or_update_with_http_info(resource_group_name, namespace_name, relay_name, parameters, custom_headers:nil)
  create_or_update_async(resource_group_name, namespace_name, relay_name, parameters, custom_headers:custom_headers).value!
end

#delete(resource_group_name, namespace_name, relay_name, custom_headers: nil) ⇒ Object

Deletes a WCF relay.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

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

    A hash of custom headers that



250
251
252
253
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 250

def delete(resource_group_name, namespace_name, relay_name, custom_headers:nil)
  response = delete_async(resource_group_name, namespace_name, relay_name, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, namespace_name, relay_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a WCF relay.

Azure subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 283

def delete_async(resource_group_name, namespace_name, relay_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'namespace_name is nil' if namespace_name.nil?
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MaxLength': '50'" if !namespace_name.nil? && namespace_name.length > 50
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MinLength': '6'" if !namespace_name.nil? && namespace_name.length < 6
  fail ArgumentError, 'relay_name is nil' if relay_name.nil?
  fail ArgumentError, "'relay_name' should satisfy the constraint - 'MinLength': '1'" if !relay_name.nil? && relay_name.length < 1
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'namespaceName' => namespace_name,'relayName' => relay_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, 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 || status_code == 204
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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?

    result
  end

  promise.execute
end

#delete_authorization_rule(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers: nil) ⇒ Object

Deletes a WCF relay authorization rule.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

  • authorization_rule_name (String) —

    The authorization rule name.

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

    A hash of custom headers that



672
673
674
675
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 672

def delete_authorization_rule(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers:nil)
  response = delete_authorization_rule_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers:custom_headers).value!
  nil
end

#delete_authorization_rule_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a WCF relay authorization rule.

Azure subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

  • authorization_rule_name (String) —

    The authorization rule name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 707

def delete_authorization_rule_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'namespace_name is nil' if namespace_name.nil?
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MaxLength': '50'" if !namespace_name.nil? && namespace_name.length > 50
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MinLength': '6'" if !namespace_name.nil? && namespace_name.length < 6
  fail ArgumentError, 'relay_name is nil' if relay_name.nil?
  fail ArgumentError, "'relay_name' should satisfy the constraint - 'MinLength': '1'" if !relay_name.nil? && relay_name.length < 1
  fail ArgumentError, 'authorization_rule_name is nil' if authorization_rule_name.nil?
  fail ArgumentError, "'authorization_rule_name' should satisfy the constraint - 'MinLength': '1'" if !authorization_rule_name.nil? && authorization_rule_name.length < 1
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'namespaceName' => namespace_name,'relayName' => relay_name,'authorizationRuleName' => authorization_rule_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, 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 || status_code == 204
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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?

    result
  end

  promise.execute
end

#delete_authorization_rule_with_http_info(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a WCF relay authorization rule.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

  • authorization_rule_name (String) —

    The authorization rule name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



690
691
692
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 690

def delete_authorization_rule_with_http_info(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers:nil)
  delete_authorization_rule_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers:custom_headers).value!
end

#delete_with_http_info(resource_group_name, namespace_name, relay_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a WCF relay.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



267
268
269
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 267

def delete_with_http_info(resource_group_name, namespace_name, relay_name, custom_headers:nil)
  delete_async(resource_group_name, namespace_name, relay_name, custom_headers:custom_headers).value!
end

#get(resource_group_name, namespace_name, relay_name, custom_headers: nil) ⇒ WcfRelay

Returns the description for the specified WCF relay.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

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

    A hash of custom headers that

Returns:

  • (WcfRelay) —

    operation results.



344
345
346
347
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 344

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

#get_async(resource_group_name, namespace_name, relay_name, custom_headers: nil) ⇒ Concurrent::Promise

Returns the description for the specified WCF relay.

Azure subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 377

def get_async(resource_group_name, namespace_name, relay_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'namespace_name is nil' if namespace_name.nil?
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MaxLength': '50'" if !namespace_name.nil? && namespace_name.length > 50
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MinLength': '6'" if !namespace_name.nil? && namespace_name.length < 6
  fail ArgumentError, 'relay_name is nil' if relay_name.nil?
  fail ArgumentError, "'relay_name' should satisfy the constraint - 'MinLength': '1'" if !relay_name.nil? && relay_name.length < 1
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'namespaceName' => namespace_name,'relayName' => relay_name,'subscriptionId' => @client.subscription_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 || status_code == 204
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.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::Relay::Mgmt::V2017_04_01::Models::WcfRelay.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_authorization_rule(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers: nil) ⇒ AuthorizationRule

Get authorizationRule for a WCF relay by name.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

  • authorization_rule_name (String) —

    The authorization rule name.

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

    A hash of custom headers that

Returns:

  • (AuthorizationRule) —

    operation results.



771
772
773
774
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 771

def get_authorization_rule(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers:nil)
  response = get_authorization_rule_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_authorization_rule_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers: nil) ⇒ Concurrent::Promise

Get authorizationRule for a WCF relay by name.

Azure subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

  • authorization_rule_name (String) —

    The authorization rule name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 806

def get_authorization_rule_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'namespace_name is nil' if namespace_name.nil?
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MaxLength': '50'" if !namespace_name.nil? && namespace_name.length > 50
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MinLength': '6'" if !namespace_name.nil? && namespace_name.length < 6
  fail ArgumentError, 'relay_name is nil' if relay_name.nil?
  fail ArgumentError, "'relay_name' should satisfy the constraint - 'MinLength': '1'" if !relay_name.nil? && relay_name.length < 1
  fail ArgumentError, 'authorization_rule_name is nil' if authorization_rule_name.nil?
  fail ArgumentError, "'authorization_rule_name' should satisfy the constraint - 'MinLength': '1'" if !authorization_rule_name.nil? && authorization_rule_name.length < 1
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'namespaceName' => namespace_name,'relayName' => relay_name,'authorizationRuleName' => authorization_rule_name,'subscriptionId' => @client.subscription_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 MsRest::HttpOperationError.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::Relay::Mgmt::V2017_04_01::Models::AuthorizationRule.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_authorization_rule_with_http_info(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get authorizationRule for a WCF relay by name.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

  • authorization_rule_name (String) —

    The authorization rule name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



789
790
791
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 789

def get_authorization_rule_with_http_info(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers:nil)
  get_authorization_rule_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers:custom_headers).value!
end

#get_with_http_info(resource_group_name, namespace_name, relay_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Returns the description for the specified WCF relay.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



361
362
363
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 361

def get_with_http_info(resource_group_name, namespace_name, relay_name, custom_headers:nil)
  get_async(resource_group_name, namespace_name, relay_name, custom_headers:custom_headers).value!
end

#list_authorization_rules(resource_group_name, namespace_name, relay_name, custom_headers: nil) ⇒ Array<AuthorizationRule>

Authorization rules for a WCF relay.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

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

    A hash of custom headers that

Returns:

  • (Array<AuthorizationRule>) —

    operation results.



448
449
450
451
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 448

def list_authorization_rules(resource_group_name, namespace_name, relay_name, custom_headers:nil)
  first_page = list_authorization_rules_as_lazy(resource_group_name, namespace_name, relay_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_authorization_rules_as_lazy(resource_group_name, namespace_name, relay_name, custom_headers: nil) ⇒ AuthorizationRuleListResult

Authorization rules for a WCF relay.

Azure subscription. will be added to the HTTP request.

the response.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

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

    A hash of custom headers that

Returns:

  • (AuthorizationRuleListResult) —

    which provide lazy access to pages of



1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 1311

def list_authorization_rules_as_lazy(resource_group_name, namespace_name, relay_name, custom_headers:nil)
  response = list_authorization_rules_async(resource_group_name, namespace_name, relay_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_authorization_rules_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_authorization_rules_async(resource_group_name, namespace_name, relay_name, custom_headers: nil) ⇒ Concurrent::Promise

Authorization rules for a WCF relay.

Azure subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 481

def list_authorization_rules_async(resource_group_name, namespace_name, relay_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'namespace_name is nil' if namespace_name.nil?
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MaxLength': '50'" if !namespace_name.nil? && namespace_name.length > 50
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MinLength': '6'" if !namespace_name.nil? && namespace_name.length < 6
  fail ArgumentError, 'relay_name is nil' if relay_name.nil?
  fail ArgumentError, "'relay_name' should satisfy the constraint - 'MinLength': '1'" if !relay_name.nil? && relay_name.length < 1
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'namespaceName' => namespace_name,'relayName' => relay_name,'subscriptionId' => @client.subscription_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::Relay::Mgmt::V2017_04_01::Models::AuthorizationRuleListResult.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_authorization_rules_next(next_page_link, custom_headers: nil) ⇒ AuthorizationRuleListResult

Authorization rules for a WCF relay.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (AuthorizationRuleListResult) —

    operation results.



1197
1198
1199
1200
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 1197

def list_authorization_rules_next(next_page_link, custom_headers:nil)
  response = list_authorization_rules_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_authorization_rules_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Authorization rules for a WCF relay.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 1226

def list_authorization_rules_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      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::Relay::Mgmt::V2017_04_01::Models::AuthorizationRuleListResult.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_authorization_rules_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Authorization rules for a WCF relay.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1212
1213
1214
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 1212

def list_authorization_rules_next_with_http_info(next_page_link, custom_headers:nil)
  list_authorization_rules_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_authorization_rules_with_http_info(resource_group_name, namespace_name, relay_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Authorization rules for a WCF relay.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



465
466
467
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 465

def list_authorization_rules_with_http_info(resource_group_name, namespace_name, relay_name, custom_headers:nil)
  list_authorization_rules_async(resource_group_name, namespace_name, relay_name, custom_headers:custom_headers).value!
end

#list_by_namespace(resource_group_name, namespace_name, custom_headers: nil) ⇒ Array<WcfRelay>

Lists the WCF relays within the namespace.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

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

    A hash of custom headers that

Returns:

  • (Array<WcfRelay>) —

    operation results.



36
37
38
39
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 36

def list_by_namespace(resource_group_name, namespace_name, custom_headers:nil)
  first_page = list_by_namespace_as_lazy(resource_group_name, namespace_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_namespace_as_lazy(resource_group_name, namespace_name, custom_headers: nil) ⇒ WcfRelaysListResult

Lists the WCF relays within the namespace.

Azure subscription. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

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

    A hash of custom headers that

Returns:

  • (WcfRelaysListResult) —

    which provide lazy access to pages of the



1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 1287

def list_by_namespace_as_lazy(resource_group_name, namespace_name, custom_headers:nil)
  response = list_by_namespace_async(resource_group_name, namespace_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_namespace_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_namespace_async(resource_group_name, namespace_name, custom_headers: nil) ⇒ Concurrent::Promise

Lists the WCF relays within the namespace.

Azure subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 67

def list_by_namespace_async(resource_group_name, namespace_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'namespace_name is nil' if namespace_name.nil?
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MaxLength': '50'" if !namespace_name.nil? && namespace_name.length > 50
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MinLength': '6'" if !namespace_name.nil? && namespace_name.length < 6
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'namespaceName' => namespace_name,'subscriptionId' => @client.subscription_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 MsRest::HttpOperationError.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::Relay::Mgmt::V2017_04_01::Models::WcfRelaysListResult.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_by_namespace_next(next_page_link, custom_headers: nil) ⇒ WcfRelaysListResult

Lists the WCF relays within the namespace.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (WcfRelaysListResult) —

    operation results.



1109
1110
1111
1112
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 1109

def list_by_namespace_next(next_page_link, custom_headers:nil)
  response = list_by_namespace_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_namespace_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Lists the WCF relays within the namespace.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 1138

def list_by_namespace_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      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 MsRest::HttpOperationError.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::Relay::Mgmt::V2017_04_01::Models::WcfRelaysListResult.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_by_namespace_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the WCF relays within the namespace.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1124
1125
1126
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 1124

def list_by_namespace_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_namespace_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_namespace_with_http_info(resource_group_name, namespace_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists the WCF relays within the namespace.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



52
53
54
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 52

def list_by_namespace_with_http_info(resource_group_name, namespace_name, custom_headers:nil)
  list_by_namespace_async(resource_group_name, namespace_name, custom_headers:custom_headers).value!
end

#list_keys(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers: nil) ⇒ AccessKeys

Primary and secondary connection strings to the WCF relay.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

  • authorization_rule_name (String) —

    The authorization rule name.

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

    A hash of custom headers that

Returns:

  • (AccessKeys) —

    operation results.



880
881
882
883
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 880

def list_keys(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers:nil)
  response = list_keys_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_keys_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers: nil) ⇒ Concurrent::Promise

Primary and secondary connection strings to the WCF relay.

Azure subscription. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

  • authorization_rule_name (String) —

    The authorization rule name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 915

def list_keys_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'namespace_name is nil' if namespace_name.nil?
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MaxLength': '50'" if !namespace_name.nil? && namespace_name.length > 50
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MinLength': '6'" if !namespace_name.nil? && namespace_name.length < 6
  fail ArgumentError, 'relay_name is nil' if relay_name.nil?
  fail ArgumentError, "'relay_name' should satisfy the constraint - 'MinLength': '1'" if !relay_name.nil? && relay_name.length < 1
  fail ArgumentError, 'authorization_rule_name is nil' if authorization_rule_name.nil?
  fail ArgumentError, "'authorization_rule_name' should satisfy the constraint - 'MinLength': '1'" if !authorization_rule_name.nil? && authorization_rule_name.length < 1
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}/listKeys'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'namespaceName' => namespace_name,'relayName' => relay_name,'authorizationRuleName' => authorization_rule_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, 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 MsRest::HttpOperationError.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::Relay::Mgmt::V2017_04_01::Models::AccessKeys.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_keys_with_http_info(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Primary and secondary connection strings to the WCF relay.

Azure subscription. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

  • authorization_rule_name (String) —

    The authorization rule name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



898
899
900
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 898

def list_keys_with_http_info(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers:nil)
  list_keys_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, custom_headers:custom_headers).value!
end

#regenerate_keys(resource_group_name, namespace_name, relay_name, authorization_rule_name, parameters, custom_headers: nil) ⇒ AccessKeys

Regenerates the primary or secondary connection strings to the WCF relay.

Azure subscription. regenerate authorization rule. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

  • authorization_rule_name (String) —

    The authorization rule name.

  • parameters (RegenerateAccessKeyParameters) —

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (AccessKeys) —

    operation results.



991
992
993
994
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 991

def regenerate_keys(resource_group_name, namespace_name, relay_name, authorization_rule_name, parameters, custom_headers:nil)
  response = regenerate_keys_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#regenerate_keys_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Regenerates the primary or secondary connection strings to the WCF relay.

Azure subscription. regenerate authorization rule. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

  • authorization_rule_name (String) —

    The authorization rule name.

  • parameters (RegenerateAccessKeyParameters) —

    Parameters supplied to

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 1030

def regenerate_keys_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'namespace_name is nil' if namespace_name.nil?
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MaxLength': '50'" if !namespace_name.nil? && namespace_name.length > 50
  fail ArgumentError, "'namespace_name' should satisfy the constraint - 'MinLength': '6'" if !namespace_name.nil? && namespace_name.length < 6
  fail ArgumentError, 'relay_name is nil' if relay_name.nil?
  fail ArgumentError, "'relay_name' should satisfy the constraint - 'MinLength': '1'" if !relay_name.nil? && relay_name.length < 1
  fail ArgumentError, 'authorization_rule_name is nil' if authorization_rule_name.nil?
  fail ArgumentError, "'authorization_rule_name' should satisfy the constraint - 'MinLength': '1'" if !authorization_rule_name.nil? && authorization_rule_name.length < 1
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_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?

  # Serialize Request
  request_mapper = Azure::Relay::Mgmt::V2017_04_01::Models::RegenerateAccessKeyParameters.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}/authorizationRules/{authorizationRuleName}/regenerateKeys'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'namespaceName' => namespace_name,'relayName' => relay_name,'authorizationRuleName' => authorization_rule_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, 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 MsRest::HttpOperationError.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::Relay::Mgmt::V2017_04_01::Models::AccessKeys.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

#regenerate_keys_with_http_info(resource_group_name, namespace_name, relay_name, authorization_rule_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Regenerates the primary or secondary connection strings to the WCF relay.

Azure subscription. regenerate authorization rule. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of the Resource group within the

  • namespace_name (String) —

    The namespace name

  • relay_name (String) —

    The relay name.

  • authorization_rule_name (String) —

    The authorization rule name.

  • parameters (RegenerateAccessKeyParameters) —

    Parameters supplied to

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1011
1012
1013
 
# File 'lib/2017-04-01/generated/azure_mgmt_relay/wcfrelays.rb', line 1011

def regenerate_keys_with_http_info(resource_group_name, namespace_name, relay_name, authorization_rule_name, parameters, custom_headers:nil)
  regenerate_keys_async(resource_group_name, namespace_name, relay_name, authorization_rule_name, parameters, custom_headers:custom_headers).value!
end