Skip to content

azurermCustomProvider

Manages an Azure Custom Provider.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const azurermResourceGroupExample = new azurerm.resourceGroup.ResourceGroup(
  this,
  "example",
  {
    location: "West Europe",
    name: "example-resources",
  }
);
const azurermCustomProviderExample = new azurerm.customProvider.CustomProvider(
  this,
  "example_1",
  {
    location: azurermResourceGroupExample.location,
    name: "example_provider",
    resource_group_name: azurermResourceGroupExample.name,
    resource_type: [
      {
        endpoint: "https://testendpoint.com/",
        name: "dEf1",
      },
    ],
  }
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermCustomProviderExample.overrideLogicalId("example");

Argument Reference

The following arguments are supported:

  • name - (Required) Specifies the name of the Custom Provider. Changing this forces a new resource to be created.

  • resourceGroupName - (Required) The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.

  • location - (Required) Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • resourceType - (Optional) Any number of resourceType block as defined below. One of resourceType or action must be specified.

  • action - (Optional) Any number of action block as defined below. One of resourceType or action must be specified.

  • validation - (Optional) Any number of validation block as defined below.

  • tags - (Optional) A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

A resourceType block supports the following:

  • name - (Required) Specifies the name of the route definition.

  • endpoint - (Required) Specifies the endpoint of the route definition.

  • routingType - (Optional) The routing type that is supported for the resource request. Valid values are proxy and proxy,cache. This value defaults to resourceTypeRoutingProxy.

A action block supports the following:

  • name - (Required) Specifies the name of the action.

  • endpoint - (Required) Specifies the endpoint of the action.

A validation block supports the following:

  • specification - (Required) The endpoint where the validation specification is located.

Attributes Reference

The following attributes are exported:

  • id - The ID of the Custom Provider.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • create - (Defaults to 30 minutes) Used when creating the resource.
  • update - (Defaults to 30 minutes) Used when updating the resource.
  • read - (Defaults to 5 minutes) Used when retrieving the resource.
  • delete - (Defaults to 30 minutes) Used when deleting the resource.

Import

Custom Provider can be imported using the resourceId, e.g.

terraform import azurerm_custom_provider.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.CustomProviders/resourceProviders/example