Database interface
Databázový prostředek.
- Extends
Vlastnosti
| auto |
Doba v minutách, po které se databáze automaticky pozastaví. Hodnota -1 znamená, že automatické pozastavení je zakázané. |
| availability |
Určuje zónu dostupnosti, ke které je databáze připnutá. |
| catalog |
Kolace katalogu metadat. |
| collation | Kolace databáze. |
| create |
Určuje režim vytváření databáze. Výchozí hodnota: běžné vytvoření databáze. Kopírování: Vytvoří databázi jako kopii existující databáze. sourceDatabaseId musí být zadán jako ID prostředku zdrojové databáze. Sekundární: Vytvoří databázi jako sekundární repliku existující databáze. sourceDatabaseId musí být zadán jako ID prostředku existující primární databáze. PointInTimeRestore: Vytvoří databázi obnovením zálohy existující databáze k určitému bodu v čase. sourceDatabaseId musí být zadán jako ID prostředku existující databáze a restorePointInTime musí být zadán. Obnovení: Vytvoří databázi obnovením geograficky replikované zálohy. sourceDatabaseId musí být zadán jako obnovitelné ID prostředku databáze. Obnovení: Vytvoří databázi obnovením zálohy odstraněné databáze. sourceDatabaseId musí být zadán. Pokud je sourceDatabaseId původní ID prostředku databáze, musí být zadán sourceDatabaseDeletionDate. Jinak sourceDatabaseId musí být obnovitelné vyřazené ID prostředku databáze a sourceDatabaseDeletionDate se ignoruje. restorePointInTime může být také zadán pro obnovení z dřívějšího bodu v čase. RestoreLongTermRetentionBackup: Vytvoří databázi obnovením z dlouhodobého trezoru uchovávání. recoveryServicesRecoveryPointResourceId musí být zadán jako ID prostředku bodu obnovení. Edice DataWarehouse nepodporuje kopírování, sekundární a restoreLongTermRetentionBackup. |
| creation |
Datum vytvoření databáze (formát ISO8601). |
| current |
Typ účtu úložiště použitý k ukládání záloh pro tuto databázi. |
| current |
Aktuální název cíle na úrovni služby databáze. |
| current |
Název a úroveň skladové položky. |
| database |
ID databáze. |
| default |
Výchozí sekundární oblast pro tuto databázi. |
| earliest |
Zaznamenává nejstarší počáteční datum a čas, kdy je pro tuto databázi k dispozici obnovení (ISO8601 formát). |
| elastic |
Identifikátor prostředku elastického fondu obsahujícího tuto databázi. |
| encryption |
Identifikátor URI služby Azure Key Vault databáze, pokud je nakonfigurovaný pro klíče spravované zákazníkem databáze. |
| encryption |
Příznak pro povolení nebo zakázání automatické obměna klíče AKV pro ochranu šifrování databáze. |
| failover |
Identifikátor prostředku skupiny převzetí služeb při selhání, do kterého tato databáze patří. |
| federated |
ID klienta používaného pro scénář cmk pro různé tenanty na databázi |
| free |
Určuje chování při vyčerpání měsíčních bezplatných limitů pro bezplatnou databázi. AutoPause: Databáze se po vyčerpání bezplatných limitů po zbytek měsíce automaticky pozastaví. BillForUsage: Databáze bude i nadále online po vyčerpání bezplatných limitů a veškeré nadlimitní využití se budou účtovat. |
| high |
Počet sekundárních replik přidružených k databázi edice Pro důležité obchodní informace, Premium nebo Hyperscale, které slouží k zajištění vysoké dostupnosti. Neplatí pro databázi Hyperscale v rámci elastického fondu. |
| identity | Identita azure Active Directory databáze. |
| is |
Pro tuto databázi je povolené šifrování infrastruktury. |
| is |
Bez ohledu na to, jestli se jedná o databázi registru, znamená to, že všechny tabulky v databázi jsou tabulky registru. Poznámka: Hodnotu této vlastnosti nelze po vytvoření databáze změnit. |
| keys | ID prostředků identit přiřazených uživatelem, které se mají použít |
| kind | Druh databáze. Toto jsou metadata používaná pro prostředí webu Azure Portal. |
| license |
Typ licence, který se má použít pro tuto databázi.
|
| long |
Identifikátor prostředku dlouhodobého uchovávání záloh přidružených k vytvoření operace této databáze. |
| maintenance |
ID konfigurace údržby přiřazené k databázi. Tato konfigurace definuje období, kdy dojde k aktualizacím údržby. |
| managed |
Prostředek, který spravuje databázi. |
| manual |
Bez ohledu na to, jestli je potřeba provést ruční přímé přechody řízené zákazníkem během operace aktualizace databáze na úroveň Hyperscale. Tato vlastnost se vztahuje pouze při škálování databáze z úrovně Pro důležité obchodní informace, Pro obecné účely, Úrovně Premium/Standard na úroveň Hyperscale. Pokud je zadán ručnícutover, operace škálování bude čekat, až uživatelský vstup aktivuje přímou migraci do databáze Hyperscale. Pokud chcete aktivovat přímou operaci, zadejte parametr performCutover, pokud je operace škálování ve stavu Čekání. |
| max |
Maximální velikost protokolu pro tuto databázi. |
| max |
Maximální velikost databáze vyjádřená v bajtech. |
| min |
Minimální kapacita, kterou databáze bude mít vždy přidělenou, pokud není pozastavená |
| paused |
Datum, kdy byla databáze pozastavena konfigurací nebo akcí uživatele (ISO8601 formát). Hodnota Null, pokud je databáze připravená. |
| perform |
Aktivace ručního přímého přechodu řízeného zákazníkem během čekacího stavu během probíhající operace škálování Tento parametr vlastnosti se vztahuje pouze na operace škálování, které jsou inicializovány spolu s parametrem manualCutover. Tato vlastnost se vztahuje pouze v případě, že už probíhá škálování databáze z úrovně Pro důležité obchodní informace, Pro obecné účely, Úrovně Premium/Standard na úroveň Hyperscale. Při zadání příkazu performCutover se operace škálování aktivuje přímou migraci a provede změnu role na databázi Hyperscale. |
| preferred |
Typ enklávy požadované v databázi, tj. výchozí enklávy nebo enklávy VBS. |
| read |
Stav směrování jen pro čtení. Pokud je tato možnost povolená, mohou být připojení, která mají v připojovacím řetězci nastavený záměr aplikace nastavenou na čtení, směrována do sekundární repliky jen pro čtení ve stejné oblasti. Neplatí pro databázi Hyperscale v rámci elastického fondu. |
| recoverable |
Identifikátor prostředku obnovitelné databáze přidružené k operaci vytvoření této databáze. |
| recovery |
Identifikátor prostředku bodu obnovení přidruženého k operaci vytvoření této databáze. |
| requested |
Typ účtu úložiště, který se má použít k ukládání záloh pro tuto databázi. |
| requested |
Požadovaný název cíle na úrovni služby databáze. |
| restorable |
Identifikátor prostředku obnovené vyřazené databáze přidružené k operaci vytvoření této databáze. |
| restore |
Určuje bod v čase (formát ISO8601) zdrojové databáze, která se obnoví a vytvoří novou databázi. |
| resumed |
Datum, kdy byla databáze obnovena akcí uživatele nebo přihlášením k databázi (ISO8601 formát). Hodnota Null, pokud je databáze pozastavena. |
| sample |
Název ukázkového schématu, které se má použít při vytváření této databáze. |
| secondary |
Sekundární typ databáze, pokud je sekundární. Platné hodnoty jsou Geo, Named a Standby. |
| sku | Skladová položka databáze. Seznam skladových položek se může lišit podle oblasti a nabídky podpory. Pokud chcete určit skladové položky (včetně názvu skladové položky, úrovně/edice, rodiny a kapacity), které jsou dostupné pro vaše předplatné v oblasti Azure, použijte
|
| source |
Určuje čas odstranění databáze. |
| source |
Identifikátor prostředku zdrojové databáze přidružené k operaci vytvoření této databáze. |
| source |
Identifikátor prostředku zdroje přidruženého k operaci vytvoření této databáze. Tato vlastnost je podporována pouze pro edici DataWarehouse a umožňuje obnovení napříč předplatnými. Pokud je zadán sourceResourceId, sourceDatabaseId, recoverableDatabaseId, restoreableDroppedDatabaseId a sourceDatabaseDeletionDate nesmí být zadán a CreateMode musí být PointInTimeRestore, Restore nebo Recover. Pokud je createMode PointInTimeRestore, sourceResourceId musí být ID prostředku existující databáze nebo existujícího fondu SQL a restorePointInTime musí být zadán. Pokud je createMode Restore, sourceResourceId musí být ID prostředku obnovitelné vyřazené databáze nebo obnovitelné vyřazené fondu SQL. Pokud je createMode Recover, sourceResourceId musí být ID prostředku obnovitelné databáze nebo obnovitelného fondu SQL. Pokud zdrojové předplatné patří do jiného tenanta než cílového předplatného, musí hlavička x-ms-authorization-auxiliary obsahovat ověřovací token pro zdrojového tenanta. Další podrobnosti o hlavičce x-ms-authorization-auxiliary najdete v tématu https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant |
| status | Stav databáze. |
| use |
Bez ohledu na to, jestli databáze používá bezplatné měsíční limity. Povoleno pro jednu databázi v předplatném. |
| zone |
Bez ohledu na to, jestli je tato databáze zónově redundantní, což znamená, že repliky této databáze budou rozloženy do více zón dostupnosti. |
Zděděné vlastnosti
| id | Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location | Geografické umístění, ve kterém se nachází zdroj |
| name | Název prostředku |
| system |
Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil. |
| tags | Značky prostředků |
| type | Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts |
Podrobnosti vlastnosti
autoPauseDelay
Doba v minutách, po které se databáze automaticky pozastaví. Hodnota -1 znamená, že automatické pozastavení je zakázané.
autoPauseDelay?: number
Hodnota vlastnosti
number
availabilityZone
Určuje zónu dostupnosti, ke které je databáze připnutá.
availabilityZone?: string
Hodnota vlastnosti
string
catalogCollation
Kolace katalogu metadat.
catalogCollation?: string
Hodnota vlastnosti
string
collation
Kolace databáze.
collation?: string
Hodnota vlastnosti
string
createMode
Určuje režim vytváření databáze.
Výchozí hodnota: běžné vytvoření databáze.
Kopírování: Vytvoří databázi jako kopii existující databáze. sourceDatabaseId musí být zadán jako ID prostředku zdrojové databáze.
Sekundární: Vytvoří databázi jako sekundární repliku existující databáze. sourceDatabaseId musí být zadán jako ID prostředku existující primární databáze.
PointInTimeRestore: Vytvoří databázi obnovením zálohy existující databáze k určitému bodu v čase. sourceDatabaseId musí být zadán jako ID prostředku existující databáze a restorePointInTime musí být zadán.
Obnovení: Vytvoří databázi obnovením geograficky replikované zálohy. sourceDatabaseId musí být zadán jako obnovitelné ID prostředku databáze.
Obnovení: Vytvoří databázi obnovením zálohy odstraněné databáze. sourceDatabaseId musí být zadán. Pokud je sourceDatabaseId původní ID prostředku databáze, musí být zadán sourceDatabaseDeletionDate. Jinak sourceDatabaseId musí být obnovitelné vyřazené ID prostředku databáze a sourceDatabaseDeletionDate se ignoruje. restorePointInTime může být také zadán pro obnovení z dřívějšího bodu v čase.
RestoreLongTermRetentionBackup: Vytvoří databázi obnovením z dlouhodobého trezoru uchovávání. recoveryServicesRecoveryPointResourceId musí být zadán jako ID prostředku bodu obnovení.
Edice DataWarehouse nepodporuje kopírování, sekundární a restoreLongTermRetentionBackup.
createMode?: string
Hodnota vlastnosti
string
creationDate
Datum vytvoření databáze (formát ISO8601).
creationDate?: Date
Hodnota vlastnosti
Date
currentBackupStorageRedundancy
Typ účtu úložiště použitý k ukládání záloh pro tuto databázi.
currentBackupStorageRedundancy?: string
Hodnota vlastnosti
string
currentServiceObjectiveName
Aktuální název cíle na úrovni služby databáze.
currentServiceObjectiveName?: string
Hodnota vlastnosti
string
currentSku
databaseId
ID databáze.
databaseId?: string
Hodnota vlastnosti
string
defaultSecondaryLocation
Výchozí sekundární oblast pro tuto databázi.
defaultSecondaryLocation?: string
Hodnota vlastnosti
string
earliestRestoreDate
Zaznamenává nejstarší počáteční datum a čas, kdy je pro tuto databázi k dispozici obnovení (ISO8601 formát).
earliestRestoreDate?: Date
Hodnota vlastnosti
Date
elasticPoolId
Identifikátor prostředku elastického fondu obsahujícího tuto databázi.
elasticPoolId?: string
Hodnota vlastnosti
string
encryptionProtector
Identifikátor URI služby Azure Key Vault databáze, pokud je nakonfigurovaný pro klíče spravované zákazníkem databáze.
encryptionProtector?: string
Hodnota vlastnosti
string
encryptionProtectorAutoRotation
Příznak pro povolení nebo zakázání automatické obměna klíče AKV pro ochranu šifrování databáze.
encryptionProtectorAutoRotation?: boolean
Hodnota vlastnosti
boolean
failoverGroupId
Identifikátor prostředku skupiny převzetí služeb při selhání, do kterého tato databáze patří.
failoverGroupId?: string
Hodnota vlastnosti
string
federatedClientId
ID klienta používaného pro scénář cmk pro různé tenanty na databázi
federatedClientId?: string
Hodnota vlastnosti
string
freeLimitExhaustionBehavior
Určuje chování při vyčerpání měsíčních bezplatných limitů pro bezplatnou databázi.
AutoPause: Databáze se po vyčerpání bezplatných limitů po zbytek měsíce automaticky pozastaví.
BillForUsage: Databáze bude i nadále online po vyčerpání bezplatných limitů a veškeré nadlimitní využití se budou účtovat.
freeLimitExhaustionBehavior?: string
Hodnota vlastnosti
string
highAvailabilityReplicaCount
Počet sekundárních replik přidružených k databázi edice Pro důležité obchodní informace, Premium nebo Hyperscale, které slouží k zajištění vysoké dostupnosti. Neplatí pro databázi Hyperscale v rámci elastického fondu.
highAvailabilityReplicaCount?: number
Hodnota vlastnosti
number
identity
Identita azure Active Directory databáze.
identity?: DatabaseIdentity
Hodnota vlastnosti
isInfraEncryptionEnabled
Pro tuto databázi je povolené šifrování infrastruktury.
isInfraEncryptionEnabled?: boolean
Hodnota vlastnosti
boolean
isLedgerOn
Bez ohledu na to, jestli se jedná o databázi registru, znamená to, že všechny tabulky v databázi jsou tabulky registru. Poznámka: Hodnotu této vlastnosti nelze po vytvoření databáze změnit.
isLedgerOn?: boolean
Hodnota vlastnosti
boolean
keys
ID prostředků identit přiřazených uživatelem, které se mají použít
keys?: Record<string, DatabaseKey>
Hodnota vlastnosti
Record<string, DatabaseKey>
kind
Druh databáze. Toto jsou metadata používaná pro prostředí webu Azure Portal.
kind?: string
Hodnota vlastnosti
string
licenseType
Typ licence, který se má použít pro tuto databázi.
LicenseIncluded, pokud potřebujete licenci, nebo BasePrice, pokud máte licenci a máte nárok na zvýhodněné hybridní využití Azure.
licenseType?: string
Hodnota vlastnosti
string
longTermRetentionBackupResourceId
Identifikátor prostředku dlouhodobého uchovávání záloh přidružených k vytvoření operace této databáze.
longTermRetentionBackupResourceId?: string
Hodnota vlastnosti
string
maintenanceConfigurationId
ID konfigurace údržby přiřazené k databázi. Tato konfigurace definuje období, kdy dojde k aktualizacím údržby.
maintenanceConfigurationId?: string
Hodnota vlastnosti
string
managedBy
Prostředek, který spravuje databázi.
managedBy?: string
Hodnota vlastnosti
string
manualCutover
Bez ohledu na to, jestli je potřeba provést ruční přímé přechody řízené zákazníkem během operace aktualizace databáze na úroveň Hyperscale.
Tato vlastnost se vztahuje pouze při škálování databáze z úrovně Pro důležité obchodní informace, Pro obecné účely, Úrovně Premium/Standard na úroveň Hyperscale.
Pokud je zadán ručnícutover, operace škálování bude čekat, až uživatelský vstup aktivuje přímou migraci do databáze Hyperscale.
Pokud chcete aktivovat přímou operaci, zadejte parametr performCutover, pokud je operace škálování ve stavu Čekání.
manualCutover?: boolean
Hodnota vlastnosti
boolean
maxLogSizeBytes
Maximální velikost protokolu pro tuto databázi.
maxLogSizeBytes?: number
Hodnota vlastnosti
number
maxSizeBytes
Maximální velikost databáze vyjádřená v bajtech.
maxSizeBytes?: number
Hodnota vlastnosti
number
minCapacity
Minimální kapacita, kterou databáze bude mít vždy přidělenou, pokud není pozastavená
minCapacity?: number
Hodnota vlastnosti
number
pausedDate
Datum, kdy byla databáze pozastavena konfigurací nebo akcí uživatele (ISO8601 formát). Hodnota Null, pokud je databáze připravená.
pausedDate?: Date
Hodnota vlastnosti
Date
performCutover
Aktivace ručního přímého přechodu řízeného zákazníkem během čekacího stavu během probíhající operace škálování
Tento parametr vlastnosti se vztahuje pouze na operace škálování, které jsou inicializovány spolu s parametrem manualCutover.
Tato vlastnost se vztahuje pouze v případě, že už probíhá škálování databáze z úrovně Pro důležité obchodní informace, Pro obecné účely, Úrovně Premium/Standard na úroveň Hyperscale.
Při zadání příkazu performCutover se operace škálování aktivuje přímou migraci a provede změnu role na databázi Hyperscale.
performCutover?: boolean
Hodnota vlastnosti
boolean
preferredEnclaveType
Typ enklávy požadované v databázi, tj. výchozí enklávy nebo enklávy VBS.
preferredEnclaveType?: string
Hodnota vlastnosti
string
readScale
Stav směrování jen pro čtení. Pokud je tato možnost povolená, mohou být připojení, která mají v připojovacím řetězci nastavený záměr aplikace nastavenou na čtení, směrována do sekundární repliky jen pro čtení ve stejné oblasti. Neplatí pro databázi Hyperscale v rámci elastického fondu.
readScale?: string
Hodnota vlastnosti
string
recoverableDatabaseId
Identifikátor prostředku obnovitelné databáze přidružené k operaci vytvoření této databáze.
recoverableDatabaseId?: string
Hodnota vlastnosti
string
recoveryServicesRecoveryPointId
Identifikátor prostředku bodu obnovení přidruženého k operaci vytvoření této databáze.
recoveryServicesRecoveryPointId?: string
Hodnota vlastnosti
string
requestedBackupStorageRedundancy
Typ účtu úložiště, který se má použít k ukládání záloh pro tuto databázi.
requestedBackupStorageRedundancy?: string
Hodnota vlastnosti
string
requestedServiceObjectiveName
Požadovaný název cíle na úrovni služby databáze.
requestedServiceObjectiveName?: string
Hodnota vlastnosti
string
restorableDroppedDatabaseId
Identifikátor prostředku obnovené vyřazené databáze přidružené k operaci vytvoření této databáze.
restorableDroppedDatabaseId?: string
Hodnota vlastnosti
string
restorePointInTime
Určuje bod v čase (formát ISO8601) zdrojové databáze, která se obnoví a vytvoří novou databázi.
restorePointInTime?: Date
Hodnota vlastnosti
Date
resumedDate
Datum, kdy byla databáze obnovena akcí uživatele nebo přihlášením k databázi (ISO8601 formát). Hodnota Null, pokud je databáze pozastavena.
resumedDate?: Date
Hodnota vlastnosti
Date
sampleName
Název ukázkového schématu, které se má použít při vytváření této databáze.
sampleName?: string
Hodnota vlastnosti
string
secondaryType
Sekundární typ databáze, pokud je sekundární. Platné hodnoty jsou Geo, Named a Standby.
secondaryType?: string
Hodnota vlastnosti
string
sku
Skladová položka databáze.
Seznam skladových položek se může lišit podle oblasti a nabídky podpory. Pokud chcete určit skladové položky (včetně názvu skladové položky, úrovně/edice, rodiny a kapacity), které jsou dostupné pro vaše předplatné v oblasti Azure, použijte Capabilities_ListByLocation rozhraní REST API nebo jeden z následujících příkazů:
az sql db list-editions -l <location> -o table
Get-AzSqlServerServiceObjective -Location <location>
sku?: Sku
Hodnota vlastnosti
sourceDatabaseDeletionDate
Určuje čas odstranění databáze.
sourceDatabaseDeletionDate?: Date
Hodnota vlastnosti
Date
sourceDatabaseId
Identifikátor prostředku zdrojové databáze přidružené k operaci vytvoření této databáze.
sourceDatabaseId?: string
Hodnota vlastnosti
string
sourceResourceId
Identifikátor prostředku zdroje přidruženého k operaci vytvoření této databáze.
Tato vlastnost je podporována pouze pro edici DataWarehouse a umožňuje obnovení napříč předplatnými.
Pokud je zadán sourceResourceId, sourceDatabaseId, recoverableDatabaseId, restoreableDroppedDatabaseId a sourceDatabaseDeletionDate nesmí být zadán a CreateMode musí být PointInTimeRestore, Restore nebo Recover.
Pokud je createMode PointInTimeRestore, sourceResourceId musí být ID prostředku existující databáze nebo existujícího fondu SQL a restorePointInTime musí být zadán.
Pokud je createMode Restore, sourceResourceId musí být ID prostředku obnovitelné vyřazené databáze nebo obnovitelné vyřazené fondu SQL.
Pokud je createMode Recover, sourceResourceId musí být ID prostředku obnovitelné databáze nebo obnovitelného fondu SQL.
Pokud zdrojové předplatné patří do jiného tenanta než cílového předplatného, musí hlavička x-ms-authorization-auxiliary obsahovat ověřovací token pro zdrojového tenanta. Další podrobnosti o hlavičce x-ms-authorization-auxiliary najdete v tématu https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/authenticate-multi-tenant
sourceResourceId?: string
Hodnota vlastnosti
string
status
Stav databáze.
status?: string
Hodnota vlastnosti
string
useFreeLimit
Bez ohledu na to, jestli databáze používá bezplatné měsíční limity. Povoleno pro jednu databázi v předplatném.
useFreeLimit?: boolean
Hodnota vlastnosti
boolean
zoneRedundant
Bez ohledu na to, jestli je tato databáze zónově redundantní, což znamená, že repliky této databáze budou rozloženy do více zón dostupnosti.
zoneRedundant?: boolean
Hodnota vlastnosti
boolean
Podrobnosti zděděných vlastností
id
Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
id?: string
Hodnota vlastnosti
string
zděděno zTrackedResource.id
location
Geografické umístění, ve kterém se nachází zdroj
location: string
Hodnota vlastnosti
string
zděděno zTrackedResource.location
name
systemData
Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
systemData?: SystemData
Hodnota vlastnosti
Zděděno zeTrackedResource.systemData
tags
Značky prostředků
tags?: Record<string, string>
Hodnota vlastnosti
Record<string, string>
zděděno zeTrackedResource.tags
type
Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts
type?: string
Hodnota vlastnosti
string
zděděno zeTrackedResource.type