Compartilhar via

Banco de dados Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers/userDefinedFunctions 01/03/2020

Definição de recurso do Bicep

O tipo de recurso databaseAccounts/sqlDatabases/containers/userDefinedFunctions pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions, adicione o Bicep a seguir ao seu modelo.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2020-03-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      throughput: 'string'
    }
    resource: {
      body: 'string'
      id: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

Nome Descrição Valor
local O local do grupo de recursos ao qual o recurso pertence. cadeia
nome O nome do recurso cadeia de caracteres (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.		 Nome simbólico para o recurso do tipo: databaseAccounts/sqlDatabases/containers
Propriedades Propriedades para criar e atualizar o userDefinedFunction do Azure Cosmos DB. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

CreateUpdateOptions

Nome Descrição Valor
taxa de transferência Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": "10000". cadeia

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

Nome Descrição Valor
Opções Um par de opções chave-valor a ser aplicado à solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. CreateUpdateOptions (obrigatório)
recurso O formato JSON padrão de um userDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource (obrigatório)

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

Nome Descrição Valor
corpo Corpo da função definida pelo usuário cadeia
id Nome do usuário do SQL do Cosmos DBDefinedFunction cadeia de caracteres (obrigatório)

Etiquetas

Nome Descrição Valor

Exemplos de uso

Exemplos de Início Rápido do Azure

Os modelos de Início Rápido do Azure a seguir contêm exemplos de Bicep para implantar esse tipo de recurso.

Arquivo Bicep Descrição
Criar procedimentos armazenados da API do SQL (Azure Cosmos DB Core) Esse modelo cria uma conta do Azure Cosmos DB para a API do Core (SQL) e um contêiner com um procedimento armazenado, gatilho e função definida pelo usuário.

Definição de recurso de modelo do ARM

O tipo de recurso databaseAccounts/sqlDatabases/containers/userDefinedFunctions pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions, adicione o JSON a seguir ao seu modelo.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions",
  "apiVersion": "2020-03-01",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "throughput": "string"
    },
    "resource": {
      "body": "string",
      "id": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

Nome Descrição Valor
apiVersion A versão da API '2020-03-01'
local O local do grupo de recursos ao qual o recurso pertence. cadeia
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades para criar e atualizar o userDefinedFunction do Azure Cosmos DB. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions'

CreateUpdateOptions

Nome Descrição Valor
taxa de transferência Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": "10000". cadeia

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

Nome Descrição Valor
Opções Um par de opções chave-valor a ser aplicado à solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. CreateUpdateOptions (obrigatório)
recurso O formato JSON padrão de um userDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource (obrigatório)

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

Nome Descrição Valor
corpo Corpo da função definida pelo usuário cadeia
id Nome do usuário do SQL do Cosmos DBDefinedFunction cadeia de caracteres (obrigatório)

Etiquetas

Nome Descrição Valor

Exemplos de uso

Modelos de Início Rápido do Azure

Os modelos de Início Rápido do Azure a seguir implantar esse tipo de recurso.

Modelo Descrição
Criar procedimentos armazenados da API do SQL (Azure Cosmos DB Core)

Implantar no Azure 		Esse modelo cria uma conta do Azure Cosmos DB para a API do Core (SQL) e um contêiner com um procedimento armazenado, gatilho e função definida pelo usuário.

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso databaseAccounts/sqlDatabases/containers/userDefinedFunctions pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2020-03-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      options = {
        throughput = "string"
      }
      resource = {
        body = "string"
        id = "string"
      }
    }
  }
}

Valores de propriedade

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

Nome Descrição Valor
local O local do grupo de recursos ao qual o recurso pertence. cadeia
nome O nome do recurso cadeia de caracteres (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: databaseAccounts/sqlDatabases/containers
Propriedades Propriedades para criar e atualizar o userDefinedFunction do Azure Cosmos DB. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2020-03-01"

CreateUpdateOptions

Nome Descrição Valor
taxa de transferência Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": "10000". cadeia

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

Nome Descrição Valor
Opções Um par de opções chave-valor a ser aplicado à solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. CreateUpdateOptions (obrigatório)
recurso O formato JSON padrão de um userDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource (obrigatório)

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

Nome Descrição Valor
corpo Corpo da função definida pelo usuário cadeia
id Nome do usuário do SQL do Cosmos DBDefinedFunction cadeia de caracteres (obrigatório)

Etiquetas

Nome Descrição Valor

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implantação da Função Definida pelo Usuário do SQL.

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    = ["*"]
}
  • Last updated on