Freigeben über


Microsoft.CustomProviders, resourceProvider

Bicep-Ressourcendefinition

Der Ressourcentyp "resourceProviders" 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.CustomProviders/resourceProviders-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.CustomProviders/resourceProviders@2018-09-01-preview' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
  properties: {
    actions: [
      {
        endpoint: 'string'
        name: 'string'
        routingType: 'string'
      }
    ]
    resourceTypes: [
      {
        endpoint: 'string'
        name: 'string'
        routingType: 'string'
      }
    ]
    validations: [
      {
        specification: 'string'
        validationType: 'string'
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschaftswerte

Microsoft.CustomProviders/resourceProviders

Name Beschreibung Wert
Ort Ressourcenspeicherort Zeichenfolge (erforderlich)
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 3
Max. Länge = 64 (erforderlich)
Eigenschaften Das Manifest für den benutzerdefinierten Ressourcenanbieter CustomRPManifestProperties-
scope Verwenden Sie diese Verwendung beim Erstellen einer Ressource in einem Bereich, der sich von dem Bereitstellungsbereich unterscheidet. Legen Sie diese Eigenschaft auf den symbolischen Namen einer Ressource fest, um die Erweiterungsressourceanzuwenden.
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

CustomRPActionRouteDefinition

Name Beschreibung Wert
Endpunkt Der Routendefinitionsendpunkt-URI, an den der benutzerdefinierte Ressourcenanbieter Proxyanforderungen sendet. Dies kann sich in Form eines flachen URI (z. B. 'https://testendpoint/') befinden oder die Route über einen Pfad angeben (z. B. 'https://testendpoint/{requestPath}') Schnur

Zwänge:
Pattern = ^https://.+ (erforderlich)
Name Der Name der Routendefinition. Dies wird der Name für die ARM-Erweiterung (z. B. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') Zeichenfolge (erforderlich)
routing-Typ Die Routingtypen, die für Aktionsanforderungen unterstützt werden. "Stellvertreter"

CustomRPManifestEigenschaften

Name Beschreibung Wert
Aktionen Eine Liste der Aktionen, die der benutzerdefinierte Ressourcenanbieter implementiert. Benutzerdefinierte RPActionRouteDefinition[]
resourceTypes Eine Liste der Ressourcentypen, die der benutzerdefinierte Ressourcenanbieter implementiert. CustomRPResourceTypeRouteDefinition[]
Bestätigungen Eine Liste der Überprüfungen, die für die Anforderungen des benutzerdefinierten Ressourcenanbieters ausgeführt werden sollen. CustomRPValidations-[]

CustomRPResourceTypeRouteDefinition

Name Beschreibung Wert
Endpunkt Der Routendefinitionsendpunkt-URI, an den der benutzerdefinierte Ressourcenanbieter Proxyanforderungen sendet. Dies kann sich in Form eines flachen URI (z. B. 'https://testendpoint/') befinden oder die Route über einen Pfad angeben (z. B. 'https://testendpoint/{requestPath}') Schnur

Zwänge:
Pattern = ^https://.+ (erforderlich)
Name Der Name der Routendefinition. Dies wird der Name für die ARM-Erweiterung (z. B. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') Zeichenfolge (erforderlich)
routing-Typ Die Routingtypen, die für Ressourcenanforderungen unterstützt werden. "Stellvertreter"
"Proxy,Cache"

CustomRPValidations

Name Beschreibung Wert
Spezifikation Eine Verknüpfung mit der Überprüfungsspezifikation. Die Spezifikation muss auf raw.githubusercontent.com gehostet werden. Schnur

Zwänge:
Pattern = ^https://raw.githubusercontent.com/.+ (erforderlich)
validationType Der Typ der Überprüfung, die für eine übereinstimmende Anforderung ausgeführt werden soll. "Prahlerei"

Ressourcen-Tags

Name Beschreibung Wert

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "resourceProviders" 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.CustomProviders/resourceProviders-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.CustomProviders/resourceProviders",
  "apiVersion": "2018-09-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "actions": [
      {
        "endpoint": "string",
        "name": "string",
        "routingType": "string"
      }
    ],
    "resourceTypes": [
      {
        "endpoint": "string",
        "name": "string",
        "routingType": "string"
      }
    ],
    "validations": [
      {
        "specification": "string",
        "validationType": "string"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschaftswerte

Microsoft.CustomProviders/resourceProviders

Name Beschreibung Wert
apiVersion (Englisch) Die API-Version '2018-09-01-Vorschau'
Ort Ressourcenspeicherort Zeichenfolge (erforderlich)
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 3
Max. Länge = 64 (erforderlich)
Eigenschaften Das Manifest für den benutzerdefinierten Ressourcenanbieter CustomRPManifestProperties-
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art Der Ressourcentyp "Microsoft.CustomProviders/resourceProviders"

CustomRPActionRouteDefinition

Name Beschreibung Wert
Endpunkt Der Routendefinitionsendpunkt-URI, an den der benutzerdefinierte Ressourcenanbieter Proxyanforderungen sendet. Dies kann sich in Form eines flachen URI (z. B. 'https://testendpoint/') befinden oder die Route über einen Pfad angeben (z. B. 'https://testendpoint/{requestPath}') Schnur

Zwänge:
Pattern = ^https://.+ (erforderlich)
Name Der Name der Routendefinition. Dies wird der Name für die ARM-Erweiterung (z. B. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') Zeichenfolge (erforderlich)
routing-Typ Die Routingtypen, die für Aktionsanforderungen unterstützt werden. "Stellvertreter"

CustomRPManifestEigenschaften

Name Beschreibung Wert
Aktionen Eine Liste der Aktionen, die der benutzerdefinierte Ressourcenanbieter implementiert. Benutzerdefinierte RPActionRouteDefinition[]
resourceTypes Eine Liste der Ressourcentypen, die der benutzerdefinierte Ressourcenanbieter implementiert. CustomRPResourceTypeRouteDefinition[]
Bestätigungen Eine Liste der Überprüfungen, die für die Anforderungen des benutzerdefinierten Ressourcenanbieters ausgeführt werden sollen. CustomRPValidations-[]

CustomRPResourceTypeRouteDefinition

Name Beschreibung Wert
Endpunkt Der Routendefinitionsendpunkt-URI, an den der benutzerdefinierte Ressourcenanbieter Proxyanforderungen sendet. Dies kann sich in Form eines flachen URI (z. B. 'https://testendpoint/') befinden oder die Route über einen Pfad angeben (z. B. 'https://testendpoint/{requestPath}') Schnur

Zwänge:
Pattern = ^https://.+ (erforderlich)
Name Der Name der Routendefinition. Dies wird der Name für die ARM-Erweiterung (z. B. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') Zeichenfolge (erforderlich)
routing-Typ Die Routingtypen, die für Ressourcenanforderungen unterstützt werden. "Stellvertreter"
"Proxy,Cache"

CustomRPValidations

Name Beschreibung Wert
Spezifikation Eine Verknüpfung mit der Überprüfungsspezifikation. Die Spezifikation muss auf raw.githubusercontent.com gehostet werden. Schnur

Zwänge:
Pattern = ^https://raw.githubusercontent.com/.+ (erforderlich)
validationType Der Typ der Überprüfung, die für eine übereinstimmende Anforderung ausgeführt werden soll. "Prahlerei"

Ressourcen-Tags

Name Beschreibung Wert

Verwendungsbeispiele

Azure-Schnellstartvorlagen

Die folgenden Azure-Schnellstartvorlagen diesen Ressourcentyp bereitstellen.

Schablone Beschreibung
Erstellen einer benutzerdefinierten Ressource für Vorlagen mit benutzerdefinierten Anbietern

Bereitstellen in Azure
In diesem Beispiel wird gezeigt, wie Benutzerdefinierte Ressourcen zu Ressourcen-Manager-Vorlagen mithilfe von benutzerdefinierten Anbietern und Logik-Apps hinzugefügt werden.
Erstellen einer Funktions-App und Aufrufen einer benutzerdefinierten Ressourcen-

Bereitstellen in Azure
Diese Vorlage erstellt Funktions-App, die als Workload für einen benutzerdefinierten Ressourcenanbieter in einer Vorlagenbereitstellung verwendet wird.
Erweitern vorhandener Azure-Ressourcen mit benutzerdefinierten Anbietern

Bereitstellen in Azure
In diesem Beispiel wird ausführlich erläutert, wie Vorhandene Azure-Ressourcen und Ressourcen-Manager-Vorlagen erweitert werden, um benutzerdefinierte Workloads hinzuzufügen.

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "resourceProviders" 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.CustomProviders/resourceProviders-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.CustomProviders/resourceProviders@2018-09-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      actions = [
        {
          endpoint = "string"
          name = "string"
          routingType = "string"
        }
      ]
      resourceTypes = [
        {
          endpoint = "string"
          name = "string"
          routingType = "string"
        }
      ]
      validations = [
        {
          specification = "string"
          validationType = "string"
        }
      ]
    }
  }
}

Eigenschaftswerte

Microsoft.CustomProviders/resourceProviders

Name Beschreibung Wert
Ort Ressourcenspeicherort Zeichenfolge (erforderlich)
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 3
Max. Länge = 64 (erforderlich)
parent_id Die ID der Ressource, auf die diese Erweiterungsressource angewendet werden soll. Zeichenfolge (erforderlich)
Eigenschaften Das Manifest für den benutzerdefinierten Ressourcenanbieter CustomRPManifestProperties-
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte.
Art Der Ressourcentyp "Microsoft.CustomProviders/resourceProviders@2018-09-01-preview"

CustomRPActionRouteDefinition

Name Beschreibung Wert
Endpunkt Der Routendefinitionsendpunkt-URI, an den der benutzerdefinierte Ressourcenanbieter Proxyanforderungen sendet. Dies kann sich in Form eines flachen URI (z. B. 'https://testendpoint/') befinden oder die Route über einen Pfad angeben (z. B. 'https://testendpoint/{requestPath}') Schnur

Zwänge:
Pattern = ^https://.+ (erforderlich)
Name Der Name der Routendefinition. Dies wird der Name für die ARM-Erweiterung (z. B. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') Zeichenfolge (erforderlich)
routing-Typ Die Routingtypen, die für Aktionsanforderungen unterstützt werden. "Stellvertreter"

CustomRPManifestEigenschaften

Name Beschreibung Wert
Aktionen Eine Liste der Aktionen, die der benutzerdefinierte Ressourcenanbieter implementiert. Benutzerdefinierte RPActionRouteDefinition[]
resourceTypes Eine Liste der Ressourcentypen, die der benutzerdefinierte Ressourcenanbieter implementiert. CustomRPResourceTypeRouteDefinition[]
Bestätigungen Eine Liste der Überprüfungen, die für die Anforderungen des benutzerdefinierten Ressourcenanbieters ausgeführt werden sollen. CustomRPValidations-[]

CustomRPResourceTypeRouteDefinition

Name Beschreibung Wert
Endpunkt Der Routendefinitionsendpunkt-URI, an den der benutzerdefinierte Ressourcenanbieter Proxyanforderungen sendet. Dies kann sich in Form eines flachen URI (z. B. 'https://testendpoint/') befinden oder die Route über einen Pfad angeben (z. B. 'https://testendpoint/{requestPath}') Schnur

Zwänge:
Pattern = ^https://.+ (erforderlich)
Name Der Name der Routendefinition. Dies wird der Name für die ARM-Erweiterung (z. B. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') Zeichenfolge (erforderlich)
routing-Typ Die Routingtypen, die für Ressourcenanforderungen unterstützt werden. "Stellvertreter"
"Proxy,Cache"

CustomRPValidations

Name Beschreibung Wert
Spezifikation Eine Verknüpfung mit der Überprüfungsspezifikation. Die Spezifikation muss auf raw.githubusercontent.com gehostet werden. Schnur

Zwänge:
Pattern = ^https://raw.githubusercontent.com/.+ (erforderlich)
validationType Der Typ der Überprüfung, die für eine übereinstimmende Anforderung ausgeführt werden soll. "Prahlerei"

Ressourcen-Tags

Name Beschreibung Wert

Verwendungsbeispiele

Terraform-Beispiele

Ein grundlegendes Beispiel für die Bereitstellung eines benutzerdefinierten Azure-Anbieters.

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" "resourceProvider" {
  type      = "Microsoft.CustomProviders/resourceProviders@2018-09-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      resourceTypes = [
        {
          endpoint    = "https://example.com/"
          name        = "dEf1"
          routingType = "Proxy"
        },
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}