UNPKG

@pulumi/azure-native

Version:

[![Slack](http://www.pulumi.com/images/docs/badges/slack.svg)](https://slack.pulumi.com) [![NPM version](https://badge.fury.io/js/%40pulumi%2Fazure-native.svg)](https://npmjs.com/package/@pulumi/azure-native) [![Python version](https://badge.fury.io/py/pu

119 lines (118 loc) 5.1 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; import * as enums from "../types/enums"; /** * Channel info. * * Uses Azure REST API version 2025-02-15. In version 2.x of the Azure Native provider, it used API version 2022-06-15. * * Other available API versions: 2022-06-15, 2023-06-01-preview, 2023-12-15-preview, 2024-06-01-preview, 2024-12-15-preview, 2025-04-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native eventgrid [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details. */ export declare class Channel extends pulumi.CustomResource { /** * Get an existing Channel resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Channel; /** * Returns true if the given object is an instance of Channel. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Channel; /** * The Azure API version of the resource. */ readonly azureApiVersion: pulumi.Output<string>; /** * The type of the event channel which represents the direction flow of events. */ readonly channelType: pulumi.Output<string | undefined>; /** * Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, * the channel and corresponding partner topic are deleted. */ readonly expirationTimeIfNotActivatedUtc: pulumi.Output<string | undefined>; /** * Context or helpful message that can be used during the approval process by the subscriber. */ readonly messageForActivation: pulumi.Output<string | undefined>; /** * Name of the resource. */ readonly name: pulumi.Output<string>; /** * This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel. */ readonly partnerTopicInfo: pulumi.Output<outputs.eventgrid.PartnerTopicInfoResponse | undefined>; /** * Provisioning state of the channel. */ readonly provisioningState: pulumi.Output<string | undefined>; /** * The readiness state of the corresponding partner topic. */ readonly readinessState: pulumi.Output<string | undefined>; /** * The system metadata relating to the Event Grid resource. */ readonly systemData: pulumi.Output<outputs.eventgrid.SystemDataResponse>; /** * Type of the resource. */ readonly type: pulumi.Output<string>; /** * Create a Channel resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: ChannelArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a Channel resource. */ export interface ChannelArgs { /** * Name of the channel. */ channelName?: pulumi.Input<string>; /** * The type of the event channel which represents the direction flow of events. */ channelType?: pulumi.Input<string | enums.eventgrid.ChannelType>; /** * Expiration time of the channel. If this timer expires while the corresponding partner topic is never activated, * the channel and corresponding partner topic are deleted. */ expirationTimeIfNotActivatedUtc?: pulumi.Input<string>; /** * Context or helpful message that can be used during the approval process by the subscriber. */ messageForActivation?: pulumi.Input<string>; /** * Name of the partner namespace. */ partnerNamespaceName: pulumi.Input<string>; /** * This property should be populated when channelType is PartnerTopic and represents information about the partner topic resource corresponding to the channel. */ partnerTopicInfo?: pulumi.Input<inputs.eventgrid.PartnerTopicInfoArgs>; /** * Provisioning state of the channel. */ provisioningState?: pulumi.Input<string | enums.eventgrid.ChannelProvisioningState>; /** * The readiness state of the corresponding partner topic. */ readinessState?: pulumi.Input<string | enums.eventgrid.ReadinessState>; /** * The name of the resource group within the partners subscription. */ resourceGroupName: pulumi.Input<string>; }