Class: Azure::ARM::Web::ClassicMobileServices

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/generated/azure_mgmt_web/classic_mobile_services.rb

Overview

Use these APIs to manage Azure Websites resources through the Azure Resource Manager. All task operations conform to the HTTP/1.1 protocol specification and each operation returns an x-ms-request-id header that can be used to obtain information about the request. You must make sure that requests made to these resources are secure. For more information, see <a href=“msdn.microsoft.com/en-us/library/azure/dn790557.aspx”>Authenticating Azure Resource Manager requests.</a>

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ClassicMobileServices

Creates and initializes a new instance of the ClassicMobileServices class.

Parameters:

  • client —

    service class for accessing basic functionality.



25
26
27
 
# File 'lib/generated/azure_mgmt_web/classic_mobile_services.rb', line 25

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns reference to the WebSiteManagementClient.

Returns:

  • reference to the WebSiteManagementClient



30
31
32
 
# File 'lib/generated/azure_mgmt_web/classic_mobile_services.rb', line 30

def client
  @client
end

Instance Method Details

#delete_classic_mobile_service(resource_group_name, name, custom_headers = nil) ⇒ Object

Delete a mobile service.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of resource group

  • name (String) —

    Name of mobile service

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

    A hash of custom headers that

Returns:

  • (Object) —

    operation results.



226
227
228
229
 
# File 'lib/generated/azure_mgmt_web/classic_mobile_services.rb', line 226

def delete_classic_mobile_service(resource_group_name, name, custom_headers = nil)
  response = delete_classic_mobile_service_async(resource_group_name, name, custom_headers).value!
  response.body unless response.nil?
end

#delete_classic_mobile_service_async(resource_group_name, name, custom_headers = nil) ⇒ Concurrent::Promise

Delete a mobile service.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of resource group

  • name (String) —

    Name of mobile service

  • 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
 
# File 'lib/generated/azure_mgmt_web/classic_mobile_services.rb', line 255

def delete_classic_mobile_service_async(resource_group_name, name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'name is nil' if name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}

  # 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.Web/classicMobileServices/{name}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'name' => name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :delete, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?

    result
  end

  promise.execute
end

#delete_classic_mobile_service_with_http_info(resource_group_name, name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Delete a mobile service.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of resource group

  • name (String) —

    Name of mobile service

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



241
242
243
 
# File 'lib/generated/azure_mgmt_web/classic_mobile_services.rb', line 241

def delete_classic_mobile_service_with_http_info(resource_group_name, name, custom_headers = nil)
  delete_classic_mobile_service_async(resource_group_name, name, custom_headers).value!
end

#get_classic_mobile_service(resource_group_name, name, custom_headers = nil) ⇒ ClassicMobileService

Get a mobile service.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of resource group

  • name (String) —

    Name of mobile service

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

    A hash of custom headers that

Returns:



132
133
134
135
 
# File 'lib/generated/azure_mgmt_web/classic_mobile_services.rb', line 132

def get_classic_mobile_service(resource_group_name, name, custom_headers = nil)
  response = get_classic_mobile_service_async(resource_group_name, name, custom_headers).value!
  response.body unless response.nil?
end

#get_classic_mobile_service_async(resource_group_name, name, custom_headers = nil) ⇒ Concurrent::Promise

Get a mobile service.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of resource group

  • name (String) —

    Name of mobile service

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
212
213
214
 
# File 'lib/generated/azure_mgmt_web/classic_mobile_services.rb', line 161

def get_classic_mobile_service_async(resource_group_name, name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'name is nil' if name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}

  # 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.Web/classicMobileServices/{name}'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'name' => name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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 = ClassicMobileService.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_classic_mobile_service_with_http_info(resource_group_name, name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Get a mobile service.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of resource group

  • name (String) —

    Name of mobile service

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



147
148
149
 
# File 'lib/generated/azure_mgmt_web/classic_mobile_services.rb', line 147

def get_classic_mobile_service_with_http_info(resource_group_name, name, custom_headers = nil)
  get_classic_mobile_service_async(resource_group_name, name, custom_headers).value!
end

#get_classic_mobile_services(resource_group_name, custom_headers = nil) ⇒ ClassicMobileServiceCollection

Get all mobile services in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of resource group

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

    A hash of custom headers that

Returns:



41
42
43
44
 
# File 'lib/generated/azure_mgmt_web/classic_mobile_services.rb', line 41

def get_classic_mobile_services(resource_group_name, custom_headers = nil)
  response = get_classic_mobile_services_async(resource_group_name, custom_headers).value!
  response.body unless response.nil?
end

#get_classic_mobile_services_async(resource_group_name, custom_headers = nil) ⇒ Concurrent::Promise

Get all mobile services in a resource group.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of resource group

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/generated/azure_mgmt_web/classic_mobile_services.rb', line 68

def get_classic_mobile_services_async(resource_group_name, custom_headers = nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?


  request_headers = {}

  # 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.Web/classicMobileServices'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :get, options)
  promise = request.run_promise do |req|
    @client.credentials.sign_request(req) unless @client.credentials.nil?
  end

  promise = promise.then do |http_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(request, http_response, error_model)
    end

    # Create Result
    result = MsRestAzure::AzureOperationResponse.new(request, http_response)
    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 = ClassicMobileServiceCollection.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response, 'result.body')
      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_classic_mobile_services_with_http_info(resource_group_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Get all mobile services in a resource group.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of resource group

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



55
56
57
 
# File 'lib/generated/azure_mgmt_web/classic_mobile_services.rb', line 55

def get_classic_mobile_services_with_http_info(resource_group_name, custom_headers = nil)
  get_classic_mobile_services_async(resource_group_name, custom_headers).value!
end