Class: Ansible::Ruby::Modules::Azure_rm_deployment

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_deployment.rb

Overview

Create or destroy Azure Resource Manager template deployments via the Azure SDK for Python. You can find some quick start templates in GitHub here github.com/azure/azure-quickstart-templates. For more information on Azue resource manager templates see azure.microsoft.com/en-us/documentation/articles/resource-group-template-deploy/.

Instance Method Summary collapse

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

#deployment_mode ⇒ :complete, ...

Returns In incremental mode, resources are deployed without deleting existing resources that are not included in the template. In complete mode resources are deployed and existing resources in the resource group not included in the template are deleted.

Returns:

  • (:complete, :incremental, nil) —

    In incremental mode, resources are deployed without deleting existing resources that are not included in the template. In complete mode resources are deployed and existing resources in the resource group not included in the template are deleted.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_deployment.rb', line 20

attribute :deployment_mode

#deployment_name ⇒ String?

Returns The name of the deployment to be tracked in the resource group deployment history. Re-using a deployment name will overwrite the previous value in the resource group’s deployment history.

Returns:

  • (String, nil) —

    The name of the deployment to be tracked in the resource group deployment history. Re-using a deployment name will overwrite the previous value in the resource group’s deployment history.



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

attribute :deployment_name

#location ⇒ String?

Returns The geo-locations in which the resource group will be located.

Returns:

  • (String, nil) —

    The geo-locations in which the resource group will be located.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_deployment.rb', line 16

attribute :location

#parameters ⇒ Hash?

Returns A hash of all the required template variables for the deployment template. This parameter is mutually exclusive with ‘parameters_link’. Either one of them is required if “state” parameter is “present”.

Returns:

  • (Hash, nil) —

    A hash of all the required template variables for the deployment template. This parameter is mutually exclusive with ‘parameters_link’. Either one of them is required if “state” parameter is “present”.



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_deployment.rb', line 36

attribute :parameters

#parameters_link ⇒ String?

Returns Uri of file containing the parameters body. This parameter is mutually exclusive with ‘parameters’. Either one of them is required if “state” parameter is “present”.

Returns:

  • (String, nil) —

    Uri of file containing the parameters body. This parameter is mutually exclusive with ‘parameters’. Either one of them is required if “state” parameter is “present”.



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

attribute :parameters_link

#resource_group_name ⇒ String

Returns The resource group name to use or create to host the deployed template.

Returns:

  • (String) —

    The resource group name to use or create to host the deployed template



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_deployment.rb', line 12

attribute :resource_group_name

#state ⇒ :present, ...

Returns If state is “present”, template will be created. If state is “present” and if deployment exists, it will be updated. If state is “absent”, stack will be removed.

Returns:

  • (:present, :absent, nil) —

    If state is “present”, template will be created. If state is “present” and if deployment exists, it will be updated. If state is “absent”, stack will be removed.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_deployment.rb', line 24

attribute :state

#template ⇒ Hash?

Returns A hash containing the templates inline. This parameter is mutually exclusive with ‘template_link’. Either one of them is required if “state” parameter is “present”.

Returns:

  • (Hash, nil) —

    A hash containing the templates inline. This parameter is mutually exclusive with ‘template_link’. Either one of them is required if “state” parameter is “present”.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_deployment.rb', line 28

attribute :template

#template_link ⇒ String?

Returns Uri of file containing the template body. This parameter is mutually exclusive with ‘template’. Either one of them is required if “state” parameter is “present”.

Returns:

  • (String, nil) —

    Uri of file containing the template body. This parameter is mutually exclusive with ‘template’. Either one of them is required if “state” parameter is “present”.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_deployment.rb', line 32

attribute :template_link

#wait_for_deployment_completion ⇒ :yes, ...

Returns Whether or not to block until the deployment has completed.

Returns:

  • (:yes, :no, nil) —

    Whether or not to block until the deployment has completed.



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

attribute :wait_for_deployment_completion

#wait_for_deployment_polling_period ⇒ Integer?

Returns Time (in seconds) to wait between polls when waiting for deployment completion.

Returns:

  • (Integer, nil) —

    Time (in seconds) to wait between polls when waiting for deployment completion.



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

attribute :wait_for_deployment_polling_period