class Azure::EventGrid::Mgmt::V2020_01_01_preview::Domains
Attributes
@return [EventGridManagementClient] reference to the EventGridManagementClient
Public Class Methods
Creates and initializes a new instance of the Domains
class. @param client service class for accessing basic functionality.
# File lib/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 17 def initialize(client) @client = client end
Public Instance Methods
Create or update a domain
Asynchronously creates or updates a new domain with the specified parameters.
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @param domain_info [Domain] Domain information @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Domain] operation results.
# File lib/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 758 def begin_create_or_update(resource_group_name, domain_name, domain_info, custom_headers:nil) response = begin_create_or_update_async(resource_group_name, domain_name, domain_info, custom_headers:custom_headers).value! response.body unless response.nil? end
Create or update a domain
Asynchronously creates or updates a new domain with the specified parameters.
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @param domain_info [Domain] Domain information @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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 795 def begin_create_or_update_async(resource_group_name, domain_name, domain_info, 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, 'domain_name is nil' if domain_name.nil? fail ArgumentError, 'domain_info is nil' if domain_info.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.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::EventGrid::Mgmt::V2020_01_01_preview::Models::Domain.mapper() request_content = @client.serialize(request_mapper, domain_info) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}' 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,'domainName' => domain_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 == 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 == 201 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::EventGrid::Mgmt::V2020_01_01_preview::Models::Domain.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 or update a domain
Asynchronously creates or updates a new domain with the specified parameters.
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @param domain_info [Domain] Domain information @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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 777 def begin_create_or_update_with_http_info(resource_group_name, domain_name, domain_info, custom_headers:nil) begin_create_or_update_async(resource_group_name, domain_name, domain_info, custom_headers:custom_headers).value! end
Delete a domain
Delete existing domain
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
# File lib/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 870 def begin_delete(resource_group_name, domain_name, custom_headers:nil) response = begin_delete_async(resource_group_name, domain_name, custom_headers:custom_headers).value! nil end
Delete a domain
Delete existing domain
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 905 def begin_delete_async(resource_group_name, domain_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, 'domain_name is nil' if domain_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.EventGrid/domains/{domainName}' 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,'domainName' => domain_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
Delete a domain
Delete existing domain
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 888 def begin_delete_with_http_info(resource_group_name, domain_name, custom_headers:nil) begin_delete_async(resource_group_name, domain_name, custom_headers:custom_headers).value! end
Update a domain
Asynchronously updates a domain with the specified parameters.
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @param domain_update_parameters [DomainUpdateParameters] Domain update information @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Domain] operation results.
# File lib/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 965 def begin_update(resource_group_name, domain_name, domain_update_parameters, custom_headers:nil) response = begin_update_async(resource_group_name, domain_name, domain_update_parameters, custom_headers:custom_headers).value! response.body unless response.nil? end
Update a domain
Asynchronously updates a domain with the specified parameters.
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @param domain_update_parameters [DomainUpdateParameters] Domain update information @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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 1004 def begin_update_async(resource_group_name, domain_name, domain_update_parameters, 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, 'domain_name is nil' if domain_name.nil? fail ArgumentError, 'domain_update_parameters is nil' if domain_update_parameters.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.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::EventGrid::Mgmt::V2020_01_01_preview::Models::DomainUpdateParameters.mapper() request_content = @client.serialize(request_mapper, domain_update_parameters) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}' 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,'domainName' => domain_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 == 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 == 201 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::EventGrid::Mgmt::V2020_01_01_preview::Models::Domain.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
Update a domain
Asynchronously updates a domain with the specified parameters.
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @param domain_update_parameters [DomainUpdateParameters] Domain update information @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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 985 def begin_update_with_http_info(resource_group_name, domain_name, domain_update_parameters, custom_headers:nil) begin_update_async(resource_group_name, domain_name, domain_update_parameters, custom_headers:custom_headers).value! end
Create or update a domain
Asynchronously creates or updates a new domain with the specified parameters.
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @param domain_info [Domain] Domain information @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Domain] operation results.
# File lib/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 141 def create_or_update(resource_group_name, domain_name, domain_info, custom_headers:nil) response = create_or_update_async(resource_group_name, domain_name, domain_info, custom_headers:custom_headers).value! response.body unless response.nil? end
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @param domain_info [Domain] Domain information @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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 157 def create_or_update_async(resource_group_name, domain_name, domain_info, custom_headers:nil) # Send request promise = begin_create_or_update_async(resource_group_name, domain_name, domain_info, custom_headers:custom_headers) promise = promise.then do |response| # Defining deserialization method. deserialize_method = lambda do |parsed_response| result_mapper = Azure::EventGrid::Mgmt::V2020_01_01_preview::Models::Domain.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 a domain
Delete existing domain
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
# File lib/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 186 def delete(resource_group_name, domain_name, custom_headers:nil) response = delete_async(resource_group_name, domain_name, custom_headers:custom_headers).value! nil end
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 201 def delete_async(resource_group_name, domain_name, custom_headers:nil) # Send request promise = begin_delete_async(resource_group_name, domain_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 a domain
Get properties of a domain
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Domain] operation results.
# File lib/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 37 def get(resource_group_name, domain_name, custom_headers:nil) response = get_async(resource_group_name, domain_name, custom_headers:custom_headers).value! response.body unless response.nil? end
Get a domain
Get properties of a domain
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 72 def get_async(resource_group_name, domain_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, 'domain_name is nil' if domain_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.EventGrid/domains/{domainName}' 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,'domainName' => domain_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::EventGrid::Mgmt::V2020_01_01_preview::Models::Domain.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 a domain
Get properties of a domain
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 55 def get_with_http_info(resource_group_name, domain_name, custom_headers:nil) get_async(resource_group_name, domain_name, custom_headers:custom_headers).value! end
List domains under a resource group
List all the domains under a resource group
@param resource_group_name [String] The name of the resource group within the user's subscription. @param filter [String] The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. @param top [Integer] The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Array<Domain>] operation results.
# File lib/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 415 def list_by_resource_group(resource_group_name, filter:nil, top:nil, custom_headers:nil) first_page = list_by_resource_group_as_lazy(resource_group_name, filter:filter, top:top, custom_headers:custom_headers) first_page.get_all_items end
List domains under a resource group
List all the domains under a resource group
@param resource_group_name [String] The name of the resource group within the user's subscription. @param filter [String] The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. @param top [Integer] The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [DomainsListResult] which provide lazy access to pages of the response.
# File lib/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 1316 def list_by_resource_group_as_lazy(resource_group_name, filter:nil, top:nil, custom_headers:nil) response = list_by_resource_group_async(resource_group_name, filter:filter, top:top, 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 domains under a resource group
List all the domains under a resource group
@param resource_group_name [String] The name of the resource group within the user's subscription. @param filter [String] The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. @param top [Integer] The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. @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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 470 def list_by_resource_group_async(resource_group_name, filter:nil, top: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, '@client.api_version is nil' if @client.api_version.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.EventGrid/domains' 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,'$filter' => filter,'$top' => top}, 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::EventGrid::Mgmt::V2020_01_01_preview::Models::DomainsListResult.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 domains under a resource group
List all the domains under a resource group
@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 [DomainsListResult] operation results.
# File lib/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 1175 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 domains under a resource group
List all the domains under a resource group
@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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 1208 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::EventGrid::Mgmt::V2020_01_01_preview::Models::DomainsListResult.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 domains under a resource group
List all the domains under a resource group
@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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 1192 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 domains under a resource group
List all the domains under a resource group
@param resource_group_name [String] The name of the resource group within the user's subscription. @param filter [String] The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. @param top [Integer] The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. @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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 443 def list_by_resource_group_with_http_info(resource_group_name, filter:nil, top:nil, custom_headers:nil) list_by_resource_group_async(resource_group_name, filter:filter, top:top, custom_headers:custom_headers).value! end
List domains under an Azure
subscription
List all the domains under an Azure
subscription
@param filter [String] The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. @param top [Integer] The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Array<Domain>] operation results.
# File lib/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 288 def list_by_subscription(filter:nil, top:nil, custom_headers:nil) first_page = list_by_subscription_as_lazy(filter:filter, top:top, custom_headers:custom_headers) first_page.get_all_items end
List domains under an Azure
subscription
List all the domains under an Azure
subscription
@param filter [String] The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. @param top [Integer] The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [DomainsListResult] which provide lazy access to pages of the response.
# File lib/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 1281 def list_by_subscription_as_lazy(filter:nil, top:nil, custom_headers:nil) response = list_by_subscription_async(filter:filter, top:top, custom_headers:custom_headers).value! unless response.nil? page = response.body page.next_method = Proc.new do |next_page_link| list_by_subscription_next_async(next_page_link, custom_headers:custom_headers) end page end end
List domains under an Azure
subscription
List all the domains under an Azure
subscription
@param filter [String] The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. @param top [Integer] The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. @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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 339 def list_by_subscription_async(filter:nil, top:nil, custom_headers:nil) fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.EventGrid/domains' 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,'$filter' => filter,'$top' => top}, 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::EventGrid::Mgmt::V2020_01_01_preview::Models::DomainsListResult.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 domains under an Azure
subscription
List all the domains under an Azure
subscription
@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 [DomainsListResult] operation results.
# File lib/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 1079 def list_by_subscription_next(next_page_link, custom_headers:nil) response = list_by_subscription_next_async(next_page_link, custom_headers:custom_headers).value! response.body unless response.nil? end
List domains under an Azure
subscription
List all the domains under an Azure
subscription
@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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 1112 def list_by_subscription_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::EventGrid::Mgmt::V2020_01_01_preview::Models::DomainsListResult.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 domains under an Azure
subscription
List all the domains under an Azure
subscription
@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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 1096 def list_by_subscription_next_with_http_info(next_page_link, custom_headers:nil) list_by_subscription_next_async(next_page_link, custom_headers:custom_headers).value! end
List domains under an Azure
subscription
List all the domains under an Azure
subscription
@param filter [String] The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. @param top [Integer] The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. @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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 314 def list_by_subscription_with_http_info(filter:nil, top:nil, custom_headers:nil) list_by_subscription_async(filter:filter, top:top, custom_headers:custom_headers).value! end
Regenerate key for a domain
Regenerate a shared access key for a domain
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @param regenerate_key_request [DomainRegenerateKeyRequest] Request body to regenerate key @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [DomainSharedAccessKeys] operation results.
# File lib/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 642 def regenerate_key(resource_group_name, domain_name, regenerate_key_request, custom_headers:nil) response = regenerate_key_async(resource_group_name, domain_name, regenerate_key_request, custom_headers:custom_headers).value! response.body unless response.nil? end
Regenerate key for a domain
Regenerate a shared access key for a domain
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @param regenerate_key_request [DomainRegenerateKeyRequest] Request body to regenerate 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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 681 def regenerate_key_async(resource_group_name, domain_name, regenerate_key_request, 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, 'domain_name is nil' if domain_name.nil? fail ArgumentError, 'regenerate_key_request is nil' if regenerate_key_request.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.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::EventGrid::Mgmt::V2020_01_01_preview::Models::DomainRegenerateKeyRequest.mapper() request_content = @client.serialize(request_mapper, regenerate_key_request) request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/regenerateKey' 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,'domainName' => domain_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::EventGrid::Mgmt::V2020_01_01_preview::Models::DomainSharedAccessKeys.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 key for a domain
Regenerate a shared access key for a domain
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @param regenerate_key_request [DomainRegenerateKeyRequest] Request body to regenerate 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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 662 def regenerate_key_with_http_info(resource_group_name, domain_name, regenerate_key_request, custom_headers:nil) regenerate_key_async(resource_group_name, domain_name, regenerate_key_request, custom_headers:custom_headers).value! end
Update a domain
Asynchronously updates a domain with the specified parameters.
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @param domain_update_parameters [DomainUpdateParameters] Domain update information @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Domain] operation results.
# File lib/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 232 def update(resource_group_name, domain_name, domain_update_parameters, custom_headers:nil) response = update_async(resource_group_name, domain_name, domain_update_parameters, custom_headers:custom_headers).value! response.body unless response.nil? end
@param resource_group_name [String] The name of the resource group within the user's subscription. @param domain_name [String] Name of the domain @param domain_update_parameters [DomainUpdateParameters] Domain update information @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/2020-01-01-preview/generated/azure_mgmt_event_grid/domains.rb, line 249 def update_async(resource_group_name, domain_name, domain_update_parameters, custom_headers:nil) # Send request promise = begin_update_async(resource_group_name, domain_name, domain_update_parameters, custom_headers:custom_headers) promise = promise.then do |response| # Defining deserialization method. deserialize_method = lambda do |parsed_response| result_mapper = Azure::EventGrid::Mgmt::V2020_01_01_preview::Models::Domain.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