We recommend using Azure Native.
azure.core.CustomProvider
Explore with Pulumi AI
Manages an Azure Custom Provider.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var exampleCustomProvider = new Azure.Core.CustomProvider("exampleCustomProvider", new()
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
ResourceTypes = new[]
{
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 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:
- Resource
Group stringName The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
- Actions
List<Custom
Provider Action> Any number of
action
block as defined below. One ofresource_type
oraction
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.
- Resource
Types List<CustomProvider Resource Type> Any number of
resource_type
block as defined below. One ofresource_type
oraction
must be specified.- Dictionary<string, string>
A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- Validations
List<Custom
Provider Validation> Any number of
validation
block as defined below.
- Resource
Group stringName The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
- Actions
[]Custom
Provider Action Args Any number of
action
block as defined below. One ofresource_type
oraction
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.
- Resource
Types []CustomProvider Resource Type Args Any number of
resource_type
block as defined below. One ofresource_type
oraction
must be specified.- map[string]string
A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- Validations
[]Custom
Provider Validation Args Any number of
validation
block as defined below.
- resource
Group StringName The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
- actions
List<Custom
Provider Action> Any number of
action
block as defined below. One ofresource_type
oraction
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.
- resource
Types List<CustomProvider Resource Type> Any number of
resource_type
block as defined below. One ofresource_type
oraction
must be specified.- Map<String,String>
A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- validations
List<Custom
Provider Validation> Any number of
validation
block as defined below.
- resource
Group stringName The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
- actions
Custom
Provider Action[] Any number of
action
block as defined below. One ofresource_type
oraction
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.
- resource
Types CustomProvider Resource Type[] Any number of
resource_type
block as defined below. One ofresource_type
oraction
must be specified.- {[key: string]: string}
A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- validations
Custom
Provider Validation[] Any number of
validation
block as defined below.
- resource_
group_ strname The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
- actions
Sequence[Custom
Provider Action Args] Any number of
action
block as defined below. One ofresource_type
oraction
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[CustomProvider Resource Type Args] Any number of
resource_type
block as defined below. One ofresource_type
oraction
must be specified.- Mapping[str, str]
A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- validations
Sequence[Custom
Provider Validation Args] Any number of
validation
block as defined below.
- resource
Group StringName 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 ofresource_type
oraction
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.
- resource
Types List<Property Map> Any number of
resource_type
block as defined below. One ofresource_type
oraction
must be specified.- 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.
- Actions
List<Custom
Provider Action> Any number of
action
block as defined below. One ofresource_type
oraction
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.
- Resource
Group stringName The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
- Resource
Types List<CustomProvider Resource Type> Any number of
resource_type
block as defined below. One ofresource_type
oraction
must be specified.- Dictionary<string, string>
A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- Validations
List<Custom
Provider Validation> Any number of
validation
block as defined below.
- Actions
[]Custom
Provider Action Args Any number of
action
block as defined below. One ofresource_type
oraction
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.
- Resource
Group stringName The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
- Resource
Types []CustomProvider Resource Type Args Any number of
resource_type
block as defined below. One ofresource_type
oraction
must be specified.- map[string]string
A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- Validations
[]Custom
Provider Validation Args Any number of
validation
block as defined below.
- actions
List<Custom
Provider Action> Any number of
action
block as defined below. One ofresource_type
oraction
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.
- resource
Group StringName The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
- resource
Types List<CustomProvider Resource Type> Any number of
resource_type
block as defined below. One ofresource_type
oraction
must be specified.- Map<String,String>
A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- validations
List<Custom
Provider Validation> Any number of
validation
block as defined below.
- actions
Custom
Provider Action[] Any number of
action
block as defined below. One ofresource_type
oraction
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.
- resource
Group stringName The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
- resource
Types CustomProvider Resource Type[] Any number of
resource_type
block as defined below. One ofresource_type
oraction
must be specified.- {[key: string]: string}
A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- validations
Custom
Provider Validation[] Any number of
validation
block as defined below.
- actions
Sequence[Custom
Provider Action Args] Any number of
action
block as defined below. One ofresource_type
oraction
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_ strname 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[CustomProvider Resource Type Args] Any number of
resource_type
block as defined below. One ofresource_type
oraction
must be specified.- Mapping[str, str]
A mapping of tags to assign to the resource. Changing this forces a new resource to be created.
- validations
Sequence[Custom
Provider Validation Args] Any number of
validation
block as defined below.
- actions List<Property Map>
Any number of
action
block as defined below. One ofresource_type
oraction
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.
- resource
Group StringName The name of the resource group in which to create the Custom Provider. Changing this forces a new resource to be created.
- resource
Types List<Property Map> Any number of
resource_type
block as defined below. One ofresource_type
oraction
must be specified.- 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
CustomProviderResourceType, CustomProviderResourceTypeArgs
- Endpoint string
Specifies the endpoint of the route definition.
- Name string
Specifies the name of the route definition.
- Routing
Type string The routing type that is supported for the resource request. Valid values are
Proxy
andProxy,Cache
. This value defaults toResourceTypeRoutingProxy
.
- Endpoint string
Specifies the endpoint of the route definition.
- Name string
Specifies the name of the route definition.
- Routing
Type string The routing type that is supported for the resource request. Valid values are
Proxy
andProxy,Cache
. This value defaults toResourceTypeRoutingProxy
.
- endpoint String
Specifies the endpoint of the route definition.
- name String
Specifies the name of the route definition.
- routing
Type String The routing type that is supported for the resource request. Valid values are
Proxy
andProxy,Cache
. This value defaults toResourceTypeRoutingProxy
.
- endpoint string
Specifies the endpoint of the route definition.
- name string
Specifies the name of the route definition.
- routing
Type string The routing type that is supported for the resource request. Valid values are
Proxy
andProxy,Cache
. This value defaults toResourceTypeRoutingProxy
.
- 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
andProxy,Cache
. This value defaults toResourceTypeRoutingProxy
.
- endpoint String
Specifies the endpoint of the route definition.
- name String
Specifies the name of the route definition.
- routing
Type String The routing type that is supported for the resource request. Valid values are
Proxy
andProxy,Cache
. This value defaults toResourceTypeRoutingProxy
.
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
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.