Partager via

Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers/userDefinedFunctions 2024-05-15

  • Article

Définition de ressource Bicep

Le type de ressource databaseAccounts/sqlDatabases/containers/userDefinedFunctions 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 de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2024-05-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      body: 'string'
      id: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

Mise à l’échelle automatique

Nom Description Valeur
maxThroughput Représente le débit maximal, la ressource peut effectuer un scale-up. Int

CreateUpdateOptions

Nom Description Valeur
autoscaleSettings Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings est requis, mais pas les deux. de mise à l’échelle automatique
débit Unités de requête par seconde. Par exemple, « débit » : 1 0000. Int

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

Nom Description Valeur
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource chaîne (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’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 : databaseAccounts/sqlDatabases/conteneurs
Propriétés Propriétés permettant de créer et de mettre à jour userDefinedFunction d’Azure Cosmos DB. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptions
ressource Format JSON standard d’un userDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource (obligatoire)

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

Nom Description Valeur
corps Corps de la fonction définie par l’utilisateur corde
id Nom de l’utilisateur SQL Cosmos DBDefinedFunction chaîne (obligatoire)

Étiquettes

Nom Description Valeur

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep Description
Créer des procédures stockées d’API Azure Cosmos DB Core (SQL) Ce modèle crée un compte Azure Cosmos DB pour l’API Core (SQL) et un conteneur avec une procédure stockée, un déclencheur et une fonction définie par l’utilisateur.

Définition de ressource de modèle ARM

Le type de ressource databaseAccounts/sqlDatabases/containers/userDefinedFunctions 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 de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions",
  "apiVersion": "2024-05-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "body": "string",
      "id": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

Mise à l’échelle automatique

Nom Description Valeur
maxThroughput Représente le débit maximal, la ressource peut effectuer un scale-up. Int

CreateUpdateOptions

Nom Description Valeur
autoscaleSettings Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings est requis, mais pas les deux. de mise à l’échelle automatique
débit Unités de requête par seconde. Par exemple, « débit » : 1 0000. Int

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

Nom Description Valeur
apiVersion Version de l’API '2024-05-15'
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés permettant de créer et de mettre à jour userDefinedFunction d’Azure Cosmos DB. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions'

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptions
ressource Format JSON standard d’un userDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource (obligatoire)

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

Nom Description Valeur
corps Corps de la fonction définie par l’utilisateur corde
id Nom de l’utilisateur SQL Cosmos DBDefinedFunction chaîne (obligatoire)

Étiquettes

Nom Description Valeur

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
Créer des procédures stockées d’API Azure Cosmos DB Core (SQL)

Déployer sur Azure 		Ce modèle crée un compte Azure Cosmos DB pour l’API Core (SQL) et un conteneur avec une procédure stockée, un déclencheur et une fonction définie par l’utilisateur.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource databaseAccounts/sqlDatabases/containers/userDefinedFunctions 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 de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions, ajoutez la terraform suivante à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2024-05-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        body = "string"
        id = "string"
      }
    }
  })
}

Valeurs de propriété

Mise à l’échelle automatique

Nom Description Valeur
maxThroughput Représente le débit maximal, la ressource peut effectuer un scale-up. Int

CreateUpdateOptions

Nom Description Valeur
autoscaleSettings Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings est requis, mais pas les deux. de mise à l’échelle automatique
débit Unités de requête par seconde. Par exemple, « débit » : 1 0000. Int

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

Nom Description Valeur
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : databaseAccounts/sqlDatabases/conteneurs
Propriétés Propriétés permettant de créer et de mettre à jour userDefinedFunction d’Azure Cosmos DB. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2024-05-15 »

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptions
ressource Format JSON standard d’un userDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource (obligatoire)

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

Nom Description Valeur
corps Corps de la fonction définie par l’utilisateur corde
id Nom de l’utilisateur SQL Cosmos DBDefinedFunction chaîne (obligatoire)

Étiquettes

Nom Description Valeur