Microsoft.DocumentDB-databaseAccounts/mongodbDatabases/collections/throughputSettings 2020-06-01-preview

Bicep-resourcedefinitie

Het resourcetype databaseAccounts/mongodbDatabases/collections/throughputSettings kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2020-06-01-preview' = {
  name: 'default'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    resource: {
      autoscaleSettings: {
        autoUpgradePolicy: {
          throughputPolicy: {
            incrementPercent: int
            isEnabled: bool
          }
        }
        maxThroughput: int
      }
      throughput: int
    }
  }
}

Eigenschapswaarden

databaseAccounts/mongodbDatabases/collections/throug...

Naam Description Waarde
naam De resourcenaam

Meer informatie over het instellen van namen en typen voor onderliggende resources in Bicep.
'default'
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: verzamelingen
identity Identiteit voor de resource. ManagedServiceIdentity
properties Eigenschappen voor het bijwerken van azure Cosmos DB-resourcedoorvoer. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (vereist)

ManagedServiceIdentity

Naam Description Waarde
type 'Geen'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned': het type identiteit dat wordt gebruikt voor de resource. 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.
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.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Naam Description Waarde
resource De standaard-JSON-indeling van een resourcedoorvoer ThroughputSettingsResourceOrThroughputSettingsGetPro... (vereist)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Naam Description Waarde
instellingen voor automatisch schalen Cosmos DB-resource voor instellingen voor automatische schaalaanpassing. Doorvoer is vereist of Instellingen voor automatische schaalaanpassing is vereist, maar niet beide. AutoscaleSettingsResource
doorvoer Waarde van de doorvoer van de Cosmos DB-resource. Doorvoer is vereist of Instellingen voor automatische schaalaanpassing is vereist, maar niet beide. int

AutoscaleSettingsResource

Naam Description Waarde
autoUpgradePolicy Beleid voor automatische upgrade van Cosmos DB-resources AutoUpgradePolicyResource
maxThroughput Vertegenwoordigt maximale doorvoer die container omhoog kan schalen. int (vereist)

AutoUpgradePolicyResource

Naam Description Waarde
throughputPolicy Vertegenwoordigt doorvoerbeleid waaraan de service moet voldoen voor automatische upgrade ThroughputPolicyResource

ThroughputPolicyResource

Naam Description Waarde
incrementPercent Vertegenwoordigt het percentage waarmee de doorvoer kan toenemen telkens wanneer het doorvoerbeleid wordt gestart. int
isEnabled Bepaalt of de ThroughputPolicy actief is of niet booleaans

Resourcedefinitie van ARM-sjabloon

Het resourcetype databaseAccounts/mongodbDatabases/collections/throughputSettings kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings",
  "apiVersion": "2020-06-01-preview",
  "name": "default",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "resource": {
      "autoscaleSettings": {
        "autoUpgradePolicy": {
          "throughputPolicy": {
            "incrementPercent": "int",
            "isEnabled": "bool"
          }
        },
        "maxThroughput": "int"
      },
      "throughput": "int"
    }
  }
}

Eigenschapswaarden

databaseAccounts/mongodbDatabases/collections/throug...

Naam Description Waarde
type Het resourcetype 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings'
apiVersion De resource-API-versie '2020-06-01-preview'
naam De resourcenaam

Meer informatie over het instellen van namen en typen voor onderliggende resources in JSON ARM-sjablonen.
'standaard'
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 bijwerken van Azure Cosmos DB-resourcedoorvoer. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (vereist)

ManagedServiceIdentity

Naam Description Waarde
type 'Geen'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned': het type identiteit dat wordt gebruikt voor de resource. 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.
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.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Naam Description Waarde
resource De standaard-JSON-indeling van een resourcedoorvoer ThroughputSettingsResourceOrThroughputSettingsGetPro... (vereist)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Naam Description Waarde
autoscaleSettings Cosmos DB-resource voor instellingen voor automatische schaalaanpassing. Doorvoer is vereist of autoscaleSettings is vereist, maar niet beide. AutoscaleSettingsResource
doorvoer Waarde van de doorvoer van de Cosmos DB-resource. Doorvoer is vereist of autoscaleSettings is vereist, maar niet beide. int

AutoscaleSettingsResource

Naam Description Waarde
autoUpgradePolicy Beleid voor automatische upgrade van Cosmos DB-resources AutoUpgradePolicyResource
maxThroughput Vertegenwoordigt maximale doorvoer die container omhoog kan schalen. int (vereist)

AutoUpgradePolicyResource

Naam Description Waarde
throughputPolicy Vertegenwoordigt doorvoerbeleid waaraan de service moet voldoen voor automatische upgrade ThroughputPolicyResource

ThroughputPolicyResource

Naam Description Waarde
incrementPercent Geeft het percentage aan waarmee de doorvoer kan toenemen telkens wanneer het doorvoerbeleid van kracht wordt. int
isEnabled Bepaalt of de ThroughputPolicy actief is of niet booleaans

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype databaseAccounts/mongodbDatabases/collections/throughputSettings 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 resource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2020-06-01-preview"
  name = "default"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      resource = {
        autoscaleSettings = {
          autoUpgradePolicy = {
            throughputPolicy = {
              incrementPercent = int
              isEnabled = bool
            }
          }
          maxThroughput = int
        }
        throughput = int
      }
    }
  })
}

Eigenschapswaarden

databaseAccounts/mongodbDatabases/collections/throug...

Naam Description Waarde
type Het resourcetype "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2020-06-01-preview"
naam De resourcenaam "default"
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: verzamelingen
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.
identity Identiteit voor de resource. ManagedServiceIdentity
properties Eigenschappen voor het bijwerken van azure Cosmos DB-resourcedoorvoer. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (vereist)

ManagedServiceIdentity

Naam Description Waarde
type "SystemAssigned"
"SystemAssigned,UserAssigned"
'UserAssigned': het type identiteit dat wordt gebruikt voor de resource. 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.
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.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Naam Description Waarde
resource De standaard-JSON-indeling van een resourcedoorvoer ThroughputSettingsResourceOrThroughputSettingsGetPro... (vereist)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Naam Description Waarde
instellingen voor automatisch schalen Cosmos DB-resource voor instellingen voor automatische schaalaanpassing. Doorvoer is vereist of Instellingen voor automatische schaalaanpassing is vereist, maar niet beide. AutoscaleSettingsResource
doorvoer Waarde van de doorvoer van de Cosmos DB-resource. Doorvoer is vereist of Instellingen voor automatische schaalaanpassing is vereist, maar niet beide. int

AutoscaleSettingsResource

Naam Description Waarde
autoUpgradePolicy Beleid voor automatische upgrade van Cosmos DB-resources AutoUpgradePolicyResource
maxThroughput Vertegenwoordigt maximale doorvoer die container omhoog kan schalen. int (vereist)

AutoUpgradePolicyResource

Naam Description Waarde
throughputPolicy Vertegenwoordigt doorvoerbeleid waaraan de service moet voldoen voor automatische upgrade ThroughputPolicyResource

ThroughputPolicyResource

Naam Description Waarde
incrementPercent Vertegenwoordigt het percentage waarmee de doorvoer kan toenemen telkens wanneer het doorvoerbeleid wordt gestart. int
isEnabled Bepaalt of de ThroughputPolicy actief is of niet booleaans