iot

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 4, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

nolint: lll Package iot exports types, functions, subpackages for provisioning iot resources.

> This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-azurerm) > distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature, > first check the [`pulumi/pulumi-azure` repo](https://github.com/pulumi/pulumi-azure/issues); however, if that doesn't turn up anything, > please consult the source [`terraform-providers/terraform-provider-azurerm` repo](https://github.com/terraform-providers/terraform-provider-azurerm/issues).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Certificate added in v0.19.1 

type Certificate struct {
	// contains filtered or unexported fields
}

Manages an IoT Device Provisioning Service Certificate.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/iot_dps_certificate.html.markdown.

func GetCertificate added in v0.19.1 

func GetCertificate(ctx *pulumi.Context,
	name string, id pulumi.ID, state *CertificateState, opts ...pulumi.ResourceOpt) (*Certificate, error)

GetCertificate gets an existing Certificate resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCertificate added in v0.19.1 

func NewCertificate(ctx *pulumi.Context,
	name string, args *CertificateArgs, opts ...pulumi.ResourceOpt) (*Certificate, error)

NewCertificate registers a new resource with the given unique name, arguments, and options.

func (*Certificate) CertificateContent added in v0.19.1 

func (r *Certificate) CertificateContent() *pulumi.StringOutput

The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.

func (*Certificate) ID added in v0.19.1 

func (r *Certificate) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Certificate) IotDpsName added in v0.19.1 

func (r *Certificate) IotDpsName() *pulumi.StringOutput

The name of the IoT Device Provisioning Service that this certificate will be attached to. Changing this forces a new resource to be created.

func (*Certificate) Name added in v0.19.1 

func (r *Certificate) Name() *pulumi.StringOutput

Specifies the name of the Iot Device Provisioning Service Certificate resource. Changing this forces a new resource to be created.

func (*Certificate) ResourceGroupName added in v0.19.1 

func (r *Certificate) ResourceGroupName() *pulumi.StringOutput

The name of the resource group under which the Iot Device Provisioning Service Certificate resource has to be created. Changing this forces a new resource to be created.

func (*Certificate) URN added in v0.19.1 

func (r *Certificate) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type CertificateArgs added in v0.19.1 

type CertificateArgs struct {
	// The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.
	CertificateContent interface{}
	// The name of the IoT Device Provisioning Service that this certificate will be attached to. Changing this forces a new resource to be created.
	IotDpsName interface{}
	// Specifies the name of the Iot Device Provisioning Service Certificate resource. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the resource group under which the Iot Device Provisioning Service Certificate resource has to be created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
}

The set of arguments for constructing a Certificate resource.

type CertificateState added in v0.19.1 

type CertificateState struct {
	// The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.
	CertificateContent interface{}
	// The name of the IoT Device Provisioning Service that this certificate will be attached to. Changing this forces a new resource to be created.
	IotDpsName interface{}
	// Specifies the name of the Iot Device Provisioning Service Certificate resource. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the resource group under which the Iot Device Provisioning Service Certificate resource has to be created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
}

Input properties used for looking up and filtering Certificate resources.

type ConsumerGroup added in v0.16.5 

type ConsumerGroup struct {
	// contains filtered or unexported fields
}

Manages a Consumer Group within an IotHub

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/iothub_consumer_group.html.markdown.

func GetConsumerGroup added in v0.16.5 

func GetConsumerGroup(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ConsumerGroupState, opts ...pulumi.ResourceOpt) (*ConsumerGroup, error)

GetConsumerGroup gets an existing ConsumerGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewConsumerGroup added in v0.16.5 

func NewConsumerGroup(ctx *pulumi.Context,
	name string, args *ConsumerGroupArgs, opts ...pulumi.ResourceOpt) (*ConsumerGroup, error)

NewConsumerGroup registers a new resource with the given unique name, arguments, and options.

func (*ConsumerGroup) EventhubEndpointName added in v0.16.5 

func (r *ConsumerGroup) EventhubEndpointName() *pulumi.StringOutput

The name of the Event Hub-compatible endpoint in the IoT hub. Changing this forces a new resource to be created.

func (*ConsumerGroup) ID added in v0.16.5 

func (r *ConsumerGroup) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*ConsumerGroup) IothubName added in v0.16.5 

func (r *ConsumerGroup) IothubName() *pulumi.StringOutput

The name of the IoT Hub. Changing this forces a new resource to be created.

func (*ConsumerGroup) Name added in v0.16.5 

func (r *ConsumerGroup) Name() *pulumi.StringOutput

The name of this Consumer Group. Changing this forces a new resource to be created.

func (*ConsumerGroup) ResourceGroupName added in v0.16.5 

func (r *ConsumerGroup) ResourceGroupName() *pulumi.StringOutput

The name of the resource group that contains the IoT hub. Changing this forces a new resource to be created.

func (*ConsumerGroup) URN added in v0.16.5 

func (r *ConsumerGroup) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type ConsumerGroupArgs added in v0.16.5 

type ConsumerGroupArgs struct {
	// The name of the Event Hub-compatible endpoint in the IoT hub. Changing this forces a new resource to be created.
	EventhubEndpointName interface{}
	// The name of the IoT Hub. Changing this forces a new resource to be created.
	IothubName interface{}
	// The name of this Consumer Group. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the resource group that contains the IoT hub. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
}

The set of arguments for constructing a ConsumerGroup resource.

type ConsumerGroupState added in v0.16.5 

type ConsumerGroupState struct {
	// The name of the Event Hub-compatible endpoint in the IoT hub. Changing this forces a new resource to be created.
	EventhubEndpointName interface{}
	// The name of the IoT Hub. Changing this forces a new resource to be created.
	IothubName interface{}
	// The name of this Consumer Group. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the resource group that contains the IoT hub. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
}

Input properties used for looking up and filtering ConsumerGroup resources.

type Dps added in v0.19.1 

type Dps struct {
	// contains filtered or unexported fields
}

Manages an IoT Device Provisioning Service.

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/iot_dps.html.markdown.

func GetDps added in v0.19.1 

func GetDps(ctx *pulumi.Context,
	name string, id pulumi.ID, state *DpsState, opts ...pulumi.ResourceOpt) (*Dps, error)

GetDps gets an existing Dps resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDps added in v0.19.1 

func NewDps(ctx *pulumi.Context,
	name string, args *DpsArgs, opts ...pulumi.ResourceOpt) (*Dps, error)

NewDps registers a new resource with the given unique name, arguments, and options.

func (*Dps) ID added in v0.19.1 

func (r *Dps) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Dps) LinkedHubs added in v1.0.0 

func (r *Dps) LinkedHubs() *pulumi.ArrayOutput

A `linkedHub` block as defined below.

func (*Dps) Location added in v0.19.1 

func (r *Dps) Location() *pulumi.StringOutput

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

func (*Dps) Name added in v0.19.1 

func (r *Dps) Name() *pulumi.StringOutput

Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.

func (*Dps) ResourceGroupName added in v0.19.1 

func (r *Dps) ResourceGroupName() *pulumi.StringOutput

The name of the resource group under which the Iot Device Provisioning Service resource has to be created. Changing this forces a new resource to be created.

func (*Dps) Sku added in v0.19.1 

func (r *Dps) Sku() *pulumi.Output

A `sku` block as defined below.

func (*Dps) Tags added in v0.19.1 

func (r *Dps) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*Dps) URN added in v0.19.1 

func (r *Dps) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type DpsArgs added in v0.19.1 

type DpsArgs struct {
	// A `linkedHub` block as defined below.
	LinkedHubs interface{}
	// Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
	Location interface{}
	// Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the resource group under which the Iot Device Provisioning Service resource has to be created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// A `sku` block as defined below.
	Sku interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

The set of arguments for constructing a Dps resource.

type DpsState added in v0.19.1 

type DpsState struct {
	// A `linkedHub` block as defined below.
	LinkedHubs interface{}
	// Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
	Location interface{}
	// Specifies the name of the Iot Device Provisioning Service resource. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the resource group under which the Iot Device Provisioning Service resource has to be created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// A `sku` block as defined below.
	Sku interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

Input properties used for looking up and filtering Dps resources.

type IoTHub 

type IoTHub struct {
	// contains filtered or unexported fields
}

Manages an IotHub

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/iothub.html.markdown.

func GetIoTHub 

func GetIoTHub(ctx *pulumi.Context,
	name string, id pulumi.ID, state *IoTHubState, opts ...pulumi.ResourceOpt) (*IoTHub, error)

GetIoTHub gets an existing IoTHub resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewIoTHub 

func NewIoTHub(ctx *pulumi.Context,
	name string, args *IoTHubArgs, opts ...pulumi.ResourceOpt) (*IoTHub, error)

NewIoTHub registers a new resource with the given unique name, arguments, and options.

func (*IoTHub) Endpoints added in v0.16.0 

func (r *IoTHub) Endpoints() *pulumi.ArrayOutput

An `endpoint` block as defined below.

func (*IoTHub) EventHubEventsEndpoint added in v0.16.0 

func (r *IoTHub) EventHubEventsEndpoint() *pulumi.StringOutput

The EventHub compatible endpoint for events data

func (*IoTHub) EventHubEventsPath added in v0.16.0 

func (r *IoTHub) EventHubEventsPath() *pulumi.StringOutput

The EventHub compatible path for events data

func (*IoTHub) EventHubOperationsEndpoint added in v0.16.0 

func (r *IoTHub) EventHubOperationsEndpoint() *pulumi.StringOutput

The EventHub compatible endpoint for operational data

func (*IoTHub) EventHubOperationsPath added in v0.16.0 

func (r *IoTHub) EventHubOperationsPath() *pulumi.StringOutput

The EventHub compatible path for operational data

func (*IoTHub) FallbackRoute added in v0.17.2 

func (r *IoTHub) FallbackRoute() *pulumi.Output

A `fallbackRoute` block as defined below. If the fallback route is enabled, messages that don't match any of the supplied routes are automatically sent to this route. Defaults to messages/events.

func (*IoTHub) FileUpload added in v1.0.0 

func (r *IoTHub) FileUpload() *pulumi.Output

A `fileUpload` block as defined below.

func (*IoTHub) Hostname 

func (r *IoTHub) Hostname() *pulumi.StringOutput

The hostname of the IotHub Resource.

func (*IoTHub) ID 

func (r *IoTHub) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*IoTHub) IpFilterRules added in v0.18.0 

func (r *IoTHub) IpFilterRules() *pulumi.ArrayOutput

One or more `ipFilterRule` blocks as defined below.

func (*IoTHub) Location 

func (r *IoTHub) Location() *pulumi.StringOutput

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

func (*IoTHub) Name 

func (r *IoTHub) Name() *pulumi.StringOutput

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

func (*IoTHub) ResourceGroupName 

func (r *IoTHub) ResourceGroupName() *pulumi.StringOutput

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

func (*IoTHub) Routes added in v0.16.0 

func (r *IoTHub) Routes() *pulumi.ArrayOutput

A `route` block as defined below.

func (*IoTHub) SharedAccessPolicies 

func (r *IoTHub) SharedAccessPolicies() *pulumi.ArrayOutput

One or more `sharedAccessPolicy` blocks as defined below.

func (*IoTHub) Sku 

func (r *IoTHub) Sku() *pulumi.Output

A `sku` block as defined below.

func (*IoTHub) Tags 

func (r *IoTHub) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*IoTHub) Type 

func (r *IoTHub) Type() *pulumi.StringOutput

func (*IoTHub) URN 

func (r *IoTHub) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type IoTHubArgs 

type IoTHubArgs struct {
	// An `endpoint` block as defined below.
	Endpoints interface{}
	// A `fallbackRoute` block as defined below. If the fallback route is enabled, messages that don't match any of the supplied routes are automatically sent to this route. Defaults to messages/events.
	FallbackRoute interface{}
	// A `fileUpload` block as defined below.
	FileUpload interface{}
	// One or more `ipFilterRule` blocks as defined below.
	IpFilterRules interface{}
	// Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
	Location interface{}
	// Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// A `route` block as defined below.
	Routes interface{}
	// A `sku` block as defined below.
	Sku interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

The set of arguments for constructing a IoTHub resource.

type IoTHubState 

type IoTHubState struct {
	// An `endpoint` block as defined below.
	Endpoints interface{}
	// The EventHub compatible endpoint for events data
	EventHubEventsEndpoint interface{}
	// The EventHub compatible path for events data
	EventHubEventsPath interface{}
	// The EventHub compatible endpoint for operational data
	EventHubOperationsEndpoint interface{}
	// The EventHub compatible path for operational data
	EventHubOperationsPath interface{}
	// A `fallbackRoute` block as defined below. If the fallback route is enabled, messages that don't match any of the supplied routes are automatically sent to this route. Defaults to messages/events.
	FallbackRoute interface{}
	// A `fileUpload` block as defined below.
	FileUpload interface{}
	// The hostname of the IotHub Resource.
	Hostname interface{}
	// One or more `ipFilterRule` blocks as defined below.
	IpFilterRules interface{}
	// Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.
	Location interface{}
	// Specifies the name of the IotHub resource. Changing this forces a new resource to be created.
	Name interface{}
	// The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// A `route` block as defined below.
	Routes interface{}
	// One or more `sharedAccessPolicy` blocks as defined below.
	SharedAccessPolicies interface{}
	// A `sku` block as defined below.
	Sku interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
	Type interface{}
}

Input properties used for looking up and filtering IoTHub resources.

type SharedAccessPolicy added in v0.18.0 

type SharedAccessPolicy struct {
	// contains filtered or unexported fields
}

Manages an IotHub Shared Access Policy

> This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/iothub_shared_access_policy.html.markdown.

func GetSharedAccessPolicy added in v0.18.0 

func GetSharedAccessPolicy(ctx *pulumi.Context,
	name string, id pulumi.ID, state *SharedAccessPolicyState, opts ...pulumi.ResourceOpt) (*SharedAccessPolicy, error)

GetSharedAccessPolicy gets an existing SharedAccessPolicy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSharedAccessPolicy added in v0.18.0 

func NewSharedAccessPolicy(ctx *pulumi.Context,
	name string, args *SharedAccessPolicyArgs, opts ...pulumi.ResourceOpt) (*SharedAccessPolicy, error)

NewSharedAccessPolicy registers a new resource with the given unique name, arguments, and options.

func (*SharedAccessPolicy) DeviceConnect added in v0.18.0 

func (r *SharedAccessPolicy) DeviceConnect() *pulumi.BoolOutput

Adds `DeviceConnect` permission to this Shared Access Account. It allows sending and receiving on the device-side endpoints.

func (*SharedAccessPolicy) ID added in v0.18.0 

func (r *SharedAccessPolicy) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*SharedAccessPolicy) IothubName added in v0.18.0 

func (r *SharedAccessPolicy) IothubName() *pulumi.StringOutput

The name of the IoTHub to which this Shared Access Policy belongs. Changing this forces a new resource to be created.

func (*SharedAccessPolicy) Name added in v0.18.0 

func (r *SharedAccessPolicy) Name() *pulumi.StringOutput

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

func (*SharedAccessPolicy) PrimaryConnectionString added in v0.18.0 

func (r *SharedAccessPolicy) PrimaryConnectionString() *pulumi.StringOutput

The primary connection string of the Shared Access Policy.

func (*SharedAccessPolicy) PrimaryKey added in v0.18.0 

func (r *SharedAccessPolicy) PrimaryKey() *pulumi.StringOutput

The primary key used to create the authentication token.

func (*SharedAccessPolicy) RegistryRead added in v0.18.0 

func (r *SharedAccessPolicy) RegistryRead() *pulumi.BoolOutput

Adds `RegistryRead` permission to this Shared Access Account. It allows read access to the identity registry.

func (*SharedAccessPolicy) RegistryWrite added in v0.18.0 

func (r *SharedAccessPolicy) RegistryWrite() *pulumi.BoolOutput

Adds `RegistryWrite` permission to this Shared Access Account. It allows write access to the identity registry.

func (*SharedAccessPolicy) ResourceGroupName added in v0.18.0 

func (r *SharedAccessPolicy) ResourceGroupName() *pulumi.StringOutput

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

func (*SharedAccessPolicy) SecondaryConnectionString added in v0.18.0 

func (r *SharedAccessPolicy) SecondaryConnectionString() *pulumi.StringOutput

The secondary connection string of the Shared Access Policy.

func (*SharedAccessPolicy) SecondaryKey added in v0.18.0 

func (r *SharedAccessPolicy) SecondaryKey() *pulumi.StringOutput

The secondary key used to create the authentication token.

func (*SharedAccessPolicy) ServiceConnect added in v0.18.0 

func (r *SharedAccessPolicy) ServiceConnect() *pulumi.BoolOutput

Adds `ServiceConnect` permission to this Shared Access Account. It allows sending and receiving on the cloud-side endpoints.

func (*SharedAccessPolicy) URN added in v0.18.0 

func (r *SharedAccessPolicy) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type SharedAccessPolicyArgs added in v0.18.0 

type SharedAccessPolicyArgs struct {
	// Adds `DeviceConnect` permission to this Shared Access Account. It allows sending and receiving on the device-side endpoints.
	DeviceConnect interface{}
	// The name of the IoTHub to which this Shared Access Policy belongs. Changing this forces a new resource to be created.
	IothubName interface{}
	// Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
	Name interface{}
	// Adds `RegistryRead` permission to this Shared Access Account. It allows read access to the identity registry.
	RegistryRead interface{}
	// Adds `RegistryWrite` permission to this Shared Access Account. It allows write access to the identity registry.
	RegistryWrite interface{}
	// The name of the resource group under which the IotHub Shared Access Policy resource has to be created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// Adds `ServiceConnect` permission to this Shared Access Account. It allows sending and receiving on the cloud-side endpoints.
	ServiceConnect interface{}
}

The set of arguments for constructing a SharedAccessPolicy resource.

type SharedAccessPolicyState added in v0.18.0 

type SharedAccessPolicyState struct {
	// Adds `DeviceConnect` permission to this Shared Access Account. It allows sending and receiving on the device-side endpoints.
	DeviceConnect interface{}
	// The name of the IoTHub to which this Shared Access Policy belongs. Changing this forces a new resource to be created.
	IothubName interface{}
	// Specifies the name of the IotHub Shared Access Policy resource. Changing this forces a new resource to be created.
	Name interface{}
	// The primary connection string of the Shared Access Policy.
	PrimaryConnectionString interface{}
	// The primary key used to create the authentication token.
	PrimaryKey interface{}
	// Adds `RegistryRead` permission to this Shared Access Account. It allows read access to the identity registry.
	RegistryRead interface{}
	// Adds `RegistryWrite` permission to this Shared Access Account. It allows write access to the identity registry.
	RegistryWrite interface{}
	// The name of the resource group under which the IotHub Shared Access Policy resource has to be created. Changing this forces a new resource to be created.
	ResourceGroupName interface{}
	// The secondary connection string of the Shared Access Policy.
	SecondaryConnectionString interface{}
	// The secondary key used to create the authentication token.
	SecondaryKey interface{}
	// Adds `ServiceConnect` permission to this Shared Access Account. It allows sending and receiving on the cloud-side endpoints.
	ServiceConnect interface{}
}

Input properties used for looking up and filtering SharedAccessPolicy resources.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.