Class: DatadogAPIClient::V1::AzureIntegrationAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v1/api/azure_integration_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ AzureIntegrationAPI

Returns a new instance of AzureIntegrationAPI.



22
23
24
 
# File 'lib/datadog_api_client/v1/api/azure_integration_api.rb', line 22

def initialize(api_client = APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v1/api/azure_integration_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_azure_integration(body, opts = {}) ⇒ Object

Create an Azure integration.

See Also:



30
31
32
33
 
# File 'lib/datadog_api_client/v1/api/azure_integration_api.rb', line 30

def create_azure_integration(body, opts = {})
  data, _status_code, _headers = create_azure_integration_with_http_info(body, opts)
  data
end

#create_azure_integration_with_http_info(body, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Create an Azure integration.

Create a Datadog-Azure integration.

Using the POST method updates your integration configuration by adding your new configuration to the existing one in your Datadog organization.

Using the PUT method updates your integration configuration by replacing your current configuration with the new one sent to your Datadog organization.

Parameters:

  • body (AzureAccount) —

    Create a Datadog-Azure integration for your Datadog account request body.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/datadog_api_client/v1/api/azure_integration_api.rb', line 40

def create_azure_integration_with_http_info(body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:create_azure_integration)
    unstable_enabled = @api_client.config.unstable_operations[:create_azure_integration]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "create_azure_integration")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "create_azure_integration"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AzureIntegrationAPI.create_azure_integration ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AzureIntegrationAPI.create_azure_integration"
  end
  # resource path
  local_var_path = '/api/v1/integration/azure'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_azure_integration,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AzureIntegrationAPI#create_azure_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_azure_integration(body, opts = {}) ⇒ Object

Delete an Azure integration.

See Also:



105
106
107
108
 
# File 'lib/datadog_api_client/v1/api/azure_integration_api.rb', line 105

def delete_azure_integration(body, opts = {})
  data, _status_code, _headers = delete_azure_integration_with_http_info(body, opts)
  data
end

#delete_azure_integration_with_http_info(body, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete an Azure integration.

Delete a given Datadog-Azure integration from your Datadog account.

Parameters:

  • body (AzureAccount) —

    Delete a given Datadog-Azure integration request body.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/datadog_api_client/v1/api/azure_integration_api.rb', line 115

def delete_azure_integration_with_http_info(body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:delete_azure_integration)
    unstable_enabled = @api_client.config.unstable_operations[:delete_azure_integration]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "delete_azure_integration")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "delete_azure_integration"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AzureIntegrationAPI.delete_azure_integration ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AzureIntegrationAPI.delete_azure_integration"
  end
  # resource path
  local_var_path = '/api/v1/integration/azure'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :delete_azure_integration,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AzureIntegrationAPI#delete_azure_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_azure_integration(opts = {}) ⇒ Object

List all Azure integrations.

See Also:



179
180
181
182
 
# File 'lib/datadog_api_client/v1/api/azure_integration_api.rb', line 179

def list_azure_integration(opts = {})
  data, _status_code, _headers = list_azure_integration_with_http_info(opts)
  data
end

#list_azure_integration_with_http_info(opts = {}) ⇒ Array<(Array<AzureAccount>, Integer, Hash)>

List all Azure integrations.

List all Datadog-Azure integrations configured in your Datadog account.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<AzureAccount>, Integer, Hash)>) —

    Array data, response status code and response headers



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/datadog_api_client/v1/api/azure_integration_api.rb', line 188

def list_azure_integration_with_http_info(opts = {})

  if @api_client.config.unstable_operations.has_key?(:list_azure_integration)
    unstable_enabled = @api_client.config.unstable_operations[:list_azure_integration]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "list_azure_integration")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_azure_integration"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AzureIntegrationAPI.list_azure_integration ...'
  end
  # resource path
  local_var_path = '/api/v1/integration/azure'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<AzureAccount>'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_azure_integration,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AzureIntegrationAPI#list_azure_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_azure_host_filters(body, opts = {}) ⇒ Object

Update Azure integration host filters.

See Also:



247
248
249
250
 
# File 'lib/datadog_api_client/v1/api/azure_integration_api.rb', line 247

def update_azure_host_filters(body, opts = {})
  data, _status_code, _headers = update_azure_host_filters_with_http_info(body, opts)
  data
end

#update_azure_host_filters_with_http_info(body, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Update Azure integration host filters.

Update the defined list of host filters for a given Datadog-Azure integration.

Parameters:

  • body (AzureAccount) —

    Update a Datadog-Azure integration's host filters request body.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/datadog_api_client/v1/api/azure_integration_api.rb', line 257

def update_azure_host_filters_with_http_info(body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:update_azure_host_filters)
    unstable_enabled = @api_client.config.unstable_operations[:update_azure_host_filters]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "update_azure_host_filters")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "update_azure_host_filters"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AzureIntegrationAPI.update_azure_host_filters ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AzureIntegrationAPI.update_azure_host_filters"
  end
  # resource path
  local_var_path = '/api/v1/integration/azure/host_filters'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_azure_host_filters,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AzureIntegrationAPI#update_azure_host_filters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_azure_integration(body, opts = {}) ⇒ Object

Update an Azure integration.

See Also:



322
323
324
325
 
# File 'lib/datadog_api_client/v1/api/azure_integration_api.rb', line 322

def update_azure_integration(body, opts = {})
  data, _status_code, _headers = update_azure_integration_with_http_info(body, opts)
  data
end

#update_azure_integration_with_http_info(body, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Update an Azure integration.

Update a Datadog-Azure integration. Requires an existing tenant_name and client_id. Any other fields supplied will overwrite existing values. To overwrite tenant_name or client_id, use new_tenant_name and new_client_id. To leave a field unchanged, do not supply that field in the payload.

Parameters:

  • body (AzureAccount) —

    Update a Datadog-Azure integration request body.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/datadog_api_client/v1/api/azure_integration_api.rb', line 332

def update_azure_integration_with_http_info(body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:update_azure_integration)
    unstable_enabled = @api_client.config.unstable_operations[:update_azure_integration]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "update_azure_integration")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "update_azure_integration"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AzureIntegrationAPI.update_azure_integration ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AzureIntegrationAPI.update_azure_integration"
  end
  # resource path
  local_var_path = '/api/v1/integration/azure'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_azure_integration,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AzureIntegrationAPI#update_azure_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end