Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.14.0 published on Thursday, Jul 28, 2022 by Pulumi

CustomProvider

Manages an Azure Custom Provider.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleCustomProvider = new Azure.Core.CustomProvider("exampleCustomProvider", new Azure.Core.CustomProviderArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            ResourceTypes = 
            {
                new Azure.Core.Inputs.CustomProviderResourceTypeArgs
                {
                    Name = "dEf1",
                    Endpoint = "https://testendpoint.com/",
                },
            },
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = core.NewCustomProvider(ctx, "exampleCustomProvider", &core.CustomProviderArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			ResourceTypes: core.CustomProviderResourceTypeArray{
				&core.CustomProviderResourceTypeArgs{
					Name:     pulumi.String("dEf1"),
					Endpoint: pulumi.String("https://testendpoint.com/"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

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

    }
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_custom_provider = azure.core.CustomProvider("exampleCustomProvider",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    resource_types=[azure.core.CustomProviderResourceTypeArgs(
        name="dEf1",
        endpoint="https://testendpoint.com/",
    )])
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

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

Create a CustomProvider Resource

new CustomProvider(name: string, args: CustomProviderArgs, opts?: CustomResourceOptions);
@overload
def CustomProvider(resource_name: 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)
@overload
def CustomProvider(resource_name: str,
                   args: CustomProviderArgs,
                   opts: Optional[ResourceOptions] = 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.

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.

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.

Actions List<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 List<CustomProviderResourceTypeArgs>

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.

Validations List<CustomProviderValidationArgs>

Any number of validation block as defined below.

ResourceGroupName string

The name of the resource group in which to create the Custom Provider.

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.

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.

actions List<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 List<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.

validations List<CustomProviderValidationArgs>

Any number of validation block as defined below.

resourceGroupName string

The name of the resource group in which to create the Custom Provider.

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 {[key: string]: string}

A mapping of tags to assign to the resource.

validations CustomProviderValidationArgs[]

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.

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.

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.

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.

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 an 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<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.

ResourceTypes List<CustomProviderResourceTypeArgs>

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.

Validations List<CustomProviderValidationArgs>

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.

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.

Validations []CustomProviderValidationArgs

Any number of validation block as defined below.

actions List<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.

resourceTypes List<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.

validations List<CustomProviderValidationArgs>

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.

resourceTypes CustomProviderResourceTypeArgs[]

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.

validations CustomProviderValidationArgs[]

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.

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.

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.

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.

validations List<Property Map>

Any number of validation block as defined below.

Supporting Types

CustomProviderAction

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

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 ResourceTypeRoutingProxy or ResourceTypeRoutingProxyCache. This value defaults to ResourceTypeRoutingProxy.

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 ResourceTypeRoutingProxy or ResourceTypeRoutingProxyCache. This value defaults to ResourceTypeRoutingProxy.

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 ResourceTypeRoutingProxy or ResourceTypeRoutingProxyCache. This value defaults to ResourceTypeRoutingProxy.

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 ResourceTypeRoutingProxy or ResourceTypeRoutingProxyCache. This value defaults to ResourceTypeRoutingProxy.

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 ResourceTypeRoutingProxy or ResourceTypeRoutingProxyCache. This value defaults to ResourceTypeRoutingProxy.

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 ResourceTypeRoutingProxy or ResourceTypeRoutingProxyCache. This value defaults to ResourceTypeRoutingProxy.

CustomProviderValidation

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.