Share via


Microsoft.DocumentDB-DatenbankAccounts/sqlDatabases/containers/userDefinedFunctions 2023-09-15-preview

Bicep-Ressourcendefinition

Der Ressourcentyp databaseAccounts/sqlDatabases/containers/userDefinedFunctions kann mit Vorgängen bereitgestellt werden, die auf folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2023-09-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      body: 'string'
      id: 'string'
    }
  }
}

Eigenschaftswerte

databaseAccounts/sqlDatabases/containers/userDefined...

Name BESCHREIBUNG Wert
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen.
Zeichenfolge (erforderlich)
location Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Zeichenfolge
tags Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
parent In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.
Symbolischer Name für Ressource vom Typ: Container
Identität Identität für die Ressource. ManagedServiceIdentity
properties Eigenschaften zum Erstellen und Aktualisieren von Azure Cosmos DB userDefinedFunction. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... (erforderlich)

ManagedServiceIdentity

Name BESCHREIBUNG Wert
type "Keine"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned": Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.
userAssignedIdentities Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

Name BESCHREIBUNG Wert
Optionen Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet wurden. CreateUpdateOptions
resource Das JSON-Standardformat einer userDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti... (erforderlich)

CreateUpdateOptions

Name BESCHREIBUNG Wert
autoscaleSettings Gibt die Einstellungen für die automatische Skalierung an. Hinweis: Entweder durchsatz oder autoscaleSettings ist erforderlich, aber nicht beides. AutoscaleSettings
throughput Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. INT

AutoscaleSettings

Name BESCHREIBUNG Wert
maxThroughput Stellt den maximalen Durchsatz dar, auf den die Ressource hochskaliert werden kann. INT

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

Name BESCHREIBUNG Wert
body Textkörper der benutzerdefinierten Funktion Zeichenfolge
id Name des Cosmos DB SQL-BenutzersDefinedFunction Zeichenfolge (erforderlich)

Schnellstartvorlagen

Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen gespeicherter Prozeduren der Azure Cosmos DB Core-API (SQL)

Bereitstellen in Azure
Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die SQL-API (Core) und einen Container mit einer gespeicherten Prozedur, einem Trigger und einer benutzerdefinierten Funktion.

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp databaseAccounts/sqlDatabases/containers/userDefinedFunctions kann mit Vorgängen bereitgestellt werden, die auf folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions",
  "apiVersion": "2023-09-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "body": "string",
      "id": "string"
    }
  }
}

Eigenschaftswerte

databaseAccounts/sqlDatabases/containers/userDefined...

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions"
apiVersion Die Ressourcen-API-Version '2023-09-15-preview'
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen.
Zeichenfolge (erforderlich)
location Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Zeichenfolge
tags Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Identität Identität für die Ressource. ManagedServiceIdentity
properties Eigenschaften zum Erstellen und Aktualisieren von Azure Cosmos DB userDefinedFunction. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... (erforderlich)

ManagedServiceIdentity

Name BESCHREIBUNG Wert
type "Keine"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned": Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.
userAssignedIdentities Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

Name BESCHREIBUNG Wert
Optionen Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet werden. CreateUpdateOptions
resource Das JSON-Standardformat einer userDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti... (erforderlich)

CreateUpdateOptions

Name BESCHREIBUNG Wert
autoscaleSettings Gibt die Einstellungen für die automatische Skalierung an. Hinweis: Es ist entweder "throughput" oder "autoscaleSettings" erforderlich, aber nicht beides. AutoscaleSettings
throughput Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. INT

AutoscaleSettings

Name BESCHREIBUNG Wert
maxThroughput Stellt den maximalen Durchsatz dar, auf den die Ressource hochskaliert werden kann. INT

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

Name BESCHREIBUNG Wert
body Text der benutzerdefinierten Funktion Zeichenfolge
id Name der Cosmos DB SQL userDefinedFunction Zeichenfolge (erforderlich)

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen gespeicherter Prozeduren der Azure Cosmos DB Core-API (SQL)

Bereitstellen in Azure
Mit dieser Vorlage werden ein Azure Cosmos DB-Konto für die Core-API (SQL) und ein Container mit einer gespeicherten Prozedur, einem Trigger und einer benutzerdefinierten Funktion erstellt.

Terraform-Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp databaseAccounts/sqlDatabases/containers/userDefinedFunctions kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Ressource Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.

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

Eigenschaftswerte

databaseAccounts/sqlDatabases/containers/userDefined...

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/userDefinedFunctions@2023-09-15-preview"
name Der Ressourcenname Zeichenfolge (erforderlich)
location Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Zeichenfolge
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource vom Typ Container
tags Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Beispielsweise ist die Standardumgebung für einen Vorlagentyp auf "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". Wörterbuch der Tagnamen und -werte.
Identität Identität für die Ressource. ManagedServiceIdentity
properties Eigenschaften zum Erstellen und Aktualisieren von Azure Cosmos DB userDefinedFunction. SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse... (erforderlich)

ManagedServiceIdentity

Name BESCHREIBUNG Wert
type "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned": Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.
identity_ids Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Array von Benutzeridentitäts-IDs.

ManagedServiceIdentityUserAssignedIdentities

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

SqlUserDefinedFunctionCreateUpdatePropertiesOrSqlUse...

Name BESCHREIBUNG Wert
Optionen Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet wurden. CreateUpdateOptions
resource Das JSON-Standardformat einer userDefinedFunction SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti... (erforderlich)

CreateUpdateOptions

Name BESCHREIBUNG Wert
autoscaleSettings Gibt die Einstellungen für die automatische Skalierung an. Hinweis: Entweder durchsatz oder autoscaleSettings ist erforderlich, aber nicht beides. AutoscaleSettings
throughput Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. INT

AutoscaleSettings

Name BESCHREIBUNG Wert
maxThroughput Stellt den maximalen Durchsatz dar, auf den die Ressource hochskaliert werden kann. INT

SqlUserDefinedFunctionResourceOrSqlUserDefinedFuncti...

Name BESCHREIBUNG Wert
body Textkörper der benutzerdefinierten Funktion Zeichenfolge
id Name des Cosmos DB SQL-BenutzersDefinedFunction Zeichenfolge (erforderlich)