azure-native-v2.engagementfabric.Channel
Explore with Pulumi AI
The EngagementFabric channel Azure REST API version: 2018-09-01-preview. Prior API version in Azure Native 1.x: 2018-09-01-preview.
Create Channel Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Channel(name: string, args: ChannelArgs, opts?: CustomResourceOptions);
@overload
def Channel(resource_name: str,
args: ChannelArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Channel(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_name: Optional[str] = None,
channel_type: Optional[str] = None,
resource_group_name: Optional[str] = None,
channel_functions: Optional[Sequence[str]] = None,
channel_name: Optional[str] = None,
credentials: Optional[Mapping[str, str]] = None)
func NewChannel(ctx *Context, name string, args ChannelArgs, opts ...ResourceOption) (*Channel, error)
public Channel(string name, ChannelArgs args, CustomResourceOptions? opts = null)
public Channel(String name, ChannelArgs args)
public Channel(String name, ChannelArgs args, CustomResourceOptions options)
type: azure-native:engagementfabric:Channel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ChannelArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. ChannelArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ChannelArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ChannelArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. ChannelArgs - 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 azure_nativeChannelResource = new AzureNative.Engagementfabric.Channel("azure-nativeChannelResource", new()
{
AccountName = "string",
ChannelType = "string",
ResourceGroupName = "string",
ChannelFunctions = new[]
{
"string",
},
ChannelName = "string",
Credentials =
{
{ "string", "string" },
},
});
example, err := engagementfabric.NewChannel(ctx, "azure-nativeChannelResource", &engagementfabric.ChannelArgs{
AccountName: "string",
ChannelType: "string",
ResourceGroupName: "string",
ChannelFunctions: []string{
"string",
},
ChannelName: "string",
Credentials: map[string]interface{}{
"string": "string",
},
})
var azure_nativeChannelResource = new Channel("azure-nativeChannelResource", ChannelArgs.builder()
.accountName("string")
.channelType("string")
.resourceGroupName("string")
.channelFunctions("string")
.channelName("string")
.credentials(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build());
azure_native_channel_resource = azure_native.engagementfabric.Channel("azure-nativeChannelResource",
account_name=string,
channel_type=string,
resource_group_name=string,
channel_functions=[string],
channel_name=string,
credentials={
string: string,
})
const azure_nativeChannelResource = new azure_native.engagementfabric.Channel("azure-nativeChannelResource", {
accountName: "string",
channelType: "string",
resourceGroupName: "string",
channelFunctions: ["string"],
channelName: "string",
credentials: {
string: "string",
},
});
type: azure-native:engagementfabric:Channel
properties:
accountName: string
channelFunctions:
- string
channelName: string
channelType: string
credentials:
string: string
resourceGroupName: string
Channel Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Channel resource accepts the following input properties:
- Account
Name This property is required. Changes to this property will trigger replacement.
- Account Name
- Channel
Type This property is required. string - The channel type
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- Resource Group Name
- Channel
Functions List<string> - The functions to be enabled for the channel
- Channel
Name Changes to this property will trigger replacement.
- Channel Name
- Credentials Dictionary<string, string>
- The channel credentials
- Account
Name This property is required. Changes to this property will trigger replacement.
- Account Name
- Channel
Type This property is required. string - The channel type
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- Resource Group Name
- Channel
Functions []string - The functions to be enabled for the channel
- Channel
Name Changes to this property will trigger replacement.
- Channel Name
- Credentials map[string]string
- The channel credentials
- account
Name This property is required. Changes to this property will trigger replacement.
- Account Name
- channel
Type This property is required. String - The channel type
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Resource Group Name
- channel
Functions List<String> - The functions to be enabled for the channel
- channel
Name Changes to this property will trigger replacement.
- Channel Name
- credentials Map<String,String>
- The channel credentials
- account
Name This property is required. Changes to this property will trigger replacement.
- Account Name
- channel
Type This property is required. string - The channel type
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Resource Group Name
- channel
Functions string[] - The functions to be enabled for the channel
- channel
Name Changes to this property will trigger replacement.
- Channel Name
- credentials {[key: string]: string}
- The channel credentials
- account_
name This property is required. Changes to this property will trigger replacement.
- Account Name
- channel_
type This property is required. str - The channel type
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- Resource Group Name
- channel_
functions Sequence[str] - The functions to be enabled for the channel
- channel_
name Changes to this property will trigger replacement.
- Channel Name
- credentials Mapping[str, str]
- The channel credentials
- account
Name This property is required. Changes to this property will trigger replacement.
- Account Name
- channel
Type This property is required. String - The channel type
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Resource Group Name
- channel
Functions List<String> - The functions to be enabled for the channel
- channel
Name Changes to this property will trigger replacement.
- Channel Name
- credentials Map<String>
- The channel credentials
Outputs
All input properties are implicitly available as output properties. Additionally, the Channel resource produces the following output properties:
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:engagementfabric:Channel ExampleChannel /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/Channels/{channelName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0