Udostępnij przez

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

Definicja zasobu Bicep

Typ zasobu databaseAccounts/sqlDatabases/containers/userDefinedFunctions można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions, dodaj następujący kod Bicep do szablonu.

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

Wartości właściwości

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

Nazwa Opis Wartość
lokalizacja Lokalizacja grupy zasobów, do której należy zasób. ciąg
nazwa Nazwa zasobu ciąg (wymagany)
nadrzędny W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Nazwa symboliczna zasobu typu: databaseAccounts/sqlDatabases/containers
Właściwości Właściwości do tworzenia i aktualizowania użytkownika usługi Azure Cosmos DBDefinedFunction. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

AutoskalowanieUstawienia

Nazwa Opis Wartość
maxThroughput (maksymalna przepływność) Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. Int

CreateUpdateOptions (CreateUpdateOptions)

Nazwa Opis Wartość
autoskalowanieUstawienia Określa ustawienia autoskalu. AutoskalowanieUstawienia
przepływność Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. Int

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

Nazwa Opis Wartość
Opcje Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. CreateUpdateOptions (CreateUpdateOptions)
zasób Standardowy format JSON użytkownikaDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource (wymagane)

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

Nazwa Opis Wartość
ciało Treść funkcji zdefiniowanej przez użytkownika ciąg
id Nazwa użytkownika SQL usługi Cosmos DBDefinedFunction ciąg (wymagany)

Tagi

Nazwa Opis Wartość

Przykłady użycia

Przykłady szybkiego startu platformy Azure

Poniższe szablony szybkiego startu platformy Azure zawierają przykłady Bicep na potrzeby wdrażania tego typu zasobu.

Plik Bicep Opis
tworzenie procedur składowanych interfejsu API Azure Cosmos DB Core (SQL) Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API Core (SQL) i kontener z procedurą składowaną, wyzwalaczem i funkcją zdefiniowaną przez użytkownika.

Definicja zasobu szablonu usługi ARM

Typ zasobu databaseAccounts/sqlDatabases/containers/userDefinedFunctions można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions, dodaj następujący kod JSON do szablonu.

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

Wartości właściwości

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) Wersja interfejsu API '2021-05-15'
lokalizacja Lokalizacja grupy zasobów, do której należy zasób. ciąg
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości do tworzenia i aktualizowania użytkownika usługi Azure Cosmos DBDefinedFunction. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions"

AutoskalowanieUstawienia

Nazwa Opis Wartość
maxThroughput (maksymalna przepływność) Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. Int

CreateUpdateOptions (CreateUpdateOptions)

Nazwa Opis Wartość
autoskalowanieUstawienia Określa ustawienia autoskalu. AutoskalowanieUstawienia
przepływność Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. Int

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

Nazwa Opis Wartość
Opcje Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. CreateUpdateOptions (CreateUpdateOptions)
zasób Standardowy format JSON użytkownikaDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource (wymagane)

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

Nazwa Opis Wartość
ciało Treść funkcji zdefiniowanej przez użytkownika ciąg
id Nazwa użytkownika SQL usługi Cosmos DBDefinedFunction ciąg (wymagany)

Tagi

Nazwa Opis Wartość

Przykłady użycia

Szablony szybkiego startu platformy Azure

Następujące szablony szybkiego startu platformy Azure wdrożyć ten typ zasobu.

Szablon Opis
tworzenie procedur składowanych interfejsu API Azure Cosmos DB Core (SQL)

wdrażanie w usłudze Azure		 Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API Core (SQL) i kontener z procedurą składowaną, wyzwalaczem i funkcją zdefiniowaną przez użytkownika.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu databaseAccounts/sqlDatabases/containers/userDefinedFunctions można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-05-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"
      }
    }
  }
}

Wartości właściwości

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions

Nazwa Opis Wartość
lokalizacja Lokalizacja grupy zasobów, do której należy zasób. ciąg
nazwa Nazwa zasobu ciąg (wymagany)
parent_id (identyfikator rodzica) Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: databaseAccounts/sqlDatabases/containers
Właściwości Właściwości do tworzenia i aktualizowania użytkownika usługi Azure Cosmos DBDefinedFunction. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2021-05-15"

AutoskalowanieUstawienia

Nazwa Opis Wartość
maxThroughput (maksymalna przepływność) Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. Int

CreateUpdateOptions (CreateUpdateOptions)

Nazwa Opis Wartość
autoskalowanieUstawienia Określa ustawienia autoskalu. AutoskalowanieUstawienia
przepływność Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. Int

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUserDefinedFunctionGetProperties

Nazwa Opis Wartość
Opcje Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. CreateUpdateOptions (CreateUpdateOptions)
zasób Standardowy format JSON użytkownikaDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource (wymagane)

SqlUserDefinedFunctionResourceOrSqlUserDefinedFunctionGetPropertiesResource

Nazwa Opis Wartość
ciało Treść funkcji zdefiniowanej przez użytkownika ciąg
id Nazwa użytkownika SQL usługi Cosmos DBDefinedFunction ciąg (wymagany)

Tagi

Nazwa Opis Wartość

Przykłady użycia

Przykłady programu Terraform

Podstawowy przykład wdrażania funkcji zdefiniowanej przez użytkownika 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