Class: Ansible::Ruby::Modules::Azure_rm_sqldatabase

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

Overview

Create, update and delete instance of SQL Database.

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

#collation ⇒ Object?

Returns The collation of the database. If I(create_mode) is not C(default), this value is ignored.

Returns:

  • (Object, nil) —

    The collation of the database. If I(create_mode) is not C(default), this value is ignored.



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

attribute :collation

#create_mode ⇒ :copy, ...

Returns Specifies the mode of database creation.,C(default): regular database creation.,C(copy): creates a database as a copy of an existing database.,C(online_secondary)/C(non_readable_secondary): creates a database as a (readable or nonreadable) secondary replica of an existing database.,C(point_in_time_restore): Creates a database by restoring a point in time backup of an existing database.,C(recovery): Creates a database by restoring a geo-replicated backup.,C(restore): Creates a database by restoring a backup of a deleted database.,C(restore_long_term_retention_backup): Creates a database by restoring from a long term retention vault.,C(copy), C(non_readable_secondary), C(online_secondary) and C(restore_long_term_retention_backup) are not supported for C(data_warehouse) edition.

Returns:

  • (:copy, :default, :non_readable_secondary, :online_secondary, :point_in_time_restore, :recovery, :restore, :restore_long_term_retention_backup, nil) —

    Specifies the mode of database creation.,C(default): regular database creation.,C(copy): creates a database as a copy of an existing database.,C(online_secondary)/C(non_readable_secondary): creates a database as a (readable or nonreadable) secondary replica of an existing database.,C(point_in_time_restore): Creates a database by restoring a point in time backup of an existing database.,C(recovery): Creates a database by restoring a geo-replicated backup.,C(restore): Creates a database by restoring a backup of a deleted database.,C(restore_long_term_retention_backup): Creates a database by restoring from a long term retention vault.,C(copy), C(non_readable_secondary), C(online_secondary) and C(restore_long_term_retention_backup) are not supported for C(data_warehouse) edition.



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

attribute :create_mode

#edition ⇒ :web, ...

Returns The edition of the database. The DatabaseEditions enumeration contains all the valid editions. If I(create_mode) is C(non_readable_secondary) or C(online_secondary), this value is ignored. To see possible values, query the capabilities API (/subscriptions/subscriptionId/providers/Microsoft.Sql/locations/locationID/capabilities) referred to by operationId: ‘Capabilities_ListByLocation.’.

Returns:

  • (:web, :business, :basic, :standard, :premium, :free, :stretch, :data_warehouse, :system, :system2, nil) —

    The edition of the database. The DatabaseEditions enumeration contains all the valid editions. If I(create_mode) is C(non_readable_secondary) or C(online_secondary), this value is ignored. To see possible values, query the capabilities API (/subscriptions/subscriptionId/providers/Microsoft.Sql/locations/locationID/capabilities) referred to by operationId: ‘Capabilities_ListByLocation.’.



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

attribute :edition

#elastic_pool_name ⇒ Object?

Returns The name of the elastic pool the database is in. Not supported for C(data_warehouse) edition.

Returns:

  • (Object, nil) —

    The name of the elastic pool the database is in. Not supported for C(data_warehouse) edition.



55
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_sqldatabase.rb', line 55

attribute :elastic_pool_name

#force_update ⇒ Symbol?

Returns SQL Database will be updated if given parameters differ from existing resource state.,To force SQL Database update in any circumstances set this parameter to True.

Returns:

  • (Symbol, nil) —

    SQL Database will be updated if given parameters differ from existing resource state.,To force SQL Database update in any circumstances set this parameter to True.



70
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_sqldatabase.rb', line 70

attribute :force_update

#location ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :location

#max_size_bytes ⇒ Object?

Returns The max size of the database expressed in bytes. If I(create_mode) is not C(default), this value is ignored. To see possible values, query the capabilities API (/subscriptions/subscriptionId/providers/Microsoft.Sql/locations/locationID/capabilities) referred to by operationId: ‘Capabilities_ListByLocation.’.

Returns:

  • (Object, nil) —

    The max size of the database expressed in bytes. If I(create_mode) is not C(default), this value is ignored. To see possible values, query the capabilities API (/subscriptions/subscriptionId/providers/Microsoft.Sql/locations/locationID/capabilities) referred to by operationId: ‘Capabilities_ListByLocation.’



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

attribute :max_size_bytes

#name ⇒ String

Returns The name of the database to be operated on (updated or created).

Returns:

  • (String) —

    The name of the database to be operated on (updated or created).



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

attribute :name

#read_scale ⇒ Symbol?

Returns If the database is a geo-secondary, indicates whether read-only connections are allowed to this database or not. Not supported for C(data_warehouse) edition.

Returns:

  • (Symbol, nil) —

    If the database is a geo-secondary, indicates whether read-only connections are allowed to this database or not. Not supported for C(data_warehouse) edition.



58
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_sqldatabase.rb', line 58

attribute :read_scale

#recovery_services_recovery_point_resource_id ⇒ Object?

Returns Required if I(create_mode) is C(restore_long_term_retention_backup), then this value is required. Specifies the resource ID of the recovery point to restore from.

Returns:

  • (Object, nil) —

    Required if I(create_mode) is C(restore_long_term_retention_backup), then this value is required. Specifies the resource ID of the recovery point to restore from.



45
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_sqldatabase.rb', line 45

attribute :recovery_services_recovery_point_resource_id

#resource_group ⇒ String

Returns The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

Returns:

  • (String) —

    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.



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

attribute :resource_group

#restore_point_in_time ⇒ Object?

Returns Required if I(create_mode) is C(point_in_time_restore), this value is required. If I(create_mode) is C(restore), this value is optional. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. Must be greater than or equal to the source database’s earliestRestoreDate value.

Returns:

  • (Object, nil) —

    Required if I(create_mode) is C(point_in_time_restore), this value is required. If I(create_mode) is C(restore), this value is optional. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. Must be greater than or equal to the source database’s earliestRestoreDate value.



42
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_sqldatabase.rb', line 42

attribute :restore_point_in_time

#sample_name ⇒ :adventure_works_lt?

Returns Indicates the name of the sample schema to apply when creating this database. If I(create_mode) is not C(default), this value is ignored. Not supported for C(data_warehouse) edition.

Returns:

  • (:adventure_works_lt, nil) —

    Indicates the name of the sample schema to apply when creating this database. If I(create_mode) is not C(default), this value is ignored. Not supported for C(data_warehouse) edition.



62
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_sqldatabase.rb', line 62

attribute :sample_name

#server_name ⇒ String

Returns The name of the server.

Returns:

  • (String) —

    The name of the server.



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

attribute :server_name

#source_database_deletion_date ⇒ Object?

Returns Required if I(create_mode) is C(restore) and I(source_database_id) is the deleted database’s original resource id when it existed (as opposed to its current restorable dropped database id), then this value is required. Specifies the time that the database was deleted.

Returns:

  • (Object, nil) —

    Required if I(create_mode) is C(restore) and I(source_database_id) is the deleted database’s original resource id when it existed (as opposed to its current restorable dropped database id), then this value is required. Specifies the time that the database was deleted.



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_sqldatabase.rb', line 39

attribute :source_database_deletion_date

#source_database_id ⇒ String?

Returns Required unless I(create_mode) is C(default) or C(restore_long_term_retention_backup).,Specifies the resource ID of the source database.

Returns:

  • (String, nil) —

    Required unless I(create_mode) is C(default) or C(restore_long_term_retention_backup).,Specifies the resource ID of the source database



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

attribute :source_database_id

#state ⇒ :absent, ...

Returns Assert the state of the SQL Database. Use ‘present’ to create or update an SQL Database and ‘absent’ to delete it.

Returns:

  • (:absent, :present, nil) —

    Assert the state of the SQL Database. Use ‘present’ to create or update an SQL Database and ‘absent’ to delete it.



74
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_sqldatabase.rb', line 74

attribute :state

#zone_redundant ⇒ Symbol?

Returns Is this database is zone redundant? It means the replicas of this database will be spread across multiple availability zones.

Returns:

  • (Symbol, nil) —

    Is this database is zone redundant? It means the replicas of this database will be spread across multiple availability zones.



66
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_sqldatabase.rb', line 66

attribute :zone_redundant