Database interface
Ресурс базы данных.
- Extends
Свойства
auto |
Время в минутах после автоматической приостановки базы данных. Значение -1 означает, что автоматическая приостановка отключена |
availability |
Указывает зону доступности, к ней закреплена база данных. |
catalog |
Параметры сортировки каталога метаданных. |
collation | Параметры сортировки базы данных. |
create |
Задает режим создания базы данных. По умолчанию: регулярное создание базы данных. Копирование: создает базу данных как копию существующей базы данных. sourceDatabaseId должен быть указан в качестве идентификатора ресурса исходной базы данных. Вторичный: создает базу данных в качестве вторичной реплики существующей базы данных. sourceDatabaseId должен быть указан в качестве идентификатора ресурса существующей базы данных-источника. PointInTimeRestore: создает базу данных путем восстановления резервной копии существующей базы данных на определенный момент времени. sourceDatabaseId необходимо указать в качестве идентификатора ресурса существующей базы данных, и необходимо указать restorePointInTime. Восстановление. Создание базы данных путем восстановления геореплицированной резервной копии. sourceDatabaseId необходимо указать в качестве идентификатора ресурса базы данных для восстановления. Восстановление. Создание базы данных путем восстановления резервной копии удаленной базы данных. необходимо указать sourceDatabaseId. Если sourceDatabaseId является исходным идентификатором ресурса базы данных, необходимо указать sourceDatabaseDeletionDeletionDate. В противном случае sourceDatabaseId должен быть идентификатором ресурса базы данных, который можно восстановить, и sourceDatabaseDeletionDeletionDate игнорируется. restorePointInTime также можно указать для восстановления с более ранней точки во времени. RestoreLongTermRetentionBackup: создает базу данных путем восстановления из долгосрочного хранилища хранения. RecoveryServicesRecoveryPointResourceId необходимо указать в качестве идентификатора ресурса точки восстановления. Копирование, вторичный и restoreLongTermRetentionBackup не поддерживается для выпуска DataWarehouse. |
creation |
Дата создания базы данных (формат ISO8601). ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером. |
current |
Тип учетной записи хранения, используемый для хранения резервных копий для этой базы данных. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером. |
current |
Текущее имя цели уровня обслуживания базы данных. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером. |
current |
Имя и уровень номера SKU. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером. |
database |
Идентификатор базы данных. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером. |
default |
Регион-получатель по умолчанию для этой базы данных. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером. |
earliest |
В этом отчете записывается самая ранняя дата начала и время восстановления, доступное для этой базы данных (ISO8601 формате). ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером. |
elastic |
Идентификатор ресурса эластичного пула, содержащего эту базу данных. |
encryption |
URI хранилища ключей Azure базы данных, если она настроена с использованием ключей, управляемых клиентом базы данных. |
failover |
Идентификатор ресурса группы отработки отказа, к которому принадлежит эта база данных. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером. |
federated |
Идентификатор клиента, используемый для межтенантного сценария CMK для каждой базы данных |
high |
Количество вторичных реплик, связанных с базой данных, которая используется для обеспечения высокой доступности. Неприменимо к базе данных гипермасштабирования в эластичном пуле. |
identity | Удостоверение базы данных Azure Active Directory. |
is |
Для этой базы данных включено шифрование с помощью инфракрасного шифрования. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером. |
is |
Независимо от того, является ли эта база данных базой данных реестра, то есть все таблицы в базе данных являются таблицами реестра. Примечание. Значение этого свойства невозможно изменить после создания базы данных. |
keys | Идентификаторы ресурса назначенных пользователем удостоверений для использования |
kind | Тип базы данных. Это метаданные, используемые для интерфейса портала Azure. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером. |
license |
Тип лицензии, применяемый для этой базы данных.
|
long |
Идентификатор ресурса долгосрочной резервной копии хранения, связанной с операцией создания этой базы данных. |
maintenance |
Идентификатор конфигурации обслуживания, назначенный базе данных. Эта конфигурация определяет период, когда будут выполняться обновления обслуживания. |
managed |
Ресурс, который управляет базой данных. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером. |
manual |
Требуется ли выполнить переход вручную, контролируемый клиентом, во время операции "Обновить базу данных" на уровень "Гипермасштабирование". Это свойство применимо только при масштабировании базы данных из уровня "Критически важный для бизнеса", "Общего назначения", "Премиум"/ "Стандартный" на уровень "Гипермасштабирование". При указании вручнуюCutover операция масштабирования будет ожидать, пока входные данные пользователя активируют переключение в базу данных Гипермасштабирования. Чтобы активировать переключение, укажите параметр "performCutover", когда операция масштабирования находится в состоянии ожидания. |
max |
Максимальный размер журнала для этой базы данных. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером. |
max |
Максимальный размер базы данных, выраженный в байтах. |
min |
Минимальная емкость, которую база данных всегда будет выделена, если она не приостановлена |
paused |
Дата приостановки базы данных с помощью пользовательской конфигурации или действия (ISO8601 формата). Значение NULL, если база данных готова. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером. |
perform |
Для активации управляемой клиентом ручной переключения во время выполнения операции масштабирования. Этот параметр свойства применим только для операций масштабирования, инициируемых вместе с параметром ManualCutover. Это свойство применимо только при масштабировании базы данных с уровня "Критически важный для бизнеса", "Общего назначения", "Премиум"/ "Стандартный" на уровень "Гипермасштабирование". При указании performCutover операция масштабирования активирует переключение и выполняет изменение роли в базе данных Гипермасштабирования. |
preferred |
Тип анклава, запрошенного в базе данных, например по умолчанию или анклавов VBS. |
read |
Состояние маршрутизации только для чтения. Если этот параметр включен, подключения с намерением приложения, которые настроены для чтения в их строке подключения, могут быть перенаправлены на вторичную реплику чтения в том же регионе. Неприменимо к базе данных гипермасштабирования в эластичном пуле. |
recoverable |
Идентификатор ресурса восстанавливаемой базы данных, связанной с операцией создания этой базы данных. |
recovery |
Идентификатор ресурса точки восстановления, связанной с операцией создания этой базы данных. |
requested |
Тип учетной записи хранения, используемый для хранения резервных копий для этой базы данных. |
requested |
Запрошенное имя цели уровня обслуживания базы данных. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером. |
restorable |
Идентификатор ресурса восстанавливаемой удаленной базы данных, связанной с операцией создания этой базы данных. |
restore |
Указывает точку во времени (ISO8601 формате) исходной базы данных, которая будет восстановлена для создания новой базы данных. |
resumed |
Дата возобновления базы данных с помощью действия пользователя или имени входа базы данных (ISO8601 формате). Значение NULL, если база данных приостановлена. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером. |
sample |
Имя примера схемы, применяемой при создании этой базы данных. |
secondary |
Тип вторичной базы данных, если она является вторичной. Допустимыми значениями являются гео, именованные и резервные. |
sku | Номер SKU базы данных. Список номеров SKU может отличаться по регионам и предложению поддержки. Чтобы определить номера SKU (включая имя SKU, уровень или выпуск, семейство и емкость), доступные в вашей подписке в регионе Azure, используйте
|
source |
Указывает время удаления базы данных. |
source |
Идентификатор ресурса исходной базы данных, связанной с операцией создания этой базы данных. |
source |
Идентификатор ресурса источника, связанного с операцией создания этой базы данных. Это свойство поддерживается только для выпуска DataWarehouse и позволяет восстанавливаться в подписках. Если задан sourceResourceId, sourceDatabaseId, restoreableDatabaseId, restoreableDroppedDatabaseId и sourceDatabaseDeletionDeletionDate, а CreateMode должно быть PointInTimeRestore, Restore или Restore. Если createMode — PointInTimeRestore, sourceResourceId должен быть идентификатором ресурса существующей базы данных или существующего пула SQL, а также необходимо указать restorePointInTime. При созданииmode — restore, sourceResourceId должен быть идентификатором ресурса восстанавливаемой удаленной базы данных или восстанавливаемым пулом SQL. При создании объекта CreateMode is Recover источникResourceId должен быть идентификатором ресурса восстанавливаемой базы данных или пула sql с возможностью восстановления. Если исходная подписка принадлежит к клиенту, отличному от целевой подписки, заголовок x-ms-authorization-вспомогательный должен содержать маркер проверки подлинности для исходного клиента. Дополнительные сведения о заголовке x-ms-authorization-вспомогательный см. в https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant |
status | Состояние базы данных. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером. |
zone |
Независимо от того, является ли эта база данных избыточной по зонам, то есть реплики этой базы данных будут распространяться по нескольким зонам доступности. |
Унаследованные свойства
id | Идентификатор ресурса. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером. |
location | Расположение ресурса. |
name | Имя ресурса. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером. |
tags | Теги ресурсов. |
type | Тип ресурса. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером. |
Сведения о свойстве
autoPauseDelay
Время в минутах после автоматической приостановки базы данных. Значение -1 означает, что автоматическая приостановка отключена
autoPauseDelay?: number
Значение свойства
number
availabilityZone
Указывает зону доступности, к ней закреплена база данных.
availabilityZone?: string
Значение свойства
string
catalogCollation
Параметры сортировки каталога метаданных.
catalogCollation?: string
Значение свойства
string
collation
Параметры сортировки базы данных.
collation?: string
Значение свойства
string
createMode
Задает режим создания базы данных.
По умолчанию: регулярное создание базы данных.
Копирование: создает базу данных как копию существующей базы данных. sourceDatabaseId должен быть указан в качестве идентификатора ресурса исходной базы данных.
Вторичный: создает базу данных в качестве вторичной реплики существующей базы данных. sourceDatabaseId должен быть указан в качестве идентификатора ресурса существующей базы данных-источника.
PointInTimeRestore: создает базу данных путем восстановления резервной копии существующей базы данных на определенный момент времени. sourceDatabaseId необходимо указать в качестве идентификатора ресурса существующей базы данных, и необходимо указать restorePointInTime.
Восстановление. Создание базы данных путем восстановления геореплицированной резервной копии. sourceDatabaseId необходимо указать в качестве идентификатора ресурса базы данных для восстановления.
Восстановление. Создание базы данных путем восстановления резервной копии удаленной базы данных. необходимо указать sourceDatabaseId. Если sourceDatabaseId является исходным идентификатором ресурса базы данных, необходимо указать sourceDatabaseDeletionDeletionDate. В противном случае sourceDatabaseId должен быть идентификатором ресурса базы данных, который можно восстановить, и sourceDatabaseDeletionDeletionDate игнорируется. restorePointInTime также можно указать для восстановления с более ранней точки во времени.
RestoreLongTermRetentionBackup: создает базу данных путем восстановления из долгосрочного хранилища хранения. RecoveryServicesRecoveryPointResourceId необходимо указать в качестве идентификатора ресурса точки восстановления.
Копирование, вторичный и restoreLongTermRetentionBackup не поддерживается для выпуска DataWarehouse.
createMode?: string
Значение свойства
string
creationDate
Дата создания базы данных (формат ISO8601). ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
creationDate?: Date
Значение свойства
Date
currentBackupStorageRedundancy
Тип учетной записи хранения, используемый для хранения резервных копий для этой базы данных. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
currentBackupStorageRedundancy?: string
Значение свойства
string
currentServiceObjectiveName
Текущее имя цели уровня обслуживания базы данных. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
currentServiceObjectiveName?: string
Значение свойства
string
currentSku
Имя и уровень номера SKU. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
currentSku?: Sku
Значение свойства
databaseId
Идентификатор базы данных. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
databaseId?: string
Значение свойства
string
defaultSecondaryLocation
Регион-получатель по умолчанию для этой базы данных. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
defaultSecondaryLocation?: string
Значение свойства
string
earliestRestoreDate
В этом отчете записывается самая ранняя дата начала и время восстановления, доступное для этой базы данных (ISO8601 формате). ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
earliestRestoreDate?: Date
Значение свойства
Date
elasticPoolId
Идентификатор ресурса эластичного пула, содержащего эту базу данных.
elasticPoolId?: string
Значение свойства
string
encryptionProtector
URI хранилища ключей Azure базы данных, если она настроена с использованием ключей, управляемых клиентом базы данных.
encryptionProtector?: string
Значение свойства
string
failoverGroupId
Идентификатор ресурса группы отработки отказа, к которому принадлежит эта база данных. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
failoverGroupId?: string
Значение свойства
string
federatedClientId
Идентификатор клиента, используемый для межтенантного сценария CMK для каждой базы данных
federatedClientId?: string
Значение свойства
string
highAvailabilityReplicaCount
Количество вторичных реплик, связанных с базой данных, которая используется для обеспечения высокой доступности. Неприменимо к базе данных гипермасштабирования в эластичном пуле.
highAvailabilityReplicaCount?: number
Значение свойства
number
identity
Удостоверение базы данных Azure Active Directory.
identity?: DatabaseIdentity
Значение свойства
isInfraEncryptionEnabled
Для этой базы данных включено шифрование с помощью инфракрасного шифрования. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
isInfraEncryptionEnabled?: boolean
Значение свойства
boolean
isLedgerOn
Независимо от того, является ли эта база данных базой данных реестра, то есть все таблицы в базе данных являются таблицами реестра. Примечание. Значение этого свойства невозможно изменить после создания базы данных.
isLedgerOn?: boolean
Значение свойства
boolean
keys
Идентификаторы ресурса назначенных пользователем удостоверений для использования
keys?: {[propertyName: string]: DatabaseKey}
Значение свойства
{[propertyName: string]: DatabaseKey}
kind
Тип базы данных. Это метаданные, используемые для интерфейса портала Azure. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
kind?: string
Значение свойства
string
licenseType
Тип лицензии, применяемый для этой базы данных.
LicenseIncluded
, если вам нужна лицензия или BasePrice
, если у вас есть лицензия и имеется право на преимущество гибридного использования Azure.
licenseType?: string
Значение свойства
string
longTermRetentionBackupResourceId
Идентификатор ресурса долгосрочной резервной копии хранения, связанной с операцией создания этой базы данных.
longTermRetentionBackupResourceId?: string
Значение свойства
string
maintenanceConfigurationId
Идентификатор конфигурации обслуживания, назначенный базе данных. Эта конфигурация определяет период, когда будут выполняться обновления обслуживания.
maintenanceConfigurationId?: string
Значение свойства
string
managedBy
Ресурс, который управляет базой данных. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
managedBy?: string
Значение свойства
string
manualCutover
Требуется ли выполнить переход вручную, контролируемый клиентом, во время операции "Обновить базу данных" на уровень "Гипермасштабирование".
Это свойство применимо только при масштабировании базы данных из уровня "Критически важный для бизнеса", "Общего назначения", "Премиум"/ "Стандартный" на уровень "Гипермасштабирование".
При указании вручнуюCutover операция масштабирования будет ожидать, пока входные данные пользователя активируют переключение в базу данных Гипермасштабирования.
Чтобы активировать переключение, укажите параметр "performCutover", когда операция масштабирования находится в состоянии ожидания.
manualCutover?: boolean
Значение свойства
boolean
maxLogSizeBytes
Максимальный размер журнала для этой базы данных. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
maxLogSizeBytes?: number
Значение свойства
number
maxSizeBytes
Максимальный размер базы данных, выраженный в байтах.
maxSizeBytes?: number
Значение свойства
number
minCapacity
Минимальная емкость, которую база данных всегда будет выделена, если она не приостановлена
minCapacity?: number
Значение свойства
number
pausedDate
Дата приостановки базы данных с помощью пользовательской конфигурации или действия (ISO8601 формата). Значение NULL, если база данных готова. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
pausedDate?: Date
Значение свойства
Date
performCutover
Для активации управляемой клиентом ручной переключения во время выполнения операции масштабирования.
Этот параметр свойства применим только для операций масштабирования, инициируемых вместе с параметром ManualCutover.
Это свойство применимо только при масштабировании базы данных с уровня "Критически важный для бизнеса", "Общего назначения", "Премиум"/ "Стандартный" на уровень "Гипермасштабирование".
При указании performCutover операция масштабирования активирует переключение и выполняет изменение роли в базе данных Гипермасштабирования.
performCutover?: boolean
Значение свойства
boolean
preferredEnclaveType
Тип анклава, запрошенного в базе данных, например по умолчанию или анклавов VBS.
preferredEnclaveType?: string
Значение свойства
string
readScale
Состояние маршрутизации только для чтения. Если этот параметр включен, подключения с намерением приложения, которые настроены для чтения в их строке подключения, могут быть перенаправлены на вторичную реплику чтения в том же регионе. Неприменимо к базе данных гипермасштабирования в эластичном пуле.
readScale?: string
Значение свойства
string
recoverableDatabaseId
Идентификатор ресурса восстанавливаемой базы данных, связанной с операцией создания этой базы данных.
recoverableDatabaseId?: string
Значение свойства
string
recoveryServicesRecoveryPointId
Идентификатор ресурса точки восстановления, связанной с операцией создания этой базы данных.
recoveryServicesRecoveryPointId?: string
Значение свойства
string
requestedBackupStorageRedundancy
Тип учетной записи хранения, используемый для хранения резервных копий для этой базы данных.
requestedBackupStorageRedundancy?: string
Значение свойства
string
requestedServiceObjectiveName
Запрошенное имя цели уровня обслуживания базы данных. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
requestedServiceObjectiveName?: string
Значение свойства
string
restorableDroppedDatabaseId
Идентификатор ресурса восстанавливаемой удаленной базы данных, связанной с операцией создания этой базы данных.
restorableDroppedDatabaseId?: string
Значение свойства
string
restorePointInTime
Указывает точку во времени (ISO8601 формате) исходной базы данных, которая будет восстановлена для создания новой базы данных.
restorePointInTime?: Date
Значение свойства
Date
resumedDate
Дата возобновления базы данных с помощью действия пользователя или имени входа базы данных (ISO8601 формате). Значение NULL, если база данных приостановлена. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
resumedDate?: Date
Значение свойства
Date
sampleName
Имя примера схемы, применяемой при создании этой базы данных.
sampleName?: string
Значение свойства
string
secondaryType
Тип вторичной базы данных, если она является вторичной. Допустимыми значениями являются гео, именованные и резервные.
secondaryType?: string
Значение свойства
string
sku
Номер SKU базы данных.
Список номеров SKU может отличаться по регионам и предложению поддержки. Чтобы определить номера SKU (включая имя SKU, уровень или выпуск, семейство и емкость), доступные в вашей подписке в регионе Azure, используйте Capabilities_ListByLocation
REST API или одну из следующих команд:
az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
sku?: Sku
Значение свойства
sourceDatabaseDeletionDate
Указывает время удаления базы данных.
sourceDatabaseDeletionDate?: Date
Значение свойства
Date
sourceDatabaseId
Идентификатор ресурса исходной базы данных, связанной с операцией создания этой базы данных.
sourceDatabaseId?: string
Значение свойства
string
sourceResourceId
Идентификатор ресурса источника, связанного с операцией создания этой базы данных.
Это свойство поддерживается только для выпуска DataWarehouse и позволяет восстанавливаться в подписках.
Если задан sourceResourceId, sourceDatabaseId, restoreableDatabaseId, restoreableDroppedDatabaseId и sourceDatabaseDeletionDeletionDate, а CreateMode должно быть PointInTimeRestore, Restore или Restore.
Если createMode — PointInTimeRestore, sourceResourceId должен быть идентификатором ресурса существующей базы данных или существующего пула SQL, а также необходимо указать restorePointInTime.
При созданииmode — restore, sourceResourceId должен быть идентификатором ресурса восстанавливаемой удаленной базы данных или восстанавливаемым пулом SQL.
При создании объекта CreateMode is Recover источникResourceId должен быть идентификатором ресурса восстанавливаемой базы данных или пула sql с возможностью восстановления.
Если исходная подписка принадлежит к клиенту, отличному от целевой подписки, заголовок x-ms-authorization-вспомогательный должен содержать маркер проверки подлинности для исходного клиента. Дополнительные сведения о заголовке x-ms-authorization-вспомогательный см. в https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant
sourceResourceId?: string
Значение свойства
string
status
Состояние базы данных. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
status?: string
Значение свойства
string
zoneRedundant
Независимо от того, является ли эта база данных избыточной по зонам, то есть реплики этой базы данных будут распространяться по нескольким зонам доступности.
zoneRedundant?: boolean
Значение свойства
boolean
Сведения об унаследованном свойстве
id
Идентификатор ресурса. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
id?: string
Значение свойства
string
унаследован отTrackedResource.id
location
Расположение ресурса.
location: string
Значение свойства
string
наследуется отTrackedResource.location
name
Имя ресурса. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
name?: string
Значение свойства
string
унаследован отTrackedResource.name
tags
Теги ресурсов.
tags?: {[propertyName: string]: string}
Значение свойства
{[propertyName: string]: string}
Наследуется отTrackedResource.tags
type
Тип ресурса. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его можно заполнить только сервером.
type?: string
Значение свойства
string
наследуется отTrackedResource.type