Class: Azure::Signalr::Mgmt::V2020_05_01::SignalRPrivateEndpointConnections

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-05-01/generated/azure_mgmt_signalr/signal_rprivate_endpoint_connections.rb

Overview

REST API for Azure SignalR Service

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ SignalRPrivateEndpointConnections

Creates and initializes a new instance of the SignalRPrivateEndpointConnections class.



17
18
19
 
# File 'lib/2020-05-01/generated/azure_mgmt_signalr/signal_rprivate_endpoint_connections.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SignalRManagementClient (readonly) 



22
23
24
 
# File 'lib/2020-05-01/generated/azure_mgmt_signalr/signal_rprivate_endpoint_connections.rb', line 22

def client
  @client
end

Instance Method Details

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

Delete the specified private endpoint connection associated with a SignalR resource.

endpoint connection associated with 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.



318
319
320
321
 
# File 'lib/2020-05-01/generated/azure_mgmt_signalr/signal_rprivate_endpoint_connections.rb', line 318

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

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

Delete the specified private endpoint connection associated with a SignalR resource.

endpoint connection associated with the SignalR resource. contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. to the HTTP request.



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
 
# File 'lib/2020-05-01/generated/azure_mgmt_signalr/signal_rprivate_endpoint_connections.rb', line 357

def begin_delete_async(private_endpoint_connection_name, resource_group_name, resource_name, custom_headers:nil)
  fail ArgumentError, 'private_endpoint_connection_name is nil' if private_endpoint_connection_name.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?
  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}/privateEndpointConnections/{privateEndpointConnectionName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'privateEndpointConnectionName' => private_endpoint_connection_name,'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 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.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(private_endpoint_connection_name, resource_group_name, resource_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Delete the specified private endpoint connection associated with a SignalR resource.

endpoint connection associated with 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.



338
339
340
 
# File 'lib/2020-05-01/generated/azure_mgmt_signalr/signal_rprivate_endpoint_connections.rb', line 338

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

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

Delete the specified private endpoint connection associated with a SignalR resource.

endpoint connection associated with 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.



270
271
272
273
 
# File 'lib/2020-05-01/generated/azure_mgmt_signalr/signal_rprivate_endpoint_connections.rb', line 270

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

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

endpoint connection associated with 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.

response.



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/2020-05-01/generated/azure_mgmt_signalr/signal_rprivate_endpoint_connections.rb', line 288

def delete_async(private_endpoint_connection_name, resource_group_name, resource_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(private_endpoint_connection_name, 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(private_endpoint_connection_name, resource_group_name, resource_name, custom_headers: nil) ⇒ PrivateEndpointConnection

Get the specified private endpoint connection associated with a SignalR resource.

endpoint connection associated with 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.



39
40
41
42
 
# File 'lib/2020-05-01/generated/azure_mgmt_signalr/signal_rprivate_endpoint_connections.rb', line 39

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

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

Get the specified private endpoint connection associated with a SignalR resource.

endpoint connection associated with the SignalR resource. contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. to the HTTP request.



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
126
127
128
129
130
131
132
 
# File 'lib/2020-05-01/generated/azure_mgmt_signalr/signal_rprivate_endpoint_connections.rb', line 78

def get_async(private_endpoint_connection_name, resource_group_name, resource_name, custom_headers:nil)
  fail ArgumentError, 'private_endpoint_connection_name is nil' if private_endpoint_connection_name.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?
  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}/privateEndpointConnections/{privateEndpointConnectionName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'privateEndpointConnectionName' => private_endpoint_connection_name,'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 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.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::V2020_05_01::Models::PrivateEndpointConnection.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(private_endpoint_connection_name, resource_group_name, resource_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get the specified private endpoint connection associated with a SignalR resource.

endpoint connection associated with 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.



59
60
61
 
# File 'lib/2020-05-01/generated/azure_mgmt_signalr/signal_rprivate_endpoint_connections.rb', line 59

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

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

Update the state of specified private endpoint connection associated with a SignalR resource.

endpoint connection associated with the SignalR resource. contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. endpoint and its properties. will be added to the HTTP request.



151
152
153
154
 
# File 'lib/2020-05-01/generated/azure_mgmt_signalr/signal_rprivate_endpoint_connections.rb', line 151

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

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

Update the state of specified private endpoint connection associated with a SignalR resource.

endpoint connection associated with the SignalR resource. contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. endpoint and its properties. to the HTTP request.



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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/2020-05-01/generated/azure_mgmt_signalr/signal_rprivate_endpoint_connections.rb', line 194

def update_async(private_endpoint_connection_name, resource_group_name, resource_name, parameters:nil, custom_headers:nil)
  fail ArgumentError, 'private_endpoint_connection_name is nil' if private_endpoint_connection_name.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?
  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::V2020_05_01::Models::PrivateEndpointConnection.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}/privateEndpointConnections/{privateEndpointConnectionName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'privateEndpointConnectionName' => private_endpoint_connection_name,'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
      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.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::V2020_05_01::Models::PrivateEndpointConnection.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

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

Update the state of specified private endpoint connection associated with a SignalR resource.

endpoint connection associated with the SignalR resource. contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. endpoint and its properties. will be added to the HTTP request.



173
174
175
 
# File 'lib/2020-05-01/generated/azure_mgmt_signalr/signal_rprivate_endpoint_connections.rb', line 173

def update_with_http_info(private_endpoint_connection_name, resource_group_name, resource_name, parameters:nil, custom_headers:nil)
  update_async(private_endpoint_connection_name, resource_group_name, resource_name, parameters:parameters, custom_headers:custom_headers).value!
end