Udostępnij za pośrednictwem


Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers/userDefinedFunctions 2023-09-15

Definicja zasobu Bicep

Typ zasobu databaseAccounts/sqlDatabases/containers/userDefinedFunctions można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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@2023-09-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      body: 'string'
      id: 'string'
    }
  }
}

Wartości właściwości

databaseAccounts/sqlDatabases/containers/userDefined...

Nazwa Opis Wartość
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep.
ciąg (wymagany)
location Lokalizacja grupy zasobów, do której należy zasób. ciąg
tags Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawiane z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
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: kontenery
properties Właściwości do tworzenia i aktualizowania użytkownika usługi Azure Cosmos DBDefinedFunction. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... (wymagane)

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

Nazwa Opis Wartość
opcje Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. CreateUpdateOptions
zasób Standardowy format JSON użytkownikaDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti... (wymagane)

CreateUpdateOptions

Nazwa Opis Wartość
autoskalowanieUstawienia Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie. AutoskalowanieUstawienia
danych Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. int

AutoskalowanieUstawienia

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

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

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

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Template Opis
Tworzenie procedur składowanych interfejsu API Core (SQL) usługi Azure Cosmos DB

Wdróż na platformie 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 szablonu usługi ARM

Typ zasobu databaseAccounts/sqlDatabases/containers/userDefinedFunctions można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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": "2023-09-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "body": "string",
      "id": "string"
    }
  }
}

Wartości właściwości

databaseAccounts/sqlDatabases/containers/userDefined...

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions"
apiVersion Wersja interfejsu API zasobów '2023-09-15'
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM w formacie JSON.
ciąg (wymagany)
location Lokalizacja grupy zasobów, do której należy zasób. ciąg
tags Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawiane z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
properties Właściwości do tworzenia i aktualizowania użytkownika usługi Azure Cosmos DBDefinedFunction. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... (wymagane)

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

Nazwa Opis Wartość
opcje Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. CreateUpdateOptions
zasób Standardowy format JSON użytkownikaDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti... (wymagane)

CreateUpdateOptions

Nazwa Opis Wartość
autoskalowanieUstawienia Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie. AutoskalowanieUstawienia
danych Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. int

AutoskalowanieUstawienia

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

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

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

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Template Opis
Tworzenie procedur składowanych interfejsu API Azure Cosmos DB Core (SQL)

Wdróż na platformie 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:

  • Grupy zasobów

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

Format zasobu

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

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

Wartości właściwości

databaseAccounts/sqlDatabases/containers/userDefined...

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2023-09-15"
name Nazwa zasobu ciąg (wymagany)
location Lokalizacja grupy zasobów, do której należy zasób. ciąg
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: kontenery
tags Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą być używane w wyświetlaniu i grupowaniu tego zasobu (w grupach zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawione z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". Słownik nazw tagów i wartości.
properties Właściwości do tworzenia i aktualizowania użytkownika usługi Azure Cosmos DBDefinedFunction. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... (wymagane)

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

Nazwa Opis Wartość
opcje Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysłanym z żądaniem. CreateUpdateOptions
zasób Standardowy format JSON użytkownikaDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti... (wymagane)

CreateUpdateOptions

Nazwa Opis Wartość
autoskalowanieUstawienia Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie. AutoskalowanieUstawienia
danych Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. int

AutoskalowanieUstawienia

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

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

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