Microsoft.DocumentDB-databaseAccounts/sqlDatabases 2024-02-15-preview
- Laatste
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 15-11-2021-preview
- 2021-10-15
- 15-10-2021-preview
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 2021-01-15
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Bicep-resourcedefinitie
Het resourcetype databaseAccounts/sqlDatabases kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource Microsoft.DocumentDB/databaseAccounts/sqlDatabases wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-02-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
createMode: 'string'
id: 'string'
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
restoreWithTtlDisabled: bool
}
}
}
}
Eigenschapswaarden
databaseAccounts/sqlDatabases
| Naam | Description | Waarde |
|---|---|---|
| naam | De resourcenaam Meer informatie over het instellen van namen en typen voor onderliggende resources in Bicep. |
tekenreeks (vereist) |
| location | De locatie van de resourcegroep waartoe de resource behoort. | tekenreeks |
| tags | Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt bij het weergeven en groeperen van deze resource (in resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben die niet groter is dan 128 tekens en een waarde van niet meer dan 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige waarden voor 'defaultExperience' omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'. | Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken |
| Bovenliggende | In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd. Zie Onderliggende resource buiten bovenliggende resource voor meer informatie. |
Symbolische naam voor resource van het type: databaseAccounts |
| identity | Identiteit voor de resource. | ManagedServiceIdentity |
| properties | Eigenschappen voor het maken en bijwerken van azure Cosmos DB SQL-database. | SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (vereist) |
ManagedServiceIdentity
| Naam | Description | Waarde |
|---|---|---|
| type | Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned,UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. | 'Geen' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| userAssignedIdentities | De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | ManagedServiceIdentityUserAssignedId-entiteiten |
ManagedServiceIdentityUserAssignedId-entiteiten
| Naam | Description | Waarde |
|---|---|---|
| {aangepaste eigenschap} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn ReadOnly.
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...
| Naam | Description | Waarde |
|---|---|---|
| opties | Een sleutel-waardepaar met opties die moeten worden toegepast op de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. | CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions |
| resource | De standaard-JSON-indeling van een SQL-database | SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (vereist) |
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| Naam | Description | Waarde |
|---|---|---|
| autoscaleSettings | Hiermee geeft u de instellingen voor automatisch schalen op. Opmerking: doorvoer of automatische schaalaanpassingInstellingen is vereist, maar niet beide. | Instellingen voor automatisch schalen |
| doorvoer | Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. | int |
Instellingen voor automatisch schalen
| Naam | Description | Waarde |
|---|---|---|
| maxThroughput | Vertegenwoordigt de maximale doorvoer, zodat de resource omhoog kan worden geschaald. | int |
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...
| Naam | Description | Waarde |
|---|---|---|
| createMode | Opsomming om de modus voor het maken van resources aan te geven. | 'Standaard' 'PointInTimeRestore' 'Herstellen' |
| id | Naam van de Cosmos DB SQL-database | tekenreeks (vereist) |
| restoreParameters | Parameters om de informatie over de herstelbewerking aan te geven | ResourceRestoreParameters |
ResourceRestoreParameters
| Naam | Description | Waarde |
|---|---|---|
| restoreSource | De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | tekenreeks |
| restoreTimestampInUtc | Tijd waarop het account moet worden hersteld (ISO-8601-indeling). | tekenreeks |
| restoreWithTtlDisabled | Hiermee geeft u op of time-to-live is uitgeschakeld voor het herstelde account na een geslaagde herstelbewerking. | booleaans |
Snelstartsjablonen
Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.
| Template | Beschrijving |
|---|---|
Een Gratis Azure Cosmos DB-account maken |
Met deze sjabloon maakt u een Gratis Azure Cosmos DB-account voor SQL API met een database met gedeelde doorvoer en container. |
| Een Azure Cosmos DB-account maken voor Core (SQL) API |
Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en een container met doorvoer met meerdere andere opties. |
| SQL-API voor Azure Cosmos DB-account met analytische opslag |
Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en container die zijn geconfigureerd met analytische opslag. |
| Een SQL-API voor een Azure Cosmos DB-account maken met automatische schaalaanpassing |
Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en een container met doorvoer automatisch schalen met meerdere andere opties. |
| Opgeslagen procedures voor azure Cosmos DB Core (SQL) API maken |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor Core (SQL) API en een container met een opgeslagen procedure, trigger en door de gebruiker gedefinieerde functie. |
| Azure Data Explorer DB implementeren met Cosmos DB-verbinding |
Azure Data Explorer DB implementeren met Cosmos DB-verbinding. |
Resourcedefinitie van ARM-sjabloon
Het resourcetype databaseAccounts/sqlDatabases kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource Microsoft.DocumentDB/databaseAccounts/sqlDatabases wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
"apiVersion": "2024-02-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"createMode": "string",
"id": "string",
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string",
"restoreWithTtlDisabled": "bool"
}
}
}
}
Eigenschapswaarden
databaseAccounts/sqlDatabases
| Naam | Description | Waarde |
|---|---|---|
| type | Het resourcetype | 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases' |
| apiVersion | De resource-API-versie | '2024-02-15-preview' |
| naam | De resourcenaam Meer informatie over het instellen van namen en typen voor onderliggende resources in JSON ARM-sjablonen. |
tekenreeks (vereist) |
| location | De locatie van de resourcegroep waartoe de resource behoort. | tekenreeks |
| tags | Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt bij het weergeven en groeperen van deze resource (tussen resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben die niet groter is dan 128 tekens en de waarde niet groter is dan 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige 'defaultExperience'-waarden omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'. | Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken |
| identity | Identiteit voor de resource. | ManagedServiceIdentity |
| properties | Eigenschappen voor het maken en bijwerken van azure Cosmos DB SQL-database. | SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (vereist) |
ManagedServiceIdentity
| Naam | Description | Waarde |
|---|---|---|
| type | Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned,UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. | 'Geen' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| userAssignedIdentities | De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | ManagedServiceIdentityUserAssignedId-entiteiten |
ManagedServiceIdentityUserAssignedId-entiteiten
| Naam | Description | Waarde |
|---|---|---|
| {aangepaste eigenschap} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn Alleen-lezen.
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...
| Naam | Description | Waarde |
|---|---|---|
| opties | Een sleutel-waardepaar met opties die voor de aanvraag moeten worden toegepast. Dit komt overeen met de headers die met de aanvraag zijn verzonden. | CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions |
| resource | De standaard-JSON-indeling van een SQL-database | SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (vereist) |
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| Naam | Description | Waarde |
|---|---|---|
| instellingen voor automatisch schalen | Hiermee geeft u de instellingen voor automatisch schalen. Opmerking: doorvoer of Automatische schaalaanpassingInstellingen is vereist, maar niet beide. | Instellingen voor automatisch schalen |
| doorvoer | Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. | int |
Instellingen voor automatisch schalen
| Naam | Description | Waarde |
|---|---|---|
| maxThroughput | Staat voor maximale doorvoer, de resource kan omhoog worden geschaald. | int |
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...
| Naam | Description | Waarde |
|---|---|---|
| createMode | Opsomming om de modus voor het maken van resources aan te geven. | 'Standaard' 'PointInTimeRestore' 'Herstellen' |
| id | Naam van de Cosmos DB SQL-database | tekenreeks (vereist) |
| restoreParameters | Parameters om de informatie over de herstelbewerking aan te geven | ResourceRestoreParameters |
ResourceRestoreParameters
| Naam | Description | Waarde |
|---|---|---|
| restoreSource | De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | tekenreeks |
| restoreTimestampInUtc | Het tijdstip waarop het account moet worden hersteld (ISO-8601-indeling). | tekenreeks |
| restoreWithTtlDisabled | Hiermee geeft u op of Time-To-Live is uitgeschakeld voor het herstelde account wanneer de herstelbewerking is voltooid. | booleaans |
Snelstartsjablonen
Met de volgende snelstartsjablonen wordt dit resourcetype geïmplementeerd.
| Template | Beschrijving |
|---|---|
| Een Gratis Azure Cosmos DB-account maken |
Met deze sjabloon maakt u een Gratis Azure Cosmos DB-account voor SQL API met een database met gedeelde doorvoer en container. |
| Een Azure Cosmos DB-account maken voor Core (SQL) API |
Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en een container met doorvoer met meerdere andere opties. |
| SQL-API voor Azure Cosmos DB-account met analytische opslag |
Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en container die zijn geconfigureerd met analytische opslag. |
| Een SQL-API voor een Azure Cosmos DB-account maken met automatische schaalaanpassing |
Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en een container met doorvoer voor automatische schaalaanpassing met meerdere andere opties. |
| Opgeslagen procedures voor Azure Cosmos DB Core (SQL) API maken |
Met deze sjabloon maakt u een Azure Cosmos DB-account voor Core (SQL) API en een container met een opgeslagen procedure, trigger en door de gebruiker gedefinieerde functie. |
| Azure Data Explorer DB implementeren met Cosmos DB-verbinding |
Implementeer Azure Data Explorer DB met Cosmos DB-verbinding. |
Terraform-resourcedefinitie (AzAPI-provider)
Het resourcetype databaseAccounts/sqlDatabases kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.DocumentDB/databaseAccounts/sqlDatabases-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-02-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
createMode = "string"
id = "string"
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
restoreWithTtlDisabled = bool
}
}
}
})
}
Eigenschapswaarden
databaseAccounts/sqlDatabases
| Naam | Description | Waarde |
|---|---|---|
| type | Het resourcetype | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-02-15-preview" |
| naam | De resourcenaam | tekenreeks (vereist) |
| location | De locatie van de resourcegroep waartoe de resource behoort. | tekenreeks |
| parent_id | De id van de resource die het bovenliggende item voor deze resource is. | Id voor resource van het type: databaseAccounts |
| tags | Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt bij het weergeven en groeperen van deze resource (tussen resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben die niet groter is dan 128 tekens en de waarde niet groter is dan 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige 'defaultExperience'-waarden omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'. | Woordenlijst met tagnamen en -waarden. |
| identity | Identiteit voor de resource. | ManagedServiceIdentity |
| properties | Eigenschappen voor het maken en bijwerken van azure Cosmos DB SQL-database. | SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro... (vereist) |
ManagedServiceIdentity
| Naam | Description | Waarde |
|---|---|---|
| type | Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned,UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd. | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| identity_ids | De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | Matrix met gebruikersidentiteits-id's. |
ManagedServiceIdentityUserAssignedId-entiteiten
| Naam | Description | Waarde |
|---|---|---|
| {aangepaste eigenschap} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn Alleen-lezen.
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetPro...
| Naam | Description | Waarde |
|---|---|---|
| opties | Een sleutel-waardepaar met opties die voor de aanvraag moeten worden toegepast. Dit komt overeen met de headers die met de aanvraag zijn verzonden. | CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions |
| resource | De standaard-JSON-indeling van een SQL-database | SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc... (vereist) |
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| Naam | Description | Waarde |
|---|---|---|
| autoscaleSettings | Hiermee geeft u de instellingen voor automatisch schalen op. Opmerking: doorvoer of automatische schaalaanpassingInstellingen is vereist, maar niet beide. | Instellingen voor automatisch schalen |
| doorvoer | Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. | int |
Instellingen voor automatisch schalen
| Naam | Description | Waarde |
|---|---|---|
| maxThroughput | Vertegenwoordigt de maximale doorvoer, zodat de resource omhoog kan worden geschaald. | int |
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResourc...
| Naam | Description | Waarde |
|---|---|---|
| createMode | Opsomming om de modus voor het maken van resources aan te geven. | "Standaard" "PointInTimeRestore" "Herstellen" |
| id | Naam van de Cosmos DB SQL-database | tekenreeks (vereist) |
| restoreParameters | Parameters om de informatie over de herstelbewerking aan te geven | ResourceRestoreParameters |
ResourceRestoreParameters
| Naam | Description | Waarde |
|---|---|---|
| restoreSource | De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | tekenreeks |
| restoreTimestampInUtc | Tijd waarop het account moet worden hersteld (ISO-8601-indeling). | tekenreeks |
| restoreWithTtlDisabled | Hiermee geeft u op of time-to-live is uitgeschakeld voor het herstelde account na een geslaagde herstelbewerking. | booleaans |