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

Inherits:
Base show all
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 collapse

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, #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:

  • (String) —

    Specific API version to be used.



17
 
# 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:

  • (String, nil) —

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



40
 
# 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:

  • (Symbol, nil) —

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



52
 
# 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:

  • (:GET, :PUT, :POST, :HEAD, :PATCH, :DELETE, :MERGE, nil) —

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



44
 
# 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:

  • (String, nil) —

    Provider type.,Required if URL is not specified.



21
 
# 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:

  • (String, nil) —

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



25
 
# 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:

  • (String, nil) —

    Resource name.,Required if URL Is not specified.



33
 
# 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:

  • (String, nil) —

    Resource type.,Required if URL is not specified.



29
 
# 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:

  • (:absent, :present, nil) —

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



56
 
# 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:

  • (Integer, nil) —

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



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

attribute :status_code

#subresource ⇒ Object?

Returns List of subresources.

Returns:

  • (Object, nil) —

    List of subresources



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

attribute :subresource

#url ⇒ Object?

Returns Azure RM Resource URL.

Returns:

  • (Object, nil) —

    Azure RM Resource URL.



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

attribute :url