class Azure::Synapse::Mgmt::V2019_06_01_preview::Keys
Attributes
@return [SynapseManagementClient] reference to the SynapseManagementClient
Private Class Methods
Creates and initializes a new instance of the Keys
class. @param client service class for accessing basic functionality.
# File lib/2019-06-01-preview/generated/azure_mgmt_synapse/keys.rb, line 17 def initialize(client) @client = client end
Private Instance Methods
Creates or updates a workspace key
@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 key_name [String] The name of the workspace key @param key_properties [Key] Key put request properties @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Key] operation results.
# File lib/2019-06-01-preview/generated/azure_mgmt_synapse/keys.rb, line 245 def create_or_update(resource_group_name, workspace_name, key_name, key_properties, custom_headers:nil) response = create_or_update_async(resource_group_name, workspace_name, key_name, key_properties, custom_headers:custom_headers).value! response.body unless response.nil? end
Creates or updates a workspace key
@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 key_name [String] The name of the workspace key @param key_properties [Key] Key put request properties @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/keys.rb, line 280 def create_or_update_async(resource_group_name, workspace_name, key_name, key_properties, 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, 'key_name is nil' if key_name.nil? fail ArgumentError, 'key_properties is nil' if key_properties.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::Key.mapper() request_content = @client.serialize(request_mapper, key_properties) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName}' 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,'keyName' => key_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 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::Synapse::Mgmt::V2019_06_01_preview::Models::Key.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
Creates or updates a workspace key
@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 key_name [String] The name of the workspace key @param key_properties [Key] Key put request properties @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/keys.rb, line 263 def create_or_update_with_http_info(resource_group_name, workspace_name, key_name, key_properties, custom_headers:nil) create_or_update_async(resource_group_name, workspace_name, key_name, key_properties, custom_headers:custom_headers).value! end
Deletes a workspace key
@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 key_name [String] The name of the workspace key @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Key] operation results.
# File lib/2019-06-01-preview/generated/azure_mgmt_synapse/keys.rb, line 361 def delete(resource_group_name, workspace_name, key_name, custom_headers:nil) response = delete_async(resource_group_name, workspace_name, key_name, custom_headers:custom_headers).value! response.body unless response.nil? end
Deletes a workspace key
@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 key_name [String] The name of the workspace 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/keys.rb, line 394 def delete_async(resource_group_name, workspace_name, key_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, 'key_name is nil' if key_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}/keys/{keyName}' 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,'keyName' => key_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 || status_code == 204 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::Synapse::Mgmt::V2019_06_01_preview::Models::Key.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
Deletes a workspace key
@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 key_name [String] The name of the workspace 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/keys.rb, line 378 def delete_with_http_info(resource_group_name, workspace_name, key_name, custom_headers:nil) delete_async(resource_group_name, workspace_name, key_name, custom_headers:custom_headers).value! end
Gets a workspace key
@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 key_name [String] The name of the workspace key @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Key] operation results.
# File lib/2019-06-01-preview/generated/azure_mgmt_synapse/keys.rb, line 138 def get(resource_group_name, workspace_name, key_name, custom_headers:nil) response = get_async(resource_group_name, workspace_name, key_name, custom_headers:custom_headers).value! response.body unless response.nil? end
Gets a workspace key
@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 key_name [String] The name of the workspace 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/keys.rb, line 171 def get_async(resource_group_name, workspace_name, key_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, 'key_name is nil' if key_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}/keys/{keyName}' 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,'keyName' => key_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 MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::Synapse::Mgmt::V2019_06_01_preview::Models::Key.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
Gets a workspace key
@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 key_name [String] The name of the workspace 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/keys.rb, line 155 def get_with_http_info(resource_group_name, workspace_name, key_name, custom_headers:nil) get_async(resource_group_name, workspace_name, key_name, custom_headers:custom_headers).value! end
Returns a list of keys in a workspace
@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 custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Array<Key>] operation results.
# File lib/2019-06-01-preview/generated/azure_mgmt_synapse/keys.rb, line 35 def list_by_workspace(resource_group_name, workspace_name, custom_headers:nil) first_page = list_by_workspace_as_lazy(resource_group_name, workspace_name, custom_headers:custom_headers) first_page.get_all_items end
Returns a list of keys in a workspace
@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 custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [KeyInfoListResult] which provide lazy access to pages of the response.
# File lib/2019-06-01-preview/generated/azure_mgmt_synapse/keys.rb, line 557 def list_by_workspace_as_lazy(resource_group_name, workspace_name, custom_headers:nil) response = list_by_workspace_async(resource_group_name, workspace_name, custom_headers:custom_headers).value! unless response.nil? page = response.body page.next_method = Proc.new do |next_page_link| list_by_workspace_next_async(next_page_link, custom_headers:custom_headers) end page end end
Returns a list of keys in a workspace
@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 [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/keys.rb, line 66 def list_by_workspace_async(resource_group_name, workspace_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? 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}/keys' 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}, 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 MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::Synapse::Mgmt::V2019_06_01_preview::Models::KeyInfoListResult.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
Returns a list of keys in a workspace
@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 [KeyInfoListResult] operation results.
# File lib/2019-06-01-preview/generated/azure_mgmt_synapse/keys.rb, line 465 def list_by_workspace_next(next_page_link, custom_headers:nil) response = list_by_workspace_next_async(next_page_link, custom_headers:custom_headers).value! response.body unless response.nil? end
Returns a list of keys in a workspace
@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/2019-06-01-preview/generated/azure_mgmt_synapse/keys.rb, line 494 def list_by_workspace_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 MsRest::HttpOperationError.new(result.request, http_response, error_model) end result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil? result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil? result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil? # Deserialize Response if status_code == 200 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::Synapse::Mgmt::V2019_06_01_preview::Models::KeyInfoListResult.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
Returns a list of keys in a workspace
@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/2019-06-01-preview/generated/azure_mgmt_synapse/keys.rb, line 480 def list_by_workspace_next_with_http_info(next_page_link, custom_headers:nil) list_by_workspace_next_async(next_page_link, custom_headers:custom_headers).value! end
Returns a list of keys in a workspace
@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 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/keys.rb, line 51 def list_by_workspace_with_http_info(resource_group_name, workspace_name, custom_headers:nil) list_by_workspace_async(resource_group_name, workspace_name, custom_headers:custom_headers).value! end