Compartilhar via


Banco de dados Microsoft.DocumentDBAccounts/sqlDatabases/containers/userDefinedFunctions

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 das propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

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

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

Valores de propriedade

databaseAccounts/sqlDatabases/containers/userDefined...

Name Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos filho no Bicep.
cadeia de caracteres (obrigatório)
local O local do grupo de recursos ao qual o recurso pertence. string
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas. Confira Marcas em modelos
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: contêineres
properties Propriedades para criar e atualizar userDefinedFunction do Azure Cosmos DB. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... (obrigatório)

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

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

CreateUpdateOptions

Name Descrição Valor
autoscaleSettings Especifica as configurações de Dimensionamento automático. Observação: a taxa de transferência ou autoscaleSettings é necessária, mas não ambas. AutoscaleSettings
throughput Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. INT

AutoscaleSettings

Name Descrição Valor
maxThroughput Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. INT

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

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

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

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

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, um gatilho e uma 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 das propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

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

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

Valores de propriedade

databaseAccounts/sqlDatabases/containers/userDefined...

Name Descrição Valor
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions'
apiVersion A versão da API do recurso '2024-05-15'
name O nome do recurso

Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.
cadeia de caracteres (obrigatório)
local O local do grupo de recursos ao qual o recurso pertence. string
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas. Confira Marcas em modelos
properties Propriedades para criar e atualizar userDefinedFunction do Azure Cosmos DB. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... (obrigatório)

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

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

CreateUpdateOptions

Name Descrição Valor
autoscaleSettings Especifica as configurações de Dimensionamento automático. Observação: a taxa de transferência ou autoscaleSettings é necessária, mas não ambas. AutoscaleSettings
throughput Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. INT

AutoscaleSettings

Name Descrição Valor
maxThroughput Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. INT

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

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

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

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

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, um gatilho e uma 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:

  • Grupos de recursos

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

Formato de recurso

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

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

Valores de propriedade

databaseAccounts/sqlDatabases/containers/userDefined...

Name Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2024-05-15"
name O nome do recurso cadeia de caracteres (obrigatório)
local O local do grupo de recursos ao qual o recurso pertence. string
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: contêineres
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas.
properties Propriedades para criar e atualizar userDefinedFunction do Azure Cosmos DB. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... (obrigatório)

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

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

CreateUpdateOptions

Name Descrição Valor
autoscaleSettings Especifica as configurações de Dimensionamento automático. Observação: a taxa de transferência ou autoscaleSettings é necessária, mas não ambas. AutoscaleSettings
throughput Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. INT

AutoscaleSettings

Name Descrição Valor
maxThroughput Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. INT

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

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