Microsoft. DocumentDB databaseAccounts/sqlDatabases/containers/userDefinedFunctions 2025-10-15

Bicep-resourcedefinitie

Het resourcetype databaseAccounts/sqlDatabases/containers/userDefinedFunctions kan worden geïmplementeerd met bewerkingen die als doel hebben:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Gebruiksvoorbeelden

Bicep-voorbeelden

Een eenvoudig voorbeeld van het implementeren van SQL User Defined Function.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource databaseAccount 'Microsoft.DocumentDB/databaseAccounts@2021-10-15' = {
  name: resourceName
  location: location
  kind: 'GlobalDocumentDB'
  properties: {
    capabilities: []
    consistencyPolicy: {
      defaultConsistencyLevel: 'Session'
      maxIntervalInSeconds: 5
      maxStalenessPrefix: 100
    }
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'FirstPartyIdentity'
    disableKeyBasedMetadataWriteAccess: false
    disableLocalAuth: false
    enableAnalyticalStorage: false
    enableAutomaticFailover: false
    enableFreeTier: false
    enableMultipleWriteLocations: false
    ipRules: []
    isVirtualNetworkFilterEnabled: false
    locations: [
      {
        failoverPriority: 0
        isZoneRedundant: false
        locationName: 'West Europe'
      }
    ]
    networkAclBypass: 'None'
    networkAclBypassResourceIds: []
    publicNetworkAccess: 'Enabled'
    virtualNetworkRules: []
  }
}

resource sqlDatabase 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-10-15' = {
  name: resourceName
  parent: databaseAccount
  properties: {
    options: {}
    resource: {
      id: resourceName
    }
  }
}

resource container 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-04-15' = {
  name: resourceName
  parent: sqlDatabase
  properties: {
    options: {}
    resource: {
      id: resourceName
      partitionKey: {
        kind: 'Hash'
        paths: [
          '/definition/id'
        ]
      }
    }
  }
}

resource userDefinedFunction 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-10-15' = {
  name: resourceName
  parent: container
  properties: {
    options: {}
    resource: {
      body: '''  	function test() {
		var context = getContext();
		var response = context.getResponse();
		response.setBody(''Hello, World'');
	}
'''
      id: resourceName
    }
  }
}

Azure-snelstartvoorbeelden

De volgende Azure-snelstartsjablonen bevatten Bicep-voorbeelden voor het implementeren van dit resourcetype.

Biceps-bestand Description
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.

Resource-indeling

Als u een Resource Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

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

Eigenschapswaarden

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

Naam Description Waarde
location De locatie van de resourcegroep waartoe de resource behoort. touw
naam De resourcenaam tekenreeks (vereist)
parent 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 de bovenliggende resourcevoor meer informatie.
Symbolische naam voor resource van het type: databaseAccounts/sqlDatabases/containers
properties Eigenschappen voor het maken en bijwerken van Azure Cosmos DB userDefinedFunction. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties (vereist)
tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen

Instellingen voor automatisch schalen

Naam Description Waarde
maximale doorvoer Vertegenwoordigt de maximale doorvoer, de resource kan omhoog worden geschaald. int

CreateUpdateOpties

Naam Description Waarde
autoscale-instellingen Hiermee geeft u de instellingen voor automatisch schalen. Opmerking: doorvoer of autoscaleSettings is vereist, maar niet beide. Instellingen voor automatisch schalen
doorvoer Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. int

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

Naam Description Waarde
options Een sleutel-waardepaar met opties die moeten worden toegepast voor de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. CreateUpdateOptions-
resource De standaard JSON-indeling van een userDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource (vereist)

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

Naam Description Waarde
body Hoofdtekst van de door de gebruiker gedefinieerde functie touw
identiteitskaart Naam van de Cosmos DB SQL userDefinedFunction tekenreeks (vereist)

Tags

Naam Description Waarde

Resourcedefinitie van ARM-sjabloon

Het resourcetype databaseAccounts/sqlDatabases/containers/userDefinedFunctions kan worden geïmplementeerd met bewerkingen die als doel hebben:

Gebruiksvoorbeelden

Azure Snelle Start Sjablonen

Met de volgende Azure-quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Template Description
Opgeslagen procedures voor Azure Cosmos DB Core (SQL) API maken

Implementeren in Azure
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.

Resource-indeling

Als u een resource Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

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

Eigenschapswaarden

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

Naam Description Waarde
apiVersion De API-versie '2025-10-15'
location De locatie van de resourcegroep waartoe de resource behoort. touw
naam De resourcenaam tekenreeks (vereist)
properties Eigenschappen voor het maken en bijwerken van Azure Cosmos DB userDefinedFunction. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties (vereist)
tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
type Het brontype 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions'

Instellingen voor automatisch schalen

Naam Description Waarde
maximale doorvoer Vertegenwoordigt de maximale doorvoer, de resource kan omhoog worden geschaald. int

CreateUpdateOpties

Naam Description Waarde
autoscale-instellingen Hiermee geeft u de instellingen voor automatisch schalen. Opmerking: doorvoer of autoscaleSettings is vereist, maar niet beide. Instellingen voor automatisch schalen
doorvoer Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. int

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

Naam Description Waarde
options Een sleutel-waardepaar met opties die moeten worden toegepast voor de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. CreateUpdateOptions-
resource De standaard JSON-indeling van een userDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource (vereist)

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

Naam Description Waarde
body Hoofdtekst van de door de gebruiker gedefinieerde functie touw
identiteitskaart Naam van de Cosmos DB SQL userDefinedFunction tekenreeks (vereist)

Tags

Naam Description Waarde

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype databaseAccounts/sqlDatabases/containers/userDefinedFunctions kan worden geïmplementeerd met bewerkingen die als doel hebben:

  • Resourcegroepen Voor een lijst van gewijzigde eigenschappen in elke API-versie, zie wijzigingslogboek.

Gebruiksvoorbeelden

Terraform-monsters

Een eenvoudig voorbeeld van het implementeren van SQL User Defined Function.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "databaseAccount" {
  type      = "Microsoft.DocumentDB/databaseAccounts@2021-10-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "GlobalDocumentDB"
    properties = {
      capabilities = [
      ]
      consistencyPolicy = {
        defaultConsistencyLevel = "Session"
        maxIntervalInSeconds    = 5
        maxStalenessPrefix      = 100
      }
      databaseAccountOfferType           = "Standard"
      defaultIdentity                    = "FirstPartyIdentity"
      disableKeyBasedMetadataWriteAccess = false
      disableLocalAuth                   = false
      enableAnalyticalStorage            = false
      enableAutomaticFailover            = false
      enableFreeTier                     = false
      enableMultipleWriteLocations       = false
      ipRules = [
      ]
      isVirtualNetworkFilterEnabled = false
      locations = [
        {
          failoverPriority = 0
          isZoneRedundant  = false
          locationName     = "West Europe"
        },
      ]
      networkAclBypass = "None"
      networkAclBypassResourceIds = [
      ]
      publicNetworkAccess = "Enabled"
      virtualNetworkRules = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "sqlDatabase" {
  type      = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-10-15"
  parent_id = azapi_resource.databaseAccount.id
  name      = var.resource_name
  body = {
    properties = {
      options = {
      }
      resource = {
        id = var.resource_name
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "container" {
  type      = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-04-15"
  parent_id = azapi_resource.sqlDatabase.id
  name      = var.resource_name
  body = {
    properties = {
      options = {
      }
      resource = {
        id = var.resource_name
        partitionKey = {
          kind = "Hash"
          paths = [
            "/definition/id",
          ]
        }
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "userDefinedFunction" {
  type      = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-10-15"
  parent_id = azapi_resource.container.id
  name      = var.resource_name
  body = {
    properties = {
      options = {
      }
      resource = {
        body = "  \tfunction test() {\n\t\tvar context = getContext();\n\t\tvar response = context.getResponse();\n\t\tresponse.setBody('Hello, World');\n\t}\n"
        id   = var.resource_name
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Resource-indeling

Als u een resource Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

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

Eigenschapswaarden

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

Naam Description Waarde
location De locatie van de resourcegroep waartoe de resource behoort. touw
naam De resourcenaam tekenreeks (vereist)
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van het type: databaseAccounts/sqlDatabases/containers
properties Eigenschappen voor het maken en bijwerken van Azure Cosmos DB userDefinedFunction. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties (vereist)
tags Resourcetags Woordenlijst met tagnamen en -waarden.
type Het brontype "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2025-10-15"

Instellingen voor automatisch schalen

Naam Description Waarde
maximale doorvoer Vertegenwoordigt de maximale doorvoer, de resource kan omhoog worden geschaald. int

CreateUpdateOpties

Naam Description Waarde
autoscale-instellingen Hiermee geeft u de instellingen voor automatisch schalen. Opmerking: doorvoer of autoscaleSettings is vereist, maar niet beide. Instellingen voor automatisch schalen
doorvoer Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. int

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

Naam Description Waarde
options Een sleutel-waardepaar met opties die moeten worden toegepast voor de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. CreateUpdateOptions-
resource De standaard JSON-indeling van een userDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource (vereist)

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

Naam Description Waarde
body Hoofdtekst van de door de gebruiker gedefinieerde functie touw
identiteitskaart Naam van de Cosmos DB SQL userDefinedFunction tekenreeks (vereist)

Tags

Naam Description Waarde