Class: Ansible::Ruby::Modules::Azure_rm_resource

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Azure_rm_resource

Defined in:

lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_resource.rb

Overview

Create, update or delete any Azure resource using Azure REST API. This module gives access to resources that are not supported via Ansible modules. Refer to docs.microsoft.com/en-us/rest/api/ regarding details related to specific resource REST API.

Instance Method Summary

• #api_version ⇒ String

  Specific API version to be used.

• #body ⇒ String^?

  The body of the http request/response to the web service.

• #idempotency ⇒ Symbol^?

  If enabled, idempotency check will be done by using GET method first and then comparing with I(body).

• #method ⇒ :GET, ...

  The HTTP method of the request or response.

• #provider ⇒ String^?

  Provider type.,Required if URL is not specified.

• #resource_group ⇒ String^?

  Resource group to be used.,Required if URL is not specified.

• #resource_name ⇒ String^?

  Resource name.,Required if URL Is not specified.

• #resource_type ⇒ String^?

  Resource type.,Required if URL is not specified.

• #state ⇒ :absent, ...

  Assert the state of the resource.

• #status_code ⇒ Integer^?

  A valid, numeric, HTTP status code that signifies success of the request.

• #subresource ⇒ Object^?

  List of subresources.

• #url ⇒ Object^?

  Azure RM Resource URL.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#api_version ⇒ String

Returns Specific API version to be used.

Returns:

• Specific API version to be used.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_resource.rb', line 17

attribute :api_version

#body ⇒ String^?

Returns The body of the http request/response to the web service.

Returns:

• The body of the http request/response to the web service.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_resource.rb', line 40

attribute :body

#idempotency ⇒ Symbol^?

Returns If enabled, idempotency check will be done by using GET method first and then comparing with I(body).

Returns:

• If enabled, idempotency check will be done by using GET method first and then comparing with I(body)

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_resource.rb', line 52

attribute :idempotency

#method ⇒ :GET, ...

Returns The HTTP method of the request or response. It MUST be uppercase.

Returns:

• The HTTP method of the request or response. It MUST be uppercase.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_resource.rb', line 44

attribute :method

#provider ⇒ String^?

Returns Provider type.,Required if URL is not specified.

Returns:

• Provider type.,Required if URL is not specified.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_resource.rb', line 21

attribute :provider

#resource_group ⇒ String^?

Returns Resource group to be used.,Required if URL is not specified.

Returns:

• Resource group to be used.,Required if URL is not specified.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_resource.rb', line 25

attribute :resource_group

#resource_name ⇒ String^?

Returns Resource name.,Required if URL Is not specified.

Returns:

• Resource name.,Required if URL Is not specified.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_resource.rb', line 33

attribute :resource_name

#resource_type ⇒ String^?

Returns Resource type.,Required if URL is not specified.

Returns:

• Resource type.,Required if URL is not specified.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_resource.rb', line 29

attribute :resource_type

#state ⇒ :absent, ...

Returns Assert the state of the resource. Use C(present) to create or update resource or C(absent) to delete resource.

Returns:

• Assert the state of the resource. Use C(present) to create or update resource or C(absent) to delete resource.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_resource.rb', line 56

attribute :state

#status_code ⇒ Integer^?

Returns A valid, numeric, HTTP status code that signifies success of the request. Can also be comma separated list of status codes.

Returns:

• A valid, numeric, HTTP status code that signifies success of the request. Can also be comma separated list of status codes.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_resource.rb', line 48

attribute :status_code

#subresource ⇒ Object^?

Returns List of subresources.

Returns:

• List of subresources

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_resource.rb', line 37

attribute :subresource

#url ⇒ Object^?

Returns Azure RM Resource URL.

Returns:

• Azure RM Resource URL.

# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_resource.rb', line 14

attribute :url