class Azure::ContainerService::Mgmt::V2018_09_30_preview::OpenShiftManagedClusters

The Container Service Client.

Attributes

client[R]

@return [ContainerServiceClient] reference to the ContainerServiceClient

Public Class Methods

new(client) click to toggle source

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

# File lib/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 17
def initialize(client)
  @client = client
end

Public Instance Methods

begin_create_or_update(resource_group_name, resource_name, parameters, custom_headers:nil) click to toggle source

Creates or updates an OpenShift managed cluster.

Creates or updates a OpenShift managed cluster with the specified configuration for agents and OpenShift version.

@param resource_group_name [String] The name of the resource group. @param resource_name [String] The name of the OpenShift managed cluster resource. @param parameters [OpenShiftManagedCluster] Parameters supplied to the Create or Update an OpenShift Managed Cluster operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [OpenShiftManagedCluster] operation results.

# File lib/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 489
def begin_create_or_update(resource_group_name, resource_name, parameters, custom_headers:nil)
  response = begin_create_or_update_async(resource_group_name, resource_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
begin_create_or_update_async(resource_group_name, resource_name, parameters, custom_headers:nil) click to toggle source

Creates or updates an OpenShift managed cluster.

Creates or updates a OpenShift managed cluster with the specified configuration for agents and OpenShift version.

@param resource_group_name [String] The name of the resource group. @param resource_name [String] The name of the OpenShift managed cluster resource. @param parameters [OpenShiftManagedCluster] Parameters supplied to the Create or Update an OpenShift Managed Cluster 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/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 530
def begin_create_or_update_async(resource_group_name, resource_name, parameters, custom_headers: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_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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::ContainerService::Mgmt::V2018_09_30_preview::Models::OpenShiftManagedCluster.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.ContainerService/openShiftManagedClusters/{resourceName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'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 || 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::ContainerService::Mgmt::V2018_09_30_preview::Models::OpenShiftManagedCluster.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::ContainerService::Mgmt::V2018_09_30_preview::Models::OpenShiftManagedCluster.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
begin_create_or_update_with_http_info(resource_group_name, resource_name, parameters, custom_headers:nil) click to toggle source

Creates or updates an OpenShift managed cluster.

Creates or updates a OpenShift managed cluster with the specified configuration for agents and OpenShift version.

@param resource_group_name [String] The name of the resource group. @param resource_name [String] The name of the OpenShift managed cluster resource. @param parameters [OpenShiftManagedCluster] Parameters supplied to the Create or Update an OpenShift Managed Cluster 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/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 510
def begin_create_or_update_with_http_info(resource_group_name, resource_name, parameters, custom_headers:nil)
  begin_create_or_update_async(resource_group_name, resource_name, parameters, custom_headers:custom_headers).value!
end
begin_delete(resource_group_name, resource_name, custom_headers:nil) click to toggle source

Deletes an OpenShift managed cluster.

Deletes the OpenShift managed cluster with a specified resource group and name.

@param resource_group_name [String] The name of the resource group. @param resource_name [String] The name of the OpenShift managed cluster resource. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

# File lib/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 735
def begin_delete(resource_group_name, resource_name, custom_headers:nil)
  response = begin_delete_async(resource_group_name, resource_name, custom_headers:custom_headers).value!
  nil
end
begin_delete_async(resource_group_name, resource_name, custom_headers:nil) click to toggle source

Deletes an OpenShift managed cluster.

Deletes the OpenShift managed cluster with a specified resource group and name.

@param resource_group_name [String] The name of the resource group. @param resource_name [String] The name of the OpenShift managed cluster resource. @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/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 772
def begin_delete_async(resource_group_name, resource_name, custom_headers: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_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  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.ContainerService/openShiftManagedClusters/{resourceName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'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 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
begin_delete_with_http_info(resource_group_name, resource_name, custom_headers:nil) click to toggle source

Deletes an OpenShift managed cluster.

Deletes the OpenShift managed cluster with a specified resource group and name.

@param resource_group_name [String] The name of the resource group. @param resource_name [String] The name of the OpenShift managed cluster resource. @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/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 754
def begin_delete_with_http_info(resource_group_name, resource_name, custom_headers:nil)
  begin_delete_async(resource_group_name, resource_name, custom_headers:custom_headers).value!
end
begin_update_tags(resource_group_name, resource_name, parameters, custom_headers:nil) click to toggle source

Updates tags on an OpenShift managed cluster.

Updates an OpenShift managed cluster with the specified tags.

@param resource_group_name [String] The name of the resource group. @param resource_name [String] The name of the OpenShift managed cluster resource. @param parameters [TagsObject] Parameters supplied to the Update OpenShift Managed Cluster Tags operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [OpenShiftManagedCluster] operation results.

# File lib/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 619
def begin_update_tags(resource_group_name, resource_name, parameters, custom_headers:nil)
  response = begin_update_tags_async(resource_group_name, resource_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
begin_update_tags_async(resource_group_name, resource_name, parameters, custom_headers:nil) click to toggle source

Updates tags on an OpenShift managed cluster.

Updates an OpenShift managed cluster with the specified tags.

@param resource_group_name [String] The name of the resource group. @param resource_name [String] The name of the OpenShift managed cluster resource. @param parameters [TagsObject] Parameters supplied to the Update OpenShift Managed Cluster Tags 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/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 658
def begin_update_tags_async(resource_group_name, resource_name, parameters, custom_headers: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_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, 'resource_name is nil' if resource_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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::ContainerService::Mgmt::V2018_09_30_preview::Models::TagsObject.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.ContainerService/openShiftManagedClusters/{resourceName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'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(: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::ContainerService::Mgmt::V2018_09_30_preview::Models::OpenShiftManagedCluster.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
begin_update_tags_with_http_info(resource_group_name, resource_name, parameters, custom_headers:nil) click to toggle source

Updates tags on an OpenShift managed cluster.

Updates an OpenShift managed cluster with the specified tags.

@param resource_group_name [String] The name of the resource group. @param resource_name [String] The name of the OpenShift managed cluster resource. @param parameters [TagsObject] Parameters supplied to the Update OpenShift Managed Cluster Tags 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/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 639
def begin_update_tags_with_http_info(resource_group_name, resource_name, parameters, custom_headers:nil)
  begin_update_tags_async(resource_group_name, resource_name, parameters, custom_headers:custom_headers).value!
end
create_or_update(resource_group_name, resource_name, parameters, custom_headers:nil) click to toggle source

Creates or updates an OpenShift managed cluster.

Creates or updates a OpenShift managed cluster with the specified configuration for agents and OpenShift version.

@param resource_group_name [String] The name of the resource group. @param resource_name [String] The name of the OpenShift managed cluster resource. @param parameters [OpenShiftManagedCluster] Parameters supplied to the Create or Update an OpenShift Managed Cluster operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [OpenShiftManagedCluster] operation results.

# File lib/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 345
def create_or_update(resource_group_name, resource_name, parameters, custom_headers:nil)
  response = create_or_update_async(resource_group_name, resource_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
create_or_update_async(resource_group_name, resource_name, parameters, custom_headers:nil) click to toggle source

@param resource_group_name [String] The name of the resource group. @param resource_name [String] The name of the OpenShift managed cluster resource. @param parameters [OpenShiftManagedCluster] Parameters supplied to the Create or Update an OpenShift Managed Cluster operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] promise which provides async access to http response.

# File lib/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 362
def create_or_update_async(resource_group_name, resource_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, resource_name, parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::ContainerService::Mgmt::V2018_09_30_preview::Models::OpenShiftManagedCluster.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end
delete(resource_group_name, resource_name, custom_headers:nil) click to toggle source

Deletes an OpenShift managed cluster.

Deletes the OpenShift managed cluster with a specified resource group and name.

@param resource_group_name [String] The name of the resource group. @param resource_name [String] The name of the OpenShift managed cluster resource. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

# File lib/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 442
def delete(resource_group_name, resource_name, custom_headers:nil)
  response = delete_async(resource_group_name, resource_name, custom_headers:custom_headers).value!
  nil
end
delete_async(resource_group_name, resource_name, custom_headers:nil) click to toggle source

@param resource_group_name [String] The name of the resource group. @param resource_name [String] The name of the OpenShift managed cluster resource. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] promise which provides async access to http response.

# File lib/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 457
def delete_async(resource_group_name, resource_name, custom_headers:nil)
  # Send request
  promise = begin_delete_async(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(resource_group_name, resource_name, custom_headers:nil) click to toggle source

Gets a OpenShift managed cluster.

Gets the details of the managed OpenShift cluster with a specified resource group and name.

@param resource_group_name [String] The name of the resource group. @param resource_name [String] The name of the OpenShift managed cluster resource. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [OpenShiftManagedCluster] operation results.

# File lib/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 236
def get(resource_group_name, resource_name, custom_headers:nil)
  response = get_async(resource_group_name, resource_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
get_async(resource_group_name, resource_name, custom_headers:nil) click to toggle source

Gets a OpenShift managed cluster.

Gets the details of the managed OpenShift cluster with a specified resource group and name.

@param resource_group_name [String] The name of the resource group. @param resource_name [String] The name of the OpenShift managed cluster resource. @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/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 273
def get_async(resource_group_name, resource_name, custom_headers: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_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  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.ContainerService/openShiftManagedClusters/{resourceName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'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 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::ContainerService::Mgmt::V2018_09_30_preview::Models::OpenShiftManagedCluster.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, resource_name, custom_headers:nil) click to toggle source

Gets a OpenShift managed cluster.

Gets the details of the managed OpenShift cluster with a specified resource group and name.

@param resource_group_name [String] The name of the resource group. @param resource_name [String] The name of the OpenShift managed cluster resource. @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/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 255
def get_with_http_info(resource_group_name, resource_name, custom_headers:nil)
  get_async(resource_group_name, resource_name, custom_headers:custom_headers).value!
end
list(custom_headers:nil) click to toggle source

Gets a list of OpenShift managed clusters in the specified subscription.

Gets a list of OpenShift managed clusters in the specified subscription. The operation returns properties of each OpenShift managed cluster.

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

@return [Array<OpenShiftManagedCluster>] operation results.

# File lib/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 35
def list(custom_headers:nil)
  first_page = list_as_lazy(custom_headers:custom_headers)
  first_page.get_all_items
end
list_as_lazy(custom_headers:nil) click to toggle source

Gets a list of OpenShift managed clusters in the specified subscription.

Gets a list of OpenShift managed clusters in the specified subscription. The operation returns properties of each OpenShift managed cluster.

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

@return [OpenShiftManagedClusterListResult] which provide lazy access to pages of the response.

# File lib/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 1031
def list_as_lazy(custom_headers:nil)
  response = list_async(custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end
list_async(custom_headers:nil) click to toggle source

Gets a list of OpenShift managed clusters in the specified subscription.

Gets a list of OpenShift managed clusters in the specified subscription. The operation returns properties of each OpenShift managed cluster.

@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/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 66
def list_async(custom_headers: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}/providers/Microsoft.ContainerService/openShiftManagedClusters'

  request_url = @base_url || @client.base_url

  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 || {}),
      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::ContainerService::Mgmt::V2018_09_30_preview::Models::OpenShiftManagedClusterListResult.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
list_by_resource_group(resource_group_name, custom_headers:nil) click to toggle source

Lists OpenShift managed clusters in the specified subscription and resource group.

Lists OpenShift managed clusters in the specified subscription and resource group. The operation returns properties of each OpenShift managed cluster.

@param resource_group_name [String] The name of the resource group. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Array<OpenShiftManagedCluster>] operation results.

# File lib/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 132
def list_by_resource_group(resource_group_name, custom_headers:nil)
  first_page = list_by_resource_group_as_lazy(resource_group_name, custom_headers:custom_headers)
  first_page.get_all_items
end
list_by_resource_group_as_lazy(resource_group_name, custom_headers:nil) click to toggle source

Lists OpenShift managed clusters in the specified subscription and resource group.

Lists OpenShift managed clusters in the specified subscription and resource group. The operation returns properties of each OpenShift managed cluster.

@param resource_group_name [String] The name of the resource group. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [OpenShiftManagedClusterListResult] which provide lazy access to pages of the response.

# File lib/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 1056
def list_by_resource_group_as_lazy(resource_group_name, custom_headers:nil)
  response = list_by_resource_group_async(resource_group_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_resource_group_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end
list_by_resource_group_async(resource_group_name, custom_headers:nil) click to toggle source

Lists OpenShift managed clusters in the specified subscription and resource group.

Lists OpenShift managed clusters in the specified subscription and resource group. The operation returns properties of each OpenShift managed cluster.

@param resource_group_name [String] The name of the resource group. @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/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 167
def list_by_resource_group_async(resource_group_name, custom_headers: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_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1


  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.ContainerService/openShiftManagedClusters'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_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 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::ContainerService::Mgmt::V2018_09_30_preview::Models::OpenShiftManagedClusterListResult.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
list_by_resource_group_next(next_page_link, custom_headers:nil) click to toggle source

Lists OpenShift managed clusters in the specified subscription and resource group.

Lists OpenShift managed clusters in the specified subscription and resource group. The operation returns properties of each OpenShift managed cluster.

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [OpenShiftManagedClusterListResult] operation results.

# File lib/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 931
def list_by_resource_group_next(next_page_link, custom_headers:nil)
  response = list_by_resource_group_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
list_by_resource_group_next_async(next_page_link, custom_headers:nil) click to toggle source

Lists OpenShift managed clusters in the specified subscription and resource group.

Lists OpenShift managed clusters in the specified subscription and resource group. The operation returns properties of each OpenShift managed cluster.

@param next_page_link [String] The NextLink from the previous successful call to List 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/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 968
def list_by_resource_group_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      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::ContainerService::Mgmt::V2018_09_30_preview::Models::OpenShiftManagedClusterListResult.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
list_by_resource_group_next_with_http_info(next_page_link, custom_headers:nil) click to toggle source

Lists OpenShift managed clusters in the specified subscription and resource group.

Lists OpenShift managed clusters in the specified subscription and resource group. The operation returns properties of each OpenShift managed cluster.

@param next_page_link [String] The NextLink from the previous successful call to List 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/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 950
def list_by_resource_group_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_resource_group_next_async(next_page_link, custom_headers:custom_headers).value!
end
list_by_resource_group_with_http_info(resource_group_name, custom_headers:nil) click to toggle source

Lists OpenShift managed clusters in the specified subscription and resource group.

Lists OpenShift managed clusters in the specified subscription and resource group. The operation returns properties of each OpenShift managed cluster.

@param resource_group_name [String] The name of the resource group. @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/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 150
def list_by_resource_group_with_http_info(resource_group_name, custom_headers:nil)
  list_by_resource_group_async(resource_group_name, custom_headers:custom_headers).value!
end
list_next(next_page_link, custom_headers:nil) click to toggle source

Gets a list of OpenShift managed clusters in the specified subscription.

Gets a list of OpenShift managed clusters in the specified subscription. The operation returns properties of each OpenShift managed cluster.

@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [OpenShiftManagedClusterListResult] operation results.

# File lib/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 831
def list_next(next_page_link, custom_headers:nil)
  response = list_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
list_next_async(next_page_link, custom_headers:nil) click to toggle source

Gets a list of OpenShift managed clusters in the specified subscription.

Gets a list of OpenShift managed clusters in the specified subscription. The operation returns properties of each OpenShift managed cluster.

@param next_page_link [String] The NextLink from the previous successful call to List 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/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 866
def list_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      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::ContainerService::Mgmt::V2018_09_30_preview::Models::OpenShiftManagedClusterListResult.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
list_next_with_http_info(next_page_link, custom_headers:nil) click to toggle source

Gets a list of OpenShift managed clusters in the specified subscription.

Gets a list of OpenShift managed clusters in the specified subscription. The operation returns properties of each OpenShift managed cluster.

@param next_page_link [String] The NextLink from the previous successful call to List 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/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 849
def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers:custom_headers).value!
end
list_with_http_info(custom_headers:nil) click to toggle source

Gets a list of OpenShift managed clusters in the specified subscription.

Gets a list of OpenShift managed clusters in the specified subscription. The operation returns properties of each OpenShift managed cluster.

@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/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 51
def list_with_http_info(custom_headers:nil)
  list_async(custom_headers:custom_headers).value!
end
update_tags(resource_group_name, resource_name, parameters, custom_headers:nil) click to toggle source

Updates tags on an OpenShift managed cluster.

Updates an OpenShift managed cluster with the specified tags.

@param resource_group_name [String] The name of the resource group. @param resource_name [String] The name of the OpenShift managed cluster resource. @param parameters [TagsObject] Parameters supplied to the Update OpenShift Managed Cluster Tags operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [OpenShiftManagedCluster] operation results.

# File lib/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 395
def update_tags(resource_group_name, resource_name, parameters, custom_headers:nil)
  response = update_tags_async(resource_group_name, resource_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
update_tags_async(resource_group_name, resource_name, parameters, custom_headers:nil) click to toggle source

@param resource_group_name [String] The name of the resource group. @param resource_name [String] The name of the OpenShift managed cluster resource. @param parameters [TagsObject] Parameters supplied to the Update OpenShift Managed Cluster Tags operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Concurrent::Promise] promise which provides async access to http response.

# File lib/2018-09-30-preview/generated/azure_mgmt_container_service/open_shift_managed_clusters.rb, line 412
def update_tags_async(resource_group_name, resource_name, parameters, custom_headers:nil)
  # Send request
  promise = begin_update_tags_async(resource_group_name, resource_name, parameters, custom_headers:custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::ContainerService::Mgmt::V2018_09_30_preview::Models::OpenShiftManagedCluster.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end