class Azure::Postgresql::Mgmt::V2017_12_01_preview::FirewallRules
The Microsoft Azure
management API provides create, read, update, and delete functionality for Azure
PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.
Attributes
@return [PostgreSQLManagementClient] reference to the PostgreSQLManagementClient
Public Class Methods
Creates and initializes a new instance of the FirewallRules
class. @param client service class for accessing basic functionality.
# File lib/2017-12-01-preview/generated/azure_mgmt_postgresql/firewall_rules.rb, line 20 def initialize(client) @client = client end
Public Instance Methods
Creates a new firewall rule or updates an existing firewall rule.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param firewall_rule_name [String] The name of the server firewall rule. @param parameters [FirewallRule] The required parameters for creating or updating a firewall rule. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [FirewallRule] operation results.
# File lib/2017-12-01-preview/generated/azure_mgmt_postgresql/firewall_rules.rb, line 342 def begin_create_or_update(resource_group_name, server_name, firewall_rule_name, parameters, custom_headers:nil) response = begin_create_or_update_async(resource_group_name, server_name, firewall_rule_name, parameters, custom_headers:custom_headers).value! response.body unless response.nil? end
Creates a new firewall rule or updates an existing firewall rule.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param firewall_rule_name [String] The name of the server firewall rule. @param parameters [FirewallRule] The required parameters for creating or updating a firewall rule. @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/2017-12-01-preview/generated/azure_mgmt_postgresql/firewall_rules.rb, line 381 def begin_create_or_update_async(resource_group_name, server_name, firewall_rule_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, 'server_name is nil' if server_name.nil? fail ArgumentError, 'firewall_rule_name is nil' if firewall_rule_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::Postgresql::Mgmt::V2017_12_01_preview::Models::FirewallRule.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.DBforPostgreSQL/servers/{serverName}/firewallRules/{firewallRuleName}' 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,'serverName' => server_name,'firewallRuleName' => firewall_rule_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 || status_code == 202 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::Postgresql::Mgmt::V2017_12_01_preview::Models::FirewallRule.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::Postgresql::Mgmt::V2017_12_01_preview::Models::FirewallRule.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 a new firewall rule or updates an existing firewall rule.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param firewall_rule_name [String] The name of the server firewall rule. @param parameters [FirewallRule] The required parameters for creating or updating a firewall rule. @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/2017-12-01-preview/generated/azure_mgmt_postgresql/firewall_rules.rb, line 362 def begin_create_or_update_with_http_info(resource_group_name, server_name, firewall_rule_name, parameters, custom_headers:nil) begin_create_or_update_async(resource_group_name, server_name, firewall_rule_name, parameters, custom_headers:custom_headers).value! end
Deletes a server firewall rule.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param firewall_rule_name [String] The name of the server firewall rule. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
# File lib/2017-12-01-preview/generated/azure_mgmt_postgresql/firewall_rules.rb, line 467 def begin_delete(resource_group_name, server_name, firewall_rule_name, custom_headers:nil) response = begin_delete_async(resource_group_name, server_name, firewall_rule_name, custom_headers:custom_headers).value! nil end
Deletes a server firewall rule.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param firewall_rule_name [String] The name of the server firewall rule. @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/2017-12-01-preview/generated/azure_mgmt_postgresql/firewall_rules.rb, line 502 def begin_delete_async(resource_group_name, server_name, firewall_rule_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, 'server_name is nil' if server_name.nil? fail ArgumentError, 'firewall_rule_name is nil' if firewall_rule_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.DBforPostgreSQL/servers/{serverName}/firewallRules/{firewallRuleName}' 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,'serverName' => server_name,'firewallRuleName' => firewall_rule_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 == 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
Deletes a server firewall rule.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param firewall_rule_name [String] The name of the server firewall rule. @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/2017-12-01-preview/generated/azure_mgmt_postgresql/firewall_rules.rb, line 485 def begin_delete_with_http_info(resource_group_name, server_name, firewall_rule_name, custom_headers:nil) begin_delete_async(resource_group_name, server_name, firewall_rule_name, custom_headers:custom_headers).value! end
Creates a new firewall rule or updates an existing firewall rule.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param firewall_rule_name [String] The name of the server firewall rule. @param parameters [FirewallRule] The required parameters for creating or updating a firewall rule. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [FirewallRule] operation results.
# File lib/2017-12-01-preview/generated/azure_mgmt_postgresql/firewall_rules.rb, line 42 def create_or_update(resource_group_name, server_name, firewall_rule_name, parameters, custom_headers:nil) response = create_or_update_async(resource_group_name, server_name, firewall_rule_name, parameters, custom_headers:custom_headers).value! response.body unless response.nil? end
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param firewall_rule_name [String] The name of the server firewall rule. @param parameters [FirewallRule] The required parameters for creating or updating a firewall rule. @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/2017-12-01-preview/generated/azure_mgmt_postgresql/firewall_rules.rb, line 61 def create_or_update_async(resource_group_name, server_name, firewall_rule_name, parameters, custom_headers:nil) # Send request promise = begin_create_or_update_async(resource_group_name, server_name, firewall_rule_name, parameters, custom_headers:custom_headers) promise = promise.then do |response| # Defining deserialization method. deserialize_method = lambda do |parsed_response| result_mapper = Azure::Postgresql::Mgmt::V2017_12_01_preview::Models::FirewallRule.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
Deletes a server firewall rule.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param firewall_rule_name [String] The name of the server firewall rule. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
# File lib/2017-12-01-preview/generated/azure_mgmt_postgresql/firewall_rules.rb, line 90 def delete(resource_group_name, server_name, firewall_rule_name, custom_headers:nil) response = delete_async(resource_group_name, server_name, firewall_rule_name, custom_headers:custom_headers).value! nil end
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param firewall_rule_name [String] The name of the server firewall rule. @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/2017-12-01-preview/generated/azure_mgmt_postgresql/firewall_rules.rb, line 107 def delete_async(resource_group_name, server_name, firewall_rule_name, custom_headers:nil) # Send request promise = begin_delete_async(resource_group_name, server_name, firewall_rule_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
Gets information about a server firewall rule.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param firewall_rule_name [String] The name of the server firewall rule. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [FirewallRule] operation results.
# File lib/2017-12-01-preview/generated/azure_mgmt_postgresql/firewall_rules.rb, line 136 def get(resource_group_name, server_name, firewall_rule_name, custom_headers:nil) response = get_async(resource_group_name, server_name, firewall_rule_name, custom_headers:custom_headers).value! response.body unless response.nil? end
Gets information about a server firewall rule.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param firewall_rule_name [String] The name of the server firewall rule. @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/2017-12-01-preview/generated/azure_mgmt_postgresql/firewall_rules.rb, line 171 def get_async(resource_group_name, server_name, firewall_rule_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, 'server_name is nil' if server_name.nil? fail ArgumentError, 'firewall_rule_name is nil' if firewall_rule_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.DBforPostgreSQL/servers/{serverName}/firewallRules/{firewallRuleName}' 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,'serverName' => server_name,'firewallRuleName' => firewall_rule_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::Postgresql::Mgmt::V2017_12_01_preview::Models::FirewallRule.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 information about a server firewall rule.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param firewall_rule_name [String] The name of the server firewall rule. @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/2017-12-01-preview/generated/azure_mgmt_postgresql/firewall_rules.rb, line 154 def get_with_http_info(resource_group_name, server_name, firewall_rule_name, custom_headers:nil) get_async(resource_group_name, server_name, firewall_rule_name, custom_headers:custom_headers).value! end
List all the firewall rules in a given server.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [FirewallRuleListResult] operation results.
# File lib/2017-12-01-preview/generated/azure_mgmt_postgresql/firewall_rules.rb, line 239 def list_by_server(resource_group_name, server_name, custom_headers:nil) response = list_by_server_async(resource_group_name, server_name, custom_headers:custom_headers).value! response.body unless response.nil? end
List all the firewall rules in a given server.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @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/2017-12-01-preview/generated/azure_mgmt_postgresql/firewall_rules.rb, line 272 def list_by_server_async(resource_group_name, server_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, 'server_name is nil' if server_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.DBforPostgreSQL/servers/{serverName}/firewallRules' 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,'serverName' => server_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::Postgresql::Mgmt::V2017_12_01_preview::Models::FirewallRuleListResult.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 all the firewall rules in a given server.
@param resource_group_name [String] The name of the resource group that contains the resource. You can obtain this value from the Azure
Resource Manager API or the portal. @param server_name [String] The name of the server. @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/2017-12-01-preview/generated/azure_mgmt_postgresql/firewall_rules.rb, line 256 def list_by_server_with_http_info(resource_group_name, server_name, custom_headers:nil) list_by_server_async(resource_group_name, server_name, custom_headers:custom_headers).value! end