Class: Ansible::Ruby::Modules::Azure_rm_webapp

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

Overview

Create, update and delete instance of Web App.

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

#app_settings ⇒ Hash?

Returns Configure web app application settings. Suboptions are in key value pair format.

Returns:

  • (Hash, nil) —

    Configure web app application settings. Suboptions are in key value pair format.



63
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_webapp.rb', line 63

attribute :app_settings

#app_state ⇒ String?

Returns Start/Stop/Restart the web app.

Returns:

  • (String, nil) —

    Start/Stop/Restart the web app.



71
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_webapp.rb', line 71

attribute :app_state

#client_affinity_enabled ⇒ Boolean?

Returns True to enable client affinity; False to stop sending session affinity cookies, which route client requests in the same session to the same instance.

Returns:

  • (Boolean, nil) —

    True to enable client affinity; False to stop sending session affinity cookies, which route client requests in the same session to the same instance.



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

attribute :client_affinity_enabled

#container_settings ⇒ Hash?

Returns Web app container settings.

Returns:

  • (Hash, nil) —

    Web app container settings.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_webapp.rb', line 31

attribute :container_settings

#deployment_source ⇒ Object?

Returns Deployment source for git.

Returns:

  • (Object, nil) —

    Deployment source for git



38
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_webapp.rb', line 38

attribute :deployment_source

#dns_registration ⇒ Symbol?

Returns If true web app hostname is not registered with DNS on creation.

Returns:

  • (Symbol, nil) —

    If true web app hostname is not registered with DNS on creation.



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

attribute :dns_registration

#frameworks ⇒ Array<Hash>, ...

Returns Set of run time framework settings. Each setting is a dictionary.,See U(docs.microsoft.com/en-us/azure/app-service/app-service-web-overview) for more info.

Returns:



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_webapp.rb', line 27

attribute :frameworks

#https_only ⇒ Symbol?

Returns Configures web site to accept only https requests.

Returns:

  • (Symbol, nil) —

    Configures web site to accept only https requests.



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

attribute :https_only

#location ⇒ Object?

Returns Resource location. If not set, location from the resource group will be used as default.

Returns:

  • (Object, nil) —

    Resource location. If not set, location from the resource group will be used as default.



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

attribute :location

#name ⇒ String

Returns Unique name of the app to create or update. To create or update a deployment slot, use the slot parameter.

Returns:

  • (String) —

    Unique name of the app to create or update. To create or update a deployment slot, use the slot parameter.



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

attribute :name

#plan ⇒ Hash, ...

Returns App service plan. Required for creation.,It can be name of existing app service plan in same resource group as web app.,It can be resource id of existing app service plan. eg., /subscriptions/<subs_id>/resourceGroups/<resource_group>/providers/Microsoft.Web/serverFarms/<plan_name>,It can be a dict which contains C(name), C(resource_group), C(sku), C(is_linux) and C(number_of_workers).,C(name). Name of app service plan.,C(resource_group). Resource group name of app service plan.,C(sku). SKU of app service plan. For allowed sku, please refer to U(azure.microsoft.com/en-us/pricing/details/app-service/linux/).,C(is_linux). Indicates Linux app service plan. type bool. default False.,C(number_of_workers). Number of workers.

Returns:

  • (Hash, String, nil) —

    App service plan. Required for creation.,It can be name of existing app service plan in same resource group as web app.,It can be resource id of existing app service plan. eg., /subscriptions/<subs_id>/resourceGroups/<resource_group>/providers/Microsoft.Web/serverFarms/<plan_name>,It can be a dict which contains C(name), C(resource_group), C(sku), C(is_linux) and C(number_of_workers).,C(name). Name of app service plan.,C(resource_group). Resource group name of app service plan.,C(sku). SKU of app service plan. For allowed sku, please refer to U(azure.microsoft.com/en-us/pricing/details/app-service/linux/).,C(is_linux). Indicates Linux app service plan. type bool. default False.,C(number_of_workers). Number of workers.



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_webapp.rb', line 23

attribute :plan

#purge_app_settings ⇒ Symbol?

Returns Purge any existing application settings. Replace web app application settings with app_settings.

Returns:

  • (Symbol, nil) —

    Purge any existing application settings. Replace web app application settings with app_settings.



67
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_webapp.rb', line 67

attribute :purge_app_settings

#resource_group ⇒ String

Returns Name of the resource group to which the resource belongs.

Returns:

  • (String) —

    Name of the resource group to which the resource belongs.



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

attribute :resource_group

#scm_type ⇒ Object?

Returns Repository type of deployment source. Eg. LocalGit, GitHub.,Please see U(docs.microsoft.com/en-us/rest/api/appservice/webapps/createorupdate#scmtype) for more info.

Returns:



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_webapp.rb', line 35

attribute :scm_type

#skip_custom_domain_verification ⇒ Symbol?

Returns If true, custom (non *.azurewebsites.net) domains associated with web app are not verified.

Returns:

  • (Symbol, nil) —

    If true, custom (non *.azurewebsites.net) domains associated with web app are not verified.



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

attribute :skip_custom_domain_verification

#startup_file ⇒ Object?

Returns The web’s startup file.,This only applies for linux web app.

Returns:

  • (Object, nil) —

    The web’s startup file.,This only applies for linux web app.



41
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_webapp.rb', line 41

attribute :startup_file

#state ⇒ :absent, ...

Returns Assert the state of the Web App.,Use ‘present’ to create or update a Web App and ‘absent’ to delete it.

Returns:

  • (:absent, :present, nil) —

    Assert the state of the Web App.,Use ‘present’ to create or update a Web App and ‘absent’ to delete it.



75
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_webapp.rb', line 75

attribute :state

#ttl_in_seconds ⇒ Object?

Returns Time to live in seconds for web app default domain name.

Returns:

  • (Object, nil) —

    Time to live in seconds for web app default domain name.



60
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_webapp.rb', line 60

attribute :ttl_in_seconds