Partager via

Base de données Microsoft.DocumentDBAccounts/mongodbDatabases/collections/throughputSettings 2022-11-15-preview

  • Article

Définition de ressource Bicep

Le type de ressource databaseAccounts/mongodbDatabases/collections/throughputSettings peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2022-11-15-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
    }
  }
}

Valeurs de propriétés

databaseAccounts/mongodbDatabases/collections/throug...

Nom Description Valeur
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.		 'default'
location Emplacement du groupe de ressources auquel appartient la ressource. string
tags Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ». Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
parent Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : collections
identité Identité de la ressource. ManagedServiceIdentity
properties Propriétés pour mettre à jour le débit des ressources Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (obligatoire)

ManagedServiceIdentity

Nom Description Valeur
type Type d’identité utilisé pour la ressource. Le type « SystemAssigned,UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur sont des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nom Description Valeur
{propriété personnalisée} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

DébitSettingsUpdatePropertiesOrThroughputSettin...

Nom Description Valeur
resource Format JSON standard d’un débit de ressource DébitSettingsResourceOrThroughputSettingsGetPro... (obligatoire)

DébitSettingsResourceOrThroughputSettingsGetPro...

Nom Description Valeur
autoscaleSettings Ressource Cosmos DB pour les paramètres de mise à l’échelle automatique. Le débit est requis ou autoscaleSettings est requis, mais pas les deux. AutoscaleSettingsResource
throughput Valeur du débit des ressources Cosmos DB. Le débit est requis ou autoscaleSettings est requis, mais pas les deux. int

AutoscaleSettingsResource

Nom Description Valeur
autoUpgradePolicy Stratégie de mise à niveau automatique des ressources Cosmos DB AutoUpgradePolicyResource
maxThroughput Représente le débit maximal auquel le conteneur peut effectuer un scale-up. int (obligatoire)

AutoUpgradePolicyResource

Nom Description Valeur
débitPolicy Représente la stratégie de débit à laquelle le service doit adhérer pour la mise à niveau automatique DébitPolicyResource

DébitPolicyResource

Nom Description Valeur
incrémentpercent Représente le pourcentage par lequel le débit peut augmenter chaque fois que la stratégie de débit est lancée. int
isEnabled Détermine si débitPolicy est actif ou non bool

Définition de ressources de modèle ARM

Le type de ressource databaseAccounts/mongodbDatabases/collections/throughputSettings peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings, ajoutez le CODE JSON suivant à votre modèle.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings",
  "apiVersion": "2022-11-15-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"
    }
  }
}

Valeurs de propriétés

databaseAccounts/mongodbDatabases/collections/throug...

Nom Description Valeur
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings »
apiVersion Version de l’API de ressource « 2022-11-15-preview »
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.		 'default'
location Emplacement du groupe de ressources auquel appartient la ressource. string
tags Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ». Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
identité Identité de la ressource. ManagedServiceIdentity
properties Propriétés permettant de mettre à jour le débit des ressources Azure Cosmos DB. DébitSettingsUpdatePropertiesOrThroughputSettin... (obligatoire)

ManagedServiceIdentity

Nom Description Valeur
type Type d’identité utilisé pour la ressource. Le type « SystemAssigned,UserAssigned » inclut à la fois une identité implicitement créée et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur sont des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nom Description Valeur
{propriété personnalisée} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Nom Description Valeur
resource Format JSON standard d’un débit de ressource ThroughputSettingsResourceOrThroughputSettingsGetPro... (obligatoire)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Nom Description Valeur
autoscaleSettings Ressource Cosmos DB pour les paramètres de mise à l’échelle automatique. Le débit est requis ou autoscaleSettings est requis, mais pas les deux. AutoscaleSettingsResource
throughput Valeur du débit de la ressource Cosmos DB. Le débit est requis ou autoscaleSettings est requis, mais pas les deux. int

AutoscaleSettingsResource

Nom Description Valeur
autoUpgradePolicy Stratégie de mise à niveau automatique des ressources Cosmos DB AutoUpgradePolicyResource
maxThroughput Représente le débit maximal que le conteneur peut effectuer un scale-up. int (obligatoire)

AutoUpgradePolicyResource

Nom Description Valeur
throughputPolicy Représente la stratégie de débit à laquelle le service doit adhérer pour la mise à niveau automatique ThroughputPolicyResource

ThroughputPolicyResource

Nom Description Valeur
incrementPercent Représente le pourcentage par lequel le débit peut augmenter chaque fois que la stratégie de débit entre en jeu. int
isEnabled Détermine si l’objet ThroughputPolicy est actif ou non bool

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource databaseAccounts/mongodbDatabases/collections/throughputSettings peut être déployé avec des opérations qui ciblent :

  • Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2022-11-15-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
      }
    }
  })
}

Valeurs de propriétés

databaseAccounts/mongodbDatabases/collections/throug...

Nom Description Valeur
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2022-11-15-preview »
name Nom de la ressource « valeur par défaut »
location Emplacement du groupe de ressources auquel appartient la ressource. string
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : collections
tags Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ». Dictionnaire de noms et de valeurs d’étiquettes.
identité Identité de la ressource. ManagedServiceIdentity
properties Propriétés pour mettre à jour le débit des ressources Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (obligatoire)

ManagedServiceIdentity

Nom Description Valeur
type Type d’identité utilisé pour la ressource. Le type « SystemAssigned,UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service. « SystemAssigned »
« SystemAssigned,UserAssigned »
« UserAssigned »
identity_ids Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur sont des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». Tableau d’ID d’identité utilisateur.

ManagedServiceIdentityUserAssignedIdentities

Nom Description Valeur
{propriété personnalisée} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Nom Description Valeur
resource Format JSON standard d’un débit de ressource ThroughputSettingsResourceOrThroughputSettingsGetPro... (obligatoire)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Nom Description Valeur
autoscaleSettings Ressource Cosmos DB pour les paramètres de mise à l’échelle automatique. Le débit est requis ou autoscaleSettings est requis, mais pas les deux. AutoscaleSettingsResource
throughput Valeur du débit de la ressource Cosmos DB. Le débit est requis ou autoscaleSettings est requis, mais pas les deux. int

AutoscaleSettingsResource

Nom Description Valeur
autoUpgradePolicy Stratégie de mise à niveau automatique des ressources Cosmos DB AutoUpgradePolicyResource
maxThroughput Représente le débit maximal que le conteneur peut effectuer un scale-up. int (obligatoire)

AutoUpgradePolicyResource

Nom Description Valeur
throughputPolicy Représente la stratégie de débit à laquelle le service doit adhérer pour la mise à niveau automatique ThroughputPolicyResource

ThroughputPolicyResource

Nom Description Valeur
incrementPercent Représente le pourcentage par lequel le débit peut augmenter chaque fois que la stratégie de débit entre en jeu. int
isEnabled Détermine si l’objet ThroughputPolicy est actif ou non bool