class Azure::Synapse::Mgmt::V2019_06_01_preview::SynapseManagementClient

A service client - single point of access to the REST API.

Attributes

accept_language[RW]

@return [String] The preferred language for the response.

api_version[R]

@return [String] The API version to use for this operation.

base_url[RW]

@return [String] the base URI of the service.

big_data_pools[R]

@return [BigDataPools] big_data_pools

credentials[R]

@return Credentials needed for the client to connect to Azure.

data_masking_policies[R]

@return [DataMaskingPolicies] data_masking_policies

data_masking_rules[R]

@return [DataMaskingRules] data_masking_rules

extended_sql_pool_blob_auditing_policies[R]

@return [ExtendedSqlPoolBlobAuditingPolicies] extended_sql_pool_blob_auditing_policies

generate_client_request_id[RW]

@return [Boolean] Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

integration_runtime_auth_keys_operations[R]

@return [IntegrationRuntimeAuthKeysOperations] integration_runtime_auth_keys_operations

integration_runtime_connection_infos[R]

@return [IntegrationRuntimeConnectionInfos] integration_runtime_connection_infos

integration_runtime_credentials[R]

@return [IntegrationRuntimeCredentials] integration_runtime_credentials

integration_runtime_monitoring_data_operations[R]

@return [IntegrationRuntimeMonitoringDataOperations] integration_runtime_monitoring_data_operations

integration_runtime_node_ip_address_operations[R]

@return [IntegrationRuntimeNodeIpAddressOperations] integration_runtime_node_ip_address_operations

integration_runtime_nodes[R]

@return [IntegrationRuntimeNodes] integration_runtime_nodes

integration_runtime_object_metadata[R]

@return [IntegrationRuntimeObjectMetadata] integration_runtime_object_metadata

integration_runtime_status_operations[R]

@return [IntegrationRuntimeStatusOperations] integration_runtime_status_operations

integration_runtimes[R]

@return [IntegrationRuntimes] integration_runtimes

ip_firewall_rules[R]

@return [IpFirewallRules] ip_firewall_rules

keys[R]

@return [Keys] keys

long_running_operation_retry_timeout[RW]

@return [Integer] The retry timeout in seconds for Long Running Operations. Default value is 30.

operations[R]

@return [Operations] operations

private_endpoint_connections[R]

@return [PrivateEndpointConnections] private_endpoint_connections

restorable_dropped_sql_pools[R]

@return [RestorableDroppedSqlPools] restorable_dropped_sql_pools

sql_pool_blob_auditing_policies[R]

@return [SqlPoolBlobAuditingPolicies] sql_pool_blob_auditing_policies

sql_pool_columns[R]

@return [SqlPoolColumns] sql_pool_columns

sql_pool_connection_policies[R]

@return [SqlPoolConnectionPolicies] sql_pool_connection_policies

sql_pool_data_warehouse_user_activities[R]

@return [SqlPoolDataWarehouseUserActivities] sql_pool_data_warehouse_user_activities

sql_pool_geo_backup_policies[R]

@return [SqlPoolGeoBackupPolicies] sql_pool_geo_backup_policies

sql_pool_metadata_sync_configs[R]

@return [SqlPoolMetadataSyncConfigs] sql_pool_metadata_sync_configs

sql_pool_operation_results[R]

@return [SqlPoolOperationResults] sql_pool_operation_results

sql_pool_operations[R]

@return [SqlPoolOperations] sql_pool_operations

sql_pool_restore_points[R]

@return [SqlPoolRestorePoints] sql_pool_restore_points

sql_pool_schemas[R]

@return [SqlPoolSchemas] sql_pool_schemas

sql_pool_security_alert_policies[R]

@return [SqlPoolSecurityAlertPolicies] sql_pool_security_alert_policies

sql_pool_sensitivity_labels[R]

@return [SqlPoolSensitivityLabels] sql_pool_sensitivity_labels

sql_pool_table_columns[R]

@return [SqlPoolTableColumns] sql_pool_table_columns

sql_pool_tables[R]

@return [SqlPoolTables] sql_pool_tables

sql_pool_transparent_data_encryptions[R]

@return [SqlPoolTransparentDataEncryptions] sql_pool_transparent_data_encryptions

sql_pool_usages[R]

@return [SqlPoolUsages] sql_pool_usages

sql_pool_vulnerability_assessment_rule_baselines[R]

@return [SqlPoolVulnerabilityAssessmentRuleBaselines] sql_pool_vulnerability_assessment_rule_baselines

sql_pool_vulnerability_assessment_scans[R]

@return [SqlPoolVulnerabilityAssessmentScans] sql_pool_vulnerability_assessment_scans

sql_pool_vulnerability_assessments[R]

@return [SqlPoolVulnerabilityAssessments] sql_pool_vulnerability_assessments

sql_pool_workload_classifier[R]

@return [SqlPoolWorkloadClassifier] sql_pool_workload_classifier

sql_pool_workload_group[R]

@return [SqlPoolWorkloadGroup] sql_pool_workload_group

sql_pools[R]

@return [SqlPools] sql_pools

subscription_id[RW]

@return [String] The ID of the target subscription.

workspace_aad_admins[R]

@return [WorkspaceAadAdmins] workspace_aad_admins

workspace_managed_identity_sql_control_settings[R]

@return [WorkspaceManagedIdentitySqlControlSettings] workspace_managed_identity_sql_control_settings

workspace_managed_sql_server_blob_auditing_policies[R]

@return [WorkspaceManagedSqlServerBlobAuditingPolicies] workspace_managed_sql_server_blob_auditing_policies

workspace_managed_sql_server_extended_blob_auditing_policies[R]

@return [WorkspaceManagedSqlServerExtendedBlobAuditingPolicies] workspace_managed_sql_server_extended_blob_auditing_policies

workspace_managed_sql_server_recoverable_sqlpools[R]

@return [WorkspaceManagedSqlServerRecoverableSqlpools] workspace_managed_sql_server_recoverable_sqlpools

workspace_managed_sql_server_security_alert_policy[R]

@return [WorkspaceManagedSqlServerSecurityAlertPolicy] workspace_managed_sql_server_security_alert_policy

workspace_managed_sql_server_usages[R]

@return [WorkspaceManagedSqlServerUsages] workspace_managed_sql_server_usages

workspace_managed_sql_server_vulnerability_assessments[R]

@return [WorkspaceManagedSqlServerVulnerabilityAssessments] workspace_managed_sql_server_vulnerability_assessments

workspace_sql_aad_admins[R]

@return [WorkspaceSqlAadAdmins] workspace_sql_aad_admins

workspaces[R]

@return [Workspaces] workspaces

Public Class Methods

new(credentials = nil, base_url = nil, options = nil) click to toggle source

Creates initializes a new instance of the SynapseManagementClient class. @param credentials [MsRest::ServiceClientCredentials] credentials to authorize HTTP requests made by the service client. @param base_url [String] the base URI of the service. @param options [Array] filters to be applied to the HTTP requests.

Calls superclass method
# File lib/2019-06-01-preview/generated/azure_mgmt_synapse/synapse_management_client.rb, line 226
def initialize(credentials = nil, base_url = nil, options = nil)
  super(credentials, options)
  @base_url = base_url || 'https://management.azure.com'

  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
  @credentials = credentials

  @big_data_pools = BigDataPools.new(self)
  @operations = Operations.new(self)
  @ip_firewall_rules = IpFirewallRules.new(self)
  @sql_pools = SqlPools.new(self)
  @sql_pool_metadata_sync_configs = SqlPoolMetadataSyncConfigs.new(self)
  @sql_pool_operation_results = SqlPoolOperationResults.new(self)
  @sql_pool_geo_backup_policies = SqlPoolGeoBackupPolicies.new(self)
  @sql_pool_data_warehouse_user_activities = SqlPoolDataWarehouseUserActivities.new(self)
  @sql_pool_restore_points = SqlPoolRestorePoints.new(self)
  @sql_pool_replication_links = SqlPoolReplicationLinks.new(self)
  @sql_pool_transparent_data_encryptions = SqlPoolTransparentDataEncryptions.new(self)
  @sql_pool_blob_auditing_policies = SqlPoolBlobAuditingPolicies.new(self)
  @sql_pool_operations = SqlPoolOperations.new(self)
  @sql_pool_usages = SqlPoolUsages.new(self)
  @sql_pool_sensitivity_labels = SqlPoolSensitivityLabels.new(self)
  @sql_pool_schemas = SqlPoolSchemas.new(self)
  @sql_pool_tables = SqlPoolTables.new(self)
  @sql_pool_table_columns = SqlPoolTableColumns.new(self)
  @sql_pool_connection_policies = SqlPoolConnectionPolicies.new(self)
  @sql_pool_vulnerability_assessments = SqlPoolVulnerabilityAssessments.new(self)
  @sql_pool_vulnerability_assessment_scans = SqlPoolVulnerabilityAssessmentScans.new(self)
  @sql_pool_security_alert_policies = SqlPoolSecurityAlertPolicies.new(self)
  @sql_pool_vulnerability_assessment_rule_baselines = SqlPoolVulnerabilityAssessmentRuleBaselines.new(self)
  @extended_sql_pool_blob_auditing_policies = ExtendedSqlPoolBlobAuditingPolicies.new(self)
  @data_masking_policies = DataMaskingPolicies.new(self)
  @data_masking_rules = DataMaskingRules.new(self)
  @sql_pool_columns = SqlPoolColumns.new(self)
  @sql_pool_workload_group = SqlPoolWorkloadGroup.new(self)
  @sql_pool_workload_classifier = SqlPoolWorkloadClassifier.new(self)
  @workspaces = Workspaces.new(self)
  @workspace_aad_admins = WorkspaceAadAdmins.new(self)
  @workspace_sql_aad_admins = WorkspaceSqlAadAdmins.new(self)
  @workspace_managed_identity_sql_control_settings = WorkspaceManagedIdentitySqlControlSettings.new(self)
  @restorable_dropped_sql_pools = RestorableDroppedSqlPools.new(self)
  @integration_runtimes = IntegrationRuntimes.new(self)
  @integration_runtime_node_ip_address_operations = IntegrationRuntimeNodeIpAddressOperations.new(self)
  @integration_runtime_object_metadata = IntegrationRuntimeObjectMetadata.new(self)
  @integration_runtime_nodes = IntegrationRuntimeNodes.new(self)
  @integration_runtime_credentials = IntegrationRuntimeCredentials.new(self)
  @integration_runtime_connection_infos = IntegrationRuntimeConnectionInfos.new(self)
  @integration_runtime_auth_keys_operations = IntegrationRuntimeAuthKeysOperations.new(self)
  @integration_runtime_monitoring_data_operations = IntegrationRuntimeMonitoringDataOperations.new(self)
  @integration_runtime_status_operations = IntegrationRuntimeStatusOperations.new(self)
  @private_link_resources = PrivateLinkResources.new(self)
  @private_endpoint_connections = PrivateEndpointConnections.new(self)
  @private_link_hubs = PrivateLinkHubs.new(self)
  @private_endpoint_connections_private_link_hub = PrivateEndpointConnectionsPrivateLinkHub.new(self)
  @workspace_managed_sql_server_blob_auditing_policies = WorkspaceManagedSqlServerBlobAuditingPolicies.new(self)
  @workspace_managed_sql_server_extended_blob_auditing_policies = WorkspaceManagedSqlServerExtendedBlobAuditingPolicies.new(self)
  @workspace_managed_sql_server_security_alert_policy = WorkspaceManagedSqlServerSecurityAlertPolicy.new(self)
  @workspace_managed_sql_server_vulnerability_assessments = WorkspaceManagedSqlServerVulnerabilityAssessments.new(self)
  @workspace_managed_sql_server_usages = WorkspaceManagedSqlServerUsages.new(self)
  @workspace_managed_sql_server_recoverable_sqlpools = WorkspaceManagedSqlServerRecoverableSqlpools.new(self)
  @keys = Keys.new(self)
  @api_version = '2019-06-01-preview'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Public Instance Methods

make_request(method, path, options = {}) click to toggle source

Makes a request and returns the body of the response. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [Hash{String=>String}] containing the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)
# File lib/2019-06-01-preview/generated/azure_mgmt_synapse/synapse_management_client.rb, line 310
def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end
make_request_async(method, path, options = {}) click to toggle source

Makes a request asynchronously. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [Concurrent::Promise] Promise object which holds the HTTP response.

Calls superclass method
# File lib/2019-06-01-preview/generated/azure_mgmt_synapse/synapse_management_client.rb, line 335
def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end
make_request_with_http_info(method, path, options = {}) click to toggle source

Makes a request and returns the operation response. @param method [Symbol] with any of the following values :get, :put, :post, :patch, :delete. @param path [String] the path, relative to {base_url}. @param options [Hash{String=>String}] specifying any request options like :body. @return [MsRestAzure::AzureOperationResponse] Operation response containing the request, response and status.

# File lib/2019-06-01-preview/generated/azure_mgmt_synapse/synapse_management_client.rb, line 322
def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end

Private Instance Methods

add_telemetry() click to toggle source

Adds telemetry information.

# File lib/2019-06-01-preview/generated/azure_mgmt_synapse/synapse_management_client.rb, line 357
def add_telemetry
    sdk_information = 'azure_mgmt_synapse'
    sdk_information = "#{sdk_information}/0.17.4"
    add_user_agent_information(sdk_information)
end