class Azure::Synapse::Mgmt::V2019_06_01_preview::IntegrationRuntimeAuthKeysOperations

Azure Synapse Analytics Management Client

Attributes

client[R]

@return [SynapseManagementClient] reference to the SynapseManagementClient

Private Class Methods

new(client) click to toggle source

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

# File lib/2019-06-01-preview/generated/azure_mgmt_synapse/integration_runtime_auth_keys_operations.rb, line 17
def initialize(client)
  @client = client
end

Private Instance Methods

list(resource_group_name, workspace_name, integration_runtime_name, custom_headers:nil) click to toggle source

List integration runtime authentication keys

List authentication keys in an integration runtime

@param resource_group_name [String] The name of the resource group. The name is case insensitive. @param workspace_name [String] The name of the workspace. @param integration_runtime_name [String] Integration runtime name @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [IntegrationRuntimeAuthKeys] operation results.

# File lib/2019-06-01-preview/generated/azure_mgmt_synapse/integration_runtime_auth_keys_operations.rb, line 164
def list(resource_group_name, workspace_name, integration_runtime_name, custom_headers:nil)
  response = list_async(resource_group_name, workspace_name, integration_runtime_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
list_async(resource_group_name, workspace_name, integration_runtime_name, custom_headers:nil) click to toggle source

List integration runtime authentication keys

List authentication keys in an integration runtime

@param resource_group_name [String] The name of the resource group. The name is case insensitive. @param workspace_name [String] The name of the workspace. @param integration_runtime_name [String] Integration runtime name @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

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

# File lib/2019-06-01-preview/generated/azure_mgmt_synapse/integration_runtime_auth_keys_operations.rb, line 201
def list_async(resource_group_name, workspace_name, integration_runtime_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, 'integration_runtime_name is nil' if integration_runtime_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.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/listAuthKeys'

  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,'workspaceName' => workspace_name,'integrationRuntimeName' => integration_runtime_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail 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::Synapse::Mgmt::V2019_06_01_preview::Models::IntegrationRuntimeAuthKeys.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_with_http_info(resource_group_name, workspace_name, integration_runtime_name, custom_headers:nil) click to toggle source

List integration runtime authentication keys

List authentication keys in an integration runtime

@param resource_group_name [String] The name of the resource group. The name is case insensitive. @param workspace_name [String] The name of the workspace. @param integration_runtime_name [String] Integration runtime name @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

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

# File lib/2019-06-01-preview/generated/azure_mgmt_synapse/integration_runtime_auth_keys_operations.rb, line 183
def list_with_http_info(resource_group_name, workspace_name, integration_runtime_name, custom_headers:nil)
  list_async(resource_group_name, workspace_name, integration_runtime_name, custom_headers:custom_headers).value!
end
regenerate(resource_group_name, workspace_name, integration_runtime_name, regenerate_key_parameters, custom_headers:nil) click to toggle source

Regenerate integration runtime authentication key

Regenerate the authentication key for an integration runtime

@param resource_group_name [String] The name of the resource group. The name is case insensitive. @param workspace_name [String] The name of the workspace. @param integration_runtime_name [String] Integration runtime name @param regenerate_key_parameters [IntegrationRuntimeRegenerateKeyParameters] The parameters for regenerating integration runtime authentication key. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [IntegrationRuntimeAuthKeys] operation results.

# File lib/2019-06-01-preview/generated/azure_mgmt_synapse/integration_runtime_auth_keys_operations.rb, line 40
def regenerate(resource_group_name, workspace_name, integration_runtime_name, regenerate_key_parameters, custom_headers:nil)
  response = regenerate_async(resource_group_name, workspace_name, integration_runtime_name, regenerate_key_parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
regenerate_async(resource_group_name, workspace_name, integration_runtime_name, regenerate_key_parameters, custom_headers:nil) click to toggle source

Regenerate integration runtime authentication key

Regenerate the authentication key for an integration runtime

@param resource_group_name [String] The name of the resource group. The name is case insensitive. @param workspace_name [String] The name of the workspace. @param integration_runtime_name [String] Integration runtime name @param regenerate_key_parameters [IntegrationRuntimeRegenerateKeyParameters] The parameters for regenerating integration runtime authentication key. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

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

# File lib/2019-06-01-preview/generated/azure_mgmt_synapse/integration_runtime_auth_keys_operations.rb, line 81
def regenerate_async(resource_group_name, workspace_name, integration_runtime_name, regenerate_key_parameters, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, 'integration_runtime_name is nil' if integration_runtime_name.nil?
  fail ArgumentError, 'regenerate_key_parameters is nil' if regenerate_key_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::Synapse::Mgmt::V2019_06_01_preview::Models::IntegrationRuntimeRegenerateKeyParameters.mapper()
  request_content = @client.serialize(request_mapper,  regenerate_key_parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/regenerateAuthKey'

  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,'workspaceName' => workspace_name,'integrationRuntimeName' => integration_runtime_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(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail 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::Synapse::Mgmt::V2019_06_01_preview::Models::IntegrationRuntimeAuthKeys.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
regenerate_with_http_info(resource_group_name, workspace_name, integration_runtime_name, regenerate_key_parameters, custom_headers:nil) click to toggle source

Regenerate integration runtime authentication key

Regenerate the authentication key for an integration runtime

@param resource_group_name [String] The name of the resource group. The name is case insensitive. @param workspace_name [String] The name of the workspace. @param integration_runtime_name [String] Integration runtime name @param regenerate_key_parameters [IntegrationRuntimeRegenerateKeyParameters] The parameters for regenerating integration runtime authentication key. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

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

# File lib/2019-06-01-preview/generated/azure_mgmt_synapse/integration_runtime_auth_keys_operations.rb, line 61
def regenerate_with_http_info(resource_group_name, workspace_name, integration_runtime_name, regenerate_key_parameters, custom_headers:nil)
  regenerate_async(resource_group_name, workspace_name, integration_runtime_name, regenerate_key_parameters, custom_headers:custom_headers).value!
end