Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. core
  5. CustomProvider

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

azure.core.CustomProvider

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

    Manages an Azure Custom Provider.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleCustomProvider = new azure.core.CustomProvider("example", {
    name: "example_provider",
    location: example.location,
    resourceGroupName: example.name,
    resourceTypes: [{
        name: "dEf1",
        endpoint: "https://testendpoint.com/",
    }],
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_custom_provider = azure.core.CustomProvider("example",
    name="example_provider",
    location=example.location,
    resource_group_name=example.name,
    resource_types=[{
        "name": "dEf1",
        "endpoint": "https://testendpoint.com/",
    }])

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = core.NewCustomProvider(ctx, "example", &core.CustomProviderArgs{
			Name:              pulumi.String("example_provider"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			ResourceTypes: core.CustomProviderResourceTypeArray{
				&core.CustomProviderResourceTypeArgs{
					Name:     pulumi.String("dEf1"),
					Endpoint: pulumi.String("https://testendpoint.com/"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleCustomProvider = new Azure.Core.CustomProvider("example", new()
    {
        Name = "example_provider",
        Location = example.Location,
        ResourceGroupName = example.Name,
        ResourceTypes = new[]
        {
            new Azure.Core.Inputs.CustomProviderResourceTypeArgs
            {
                Name = "dEf1",
                Endpoint = "https://testendpoint.com/",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.core.CustomProvider;
import com.pulumi.azure.core.CustomProviderArgs;
import com.pulumi.azure.core.inputs.CustomProviderResourceTypeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleCustomProvider = new CustomProvider("exampleCustomProvider", CustomProviderArgs.builder()
            .name("example_provider")
            .location(example.location())
            .resourceGroupName(example.name())
            .resourceTypes(CustomProviderResourceTypeArgs.builder()
                .name("dEf1")
                .endpoint("https://testendpoint.com/")
                .build())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleCustomProvider:
    type: azure:core:CustomProvider
    name: example
    properties:
      name: example_provider
      location: ${example.location}
      resourceGroupName: ${example.name}
      resourceTypes:
        - name: dEf1
          endpoint: https://testendpoint.com/

    Create CustomProvider Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CustomProvider(name: string, args: CustomProviderArgs, opts?: CustomResourceOptions);
    @overload
def CustomProvider(resource_name: str,
                   args: CustomProviderArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def CustomProvider(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   resource_group_name: Optional[str] = None,
                   actions: Optional[Sequence[CustomProviderActionArgs]] = None,
                   location: Optional[str] = None,
                   name: Optional[str] = None,
                   resource_types: Optional[Sequence[CustomProviderResourceTypeArgs]] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   validations: Optional[Sequence[CustomProviderValidationArgs]] = None)
    func NewCustomProvider(ctx *Context, name string, args CustomProviderArgs, opts ...ResourceOption) (*CustomProvider, error)
    public CustomProvider(string name, CustomProviderArgs args, CustomResourceOptions? opts = null)
    public CustomProvider(String name, CustomProviderArgs args)
public CustomProvider(String name, CustomProviderArgs args, CustomResourceOptions options)

    type: azure:core:CustomProvider
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CustomProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CustomProviderArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CustomProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var customProviderResource = new Azure.Core.CustomProvider("customProviderResource", new()
{
    ResourceGroupName = "string",
    Actions = new[]
    {
        new Azure.Core.Inputs.CustomProviderActionArgs
        {
            Endpoint = "string",
            Name = "string",
        },
    },
    Location = "string",
    Name = "string",
    ResourceTypes = new[]
    {
        new Azure.Core.Inputs.CustomProviderResourceTypeArgs
        {
            Endpoint = "string",
            Name = "string",
            RoutingType = "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
    Validations = new[]
    {
        new Azure.Core.Inputs.CustomProviderValidationArgs
        {
            Specification = "string",
        },
    },
});

    example, err := core.NewCustomProvider(ctx, "customProviderResource", &core.CustomProviderArgs{
	ResourceGroupName: pulumi.String("string"),
	Actions: core.CustomProviderActionArray{
		&core.CustomProviderActionArgs{
			Endpoint: pulumi.String("string"),
			Name:     pulumi.String("string"),
		},
	},
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	ResourceTypes: core.CustomProviderResourceTypeArray{
		&core.CustomProviderResourceTypeArgs{
			Endpoint:    pulumi.String("string"),
			Name:        pulumi.String("string"),
			RoutingType: pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Validations: core.CustomProviderValidationArray{
		&core.CustomProviderValidationArgs{
			Specification: pulumi.String("string"),
		},
	},
})

    var customProviderResource = new CustomProvider("customProviderResource", CustomProviderArgs.builder()
    .resourceGroupName("string")
    .actions(CustomProviderActionArgs.builder()
        .endpoint("string")
        .name("string")
        .build())
    .location("string")
    .name("string")
    .resourceTypes(CustomProviderResourceTypeArgs.builder()
        .endpoint("string")
        .name("string")
        .routingType("string")
        .build())
    .tags(Map.of("string", "string"))
    .validations(CustomProviderValidationArgs.builder()
        .specification("string")
        .build())
    .build());

    custom_provider_resource = azure.core.CustomProvider("customProviderResource",
    resource_group_name="string",
    actions=[{
        "endpoint": "string",
        "name": "string",
    }],
    location="string",
    name="string",
    resource_types=[{
        "endpoint": "string",
        "name": "string",
        "routingType": "string",
    }],
    tags={
        "string": "string",
    },
    validations=[{
        "specification": "string",
    }])

    const customProviderResource = new azure.core.CustomProvider("customProviderResource", {
    resourceGroupName: "string",
    actions: [{
        endpoint: "string",
        name: "string",
    }],
    location: "string",
    name: "string",
    resourceTypes: [{
        endpoint: "string",
        name: "string",
        routingType: "string",
    }],
    tags: {
        string: "string",
    },
    validations: [{
        specification: "string",
    }],
});

    type: azure:core:CustomProvider
properties:
    actions:
        - endpoint: string
          name: string
    location: string
    name: string
    resourceGroupName: string
    resourceTypes:
        - endpoint: string
          name: string
          routingType: string
    tags:
        string: string
    validations:
        - specification: string

    CustomProvider Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The CustomProvider resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
    Actions List<CustomProviderAction>
    Any number of action block as defined below. One of resource_type or action must be specified.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Custom Provider. Changing this forces a new resource to be created.
    ResourceTypes List<CustomProviderResourceType>
    Any number of resource_type block as defined below. One of resource_type or action must be specified.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
    Validations List<CustomProviderValidation>
    Any number of validation block as defined below.
    ResourceGroupName string
    The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
    Actions []CustomProviderActionArgs
    Any number of action block as defined below. One of resource_type or action must be specified.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Custom Provider. Changing this forces a new resource to be created.
    ResourceTypes []CustomProviderResourceTypeArgs
    Any number of resource_type block as defined below. One of resource_type or action must be specified.
    Tags map[string]string
    A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
    Validations []CustomProviderValidationArgs
    Any number of validation block as defined below.
    resourceGroupName String
    The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
    actions List<CustomProviderAction>
    Any number of action block as defined below. One of resource_type or action must be specified.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Custom Provider. Changing this forces a new resource to be created.
    resourceTypes List<CustomProviderResourceType>
    Any number of resource_type block as defined below. One of resource_type or action must be specified.
    tags Map<String,String>
    A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
    validations List<CustomProviderValidation>
    Any number of validation block as defined below.
    resourceGroupName string
    The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
    actions CustomProviderAction[]
    Any number of action block as defined below. One of resource_type or action must be specified.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name string
    Specifies the name of the Custom Provider. Changing this forces a new resource to be created.
    resourceTypes CustomProviderResourceType[]
    Any number of resource_type block as defined below. One of resource_type or action must be specified.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
    validations CustomProviderValidation[]
    Any number of validation block as defined below.
    resource_group_name str
    The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
    actions Sequence[CustomProviderActionArgs]
    Any number of action block as defined below. One of resource_type or action must be specified.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name str
    Specifies the name of the Custom Provider. Changing this forces a new resource to be created.
    resource_types Sequence[CustomProviderResourceTypeArgs]
    Any number of resource_type block as defined below. One of resource_type or action must be specified.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
    validations Sequence[CustomProviderValidationArgs]
    Any number of validation block as defined below.
    resourceGroupName String
    The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
    actions List<Property Map>
    Any number of action block as defined below. One of resource_type or action must be specified.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Custom Provider. Changing this forces a new resource to be created.
    resourceTypes List<Property Map>
    Any number of resource_type block as defined below. One of resource_type or action must be specified.
    tags Map<String>
    A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
    validations List<Property Map>
    Any number of validation block as defined below.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CustomProvider resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CustomProvider Resource

    Get an existing CustomProvider resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CustomProviderState, opts?: CustomResourceOptions): CustomProvider
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        actions: Optional[Sequence[CustomProviderActionArgs]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        resource_types: Optional[Sequence[CustomProviderResourceTypeArgs]] = None,
        tags: Optional[Mapping[str, str]] = None,
        validations: Optional[Sequence[CustomProviderValidationArgs]] = None) -> CustomProvider
    func GetCustomProvider(ctx *Context, name string, id IDInput, state *CustomProviderState, opts ...ResourceOption) (*CustomProvider, error)
    public static CustomProvider Get(string name, Input<string> id, CustomProviderState? state, CustomResourceOptions? opts = null)
    public static CustomProvider get(String name, Output<String> id, CustomProviderState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Actions List<CustomProviderAction>
    Any number of action block as defined below. One of resource_type or action must be specified.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Custom Provider. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
    ResourceTypes List<CustomProviderResourceType>
    Any number of resource_type block as defined below. One of resource_type or action must be specified.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
    Validations List<CustomProviderValidation>
    Any number of validation block as defined below.
    Actions []CustomProviderActionArgs
    Any number of action block as defined below. One of resource_type or action must be specified.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of the Custom Provider. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
    ResourceTypes []CustomProviderResourceTypeArgs
    Any number of resource_type block as defined below. One of resource_type or action must be specified.
    Tags map[string]string
    A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
    Validations []CustomProviderValidationArgs
    Any number of validation block as defined below.
    actions List<CustomProviderAction>
    Any number of action block as defined below. One of resource_type or action must be specified.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Custom Provider. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
    resourceTypes List<CustomProviderResourceType>
    Any number of resource_type block as defined below. One of resource_type or action must be specified.
    tags Map<String,String>
    A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
    validations List<CustomProviderValidation>
    Any number of validation block as defined below.
    actions CustomProviderAction[]
    Any number of action block as defined below. One of resource_type or action must be specified.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name string
    Specifies the name of the Custom Provider. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
    resourceTypes CustomProviderResourceType[]
    Any number of resource_type block as defined below. One of resource_type or action must be specified.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
    validations CustomProviderValidation[]
    Any number of validation block as defined below.
    actions Sequence[CustomProviderActionArgs]
    Any number of action block as defined below. One of resource_type or action must be specified.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name str
    Specifies the name of the Custom Provider. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
    resource_types Sequence[CustomProviderResourceTypeArgs]
    Any number of resource_type block as defined below. One of resource_type or action must be specified.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
    validations Sequence[CustomProviderValidationArgs]
    Any number of validation block as defined below.
    actions List<Property Map>
    Any number of action block as defined below. One of resource_type or action must be specified.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of the Custom Provider. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
    resourceTypes List<Property Map>
    Any number of resource_type block as defined below. One of resource_type or action must be specified.
    tags Map<String>
    A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
    validations List<Property Map>
    Any number of validation block as defined below.

    Supporting Types

    CustomProviderAction, CustomProviderActionArgs

    Endpoint string
    Specifies the endpoint of the action.
    Name string
    Specifies the name of the action.
    Endpoint string
    Specifies the endpoint of the action.
    Name string
    Specifies the name of the action.
    endpoint String
    Specifies the endpoint of the action.
    name String
    Specifies the name of the action.
    endpoint string
    Specifies the endpoint of the action.
    name string
    Specifies the name of the action.
    endpoint str
    Specifies the endpoint of the action.
    name str
    Specifies the name of the action.
    endpoint String
    Specifies the endpoint of the action.
    name String
    Specifies the name of the action.

    CustomProviderResourceType, CustomProviderResourceTypeArgs

    Endpoint string
    Specifies the endpoint of the route definition.
    Name string
    Specifies the name of the route definition.
    RoutingType string
    The routing type that is supported for the resource request. Valid values are Proxy and Proxy,Cache. Defaults to Proxy.
    Endpoint string
    Specifies the endpoint of the route definition.
    Name string
    Specifies the name of the route definition.
    RoutingType string
    The routing type that is supported for the resource request. Valid values are Proxy and Proxy,Cache. Defaults to Proxy.
    endpoint String
    Specifies the endpoint of the route definition.
    name String
    Specifies the name of the route definition.
    routingType String
    The routing type that is supported for the resource request. Valid values are Proxy and Proxy,Cache. Defaults to Proxy.
    endpoint string
    Specifies the endpoint of the route definition.
    name string
    Specifies the name of the route definition.
    routingType string
    The routing type that is supported for the resource request. Valid values are Proxy and Proxy,Cache. Defaults to Proxy.
    endpoint str
    Specifies the endpoint of the route definition.
    name str
    Specifies the name of the route definition.
    routing_type str
    The routing type that is supported for the resource request. Valid values are Proxy and Proxy,Cache. Defaults to Proxy.
    endpoint String
    Specifies the endpoint of the route definition.
    name String
    Specifies the name of the route definition.
    routingType String
    The routing type that is supported for the resource request. Valid values are Proxy and Proxy,Cache. Defaults to Proxy.

    CustomProviderValidation, CustomProviderValidationArgs

    Specification string
    The endpoint where the validation specification is located.
    Specification string
    The endpoint where the validation specification is located.
    specification String
    The endpoint where the validation specification is located.
    specification string
    The endpoint where the validation specification is located.
    specification str
    The endpoint where the validation specification is located.
    specification String
    The endpoint where the validation specification is located.

    Import

    Custom Provider can be imported using the resource id, e.g.

    $ pulumi import azure:core/customProvider:CustomProvider example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.CustomProviders/resourceProviders/example

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-azure