Class: Azure::SQL::Mgmt::V2017_10_01_preview::Models::Database

Inherits:
TrackedResource show all
Includes:
MsRestAzure
Defined in:
lib/2017-10-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

#auto_pause_delay ⇒ Integer

paused. A value of -1 means that automatic pause is disabled

Returns:

  • (Integer) —

    Time in minutes after which database is automatically



191
192
193
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 191

def auto_pause_delay
  @auto_pause_delay
end

#catalog_collation ⇒ CatalogCollationType

Possible values include: ‘DATABASE_DEFAULT’, ‘SQL_Latin1_General_CP1_CI_AS’

Returns:



155
156
157
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 155

def catalog_collation
  @catalog_collation
end

#collation ⇒ String

Returns The collation of the database.

Returns:

  • (String) —

    The collation of the database.



81
82
83
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 81

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’, ‘PointInTimeRestore’, ‘Restore’, ‘Recovery’, ‘RestoreExternalBackup’, ‘RestoreExternalBackupSecondary’, ‘RestoreLongTermRetentionBackup’, ‘OnlineSecondary’

Returns:

  • (CreateMode) —

    Specifies the mode of database creation.



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

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).



112
113
114
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 112

def creation_date
  @creation_date
end

#current_service_objective_name ⇒ String

database.

Returns:

  • (String) —

    The current service level objective name of the



116
117
118
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 116

def current_service_objective_name
  @current_service_objective_name
end

#current_sku ⇒ Sku

Returns The name and tier of the SKU.

Returns:

  • (Sku) —

    The name and tier of the SKU.



187
188
189
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 187

def current_sku
  @current_sku
end

#database_id ⇒ Object

Returns The ID of the database.

Returns:

  • The ID of the database.



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

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.



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

def default_secondary_location
  @default_secondary_location
end

#earliest_restore_date ⇒ DateTime

restore is available for this database (ISO8601 format).

Returns:

  • (DateTime) —

    This records the earliest start date and time that



171
172
173
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 171

def earliest_restore_date
  @earliest_restore_date
end

#elastic_pool_id ⇒ String

this database.

Returns:

  • (String) —

    The resource identifier of the elastic pool containing



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

def elastic_pool_id
  @elastic_pool_id
end

#failover_group_id ⇒ String

belongs to.

Returns:

  • (String) —

    Failover Group resource identifier that this database



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

def failover_group_id
  @failover_group_id
end

#kind ⇒ String

portal experience.

Returns:

  • (String) —

    Kind of database. This is metadata used for the Azure



35
36
37
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 35

def kind
  @kind
end

#license_type ⇒ DatabaseLicenseType

database. Possible values include: ‘LicenseIncluded’, ‘BasePrice’

Returns:



164
165
166
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 164

def license_type
  @license_type
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



142
143
144
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 142

def long_term_retention_backup_resource_id
  @long_term_retention_backup_resource_id
end

#managed_by ⇒ String

Returns Resource that manages the database.

Returns:

  • (String) —

    Resource that manages the database.



38
39
40
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 38

def managed_by
  @managed_by
end

#max_log_size_bytes ⇒ Integer

Returns The max log size for this database.

Returns:

  • (Integer) —

    The max log size for this database.



167
168
169
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 167

def max_log_size_bytes
  @max_log_size_bytes
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.



84
85
86
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 84

def max_size_bytes
  @max_size_bytes
end

#min_capacity ⇒ Float

allocated, if not paused

Returns:

  • (Float) —

    Minimal capacity that database will always have



195
196
197
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 195

def min_capacity
  @min_capacity
end

#paused_date ⇒ DateTime

configuration or action (ISO8601 format). Null if the database is ready.

Returns:

  • (DateTime) —

    The date when database was paused by user



200
201
202
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 200

def paused_date
  @paused_date
end

#read_replica_count ⇒ Integer

with the database to which readonly application intent connections may be routed. This property is only settable for Hyperscale edition databases.

Returns:

  • (Integer) —

    The number of readonly secondary replicas associated



184
185
186
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 184

def read_replica_count
  @read_replica_count
end

#read_scale ⇒ DatabaseReadScale

application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases. Possible values include: ‘Enabled’, ‘Disabled’

Returns:



178
179
180
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 178

def read_scale
  @read_scale
end

#recoverable_database_id ⇒ String

associated with create operation of this database.

Returns:

  • (String) —

    The resource identifier of the recoverable database



146
147
148
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 146

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



138
139
140
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 138

def recovery_services_recovery_point_id
  @recovery_services_recovery_point_id
end

#requested_service_objective_name ⇒ String

database.

Returns:

  • (String) —

    The requested service level objective name of the



120
121
122
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 120

def requested_service_objective_name
  @requested_service_objective_name
end

#restorable_dropped_database_id ⇒ String

database associated with create operation of this database.

Returns:

  • (String) —

    The resource identifier of the restorable dropped



150
151
152
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 150

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



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

def restore_point_in_time
  @restore_point_in_time
end

#resumed_date ⇒ DateTime

database login (ISO8601 format). Null if the database is paused.

Returns:

  • (DateTime) —

    The date when database was resumed by user action or



204
205
206
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 204

def resumed_date
  @resumed_date
end

#sample_name ⇒ SampleName

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

Returns:

  • (SampleName) —

    The name of the sample schema to apply when



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

def sample_name
  @sample_name
end

#sku ⇒ Sku

The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the ‘Capabilities_ListByLocation` REST API or one of the following commands:

“‘azurecli az sql db list-editions -l <location> -o table ““

“‘powershell Get-AzSqlServerServiceObjective -Location <location> ““

Returns:

  • (Sku) —

    The database SKU.



31
32
33
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 31

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.



134
135
136
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 134

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



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

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’, ‘OfflineChangingDwPerformanceTiers’, ‘OnlineChangingDwPerformanceTiers’, ‘Disabled’

Returns:



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

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



160
161
162
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 160

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.



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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/2017-10-01-preview/generated/azure_mgmt_sql/models/database.rb', line 211

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'
          }
        },
        managed_by: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'managedBy',
          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'
          }
        },
        requested_service_objective_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.requestedServiceObjectiveName',
          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'
          }
        },
        license_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.licenseType',
          type: {
            name: 'String'
          }
        },
        max_log_size_bytes: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.maxLogSizeBytes',
          type: {
            name: 'Number'
          }
        },
        earliest_restore_date: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.earliestRestoreDate',
          type: {
            name: 'DateTime'
          }
        },
        read_scale: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.readScale',
          type: {
            name: 'String'
          }
        },
        read_replica_count: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.readReplicaCount',
          type: {
            name: 'Number'
          }
        },
        current_sku: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.currentSku',
          type: {
            name: 'Composite',
            class_name: 'Sku'
          }
        },
        auto_pause_delay: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.autoPauseDelay',
          type: {
            name: 'Number'
          }
        },
        min_capacity: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.minCapacity',
          type: {
            name: 'Double'
          }
        },
        paused_date: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.pausedDate',
          type: {
            name: 'DateTime'
          }
        },
        resumed_date: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.resumedDate',
          type: {
            name: 'DateTime'
          }
        }
      }
    }
  }
end