Class: Azure::SQL::Mgmt::V2017_03_01_preview::Models::Database

Inherits:
TrackedResource show all
Includes:
MsRestAzure
Defined in:
lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb

Overview

A database resource.

Instance Attribute Summary collapse

Attributes inherited from TrackedResource

#location, #tags

Attributes inherited from Resource

#id, #name, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#catalog_collation ⇒ CatalogCollationType

Possible values include: ‘DATABASE_DEFAULT’, ‘SQL_Latin1_General_CP1_CI_AS’

Returns:



131
132
133
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 131

def catalog_collation
  @catalog_collation
end

#collation ⇒ String

Returns The collation of the database.

Returns:

  • (String) —

    The collation of the database.



63
64
65
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 63

def collation
  @collation
end

#create_mode ⇒ CreateMode

Default: regular database creation.

Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database.

Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database.

PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified.

Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore.

Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database’s original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time.

RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID.

Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. Possible values include: ‘Default’, ‘Copy’, ‘Secondary’, ‘OnlineSecondary’, ‘PointInTimeRestore’, ‘Restore’, ‘Recovery’, ‘RestoreExternalBackup’, ‘RestoreExternalBackupSecondary’, ‘RestoreLongTermRetentionBackup’

Returns:

  • (CreateMode) —

    Specifies the mode of database creation.



60
61
62
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 60

def create_mode
  @create_mode
end

#creation_date ⇒ DateTime

Returns The creation date of the database (ISO8601 format).

Returns:

  • (DateTime) —

    The creation date of the database (ISO8601 format).



92
93
94
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 92

def creation_date
  @creation_date
end

#current_service_objective_name ⇒ String

database.

Returns:

  • (String) —

    The current service level objective name of the



96
97
98
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 96

def current_service_objective_name
  @current_service_objective_name
end

#database_id ⇒ Object

Returns The ID of the database.

Returns:

  • The ID of the database.



89
90
91
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 89

def database_id
  @database_id
end

#default_secondary_location ⇒ String

Returns The default secondary region for this database.

Returns:

  • (String) —

    The default secondary region for this database.



99
100
101
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 99

def default_secondary_location
  @default_secondary_location
end

#elastic_pool_id ⇒ String

this database.

Returns:

  • (String) —

    The resource identifier of the elastic pool containing



75
76
77
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 75

def elastic_pool_id
  @elastic_pool_id
end

#failover_group_id ⇒ String

belongs to.

Returns:

  • (String) —

    Failover Group resource identifier that this database



103
104
105
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 103

def failover_group_id
  @failover_group_id
end

#kind ⇒ String

portal experience.

Returns:

  • (String) —

    Kind of database. This is metadata used for the Azure



20
21
22
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 20

def kind
  @kind
end

#long_term_retention_backup_resource_id ⇒ String

backup associated with create operation of this database.

Returns:

  • (String) —

    The resource identifier of the long term retention



118
119
120
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 118

def long_term_retention_backup_resource_id
  @long_term_retention_backup_resource_id
end

#max_size_bytes ⇒ Integer

Returns The max size of the database expressed in bytes.

Returns:

  • (Integer) —

    The max size of the database expressed in bytes.



66
67
68
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 66

def max_size_bytes
  @max_size_bytes
end

#recoverable_database_id ⇒ String

associated with create operation of this database.

Returns:

  • (String) —

    The resource identifier of the recoverable database



122
123
124
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 122

def recoverable_database_id
  @recoverable_database_id
end

#recovery_services_recovery_point_id ⇒ String

associated with create operation of this database.

Returns:

  • (String) —

    The resource identifier of the recovery point



114
115
116
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 114

def recovery_services_recovery_point_id
  @recovery_services_recovery_point_id
end

#restorable_dropped_database_id ⇒ String

database associated with create operation of this database.

Returns:

  • (String) —

    The resource identifier of the restorable dropped



126
127
128
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 126

def restorable_dropped_database_id
  @restorable_dropped_database_id
end

#restore_point_in_time ⇒ DateTime

source database that will be restored to create the new database.

Returns:

  • (DateTime) —

    Specifies the point in time (ISO8601 format) of the



107
108
109
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 107

def restore_point_in_time
  @restore_point_in_time
end

#sample_name ⇒ SampleName

creating this database. Possible values include: ‘AdventureWorksLT’, ‘WideWorldImportersStd’, ‘WideWorldImportersFull’

Returns:

  • (SampleName) —

    The name of the sample schema to apply when



71
72
73
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 71

def sample_name
  @sample_name
end

#sku ⇒ Sku

Returns The name and tier of the SKU.

Returns:

  • (Sku) —

    The name and tier of the SKU.



16
17
18
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 16

def sku
  @sku
end

#source_database_deletion_date ⇒ DateTime

Returns Specifies the time that the database was deleted.

Returns:

  • (DateTime) —

    Specifies the time that the database was deleted.



110
111
112
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 110

def source_database_deletion_date
  @source_database_deletion_date
end

#source_database_id ⇒ String

associated with create operation of this database.

Returns:

  • (String) —

    The resource identifier of the source database



79
80
81
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 79

def source_database_id
  @source_database_id
end

#status ⇒ DatabaseStatus

include: ‘Online’, ‘Restoring’, ‘RecoveryPending’, ‘Recovering’, ‘Suspect’, ‘Offline’, ‘Standby’, ‘Shutdown’, ‘EmergencyMode’, ‘AutoClosed’, ‘Copying’, ‘Creating’, ‘Inaccessible’, ‘OfflineSecondary’, ‘Pausing’, ‘Paused’, ‘Resuming’, ‘Scaling’

Returns:



86
87
88
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 86

def status
  @status
end

#zone_redundant ⇒ Boolean

means the replicas of this database will be spread across multiple availability zones.

Returns:

  • (Boolean) —

    Whether or not this database is zone redundant, which



136
137
138
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 136

def zone_redundant
  @zone_redundant
end

Class Method Details

.mapper ⇒ Object

Mapper for Database class as Ruby Hash. This will be used for serialization/deserialization.



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/2017-03-01-preview/generated/azure_mgmt_sql/models/database.rb', line 143

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Database',
    type: {
      name: 'Composite',
      class_name: 'Database',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        location: {
          client_side_validation: true,
          required: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        sku: {
          client_side_validation: true,
          required: false,
          serialized_name: 'sku',
          type: {
            name: 'Composite',
            class_name: 'Sku'
          }
        },
        kind: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'kind',
          type: {
            name: 'String'
          }
        },
        create_mode: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.createMode',
          type: {
            name: 'String'
          }
        },
        collation: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.collation',
          type: {
            name: 'String'
          }
        },
        max_size_bytes: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.maxSizeBytes',
          type: {
            name: 'Number'
          }
        },
        sample_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.sampleName',
          type: {
            name: 'String'
          }
        },
        elastic_pool_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.elasticPoolId',
          type: {
            name: 'String'
          }
        },
        source_database_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.sourceDatabaseId',
          type: {
            name: 'String'
          }
        },
        status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.status',
          type: {
            name: 'String'
          }
        },
        database_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.databaseId',
          type: {
            name: 'String'
          }
        },
        creation_date: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.creationDate',
          type: {
            name: 'DateTime'
          }
        },
        current_service_objective_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.currentServiceObjectiveName',
          type: {
            name: 'String'
          }
        },
        default_secondary_location: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.defaultSecondaryLocation',
          type: {
            name: 'String'
          }
        },
        failover_group_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.failoverGroupId',
          type: {
            name: 'String'
          }
        },
        restore_point_in_time: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.restorePointInTime',
          type: {
            name: 'DateTime'
          }
        },
        source_database_deletion_date: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.sourceDatabaseDeletionDate',
          type: {
            name: 'DateTime'
          }
        },
        recovery_services_recovery_point_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.recoveryServicesRecoveryPointId',
          type: {
            name: 'String'
          }
        },
        long_term_retention_backup_resource_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.longTermRetentionBackupResourceId',
          type: {
            name: 'String'
          }
        },
        recoverable_database_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.recoverableDatabaseId',
          type: {
            name: 'String'
          }
        },
        restorable_dropped_database_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.restorableDroppedDatabaseId',
          type: {
            name: 'String'
          }
        },
        catalog_collation: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.catalogCollation',
          type: {
            name: 'String'
          }
        },
        zone_redundant: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.zoneRedundant',
          type: {
            name: 'Boolean'
          }
        }
      }
    }
  }
end