Class: Azure::ARM::Web::GlobalCertificateOrder

Inherits:
Object
  • Object
show all
Includes:
Models, MsRestAzure
Defined in:
lib/generated/azure_mgmt_web/global_certificate_order.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) ⇒ GlobalCertificateOrder

Creates and initializes a new instance of the GlobalCertificateOrder class.

Parameters:

  • client —

    service class for accessing basic functionality.



25
26
27
 
# File 'lib/generated/azure_mgmt_web/global_certificate_order.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/global_certificate_order.rb', line 30

def client
  @client
end

Instance Method Details

#get_all_certificate_orders(custom_headers = nil) ⇒ CertificateOrderCollection

Lists all domains 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:



40
41
42
43
 
# File 'lib/generated/azure_mgmt_web/global_certificate_order.rb', line 40

def get_all_certificate_orders(custom_headers = nil)
  response = get_all_certificate_orders_async(custom_headers).value!
  response.body unless response.nil?
end

#get_all_certificate_orders_async(custom_headers = nil) ⇒ Concurrent::Promise

Lists all domains 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.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/generated/azure_mgmt_web/global_certificate_order.rb', line 65

def get_all_certificate_orders_async(custom_headers = 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}/providers/Microsoft.CertificateRegistration/certificateOrders'
  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 || {})
  }

  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 = CertificateOrderCollection.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_all_certificate_orders_with_http_info(custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all domains 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.



53
54
55
 
# File 'lib/generated/azure_mgmt_web/global_certificate_order.rb', line 53

def get_all_certificate_orders_with_http_info(custom_headers = nil)
  get_all_certificate_orders_async(custom_headers).value!
end

#validate_certificate_purchase_information(certificate_order, custom_headers = nil) ⇒ Object

Validate certificate purchase information

will be added to the HTTP request.

Parameters:

  • certificate_order (CertificateOrder) —

    Certificate order

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

    A hash of custom headers that

Returns:

  • (Object) —

    operation results.



127
128
129
130
 
# File 'lib/generated/azure_mgmt_web/global_certificate_order.rb', line 127

def validate_certificate_purchase_information(certificate_order, custom_headers = nil)
  response = validate_certificate_purchase_information_async(certificate_order, custom_headers).value!
  response.body unless response.nil?
end

#validate_certificate_purchase_information_async(certificate_order, custom_headers = nil) ⇒ Concurrent::Promise

Validate certificate purchase information

to the HTTP request.

Parameters:

  • certificate_order (CertificateOrder) —

    Certificate order

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/generated/azure_mgmt_web/global_certificate_order.rb', line 154

def validate_certificate_purchase_information_async(certificate_order, custom_headers = nil)
  fail ArgumentError, 'certificate_order is nil' if certificate_order.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?

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

  # Serialize Request
  request_mapper = CertificateOrder.mapper()
  request_content = @client.serialize(request_mapper,  certificate_order, 'certificate_order')
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = '/subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/validateCertificateRegistrationInformation'
  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {})
  }

  request_url = @base_url || @client.base_url

  request = MsRest::HttpOperationRequest.new(request_url, path_template, :post, 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

#validate_certificate_purchase_information_with_http_info(certificate_order, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Validate certificate purchase information

will be added to the HTTP request.

Parameters:

  • certificate_order (CertificateOrder) —

    Certificate order

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



141
142
143
 
# File 'lib/generated/azure_mgmt_web/global_certificate_order.rb', line 141

def validate_certificate_purchase_information_with_http_info(certificate_order, custom_headers = nil)
  validate_certificate_purchase_information_async(certificate_order, custom_headers).value!
end