Microsoft.CustomProviders resourceProviders

Article
07/20/2023

Définition de ressource Bicep

Le type de ressource resourceProviders peut être déployé sur :

Groupes de ressources - Voir commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.CustomProviders/resourceProviders, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.CustomProviders/resourceProviders@2018-09-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    actions: [
      {
        endpoint: 'string'
        name: 'string'
        routingType: 'Proxy'
      }
    ]
    resourceTypes: [
      {
        endpoint: 'string'
        name: 'string'
        routingType: 'string'
      }
    ]
    validations: [
      {
        specification: 'string'
        validationType: 'Swagger'
      }
    ]
  }
}

Valeurs de propriétés

resourceProviders

Nom	Description	Valeur
name	Nom de la ressource	chaîne (obligatoire) Limite de caractères : 3-64 Caractères valides : Impossibilité d’utiliser : `%&\\?/` ou des caractères de contrôle. Ne peut pas se terminer par un point ou un espace.
location	Emplacement de la ressource	chaîne (obligatoire)
tags	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties	Manifeste du fournisseur de ressources personnalisé	CustomRPManifestProperties

CustomRPManifestProperties

Nom	Description	Valeur
actions	Liste d’actions que le fournisseur de ressources personnalisé implémente.	CustomRPActionRouteDefinition[]
resourceTypes	Liste des types de ressources que le fournisseur de ressources personnalisé implémente.	CustomRPResourceTypeRouteDefinition[]
validations	Liste des validations à exécuter sur les demandes du fournisseur de ressources personnalisées.	CustomRPValidations[]

CustomRPActionRouteDefinition

Nom	Description	Valeur
endpoint	URI de point de terminaison de définition de route auquel le fournisseur de ressources personnalisées demande par proxy. Cela peut se présenter sous la forme d’un URI plat (par exemple, 'https://testendpoint/') ou spécifier l’itinéraire via un chemin d’accès (par exemple , 'https://testendpoint/{requestPath}')	chaîne (obligatoire)
name	Nom de la définition d’itinéraire. Il s’agit du nom de l’extension ARM (par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name} »)	chaîne (obligatoire)
routingType	Types de routage pris en charge pour les demandes d’action.	'Proxy'

CustomRPResourceTypeRouteDefinition

Nom	Description	Valeur
endpoint	URI de point de terminaison de définition de route auquel le fournisseur de ressources personnalisées demande par proxy. Cela peut se présenter sous la forme d’un URI plat (par exemple, 'https://testendpoint/') ou spécifier l’itinéraire via un chemin d’accès (par exemple , 'https://testendpoint/{requestPath}')	chaîne (obligatoire)
name	Nom de la définition d’itinéraire. Il s’agit du nom de l’extension ARM (par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name} »)	chaîne (obligatoire)
routingType	Types de routage pris en charge pour les demandes de ressources.	'Proxy' 'Proxy,Cache'

CustomRPValidations

Nom	Description	Valeur
specification	Lien vers la spécification de validation. La spécification doit être hébergée sur raw.githubusercontent.com.	chaîne (obligatoire)
validationType	Type de validation à exécuter sur une demande correspondante.	'Swagger'

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle	Description
Étendre des ressources Azure existantes avec des fournisseurs personnalisés	Cet exemple explique en détail comment étendre les ressources Azure existantes et Resource Manager modèles pour ajouter des charges de travail personnalisées.
Créer une application de fonction et l’appeler à l’aide d’une ressource personnalisée	Ce modèle crée une application de fonction utilisée comme charge de travail pour un fournisseur de ressources personnalisées dans un déploiement de modèle.
Créer une ressource personnalisée pour les modèles avec des fournisseurs personnalisés	Cet exemple montre comment ajouter des ressources personnalisées à des modèles Resource Manager à l’aide de fournisseurs personnalisés et d’applications logiques.

Définition de ressources de modèle ARM

Le type de ressource resourceProviders peut être déployé sur :

Groupes de ressources - Voir commandes de déploiement de groupe de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.CustomProviders/resourceProviders, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.CustomProviders/resourceProviders",
  "apiVersion": "2018-09-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "actions": [
      {
        "endpoint": "string",
        "name": "string",
        "routingType": "Proxy"
      }
    ],
    "resourceTypes": [
      {
        "endpoint": "string",
        "name": "string",
        "routingType": "string"
      }
    ],
    "validations": [
      {
        "specification": "string",
        "validationType": "Swagger"
      }
    ]
  }
}

Valeurs de propriétés

resourceProviders

Nom	Description	Valeur
type	Type de ressource	« Microsoft.CustomProviders/resourceProviders »
apiVersion	Version de l’API de ressource	'2018-09-01-preview'
name	Nom de la ressource	string (obligatoire) Limite de caractères : 3-64 Caractères valides : Impossibilité d’utiliser : `%&\\?/` ou des caractères de contrôle. Ne peut pas se terminer par un point ou un espace.
location	Emplacement de la ressource	string (obligatoire)
tags	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties	Manifeste du fournisseur de ressources personnalisé	CustomRPManifestProperties

CustomRPManifestProperties

Nom	Description	Valeur
actions	Liste des actions que le fournisseur de ressources personnalisé implémente.	CustomRPActionRouteDefinition[]
resourceTypes	Liste des types de ressources que le fournisseur de ressources personnalisé implémente.	CustomRPResourceTypeRouteDefinition[]
validations	Liste des validations à exécuter sur les demandes du fournisseur de ressources personnalisées.	CustomRPValidations[]

CustomRPActionRouteDefinition

Nom	Description	Valeur
endpoint	URI de point de terminaison de définition d’itinéraire vers lequel le fournisseur de ressources personnalisé proxy les demandes. Cela peut se présenter sous la forme d’un URI plat (par exemple, 'https://testendpoint/') ou peut spécifier l’itinéraire via un chemin d’accès (par exemple, 'https://testendpoint/{requestPath}'')	string (obligatoire)
name	Nom de la définition d’itinéraire. Cela devient le nom de l’extension ARM (par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name} »)	string (obligatoire)
routingType	Types de routage pris en charge pour les demandes d’action.	'Proxy'

CustomRPResourceTypeRouteDefinition

Nom	Description	Valeur
endpoint	URI de point de terminaison de définition d’itinéraire vers lequel le fournisseur de ressources personnalisé proxy les demandes. Cela peut se présenter sous la forme d’un URI plat (par exemple, 'https://testendpoint/') ou peut spécifier l’itinéraire via un chemin d’accès (par exemple, 'https://testendpoint/{requestPath}'')	string (obligatoire)
name	Nom de la définition d’itinéraire. Cela devient le nom de l’extension ARM (par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name} »)	string (obligatoire)
routingType	Types de routage pris en charge pour les demandes de ressources.	'Proxy' 'Proxy,Cache'

CustomRPValidations

Nom	Description	Valeur
specification	Lien vers la spécification de validation. La spécification doit être hébergée sur raw.githubusercontent.com.	string (obligatoire)
validationType	Type de validation à exécuter sur une demande correspondante.	'Swagger'

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle	Description
Étendre des ressources Azure existantes avec des fournisseurs personnalisés	Cet exemple explique en détail comment étendre des ressources Azure existantes et des modèles Resource Manager pour ajouter des charges de travail personnalisées.
Créer une application de fonction et l’appeler à l’aide d’une ressource personnalisée	Ce modèle crée une application de fonction utilisée comme charge de travail pour un fournisseur de ressources personnalisées dans un déploiement de modèle.
Créer une ressource personnalisée pour les modèles avec des fournisseurs personnalisés	Cet exemple montre comment ajouter des ressources personnalisées à des modèles Resource Manager à l’aide de fournisseurs personnalisés et d’applications logiques.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource resourceProviders peut être déployé sur :

Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.CustomProviders/resourceProviders, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.CustomProviders/resourceProviders@2018-09-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      actions = [
        {
          endpoint = "string"
          name = "string"
          routingType = "Proxy"
        }
      ]
      resourceTypes = [
        {
          endpoint = "string"
          name = "string"
          routingType = "string"
        }
      ]
      validations = [
        {
          specification = "string"
          validationType = "Swagger"
        }
      ]
    }
  })
}

Valeurs de propriétés

resourceProviders

Nom	Description	Valeur
type	Type de ressource	« Microsoft.CustomProviders/resourceProviders@2018-09-01-preview »
name	Nom de la ressource	chaîne (obligatoire) Limite de caractères : 3-64 Caractères valides : Impossibilité d’utiliser : `%&\\?/` ou des caractères de contrôle. Ne peut pas se terminer par un point ou un espace.
location	Emplacement de la ressource	chaîne (obligatoire)
parent_id	Pour effectuer un déploiement sur un groupe de ressources, utilisez l’ID de ce groupe de ressources.	chaîne (obligatoire)
tags	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes.
properties	Manifeste du fournisseur de ressources personnalisé	CustomRPManifestProperties

CustomRPManifestProperties

Nom	Description	Valeur
actions	Liste d’actions que le fournisseur de ressources personnalisé implémente.	CustomRPActionRouteDefinition[]
resourceTypes	Liste des types de ressources que le fournisseur de ressources personnalisé implémente.	CustomRPResourceTypeRouteDefinition[]
validations	Liste des validations à exécuter sur les demandes du fournisseur de ressources personnalisées.	CustomRPValidations[]

CustomRPActionRouteDefinition

Nom	Description	Valeur
endpoint	URI de point de terminaison de définition de route auquel le fournisseur de ressources personnalisées demande par proxy. Cela peut se présenter sous la forme d’un URI plat (par exemple, 'https://testendpoint/') ou spécifier l’itinéraire via un chemin d’accès (par exemple , 'https://testendpoint/{requestPath}')	chaîne (obligatoire)
name	Nom de la définition d’itinéraire. Il s’agit du nom de l’extension ARM (par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name} »)	chaîne (obligatoire)
routingType	Types de routage pris en charge pour les demandes d’action.	« Proxy »

CustomRPResourceTypeRouteDefinition

Nom	Description	Valeur
endpoint	URI de point de terminaison de définition de route auquel le fournisseur de ressources personnalisées demande par proxy. Cela peut se présenter sous la forme d’un URI plat (par exemple, 'https://testendpoint/') ou spécifier l’itinéraire via un chemin d’accès (par exemple , 'https://testendpoint/{requestPath}')	chaîne (obligatoire)
name	Nom de la définition d’itinéraire. Il s’agit du nom de l’extension ARM (par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name} »)	chaîne (obligatoire)
routingType	Types de routage pris en charge pour les demandes de ressources.	« Proxy » « Proxy, Cache »

CustomRPValidations

Nom	Description	Valeur
specification	Lien vers la spécification de validation. La spécification doit être hébergée sur raw.githubusercontent.com.	chaîne (obligatoire)
validationType	Type de validation à exécuter sur une demande correspondante.	« Swagger »

Partager via

Microsoft.CustomProviders resourceProviders

Définition de ressource Bicep

Format des ressources

Valeurs de propriétés

resourceProviders

CustomRPManifestProperties

CustomRPActionRouteDefinition

CustomRPResourceTypeRouteDefinition

CustomRPValidations

Modèles de démarrage rapide

Définition de ressources de modèle ARM

Format des ressources

Valeurs de propriétés

resourceProviders

CustomRPManifestProperties

CustomRPActionRouteDefinition

CustomRPResourceTypeRouteDefinition

CustomRPValidations

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format des ressources

Valeurs de propriétés

resourceProviders

CustomRPManifestProperties

CustomRPActionRouteDefinition

CustomRPResourceTypeRouteDefinition

CustomRPValidations

Commentaires

Ressources supplémentaires