Class: Azure::Signalr::Mgmt::V2018_03_01_preview::SignalR

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb

Overview

REST API for Azure SignalR Service

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ SignalR

Creates and initializes a new instance of the SignalR class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SignalRManagementClient (readonly)

Returns reference to the SignalRManagementClient.

Returns:



22
23
24
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 22

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, resource_name, parameters: nil, custom_headers: nil) ⇒ SignalRResource

Create a new SignalR service and update an exiting SignalR service.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. update operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

  • parameters (SignalRCreateParameters) (defaults to: nil) —

    Parameters for the create or

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

    A hash of custom headers that

Returns:

  • (SignalRResource) —

    operation results.



832
833
834
835
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 832

def begin_create_or_update(resource_group_name, resource_name, parameters:nil, custom_headers:nil)
  response = begin_create_or_update_async(resource_group_name, resource_name, parameters:parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, resource_name, parameters: nil, custom_headers: nil) ⇒ Concurrent::Promise

Create a new SignalR service and update an exiting SignalR service.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. update operation to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

  • parameters (SignalRCreateParameters) (defaults to: nil) —

    Parameters for the create or

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
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
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 869

def begin_create_or_update_async(resource_group_name, resource_name, parameters:nil, custom_headers:nil)
  @client.api_version = '2018-03-01-preview'
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'resource_name is nil' if resource_name.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::Signalr::Mgmt::V2018_03_01_preview::Models::SignalRCreateParameters.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.SignalRService/SignalR/{resourceName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'resourceName' => resource_name},
      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 || status_code == 201 || status_code == 202
      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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Signalr::Mgmt::V2018_03_01_preview::Models::SignalRResource.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
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Signalr::Mgmt::V2018_03_01_preview::Models::SignalRResource.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

#begin_create_or_update_with_http_info(resource_group_name, resource_name, parameters: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Create a new SignalR service and update an exiting SignalR service.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. update operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

  • parameters (SignalRCreateParameters) (defaults to: nil) —

    Parameters for the create or

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



851
852
853
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 851

def begin_create_or_update_with_http_info(resource_group_name, resource_name, parameters:nil, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, resource_name, parameters:parameters, custom_headers:custom_headers).value!
end

#begin_delete(resource_group_name, resource_name, custom_headers: nil) ⇒ Object

Operation to delete a SignalR service.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

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

    A hash of custom headers that



952
953
954
955
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 952

def begin_delete(resource_group_name, resource_name, custom_headers:nil)
  response = begin_delete_async(resource_group_name, resource_name, custom_headers:custom_headers).value!
  nil
end

#begin_delete_async(resource_group_name, resource_name, custom_headers: nil) ⇒ Concurrent::Promise

Operation to delete a SignalR service.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 985

def begin_delete_async(resource_group_name, resource_name, custom_headers:nil)
  @client.api_version = '2018-03-01-preview'
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'resource_name is nil' if resource_name.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.SignalRService/SignalR/{resourceName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'resourceName' => resource_name},
      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 == 202 || status_code == 204
      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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#begin_delete_with_http_info(resource_group_name, resource_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Operation to delete a SignalR service.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



969
970
971
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 969

def begin_delete_with_http_info(resource_group_name, resource_name, custom_headers:nil)
  begin_delete_async(resource_group_name, resource_name, custom_headers:custom_headers).value!
end

#begin_regenerate_key(resource_group_name, resource_name, parameters: nil, custom_headers: nil) ⇒ SignalRKeys

Regenerate SignalR service access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Regenerate Key Operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

  • parameters (RegenerateKeyParameters) (defaults to: nil) —

    Parameter that describes the

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

    A hash of custom headers that

Returns:

  • (SignalRKeys) —

    operation results.



717
718
719
720
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 717

def begin_regenerate_key(resource_group_name, resource_name, parameters:nil, custom_headers:nil)
  response = begin_regenerate_key_async(resource_group_name, resource_name, parameters:parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_regenerate_key_async(resource_group_name, resource_name, parameters: nil, custom_headers: nil) ⇒ Concurrent::Promise

Regenerate SignalR service access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Regenerate Key Operation. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

  • parameters (RegenerateKeyParameters) (defaults to: nil) —

    Parameter that describes the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 756

def begin_regenerate_key_async(resource_group_name, resource_name, parameters:nil, custom_headers:nil)
  @client.api_version = '2018-03-01-preview'
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'resource_name is nil' if resource_name.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::Signalr::Mgmt::V2018_03_01_preview::Models::RegenerateKeyParameters.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.SignalRService/SignalR/{resourceName}/regenerateKey'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'resourceName' => resource_name},
      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 == 201
      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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Signalr::Mgmt::V2018_03_01_preview::Models::SignalRKeys.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

#begin_regenerate_key_with_http_info(resource_group_name, resource_name, parameters: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Regenerate SignalR service access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Regenerate Key Operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

  • parameters (RegenerateKeyParameters) (defaults to: nil) —

    Parameter that describes the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



737
738
739
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 737

def begin_regenerate_key_with_http_info(resource_group_name, resource_name, parameters:nil, custom_headers:nil)
  begin_regenerate_key_async(resource_group_name, resource_name, parameters:parameters, custom_headers:custom_headers).value!
end

#begin_update(resource_group_name, resource_name, parameters: nil, custom_headers: nil) ⇒ SignalRResource

Operation to update an exiting SignalR service.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

  • parameters (SignalRUpdateParameters) (defaults to: nil) —

    Parameters for the update

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

    A hash of custom headers that

Returns:

  • (SignalRResource) —

    operation results.



1044
1045
1046
1047
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 1044

def begin_update(resource_group_name, resource_name, parameters:nil, custom_headers:nil)
  response = begin_update_async(resource_group_name, resource_name, parameters:parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_update_async(resource_group_name, resource_name, parameters: nil, custom_headers: nil) ⇒ Concurrent::Promise

Operation to update an exiting SignalR service.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. operation to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

  • parameters (SignalRUpdateParameters) (defaults to: nil) —

    Parameters for the update

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 1081

def begin_update_async(resource_group_name, resource_name, parameters:nil, custom_headers:nil)
  @client.api_version = '2018-03-01-preview'
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'resource_name is nil' if resource_name.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::Signalr::Mgmt::V2018_03_01_preview::Models::SignalRUpdateParameters.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.SignalRService/SignalR/{resourceName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'resourceName' => resource_name},
      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(:patch, 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 == 202
      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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Signalr::Mgmt::V2018_03_01_preview::Models::SignalRResource.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

#begin_update_with_http_info(resource_group_name, resource_name, parameters: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Operation to update an exiting SignalR service.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

  • parameters (SignalRUpdateParameters) (defaults to: nil) —

    Parameters for the update

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1063
1064
1065
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 1063

def begin_update_with_http_info(resource_group_name, resource_name, parameters:nil, custom_headers:nil)
  begin_update_async(resource_group_name, resource_name, parameters:parameters, custom_headers:custom_headers).value!
end

#check_name_availability(location, parameters: nil, custom_headers: nil) ⇒ NameAvailability

Checks that the SignalR name is valid and is not already in use.

operation. will be added to the HTTP request.

Parameters:

  • location (String) —

    the region

  • parameters (NameAvailabilityParameters) (defaults to: nil) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (NameAvailability) —

    operation results.



35
36
37
38
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 35

def check_name_availability(location, parameters:nil, custom_headers:nil)
  response = check_name_availability_async(location, parameters:parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#check_name_availability_async(location, parameters: nil, custom_headers: nil) ⇒ Concurrent::Promise

Checks that the SignalR name is valid and is not already in use.

operation. to the HTTP request.

Parameters:

  • location (String) —

    the region

  • parameters (NameAvailabilityParameters) (defaults to: nil) —

    Parameters supplied to the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 66

def check_name_availability_async(location, parameters:nil, custom_headers:nil)
  fail ArgumentError, 'location is nil' if location.nil?
  @client.api_version = '2018-03-01-preview'
  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::Signalr::Mgmt::V2018_03_01_preview::Models::NameAvailabilityParameters.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}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'location' => location,'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 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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Signalr::Mgmt::V2018_03_01_preview::Models::NameAvailability.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

#check_name_availability_with_http_info(location, parameters: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Checks that the SignalR name is valid and is not already in use.

operation. will be added to the HTTP request.

Parameters:

  • location (String) —

    the region

  • parameters (NameAvailabilityParameters) (defaults to: nil) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



51
52
53
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 51

def check_name_availability_with_http_info(location, parameters:nil, custom_headers:nil)
  check_name_availability_async(location, parameters:parameters, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, resource_name, parameters: nil, custom_headers: nil) ⇒ SignalRResource

Create a new SignalR service and update an exiting SignalR service.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. update operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

  • parameters (SignalRCreateParameters) (defaults to: nil) —

    Parameters for the create or

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

    A hash of custom headers that

Returns:

  • (SignalRResource) —

    operation results.



574
575
576
577
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 574

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

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

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. update operation will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

  • parameters (SignalRCreateParameters) (defaults to: nil) —

    Parameters for the create or

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 592

def create_or_update_async(resource_group_name, resource_name, parameters:nil, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, resource_name, parameters:parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Signalr::Mgmt::V2018_03_01_preview::Models::SignalRResource.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#delete(resource_group_name, resource_name, custom_headers: nil) ⇒ Object

Operation to delete a SignalR service.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

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

    A hash of custom headers that



620
621
622
623
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 620

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

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

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 636

def delete_async(resource_group_name, resource_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(resource_group_name, resource_name, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#get(resource_group_name, resource_name, custom_headers: nil) ⇒ SignalRResource

Get the SignalR service and its properties.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

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

    A hash of custom headers that

Returns:

  • (SignalRResource) —

    operation results.



472
473
474
475
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 472

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

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

Get the SignalR service and its properties.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 505

def get_async(resource_group_name, resource_name, custom_headers:nil)
  @client.api_version = '2018-03-01-preview'
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'resource_name is nil' if resource_name.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.SignalRService/SignalR/{resourceName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'resourceName' => resource_name},
      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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Signalr::Mgmt::V2018_03_01_preview::Models::SignalRResource.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(resource_group_name, resource_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get the SignalR service and its properties.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



489
490
491
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 489

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

#list_by_resource_group(resource_group_name, custom_headers: nil) ⇒ Array<SignalRResource>

Handles requests to list all resources in a resource group.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

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

    A hash of custom headers that

Returns:

  • (Array<SignalRResource>) —

    operation results.



224
225
226
227
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 224

def list_by_resource_group(resource_group_name, custom_headers:nil)
  first_page = list_by_resource_group_as_lazy(resource_group_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_resource_group_as_lazy(resource_group_name, custom_headers: nil) ⇒ SignalRResourceList

Handles requests to list all resources in a resource group.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

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

    A hash of custom headers that

Returns:

  • (SignalRResourceList) —

    which provide lazy access to pages of the



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 1355

def list_by_resource_group_as_lazy(resource_group_name, custom_headers:nil)
  response = list_by_resource_group_async(resource_group_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_resource_group_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_resource_group_async(resource_group_name, custom_headers: nil) ⇒ Concurrent::Promise

Handles requests to list all resources in a resource group.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
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
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 255

def list_by_resource_group_async(resource_group_name, custom_headers:nil)
  @client.api_version = '2018-03-01-preview'
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.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.SignalRService/SignalR'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name},
      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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Signalr::Mgmt::V2018_03_01_preview::Models::SignalRResourceList.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_resource_group_next(next_page_link, custom_headers: nil) ⇒ SignalRResourceList

Handles requests to list all resources in a resource group.

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:

  • (SignalRResourceList) —

    operation results.



1243
1244
1245
1246
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 1243

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

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

Handles requests to list all resources in a resource group.

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.



1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 1272

def list_by_resource_group_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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Signalr::Mgmt::V2018_03_01_preview::Models::SignalRResourceList.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_resource_group_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Handles requests to list all resources in a resource group.

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.



1258
1259
1260
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 1258

def list_by_resource_group_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_resource_group_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_resource_group_with_http_info(resource_group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Handles requests to list all resources in a resource group.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



240
241
242
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 240

def list_by_resource_group_with_http_info(resource_group_name, custom_headers:nil)
  list_by_resource_group_async(resource_group_name, custom_headers:custom_headers).value!
end

#list_by_subscription(custom_headers: nil) ⇒ Array<SignalRResource>

Handles requests to list all resources in a subscription.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (Array<SignalRResource>) —

    operation results.



135
136
137
138
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 135

def list_by_subscription(custom_headers:nil)
  first_page = list_by_subscription_as_lazy(custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_subscription_as_lazy(custom_headers: nil) ⇒ SignalRResourceList

Handles requests to list all resources in a subscription.

will be added to the HTTP request.

response.

Parameters:

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

    A hash of custom headers that

Returns:

  • (SignalRResourceList) —

    which provide lazy access to pages of the



1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 1332

def list_by_subscription_as_lazy(custom_headers:nil)
  response = list_by_subscription_async(custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_subscription_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_subscription_async(custom_headers: nil) ⇒ Concurrent::Promise

Handles requests to list all resources in a subscription.

to the HTTP request.

Parameters:

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 160

def list_by_subscription_async(custom_headers:nil)
  @client.api_version = '2018-03-01-preview'
  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}/providers/Microsoft.SignalRService/SignalR'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Signalr::Mgmt::V2018_03_01_preview::Models::SignalRResourceList.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_subscription_next(next_page_link, custom_headers: nil) ⇒ SignalRResourceList

Handles requests to list all resources in a subscription.

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:

  • (SignalRResourceList) —

    operation results.



1153
1154
1155
1156
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 1153

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

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

Handles requests to list all resources in a subscription.

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.



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 1182

def list_by_subscription_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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Signalr::Mgmt::V2018_03_01_preview::Models::SignalRResourceList.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_subscription_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Handles requests to list all resources in a subscription.

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.



1168
1169
1170
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 1168

def list_by_subscription_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_subscription_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_subscription_with_http_info(custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Handles requests to list all resources in a subscription.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



148
149
150
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 148

def list_by_subscription_with_http_info(custom_headers:nil)
  list_by_subscription_async(custom_headers:custom_headers).value!
end

#list_keys(resource_group_name, resource_name, custom_headers: nil) ⇒ SignalRKeys

Get the access keys of the SignalR resource.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

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

    A hash of custom headers that

Returns:

  • (SignalRKeys) —

    operation results.



321
322
323
324
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 321

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

#list_keys_async(resource_group_name, resource_name, custom_headers: nil) ⇒ Concurrent::Promise

Get the access keys of the SignalR resource.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
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
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 354

def list_keys_async(resource_group_name, resource_name, custom_headers:nil)
  @client.api_version = '2018-03-01-preview'
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'resource_name is nil' if resource_name.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.SignalRService/SignalR/{resourceName}/listKeys'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'resourceName' => resource_name},
      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 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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::Signalr::Mgmt::V2018_03_01_preview::Models::SignalRKeys.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, resource_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get the access keys of the SignalR resource.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



338
339
340
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 338

def list_keys_with_http_info(resource_group_name, resource_name, custom_headers:nil)
  list_keys_async(resource_group_name, resource_name, custom_headers:custom_headers).value!
end

#regenerate_key(resource_group_name, resource_name, parameters: nil, custom_headers: nil) ⇒ SignalRKeys

Regenerate SignalR service access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Regenerate Key Operation. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

  • parameters (RegenerateKeyParameters) (defaults to: nil) —

    Parameter that describes the

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

    A hash of custom headers that

Returns:

  • (SignalRKeys) —

    operation results.



424
425
426
427
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 424

def regenerate_key(resource_group_name, resource_name, parameters:nil, custom_headers:nil)
  response = regenerate_key_async(resource_group_name, resource_name, parameters:parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#regenerate_key_async(resource_group_name, resource_name, parameters: nil, custom_headers: nil) ⇒ Concurrent::Promise

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Regenerate Key Operation. will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

  • parameters (RegenerateKeyParameters) (defaults to: nil) —

    Parameter that describes the

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 442

def regenerate_key_async(resource_group_name, resource_name, parameters:nil, custom_headers:nil)
  # Send request
  promise = begin_regenerate_key_async(resource_group_name, resource_name, parameters:parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Signalr::Mgmt::V2018_03_01_preview::Models::SignalRKeys.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#update(resource_group_name, resource_name, parameters: nil, custom_headers: nil) ⇒ SignalRResource

Operation to update an exiting SignalR service.

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

  • parameters (SignalRUpdateParameters) (defaults to: nil) —

    Parameters for the update

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

    A hash of custom headers that

Returns:

  • (SignalRResource) —

    operation results.



666
667
668
669
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 666

def update(resource_group_name, resource_name, parameters:nil, custom_headers:nil)
  response = update_async(resource_group_name, resource_name, parameters:parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_async(resource_group_name, resource_name, parameters: nil, custom_headers: nil) ⇒ Concurrent::Promise

contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. operation will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group that

  • resource_name (String) —

    The name of the SignalR resource.

  • parameters (SignalRUpdateParameters) (defaults to: nil) —

    Parameters for the update

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
 
# File 'lib/2018-03-01-preview/generated/azure_mgmt_signalr/signal_r.rb', line 684

def update_async(resource_group_name, resource_name, parameters:nil, custom_headers:nil)
  # Send request
  promise = begin_update_async(resource_group_name, resource_name, parameters:parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::Signalr::Mgmt::V2018_03_01_preview::Models::SignalRResource.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end