Partager via

Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers/userDefinedFunctions 2021-07-01-preview

  • 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 des ressources

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@2021-07-01-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: {
      body: 'string'
      id: 'string'
    }
  }
}

Valeurs de propriétés

databaseAccounts/sqlDatabases/containers/userDefined...

Nom Description Valeur
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.		 chaîne (obligatoire)
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 : conteneurs
identité Identité de la ressource. ManagedServiceIdentity
properties Propriétés permettant de créer et de mettre à jour userDefinedFunction Azure Cosmos DB. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... (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.

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

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

CreateUpdateOptions

Nom Description Valeur
autoscaleSettings Spécifie les paramètres de mise à l’échelle automatique. AutoscaleSettings
throughput Unités de requête par seconde. Par exemple, « débit » : 10000. int

Paramètres de mise à l’échelle automatique

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

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

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

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 de l’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 ressources 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 des ressources

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": "2021-07-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "body": "string",
      "id": "string"
    }
  }
}

Valeurs de propriétés

databaseAccounts/sqlDatabases/containers/userDefined...

Nom Description Valeur
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions »
apiVersion Version de l’API de ressource « 2021-07-01-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.		 chaîne (obligatoire)
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 créer et de mettre à jour userDefinedFunction Azure Cosmos DB. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... (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.

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

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

CreateUpdateOptions

Nom Description Valeur
autoscaleSettings Spécifie les paramètres de mise à l’échelle automatique. AutoscaleSettings
throughput Unités de requête par seconde. Par exemple, « débit » : 10000. int

Paramètres de mise à l’échelle automatique

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

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

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

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 de l’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 des ressources

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-07-01-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 = {
        body = "string"
        id = "string"
      }
    }
  })
}

Valeurs de propriétés

databaseAccounts/sqlDatabases/containers/userDefined...

Nom Description Valeur
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-07-01-preview »
name Nom de la ressource chaîne (obligatoire)
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 : conteneurs
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 permettant de créer et de mettre à jour userDefinedFunction Azure Cosmos DB. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... (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.

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

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

CreateUpdateOptions

Nom Description Valeur
autoscaleSettings Spécifie les paramètres de mise à l’échelle automatique. AutoscaleSettings
throughput Unités de requête par seconde. Par exemple, « débit » : 10000. int

AutoscaleSettings

Nom Description Valeur
maxThroughput Représente le débit maximal jusqu’à lequel la ressource peut effectuer un scale-up. int

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

Nom Description Valeur
body Corps de la fonction définie par l’utilisateur string
id Nom de l’utilisateur SQL DefinedFunction Cosmos DB string (obligatoire)