Class: Azure::DataShare::Mgmt::V2019_11_01::DataShareManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, base_url = nil, options = nil) ⇒ DataShareManagementClient

Creates initializes a new instance of the DataShareManagementClient class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) (defaults to: nil) —

    credentials to authorize HTTP requests made by the service client.

  • base_url (String) (defaults to: nil) —

    the base URI of the service.

  • options (Array) (defaults to: nil) —

    filters to be applied to the HTTP requests.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 80

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

  @accounts = Accounts.new(self)
  @consumer_invitations = ConsumerInvitations.new(self)
  @data_sets = DataSets.new(self)
  @data_set_mappings = DataSetMappings.new(self)
  @invitations = Invitations.new(self)
  @operations = Operations.new(self)
  @shares = Shares.new(self)
  @provider_share_subscriptions = ProviderShareSubscriptions.new(self)
  @share_subscriptions = ShareSubscriptions.new(self)
  @consumer_source_data_sets = ConsumerSourceDataSets.new(self)
  @synchronization_settings = SynchronizationSettings.new(self)
  @triggers = Triggers.new(self)
  @api_version = '2019-11-01'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_language ⇒ String

Returns The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



27
28
29
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 27

def accept_language
  @accept_language
end

#accounts ⇒ Accounts (readonly)

Returns accounts.

Returns:



39
40
41
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 39

def accounts
  @accounts
end

#api_version ⇒ String (readonly)

Returns The api version to use.

Returns:

  • (String) —

    The api version to use.



21
22
23
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 21

def api_version
  @api_version
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 15

def base_url
  @base_url
end

#consumer_invitations ⇒ ConsumerInvitations (readonly)

Returns consumer_invitations.

Returns:



42
43
44
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 42

def consumer_invitations
  @consumer_invitations
end

#consumer_source_data_sets ⇒ ConsumerSourceDataSets (readonly)

Returns consumer_source_data_sets.

Returns:



66
67
68
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 66

def consumer_source_data_sets
  @consumer_source_data_sets
end

#credentials ⇒ Object (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.



18
19
20
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 18

def credentials
  @credentials
end

#data_set_mappings ⇒ DataSetMappings (readonly)

Returns data_set_mappings.

Returns:



48
49
50
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 48

def data_set_mappings
  @data_set_mappings
end

#data_sets ⇒ DataSets (readonly)

Returns data_sets.

Returns:



45
46
47
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 45

def data_sets
  @data_sets
end

#generate_client_request_id ⇒ Boolean

generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    Whether a unique x-ms-client-request-id should be



36
37
38
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 36

def generate_client_request_id
  @generate_client_request_id
end

#invitations ⇒ Invitations (readonly)

Returns invitations.

Returns:



51
52
53
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 51

def invitations
  @invitations
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



31
32
33
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 31

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#operations ⇒ Operations (readonly)

Returns operations.

Returns:



54
55
56
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 54

def operations
  @operations
end

#provider_share_subscriptions ⇒ ProviderShareSubscriptions (readonly)

Returns provider_share_subscriptions.

Returns:



60
61
62
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 60

def provider_share_subscriptions
  @provider_share_subscriptions
end

#share_subscriptions ⇒ ShareSubscriptions (readonly)

Returns share_subscriptions.

Returns:



63
64
65
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 63

def share_subscriptions
  @share_subscriptions
end

#shares ⇒ Shares (readonly)

Returns shares.

Returns:



57
58
59
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 57

def shares
  @shares
end

#subscription_id ⇒ String

Returns The subscription identifier.

Returns:

  • (String) —

    The subscription identifier



24
25
26
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 24

def subscription_id
  @subscription_id
end

#synchronization_settings ⇒ SynchronizationSettings (readonly)

Returns synchronization_settings.

Returns:



69
70
71
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 69

def synchronization_settings
  @synchronization_settings
end

#triggers ⇒ Triggers (readonly)

Returns triggers.

Returns:



72
73
74
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 72

def triggers
  @triggers
end

Instance Method Details

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

Makes a request and returns 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)

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {}) —

    specifying any request options like :body.

Returns:

  • (Hash{String=>String}) —

    containing the body of the response.



122
123
124
125
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 122

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 = {}) ⇒ Concurrent::Promise

Makes a request asynchronously.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {}) —

    specifying any request options like :body.

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 147

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 = {}) ⇒ MsRestAzure::AzureOperationResponse

Makes a request and returns the operation response.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {}) —

    specifying any request options like :body.

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    Operation response containing the request, response and status.



134
135
136
137
138
 
# File 'lib/2019-11-01/generated/azure_mgmt_datashare/data_share_management_client.rb', line 134

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