class Azure::TrafficManager::Mgmt::V2015_11_01::Endpoints

Endpoints

Attributes

client[R]

@return [TrafficManagerManagementClient] reference to the TrafficManagerManagementClient

Public Class Methods

new(client) click to toggle source

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

# File lib/2015-11-01/generated/azure_mgmt_traffic_manager/endpoints.rb, line 17
def initialize(client)
  @client = client
end

Public Instance Methods

create_or_update(resource_group_name, profile_name, endpoint_type, endpoint_name, parameters, custom_headers:nil) click to toggle source

Create or update a Traffic Manager endpoint.

@param resource_group_name [String] The name of the resource group containing the Traffic Manager endpoint to be created or updated. @param profile_name [String] The name of the Traffic Manager profile. @param endpoint_type [String] The type of the Traffic Manager endpoint to be created or updated. @param endpoint_name [String] The name of the Traffic Manager endpoint to be created or updated. @param parameters [Endpoint] The Traffic Manager endpoint parameters supplied to the CreateOrUpdate operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Endpoint] operation results.

# File lib/2015-11-01/generated/azure_mgmt_traffic_manager/endpoints.rb, line 271
def create_or_update(resource_group_name, profile_name, endpoint_type, endpoint_name, parameters, custom_headers:nil)
  response = create_or_update_async(resource_group_name, profile_name, endpoint_type, endpoint_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
create_or_update_async(resource_group_name, profile_name, endpoint_type, endpoint_name, parameters, custom_headers:nil) click to toggle source

Create or update a Traffic Manager endpoint.

@param resource_group_name [String] The name of the resource group containing the Traffic Manager endpoint to be created or updated. @param profile_name [String] The name of the Traffic Manager profile. @param endpoint_type [String] The type of the Traffic Manager endpoint to be created or updated. @param endpoint_name [String] The name of the Traffic Manager endpoint to be created or updated. @param parameters [Endpoint] The Traffic Manager endpoint parameters supplied to the CreateOrUpdate operation. @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/2015-11-01/generated/azure_mgmt_traffic_manager/endpoints.rb, line 314
def create_or_update_async(resource_group_name, profile_name, endpoint_type, endpoint_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'profile_name is nil' if profile_name.nil?
  fail ArgumentError, 'endpoint_type is nil' if endpoint_type.nil?
  fail ArgumentError, 'endpoint_name is nil' if endpoint_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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?


  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::TrafficManager::Mgmt::V2015_11_01::Models::Endpoint.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.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'profileName' => profile_name,'endpointType' => endpoint_type,'endpointName' => endpoint_name,'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(: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
      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::TrafficManager::Mgmt::V2015_11_01::Models::Endpoint.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::TrafficManager::Mgmt::V2015_11_01::Models::Endpoint.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
create_or_update_with_http_info(resource_group_name, profile_name, endpoint_type, endpoint_name, parameters, custom_headers:nil) click to toggle source

Create or update a Traffic Manager endpoint.

@param resource_group_name [String] The name of the resource group containing the Traffic Manager endpoint to be created or updated. @param profile_name [String] The name of the Traffic Manager profile. @param endpoint_type [String] The type of the Traffic Manager endpoint to be created or updated. @param endpoint_name [String] The name of the Traffic Manager endpoint to be created or updated. @param parameters [Endpoint] The Traffic Manager endpoint parameters supplied to the CreateOrUpdate operation. @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/2015-11-01/generated/azure_mgmt_traffic_manager/endpoints.rb, line 293
def create_or_update_with_http_info(resource_group_name, profile_name, endpoint_type, endpoint_name, parameters, custom_headers:nil)
  create_or_update_async(resource_group_name, profile_name, endpoint_type, endpoint_name, parameters, custom_headers:custom_headers).value!
end
delete(resource_group_name, profile_name, endpoint_type, endpoint_name, custom_headers:nil) click to toggle source

Deletes a Traffic Manager endpoint.

@param resource_group_name [String] The name of the resource group containing the Traffic Manager endpoint to be deleted. @param profile_name [String] The name of the Traffic Manager profile. @param endpoint_type [String] The type of the Traffic Manager endpoint to be deleted. @param endpoint_name [String] The name of the Traffic Manager endpoint to be deleted. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

# File lib/2015-11-01/generated/azure_mgmt_traffic_manager/endpoints.rb, line 403
def delete(resource_group_name, profile_name, endpoint_type, endpoint_name, custom_headers:nil)
  response = delete_async(resource_group_name, profile_name, endpoint_type, endpoint_name, custom_headers:custom_headers).value!
  nil
end
delete_async(resource_group_name, profile_name, endpoint_type, endpoint_name, custom_headers:nil) click to toggle source

Deletes a Traffic Manager endpoint.

@param resource_group_name [String] The name of the resource group containing the Traffic Manager endpoint to be deleted. @param profile_name [String] The name of the Traffic Manager profile. @param endpoint_type [String] The type of the Traffic Manager endpoint to be deleted. @param endpoint_name [String] The name of the Traffic Manager endpoint to be deleted. @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/2015-11-01/generated/azure_mgmt_traffic_manager/endpoints.rb, line 442
def delete_async(resource_group_name, profile_name, endpoint_type, endpoint_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'profile_name is nil' if profile_name.nil?
  fail ArgumentError, 'endpoint_type is nil' if endpoint_type.nil?
  fail ArgumentError, 'endpoint_name is nil' if endpoint_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?


  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.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'profileName' => profile_name,'endpointType' => endpoint_type,'endpointName' => endpoint_name,'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(: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 == 200 || 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
delete_with_http_info(resource_group_name, profile_name, endpoint_type, endpoint_name, custom_headers:nil) click to toggle source

Deletes a Traffic Manager endpoint.

@param resource_group_name [String] The name of the resource group containing the Traffic Manager endpoint to be deleted. @param profile_name [String] The name of the Traffic Manager profile. @param endpoint_type [String] The type of the Traffic Manager endpoint to be deleted. @param endpoint_name [String] The name of the Traffic Manager endpoint to be deleted. @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/2015-11-01/generated/azure_mgmt_traffic_manager/endpoints.rb, line 423
def delete_with_http_info(resource_group_name, profile_name, endpoint_type, endpoint_name, custom_headers:nil)
  delete_async(resource_group_name, profile_name, endpoint_type, endpoint_name, custom_headers:custom_headers).value!
end
get(resource_group_name, profile_name, endpoint_type, endpoint_name, custom_headers:nil) click to toggle source

Gets a Traffic Manager endpoint.

@param resource_group_name [String] The name of the resource group containing the Traffic Manager endpoint. @param profile_name [String] The name of the Traffic Manager profile. @param endpoint_type [String] The type of the Traffic Manager endpoint. @param endpoint_name [String] The name of the Traffic Manager endpoint. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Endpoint] operation results.

# File lib/2015-11-01/generated/azure_mgmt_traffic_manager/endpoints.rb, line 162
def get(resource_group_name, profile_name, endpoint_type, endpoint_name, custom_headers:nil)
  response = get_async(resource_group_name, profile_name, endpoint_type, endpoint_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
get_async(resource_group_name, profile_name, endpoint_type, endpoint_name, custom_headers:nil) click to toggle source

Gets a Traffic Manager endpoint.

@param resource_group_name [String] The name of the resource group containing the Traffic Manager endpoint. @param profile_name [String] The name of the Traffic Manager profile. @param endpoint_type [String] The type of the Traffic Manager endpoint. @param endpoint_name [String] The name of the Traffic Manager endpoint. @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/2015-11-01/generated/azure_mgmt_traffic_manager/endpoints.rb, line 197
def get_async(resource_group_name, profile_name, endpoint_type, endpoint_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'profile_name is nil' if profile_name.nil?
  fail ArgumentError, 'endpoint_type is nil' if endpoint_type.nil?
  fail ArgumentError, 'endpoint_name is nil' if endpoint_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?


  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.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'profileName' => profile_name,'endpointType' => endpoint_type,'endpointName' => endpoint_name,'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::TrafficManager::Mgmt::V2015_11_01::Models::Endpoint.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, profile_name, endpoint_type, endpoint_name, custom_headers:nil) click to toggle source

Gets a Traffic Manager endpoint.

@param resource_group_name [String] The name of the resource group containing the Traffic Manager endpoint. @param profile_name [String] The name of the Traffic Manager profile. @param endpoint_type [String] The type of the Traffic Manager endpoint. @param endpoint_name [String] The name of the Traffic Manager endpoint. @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/2015-11-01/generated/azure_mgmt_traffic_manager/endpoints.rb, line 180
def get_with_http_info(resource_group_name, profile_name, endpoint_type, endpoint_name, custom_headers:nil)
  get_async(resource_group_name, profile_name, endpoint_type, endpoint_name, custom_headers:custom_headers).value!
end
update(resource_group_name, profile_name, endpoint_type, endpoint_name, parameters, custom_headers:nil) click to toggle source

Update a Traffic Manager endpoint.

@param resource_group_name [String] The name of the resource group containing the Traffic Manager endpoint to be updated. @param profile_name [String] The name of the Traffic Manager profile. @param endpoint_type [String] The type of the Traffic Manager endpoint to be updated. @param endpoint_name [String] The name of the Traffic Manager endpoint to be updated. @param parameters [Endpoint] The Traffic Manager endpoint parameters supplied to the Update operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Endpoint] operation results.

# File lib/2015-11-01/generated/azure_mgmt_traffic_manager/endpoints.rb, line 41
def update(resource_group_name, profile_name, endpoint_type, endpoint_name, parameters, custom_headers:nil)
  response = update_async(resource_group_name, profile_name, endpoint_type, endpoint_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
update_async(resource_group_name, profile_name, endpoint_type, endpoint_name, parameters, custom_headers:nil) click to toggle source

Update a Traffic Manager endpoint.

@param resource_group_name [String] The name of the resource group containing the Traffic Manager endpoint to be updated. @param profile_name [String] The name of the Traffic Manager profile. @param endpoint_type [String] The type of the Traffic Manager endpoint to be updated. @param endpoint_name [String] The name of the Traffic Manager endpoint to be updated. @param parameters [Endpoint] The Traffic Manager endpoint parameters supplied to the Update operation. @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/2015-11-01/generated/azure_mgmt_traffic_manager/endpoints.rb, line 84
def update_async(resource_group_name, profile_name, endpoint_type, endpoint_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'profile_name is nil' if profile_name.nil?
  fail ArgumentError, 'endpoint_type is nil' if endpoint_type.nil?
  fail ArgumentError, 'endpoint_name is nil' if endpoint_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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?


  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::TrafficManager::Mgmt::V2015_11_01::Models::Endpoint.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.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'profileName' => profile_name,'endpointType' => endpoint_type,'endpointName' => endpoint_name,'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(: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
      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::TrafficManager::Mgmt::V2015_11_01::Models::Endpoint.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(resource_group_name, profile_name, endpoint_type, endpoint_name, parameters, custom_headers:nil) click to toggle source

Update a Traffic Manager endpoint.

@param resource_group_name [String] The name of the resource group containing the Traffic Manager endpoint to be updated. @param profile_name [String] The name of the Traffic Manager profile. @param endpoint_type [String] The type of the Traffic Manager endpoint to be updated. @param endpoint_name [String] The name of the Traffic Manager endpoint to be updated. @param parameters [Endpoint] The Traffic Manager endpoint parameters supplied to the Update operation. @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/2015-11-01/generated/azure_mgmt_traffic_manager/endpoints.rb, line 63
def update_with_http_info(resource_group_name, profile_name, endpoint_type, endpoint_name, parameters, custom_headers:nil)
  update_async(resource_group_name, profile_name, endpoint_type, endpoint_name, parameters, custom_headers:custom_headers).value!
end