/
route.ts
242 lines (233 loc) · 10.2 KB
/
route.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as utilities from "../utilities";
/**
* Manages an IotHub Route
*
* > **NOTE:** Routes can be defined either directly on the `azure.iot.IoTHub` resource, or using the `azure.iot.Route` resourcs - but the two cannot be used together. If both are used against the same IoTHub, spurious changes will occur.
*
* ## Example Usage
*
*
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azure from "@pulumi/azure";
*
* const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
* const exampleAccount = new azure.storage.Account("exampleAccount", {
* resourceGroupName: exampleResourceGroup.name,
* location: exampleResourceGroup.location,
* accountTier: "Standard",
* accountReplicationType: "LRS",
* });
* const exampleContainer = new azure.storage.Container("exampleContainer", {
* resourceGroupName: exampleResourceGroup.name,
* storageAccountName: exampleAccount.name,
* containerAccessType: "private",
* });
* const exampleIoTHub = new azure.iot.IoTHub("exampleIoTHub", {
* resourceGroupName: exampleResourceGroup.name,
* location: exampleResourceGroup.location,
* sku: {
* name: "S1",
* capacity: "1",
* },
* tags: {
* purpose: "testing",
* },
* });
* const exampleEndpointStorageContainer = new azure.iot.EndpointStorageContainer("exampleEndpointStorageContainer", {
* resourceGroupName: exampleResourceGroup.name,
* iothubName: exampleIoTHub.name,
* connectionString: exampleAccount.primaryBlobConnectionString,
* batchFrequencyInSeconds: 60,
* maxChunkSizeInBytes: 10485760,
* containerName: exampleContainer.name,
* encoding: "Avro",
* fileNameFormat: "{iothub}/{partition}_{YYYY}_{MM}_{DD}_{HH}_{mm}",
* });
* const exampleRoute = new azure.iot.Route("exampleRoute", {
* resourceGroupName: exampleResourceGroup.name,
* iothubName: exampleIoTHub.name,
* source: "DeviceMessages",
* condition: "true",
* endpointNames: [exampleEndpointStorageContainer.name],
* enabled: true,
* });
* ```
*/
export class Route extends pulumi.CustomResource {
/**
* Get an existing Route 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 state Any extra arguments used during the lookup.
*/
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RouteState, opts?: pulumi.CustomResourceOptions): Route {
return new Route(name, <any>state, { ...opts, id: id });
}
/** @internal */
public static readonly __pulumiType = 'azure:iot/route:Route';
/**
* Returns true if the given object is an instance of Route. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
public static isInstance(obj: any): obj is Route {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Route.__pulumiType;
}
/**
* The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to `true` by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.
*/
public readonly condition!: pulumi.Output<string | undefined>;
/**
* Specifies whether a route is enabled.
*/
public readonly enabled!: pulumi.Output<boolean>;
/**
* The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
*/
public readonly endpointNames!: pulumi.Output<string>;
/**
* The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
*/
public readonly iothubName!: pulumi.Output<string>;
/**
* The name of the route.
*/
public readonly name!: pulumi.Output<string>;
/**
* The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
*/
public readonly resourceGroupName!: pulumi.Output<string>;
/**
* The source that the routing rule is to be applied to. Possible values include: `DeviceJobLifecycleEvents`, `DeviceLifecycleEvents`, `DeviceMessages`, `Invalid`, `TwinChangeEvents`.
*/
public readonly source!: pulumi.Output<string>;
/**
* Create a Route 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: RouteArgs, opts?: pulumi.CustomResourceOptions)
constructor(name: string, argsOrState?: RouteArgs | RouteState, opts?: pulumi.CustomResourceOptions) {
let inputs: pulumi.Inputs = {};
if (opts && opts.id) {
const state = argsOrState as RouteState | undefined;
inputs["condition"] = state ? state.condition : undefined;
inputs["enabled"] = state ? state.enabled : undefined;
inputs["endpointNames"] = state ? state.endpointNames : undefined;
inputs["iothubName"] = state ? state.iothubName : undefined;
inputs["name"] = state ? state.name : undefined;
inputs["resourceGroupName"] = state ? state.resourceGroupName : undefined;
inputs["source"] = state ? state.source : undefined;
} else {
const args = argsOrState as RouteArgs | undefined;
if (!args || args.enabled === undefined) {
throw new Error("Missing required property 'enabled'");
}
if (!args || args.endpointNames === undefined) {
throw new Error("Missing required property 'endpointNames'");
}
if (!args || args.iothubName === undefined) {
throw new Error("Missing required property 'iothubName'");
}
if (!args || args.resourceGroupName === undefined) {
throw new Error("Missing required property 'resourceGroupName'");
}
if (!args || args.source === undefined) {
throw new Error("Missing required property 'source'");
}
inputs["condition"] = args ? args.condition : undefined;
inputs["enabled"] = args ? args.enabled : undefined;
inputs["endpointNames"] = args ? args.endpointNames : undefined;
inputs["iothubName"] = args ? args.iothubName : undefined;
inputs["name"] = args ? args.name : undefined;
inputs["resourceGroupName"] = args ? args.resourceGroupName : undefined;
inputs["source"] = args ? args.source : undefined;
}
if (!opts) {
opts = {}
}
if (!opts.version) {
opts.version = utilities.getVersion();
}
super(Route.__pulumiType, name, inputs, opts);
}
}
/**
* Input properties used for looking up and filtering Route resources.
*/
export interface RouteState {
/**
* The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to `true` by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.
*/
readonly condition?: pulumi.Input<string>;
/**
* Specifies whether a route is enabled.
*/
readonly enabled?: pulumi.Input<boolean>;
/**
* The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
*/
readonly endpointNames?: pulumi.Input<string>;
/**
* The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
*/
readonly iothubName?: pulumi.Input<string>;
/**
* The name of the route.
*/
readonly name?: pulumi.Input<string>;
/**
* The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
*/
readonly resourceGroupName?: pulumi.Input<string>;
/**
* The source that the routing rule is to be applied to. Possible values include: `DeviceJobLifecycleEvents`, `DeviceLifecycleEvents`, `DeviceMessages`, `Invalid`, `TwinChangeEvents`.
*/
readonly source?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Route resource.
*/
export interface RouteArgs {
/**
* The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to `true` by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.
*/
readonly condition?: pulumi.Input<string>;
/**
* Specifies whether a route is enabled.
*/
readonly enabled: pulumi.Input<boolean>;
/**
* The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.
*/
readonly endpointNames: pulumi.Input<string>;
/**
* The name of the IoTHub to which this Route belongs. Changing this forces a new resource to be created.
*/
readonly iothubName: pulumi.Input<string>;
/**
* The name of the route.
*/
readonly name?: pulumi.Input<string>;
/**
* The name of the resource group under which the IotHub Route resource has to be created. Changing this forces a new resource to be created.
*/
readonly resourceGroupName: pulumi.Input<string>;
/**
* The source that the routing rule is to be applied to. Possible values include: `DeviceJobLifecycleEvents`, `DeviceLifecycleEvents`, `DeviceMessages`, `Invalid`, `TwinChangeEvents`.
*/
readonly source: pulumi.Input<string>;
}