Fork me on GitHub

Module iot

@pulumi/azure > iot

Index

iot/ioTHub.ts

class IoTHub

Manages a IotHub

constructor

new IoTHub(name: string, args: IoTHubArgs, opts?: pulumi.CustomResourceOptions)

Create a IoTHub resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IoTHubState): IoTHub

Get an existing IoTHub resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property endpoints

public endpoints: pulumi.Output<{ ... }[] | undefined>;

An endpoint block as defined below.

property eventHubEventsEndpoint

public eventHubEventsEndpoint: pulumi.Output<string>;

The EventHub compatible endpoint for events data

property eventHubEventsPath

public eventHubEventsPath: pulumi.Output<string>;

The EventHub compatible path for events data

property eventHubOperationsEndpoint

public eventHubOperationsEndpoint: pulumi.Output<string>;

The EventHub compatible endpoint for operational data

property eventHubOperationsPath

public eventHubOperationsPath: pulumi.Output<string>;

The EventHub compatible path for operational data

property hostname

public hostname: pulumi.Output<string>;

The hostname of the IotHub Resource.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

Specifies the name of the IotHub resource. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.

property routes

public routes: pulumi.Output<{ ... }[] | undefined>;

A route block as defined below.

property sharedAccessPolicies

public sharedAccessPolicies: pulumi.Output<{ ... }[]>;

One or more shared_access_policy blocks as defined below.

property sku

public sku: pulumi.Output<{ ... }>;

A sku block as defined below.

property tags

public tags: pulumi.Output<{ ... }>;

A mapping of tags to assign to the resource.

property type

public type: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

interface IoTHubArgs

The set of arguments for constructing a IoTHub resource.

property endpoints

endpoints?: pulumi.Input<pulumi.Input<{ ... }>[]>;

An endpoint block as defined below.

property location

location: pulumi.Input<string>;

Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the IotHub resource. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.

property routes

routes?: pulumi.Input<pulumi.Input<{ ... }>[]>;

A route block as defined below.

property sku

sku: pulumi.Input<{ ... }>;

A sku block as defined below.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

interface IoTHubState

Input properties used for looking up and filtering IoTHub resources.

property endpoints

endpoints?: pulumi.Input<pulumi.Input<{ ... }>[]>;

An endpoint block as defined below.

property eventHubEventsEndpoint

eventHubEventsEndpoint?: pulumi.Input<string>;

The EventHub compatible endpoint for events data

property eventHubEventsPath

eventHubEventsPath?: pulumi.Input<string>;

The EventHub compatible path for events data

property eventHubOperationsEndpoint

eventHubOperationsEndpoint?: pulumi.Input<string>;

The EventHub compatible endpoint for operational data

property eventHubOperationsPath

eventHubOperationsPath?: pulumi.Input<string>;

The EventHub compatible path for operational data

property hostname

hostname?: pulumi.Input<string>;

The hostname of the IotHub Resource.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the IotHub resource. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.

property routes

routes?: pulumi.Input<pulumi.Input<{ ... }>[]>;

A route block as defined below.

property sharedAccessPolicies

sharedAccessPolicies?: pulumi.Input<pulumi.Input<{ ... }>[]>;

One or more shared_access_policy blocks as defined below.

property sku

sku?: pulumi.Input<{ ... }>;

A sku block as defined below.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

property type

type?: pulumi.Input<string>;