class Azure::ADHybridHealthService::Mgmt::V2014_01_01::AddsServiceMembersOperations

REST APIs for Azure Active Directory Connect Health

Attributes

client[R]

@return [ADHybridHealthService] reference to the ADHybridHealthService

Private Class Methods

new(client) click to toggle source

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

# File lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_service_members_operations.rb, line 17
def initialize(client)
  @client = client
end

Private Instance Methods

delete(service_name, service_member_id, confirm:nil, custom_headers:nil) click to toggle source

Deletes a Active Directory Domain Controller server that has been onboarded to Azure Active Directory Connect Health Service.

@param service_name [String] The name of the service. @param service_member_id The server Id. @param confirm [Boolean] Indicates if the server will be permanently deleted or disabled. True indicates that the server will be permanently deleted and False indicates that the server will be marked disabled and then deleted after 30 days, if it is not re-registered. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

# File lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_service_members_operations.rb, line 232
def delete(service_name, service_member_id, confirm:nil, custom_headers:nil)
  response = delete_async(service_name, service_member_id, confirm:confirm, custom_headers:custom_headers).value!
  nil
end
delete_async(service_name, service_member_id, confirm:nil, custom_headers:nil) click to toggle source

Deletes a Active Directory Domain Controller server that has been onboarded to Azure Active Directory Connect Health Service.

@param service_name [String] The name of the service. @param service_member_id The server Id. @param confirm [Boolean] Indicates if the server will be permanently deleted or disabled. True indicates that the server will be permanently deleted and False indicates that the server will be marked disabled and then deleted after 30 days, if it is not re-registered. @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/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_service_members_operations.rb, line 271
def delete_async(service_name, service_member_id, confirm:nil, custom_headers:nil)
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, 'service_member_id is nil' if service_member_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 = 'providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'serviceName' => service_name,'serviceMemberId' => service_member_id},
      query_params: {'confirm' => confirm,'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end
delete_with_http_info(service_name, service_member_id, confirm:nil, custom_headers:nil) click to toggle source

Deletes a Active Directory Domain Controller server that has been onboarded to Azure Active Directory Connect Health Service.

@param service_name [String] The name of the service. @param service_member_id The server Id. @param confirm [Boolean] Indicates if the server will be permanently deleted or disabled. True indicates that the server will be permanently deleted and False indicates that the server will be marked disabled and then deleted after 30 days, if it is not re-registered. @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/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_service_members_operations.rb, line 252
def delete_with_http_info(service_name, service_member_id, confirm:nil, custom_headers:nil)
  delete_async(service_name, service_member_id, confirm:confirm, custom_headers:custom_headers).value!
end
get(service_name, service_member_id, custom_headers:nil) click to toggle source

Gets the details of a server, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.

@param service_name [String] The name of the service. @param service_member_id The server Id. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [ServiceMember] operation results.

# File lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_service_members_operations.rb, line 133
def get(service_name, service_member_id, custom_headers:nil)
  response = get_async(service_name, service_member_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
get_async(service_name, service_member_id, custom_headers:nil) click to toggle source

Gets the details of a server, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.

@param service_name [String] The name of the service. @param service_member_id The server Id. @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/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_service_members_operations.rb, line 164
def get_async(service_name, service_member_id, custom_headers:nil)
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, 'service_member_id is nil' if service_member_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 = 'providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'serviceName' => service_name,'serviceMemberId' => service_member_id},
      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::ADHybridHealthService::Mgmt::V2014_01_01::Models::ServiceMember.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end
get_with_http_info(service_name, service_member_id, custom_headers:nil) click to toggle source

Gets the details of a server, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.

@param service_name [String] The name of the service. @param service_member_id The server Id. @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/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_service_members_operations.rb, line 149
def get_with_http_info(service_name, service_member_id, custom_headers:nil)
  get_async(service_name, service_member_id, custom_headers:custom_headers).value!
end
list(service_name, filter:nil, custom_headers:nil) click to toggle source

Gets the details of the Active Directory Domain servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.

@param service_name [String] The name of the service. @param filter [String] The server property filter to apply. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Array<AddsServiceMember>] operation results.

# File lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_service_members_operations.rb, line 36
def list(service_name, filter:nil, custom_headers:nil)
  first_page = list_as_lazy(service_name, filter:filter, custom_headers:custom_headers)
  first_page.get_all_items
end
list_as_lazy(service_name, filter:nil, custom_headers:nil) click to toggle source

Gets the details of the Active Directory Domain servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.

@param service_name [String] The name of the service. @param filter [String] The server property filter to apply. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [AddsServiceMembers] which provide lazy access to pages of the response.

# File lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_service_members_operations.rb, line 523
def list_as_lazy(service_name, filter:nil, custom_headers:nil)
  response = list_async(service_name, filter:filter, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end
list_async(service_name, filter:nil, custom_headers:nil) click to toggle source

Gets the details of the Active Directory Domain servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.

@param service_name [String] The name of the service. @param filter [String] The server property filter to apply. @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/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_service_members_operations.rb, line 69
def list_async(service_name, filter:nil, custom_headers:nil)
  fail ArgumentError, 'service_name is nil' if service_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 = 'providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/addsservicemembers'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'serviceName' => service_name},
      query_params: {'$filter' => filter,'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::ADHybridHealthService::Mgmt::V2014_01_01::Models::AddsServiceMembers.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_credentials(service_name, service_member_id, filter:nil, custom_headers:nil) click to toggle source

Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.

@param service_name [String] The name of the service. @param service_member_id The server Id. @param filter [String] The property filter to apply. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [Credentials] operation results.

# File lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_service_members_operations.rb, line 327
def list_credentials(service_name, service_member_id, filter:nil, custom_headers:nil)
  response = list_credentials_async(service_name, service_member_id, filter:filter, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
list_credentials_async(service_name, service_member_id, filter:nil, custom_headers:nil) click to toggle source

Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.

@param service_name [String] The name of the service. @param service_member_id The server Id. @param filter [String] The property filter to apply. @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/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_service_members_operations.rb, line 360
def list_credentials_async(service_name, service_member_id, filter:nil, custom_headers:nil)
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, 'service_member_id is nil' if service_member_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 = 'providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/servicemembers/{serviceMemberId}/credentials'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'serviceName' => service_name,'serviceMemberId' => service_member_id},
      query_params: {'$filter' => filter,'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::ADHybridHealthService::Mgmt::V2014_01_01::Models::Credentials.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_credentials_with_http_info(service_name, service_member_id, filter:nil, custom_headers:nil) click to toggle source

Gets the credentials of the server which is needed by the agent to connect to Azure Active Directory Connect Health Service.

@param service_name [String] The name of the service. @param service_member_id The server Id. @param filter [String] The property filter to apply. @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/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_service_members_operations.rb, line 344
def list_credentials_with_http_info(service_name, service_member_id, filter:nil, custom_headers:nil)
  list_credentials_async(service_name, service_member_id, filter:filter, custom_headers:custom_headers).value!
end
list_next(next_page_link, custom_headers:nil) click to toggle source

Gets the details of the Active Directory Domain servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.

@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 [AddsServiceMembers] operation results.

# File lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_service_members_operations.rb, line 426
def list_next(next_page_link, custom_headers:nil)
  response = list_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
list_next_async(next_page_link, custom_headers:nil) click to toggle source

Gets the details of the Active Directory Domain servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.

@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/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_service_members_operations.rb, line 459
def list_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::ADHybridHealthService::Mgmt::V2014_01_01::Models::AddsServiceMembers.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_next_with_http_info(next_page_link, custom_headers:nil) click to toggle source

Gets the details of the Active Directory Domain servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.

@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/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_service_members_operations.rb, line 443
def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers:custom_headers).value!
end
list_with_http_info(service_name, filter:nil, custom_headers:nil) click to toggle source

Gets the details of the Active Directory Domain servers, for a given Active Directory Domain Service, that are onboarded to Azure Active Directory Connect Health.

@param service_name [String] The name of the service. @param filter [String] The server property filter to apply. @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/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_service_members_operations.rb, line 53
def list_with_http_info(service_name, filter:nil, custom_headers:nil)
  list_async(service_name, filter:filter, custom_headers:custom_headers).value!
end