1. Packages
  2. Azure Native v2
  3. API Docs
  4. engagementfabric
  5. Channel
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.engagementfabric.Channel

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

The EngagementFabric channel Azure REST API version: 2018-09-01-preview. Prior API version in Azure Native 1.x: 2018-09-01-preview.

Example Usage

ChannelsCreateOrUpdateExample

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

return await Deployment.RunAsync(() => 
{
    var channel = new AzureNative.EngagementFabric.Channel("channel", new()
    {
        AccountName = "ExampleAccount",
        ChannelFunctions = new[]
        {
            "MockFunction1",
            "MockFunction2",
        },
        ChannelName = "ExampleChannel",
        ChannelType = "MockChannel",
        Credentials = 
        {
            { "AppId", "exampleApp" },
            { "AppKey", "exampleAppKey" },
        },
        ResourceGroupName = "ExampleRg",
    });

});
Copy
package main

import (
	engagementfabric "github.com/pulumi/pulumi-azure-native-sdk/engagementfabric/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := engagementfabric.NewChannel(ctx, "channel", &engagementfabric.ChannelArgs{
			AccountName: pulumi.String("ExampleAccount"),
			ChannelFunctions: pulumi.StringArray{
				pulumi.String("MockFunction1"),
				pulumi.String("MockFunction2"),
			},
			ChannelName: pulumi.String("ExampleChannel"),
			ChannelType: pulumi.String("MockChannel"),
			Credentials: pulumi.StringMap{
				"AppId":  pulumi.String("exampleApp"),
				"AppKey": pulumi.String("exampleAppKey"),
			},
			ResourceGroupName: pulumi.String("ExampleRg"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.engagementfabric.Channel;
import com.pulumi.azurenative.engagementfabric.ChannelArgs;
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 channel = new Channel("channel", ChannelArgs.builder()
            .accountName("ExampleAccount")
            .channelFunctions(            
                "MockFunction1",
                "MockFunction2")
            .channelName("ExampleChannel")
            .channelType("MockChannel")
            .credentials(Map.ofEntries(
                Map.entry("AppId", "exampleApp"),
                Map.entry("AppKey", "exampleAppKey")
            ))
            .resourceGroupName("ExampleRg")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const channel = new azure_native.engagementfabric.Channel("channel", {
    accountName: "ExampleAccount",
    channelFunctions: [
        "MockFunction1",
        "MockFunction2",
    ],
    channelName: "ExampleChannel",
    channelType: "MockChannel",
    credentials: {
        AppId: "exampleApp",
        AppKey: "exampleAppKey",
    },
    resourceGroupName: "ExampleRg",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

channel = azure_native.engagementfabric.Channel("channel",
    account_name="ExampleAccount",
    channel_functions=[
        "MockFunction1",
        "MockFunction2",
    ],
    channel_name="ExampleChannel",
    channel_type="MockChannel",
    credentials={
        "AppId": "exampleApp",
        "AppKey": "exampleAppKey",
    },
    resource_group_name="ExampleRg")
Copy
resources:
  channel:
    type: azure-native:engagementfabric:Channel
    properties:
      accountName: ExampleAccount
      channelFunctions:
        - MockFunction1
        - MockFunction2
      channelName: ExampleChannel
      channelType: MockChannel
      credentials:
        AppId: exampleApp
        AppKey: exampleAppKey
      resourceGroupName: ExampleRg
Copy

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" },
    },
});
Copy
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",
	},
})
Copy
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());
Copy
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,
    })
Copy
const azure_nativeChannelResource = new azure_native.engagementfabric.Channel("azure-nativeChannelResource", {
    accountName: "string",
    channelType: "string",
    resourceGroupName: "string",
    channelFunctions: ["string"],
    channelName: "string",
    credentials: {
        string: "string",
    },
});
Copy
type: azure-native:engagementfabric:Channel
properties:
    accountName: string
    channelFunctions:
        - string
    channelName: string
    channelType: string
    credentials:
        string: string
    resourceGroupName: string
Copy

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:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
Account Name
ChannelType This property is required. string
The channel type
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Resource Group Name
ChannelFunctions List<string>
The functions to be enabled for the channel
ChannelName Changes to this property will trigger replacement. string
Channel Name
Credentials Dictionary<string, string>
The channel credentials
AccountName
This property is required.
Changes to this property will trigger replacement.
string
Account Name
ChannelType This property is required. string
The channel type
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Resource Group Name
ChannelFunctions []string
The functions to be enabled for the channel
ChannelName Changes to this property will trigger replacement. string
Channel Name
Credentials map[string]string
The channel credentials
accountName
This property is required.
Changes to this property will trigger replacement.
String
Account Name
channelType This property is required. String
The channel type
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Resource Group Name
channelFunctions List<String>
The functions to be enabled for the channel
channelName Changes to this property will trigger replacement. String
Channel Name
credentials Map<String,String>
The channel credentials
accountName
This property is required.
Changes to this property will trigger replacement.
string
Account Name
channelType This property is required. string
The channel type
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Resource Group Name
channelFunctions string[]
The functions to be enabled for the channel
channelName Changes to this property will trigger replacement. string
Channel Name
credentials {[key: string]: string}
The channel credentials
account_name
This property is required.
Changes to this property will trigger replacement.
str
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.
str
Resource Group Name
channel_functions Sequence[str]
The functions to be enabled for the channel
channel_name Changes to this property will trigger replacement. str
Channel Name
credentials Mapping[str, str]
The channel credentials
accountName
This property is required.
Changes to this property will trigger replacement.
String
Account Name
channelType This property is required. String
The channel type
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Resource Group Name
channelFunctions List<String>
The functions to be enabled for the channel
channelName Changes to this property will trigger replacement. String
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:

Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Type string
The fully qualified type of the resource
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Type string
The fully qualified type of the resource
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
type String
The fully qualified type of the resource
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
type string
The fully qualified type of the resource
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
type str
The fully qualified type of the resource
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
type String
The fully qualified type of the resource

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} 
Copy

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
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi