class Azure::Migrate::Mgmt::V2018_02_02::Groups

Move your workloads to Azure.

Attributes

client[R]

@return [AzureMigrate] reference to the AzureMigrate

Private Class Methods

new(client) click to toggle source

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

# File lib/2018-02-02/generated/azure_mgmt_migrate/groups.rb, line 17
def initialize(client)
  @client = client
end

Private Instance Methods

create(resource_group_name, project_name, group_name, group:nil, custom_headers:nil) click to toggle source

Create a new group with specified settings. If group with the name provided already exists, then the existing group is updated.

Create a new group by sending a json object of type 'group' as given in Models section as part of the Request Body. The group name in a project is unique. Labels can be applied on a group as part of creation.

If a group with the groupName specified in the URL already exists, then this call acts as an update.

This operation is Idempotent.

@param resource_group_name [String] Name of the Azure Resource Group that project is part of. @param project_name [String] Name of the Azure Migrate project. @param group_name [String] Unique name of a group within a project. @param group [Group] New or Updated Group object. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Group] operation results.

# File lib/2018-02-02/generated/azure_mgmt_migrate/groups.rb, line 264
def create(resource_group_name, project_name, group_name, group:nil, custom_headers:nil)
  response = create_async(resource_group_name, project_name, group_name, group:group, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
create_async(resource_group_name, project_name, group_name, group:nil, custom_headers:nil) click to toggle source

Create a new group with specified settings. If group with the name provided already exists, then the existing group is updated.

Create a new group by sending a json object of type 'group' as given in Models section as part of the Request Body. The group name in a project is unique. Labels can be applied on a group as part of creation.

If a group with the groupName specified in the URL already exists, then this call acts as an update.

This operation is Idempotent.

@param resource_group_name [String] Name of the Azure Resource Group that project is part of. @param project_name [String] Name of the Azure Migrate project. @param group_name [String] Unique name of a group within a project. @param group [Group] New or Updated Group object. @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-02-02/generated/azure_mgmt_migrate/groups.rb, line 321
def create_async(resource_group_name, project_name, group_name, group:nil, custom_headers: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, 'project_name is nil' if project_name.nil?
  fail ArgumentError, 'group_name is nil' if group_name.nil?
  @client.api_version = '2018-02-02'


  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::Migrate::Mgmt::V2018_02_02::Models::Group.mapper()
  request_content = @client.serialize(request_mapper,  group)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}'

  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,'projectName' => project_name,'groupName' => group_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::Migrate::Mgmt::V2018_02_02::Models::Group.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::Migrate::Mgmt::V2018_02_02::Models::Group.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_with_http_info(resource_group_name, project_name, group_name, group:nil, custom_headers:nil) click to toggle source

Create a new group with specified settings. If group with the name provided already exists, then the existing group is updated.

Create a new group by sending a json object of type 'group' as given in Models section as part of the Request Body. The group name in a project is unique. Labels can be applied on a group as part of creation.

If a group with the groupName specified in the URL already exists, then this call acts as an update.

This operation is Idempotent.

@param resource_group_name [String] Name of the Azure Resource Group that project is part of. @param project_name [String] Name of the Azure Migrate project. @param group_name [String] Unique name of a group within a project. @param group [Group] New or Updated Group object. @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-02-02/generated/azure_mgmt_migrate/groups.rb, line 293
def create_with_http_info(resource_group_name, project_name, group_name, group:nil, custom_headers:nil)
  create_async(resource_group_name, project_name, group_name, group:group, custom_headers:custom_headers).value!
end
delete(resource_group_name, project_name, group_name, custom_headers:nil) click to toggle source

Delete the group

Delete the group from the project. The machines remain in the project. Deleting a non-existent group results in a no-operation.

A group is an aggregation mechanism for machines in a project. Therefore, deleting group does not delete machines in it.

@param resource_group_name [String] Name of the Azure Resource Group that project is part of. @param project_name [String] Name of the Azure Migrate project. @param group_name [String] Unique name of a group within a project. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

# File lib/2018-02-02/generated/azure_mgmt_migrate/groups.rb, line 412
def delete(resource_group_name, project_name, group_name, custom_headers:nil)
  response = delete_async(resource_group_name, project_name, group_name, custom_headers:custom_headers).value!
  nil
end
delete_async(resource_group_name, project_name, group_name, custom_headers:nil) click to toggle source

Delete the group

Delete the group from the project. The machines remain in the project. Deleting a non-existent group results in a no-operation.

A group is an aggregation mechanism for machines in a project. Therefore, deleting group does not delete machines in it.

@param resource_group_name [String] Name of the Azure Resource Group that project is part of. @param project_name [String] Name of the Azure Migrate project. @param group_name [String] Unique name of a group within a project. @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-02-02/generated/azure_mgmt_migrate/groups.rb, line 459
def delete_async(resource_group_name, project_name, group_name, custom_headers: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, 'project_name is nil' if project_name.nil?
  fail ArgumentError, 'group_name is nil' if group_name.nil?
  @client.api_version = '2018-02-02'


  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.Migrate/projects/{projectName}/groups/{groupName}'

  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,'projectName' => project_name,'groupName' => group_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 == 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?

    result
  end

  promise.execute
end
delete_with_http_info(resource_group_name, project_name, group_name, custom_headers:nil) click to toggle source

Delete the group

Delete the group from the project. The machines remain in the project. Deleting a non-existent group results in a no-operation.

A group is an aggregation mechanism for machines in a project. Therefore, deleting group does not delete machines in it.

@param resource_group_name [String] Name of the Azure Resource Group that project is part of. @param project_name [String] Name of the Azure Migrate project. @param group_name [String] Unique name of a group within a project. @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-02-02/generated/azure_mgmt_migrate/groups.rb, line 436
def delete_with_http_info(resource_group_name, project_name, group_name, custom_headers:nil)
  delete_async(resource_group_name, project_name, group_name, custom_headers:custom_headers).value!
end
get(resource_group_name, project_name, group_name, custom_headers:nil) click to toggle source

Get a specific group.

Get information related to a specific group in the project. Returns a json object of type 'group' as specified in the models section.

@param resource_group_name [String] Name of the Azure Resource Group that project is part of. @param project_name [String] Name of the Azure Migrate project. @param group_name [String] Unique name of a group within a project. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Group] operation results.

# File lib/2018-02-02/generated/azure_mgmt_migrate/groups.rb, line 145
def get(resource_group_name, project_name, group_name, custom_headers:nil)
  response = get_async(resource_group_name, project_name, group_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
get_async(resource_group_name, project_name, group_name, custom_headers:nil) click to toggle source

Get a specific group.

Get information related to a specific group in the project. Returns a json object of type 'group' as specified in the models section.

@param resource_group_name [String] Name of the Azure Resource Group that project is part of. @param project_name [String] Name of the Azure Migrate project. @param group_name [String] Unique name of a group within a project. @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-02-02/generated/azure_mgmt_migrate/groups.rb, line 184
def get_async(resource_group_name, project_name, group_name, custom_headers: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, 'project_name is nil' if project_name.nil?
  fail ArgumentError, 'group_name is nil' if group_name.nil?
  @client.api_version = '2018-02-02'


  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.Migrate/projects/{projectName}/groups/{groupName}'

  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,'projectName' => project_name,'groupName' => 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::Migrate::Mgmt::V2018_02_02::Models::Group.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, project_name, group_name, custom_headers:nil) click to toggle source

Get a specific group.

Get information related to a specific group in the project. Returns a json object of type 'group' as specified in the models section.

@param resource_group_name [String] Name of the Azure Resource Group that project is part of. @param project_name [String] Name of the Azure Migrate project. @param group_name [String] Unique name of a group within a project. @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-02-02/generated/azure_mgmt_migrate/groups.rb, line 165
def get_with_http_info(resource_group_name, project_name, group_name, custom_headers:nil)
  get_async(resource_group_name, project_name, group_name, custom_headers:custom_headers).value!
end
list_by_project(resource_group_name, project_name, custom_headers:nil) click to toggle source

Get all groups

Get all groups created in the project. Returns a json array of objects of type 'group' as specified in the Models section.

@param resource_group_name [String] Name of the Azure Resource Group that project is part of. @param project_name [String] Name of the Azure Migrate project. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [GroupResultList] operation results.

# File lib/2018-02-02/generated/azure_mgmt_migrate/groups.rb, line 38
def list_by_project(resource_group_name, project_name, custom_headers:nil)
  response = list_by_project_async(resource_group_name, project_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
list_by_project_async(resource_group_name, project_name, custom_headers:nil) click to toggle source

Get all groups

Get all groups created in the project. Returns a json array of objects of type 'group' as specified in the Models section.

@param resource_group_name [String] Name of the Azure Resource Group that project is part of. @param project_name [String] Name of the Azure Migrate project. @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-02-02/generated/azure_mgmt_migrate/groups.rb, line 75
def list_by_project_async(resource_group_name, project_name, custom_headers: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, 'project_name is nil' if project_name.nil?
  @client.api_version = '2018-02-02'


  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.Migrate/projects/{projectName}/groups'

  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,'projectName' => project_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::Migrate::Mgmt::V2018_02_02::Models::GroupResultList.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_project_with_http_info(resource_group_name, project_name, custom_headers:nil) click to toggle source

Get all groups

Get all groups created in the project. Returns a json array of objects of type 'group' as specified in the Models section.

@param resource_group_name [String] Name of the Azure Resource Group that project is part of. @param project_name [String] Name of the Azure Migrate project. @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-02-02/generated/azure_mgmt_migrate/groups.rb, line 57
def list_by_project_with_http_info(resource_group_name, project_name, custom_headers:nil)
  list_by_project_async(resource_group_name, project_name, custom_headers:custom_headers).value!
end