class Azure::Subscriptions::Mgmt::V2019_03_01_preview::Subscriptions

Subscription client provides an interface to create and manage Azure subscriptions programmatically.

Attributes

client[R]

@return [SubscriptionClient] reference to the SubscriptionClient

Public Class Methods

new(client) click to toggle source

Creates and initializes a new instance of the Subscriptions class. @param client service class for accessing basic functionality.

# File lib/2019-03-01-preview/generated/azure_mgmt_subscriptions/subscriptions.rb, line 17
def initialize(client)
  @client = client
end

Public Instance Methods

cancel(subscription_id, custom_headers:nil) click to toggle source

The operation to cancel a subscription

@param subscription_id [String] Subscription Id. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [CanceledSubscriptionId] operation results.

# File lib/2019-03-01-preview/generated/azure_mgmt_subscriptions/subscriptions.rb, line 33
def cancel(subscription_id, custom_headers:nil)
  response = cancel_async(subscription_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
cancel_async(subscription_id, custom_headers:nil) click to toggle source

The operation to cancel a subscription

@param subscription_id [String] Subscription Id. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2019-03-01-preview/generated/azure_mgmt_subscriptions/subscriptions.rb, line 60
def cancel_async(subscription_id, custom_headers:nil)
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.Subscription/cancel'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    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::Subscriptions::Mgmt::V2019_03_01_preview::Models::CanceledSubscriptionId.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
cancel_with_http_info(subscription_id, custom_headers:nil) click to toggle source

The operation to cancel a subscription

@param subscription_id [String] Subscription Id. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2019-03-01-preview/generated/azure_mgmt_subscriptions/subscriptions.rb, line 47
def cancel_with_http_info(subscription_id, custom_headers:nil)
  cancel_async(subscription_id, custom_headers:custom_headers).value!
end
rename(subscription_id, body, custom_headers:nil) click to toggle source

The operation to rename a subscription

@param subscription_id [String] Subscription Id. @param body [SubscriptionName] Subscription Name @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [RenamedSubscriptionId] operation results.

# File lib/2019-03-01-preview/generated/azure_mgmt_subscriptions/subscriptions.rb, line 123
def rename(subscription_id, body, custom_headers:nil)
  response = rename_async(subscription_id, body, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
rename_async(subscription_id, body, custom_headers:nil) click to toggle source

The operation to rename a subscription

@param subscription_id [String] Subscription Id. @param body [SubscriptionName] Subscription Name @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] Promise object which holds the HTTP response.

# File lib/2019-03-01-preview/generated/azure_mgmt_subscriptions/subscriptions.rb, line 152
def rename_async(subscription_id, body, custom_headers:nil)
  fail ArgumentError, 'subscription_id is nil' if subscription_id.nil?
  fail ArgumentError, 'body is nil' if body.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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::Subscriptions::Mgmt::V2019_03_01_preview::Models::SubscriptionName.mapper()
  request_content = @client.serialize(request_mapper,  body)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.Subscription/rename'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRest::HttpOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    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::Subscriptions::Mgmt::V2019_03_01_preview::Models::RenamedSubscriptionId.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
rename_with_http_info(subscription_id, body, custom_headers:nil) click to toggle source

The operation to rename a subscription

@param subscription_id [String] Subscription Id. @param body [SubscriptionName] Subscription Name @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [MsRestAzure::AzureOperationResponse] HTTP response information.

# File lib/2019-03-01-preview/generated/azure_mgmt_subscriptions/subscriptions.rb, line 138
def rename_with_http_info(subscription_id, body, custom_headers:nil)
  rename_async(subscription_id, body, custom_headers:custom_headers).value!
end