Broker
data class BrokerAuthorizationArgs(val authorizationName: Output<String>? = null, val brokerName: Output<String>? = null, val extendedLocation: Output<ExtendedLocationArgs>? = null, val instanceName: Output<String>? = null, val properties: Output<BrokerAuthorizationPropertiesArgs>? = null, val resourceGroupName: Output<String>? = null) : ConvertibleToJava<BrokerAuthorizationArgs>
Instance broker authorizations resource Uses Azure REST API version 2024-11-01. In version 2.x of the Azure Native provider, it used API version 2024-07-01-preview. Other available API versions: 2024-07-01-preview, 2024-08-15-preview, 2024-09-15-preview, 2025-04-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native iotoperations [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.
Example Usage
BrokerAuthorization_CreateOrUpdate
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var brokerAuthorization = new AzureNative.IoTOperations.BrokerAuthorization("brokerAuthorization", new()
{
AuthorizationName = "resource-name123",
BrokerName = "resource-name123",
ExtendedLocation = new AzureNative.IoTOperations.Inputs.ExtendedLocationArgs
{
Name = "qmbrfwcpwwhggszhrdjv",
Type = AzureNative.IoTOperations.ExtendedLocationType.CustomLocation,
},
InstanceName = "resource-name123",
Properties = new AzureNative.IoTOperations.Inputs.BrokerAuthorizationPropertiesArgs
{
AuthorizationPolicies = new AzureNative.IoTOperations.Inputs.AuthorizationConfigArgs
{
Cache = AzureNative.IoTOperations.OperationalMode.Enabled,
Rules = new[]
{
new AzureNative.IoTOperations.Inputs.AuthorizationRuleArgs
{
BrokerResources = new[]
{
new AzureNative.IoTOperations.Inputs.BrokerResourceRuleArgs
{
ClientIds = new[]
{
"nlc",
},
Method = AzureNative.IoTOperations.BrokerResourceDefinitionMethods.Connect,
Topics = new[]
{
"wvuca",
},
},
},
Principals = new AzureNative.IoTOperations.Inputs.PrincipalDefinitionArgs
{
Attributes = new[]
{
{
{ "key5526", "nydhzdhbldygqcn" },
},
},
ClientIds = new[]
{
"smopeaeddsygz",
},
Usernames = new[]
{
"iozngyqndrteikszkbasinzdjtm",
},
},
StateStoreResources = new[]
{
new AzureNative.IoTOperations.Inputs.StateStoreResourceRuleArgs
{
KeyType = AzureNative.IoTOperations.StateStoreResourceKeyTypes.Pattern,
Keys = new[]
{
"tkounsqtwvzyaklxjqoerpu",
},
Method = AzureNative.IoTOperations.StateStoreResourceDefinitionMethods.Read,
},
},
},
},
},
},
ResourceGroupName = "rgiotoperations",
});
});Content copied to clipboard
package main
import (
iotoperations "github.com/pulumi/pulumi-azure-native-sdk/iotoperations/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := iotoperations.NewBrokerAuthorization(ctx, "brokerAuthorization", &iotoperations.BrokerAuthorizationArgs{
AuthorizationName: pulumi.String("resource-name123"),
BrokerName: pulumi.String("resource-name123"),
ExtendedLocation: &iotoperations.ExtendedLocationArgs{
Name: pulumi.String("qmbrfwcpwwhggszhrdjv"),
Type: pulumi.String(iotoperations.ExtendedLocationTypeCustomLocation),
},
InstanceName: pulumi.String("resource-name123"),
Properties: &iotoperations.BrokerAuthorizationPropertiesArgs{
AuthorizationPolicies: &iotoperations.AuthorizationConfigArgs{
Cache: pulumi.String(iotoperations.OperationalModeEnabled),
Rules: iotoperations.AuthorizationRuleArray{
&iotoperations.AuthorizationRuleArgs{
BrokerResources: iotoperations.BrokerResourceRuleArray{
&iotoperations.BrokerResourceRuleArgs{
ClientIds: pulumi.StringArray{
pulumi.String("nlc"),
},
Method: pulumi.String(iotoperations.BrokerResourceDefinitionMethodsConnect),
Topics: pulumi.StringArray{
pulumi.String("wvuca"),
},
},
},
Principals: &iotoperations.PrincipalDefinitionArgs{
Attributes: pulumi.StringMapArray{
pulumi.StringMap{
"key5526": pulumi.String("nydhzdhbldygqcn"),
},
},
ClientIds: pulumi.StringArray{
pulumi.String("smopeaeddsygz"),
},
Usernames: pulumi.StringArray{
pulumi.String("iozngyqndrteikszkbasinzdjtm"),
},
},
StateStoreResources: iotoperations.StateStoreResourceRuleArray{
&iotoperations.StateStoreResourceRuleArgs{
KeyType: pulumi.String(iotoperations.StateStoreResourceKeyTypesPattern),
Keys: pulumi.StringArray{
pulumi.String("tkounsqtwvzyaklxjqoerpu"),
},
Method: pulumi.String(iotoperations.StateStoreResourceDefinitionMethodsRead),
},
},
},
},
},
},
ResourceGroupName: pulumi.String("rgiotoperations"),
})
if err != nil {
return err
}
return nil
})
}Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.iotoperations.BrokerAuthorization;
import com.pulumi.azurenative.iotoperations.BrokerAuthorizationArgs;
import com.pulumi.azurenative.iotoperations.inputs.ExtendedLocationArgs;
import com.pulumi.azurenative.iotoperations.inputs.BrokerAuthorizationPropertiesArgs;
import com.pulumi.azurenative.iotoperations.inputs.AuthorizationConfigArgs;
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 brokerAuthorization = new BrokerAuthorization("brokerAuthorization", BrokerAuthorizationArgs.builder()
.authorizationName("resource-name123")
.brokerName("resource-name123")
.extendedLocation(ExtendedLocationArgs.builder()
.name("qmbrfwcpwwhggszhrdjv")
.type("CustomLocation")
.build())
.instanceName("resource-name123")
.properties(BrokerAuthorizationPropertiesArgs.builder()
.authorizationPolicies(AuthorizationConfigArgs.builder()
.cache("Enabled")
.rules(AuthorizationRuleArgs.builder()
.brokerResources(BrokerResourceRuleArgs.builder()
.clientIds("nlc")
.method("Connect")
.topics("wvuca")
.build())
.principals(PrincipalDefinitionArgs.builder()
.attributes(Map.of("key5526", "nydhzdhbldygqcn"))
.clientIds("smopeaeddsygz")
.usernames("iozngyqndrteikszkbasinzdjtm")
.build())
.stateStoreResources(StateStoreResourceRuleArgs.builder()
.keyType("Pattern")
.keys("tkounsqtwvzyaklxjqoerpu")
.method("Read")
.build())
.build())
.build())
.build())
.resourceGroupName("rgiotoperations")
.build());
}
}Content copied to clipboard
BrokerAuthorization_CreateOrUpdate_Complex
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var brokerAuthorization = new AzureNative.IoTOperations.BrokerAuthorization("brokerAuthorization", new()
{
AuthorizationName = "resource-name123",
BrokerName = "resource-name123",
ExtendedLocation = new AzureNative.IoTOperations.Inputs.ExtendedLocationArgs
{
Name = "qmbrfwcpwwhggszhrdjv",
Type = AzureNative.IoTOperations.ExtendedLocationType.CustomLocation,
},
InstanceName = "resource-name123",
Properties = new AzureNative.IoTOperations.Inputs.BrokerAuthorizationPropertiesArgs
{
AuthorizationPolicies = new AzureNative.IoTOperations.Inputs.AuthorizationConfigArgs
{
Cache = AzureNative.IoTOperations.OperationalMode.Enabled,
Rules = new[]
{
new AzureNative.IoTOperations.Inputs.AuthorizationRuleArgs
{
BrokerResources = new[]
{
new AzureNative.IoTOperations.Inputs.BrokerResourceRuleArgs
{
ClientIds = new[]
{
"{principal.attributes.building}*",
},
Method = AzureNative.IoTOperations.BrokerResourceDefinitionMethods.Connect,
},
new AzureNative.IoTOperations.Inputs.BrokerResourceRuleArgs
{
Method = AzureNative.IoTOperations.BrokerResourceDefinitionMethods.Publish,
Topics = new[]
{
"sensors/{principal.attributes.building}/{principal.clientId}/telemetry/*",
},
},
new AzureNative.IoTOperations.Inputs.BrokerResourceRuleArgs
{
Method = AzureNative.IoTOperations.BrokerResourceDefinitionMethods.Subscribe,
Topics = new[]
{
"commands/{principal.attributes.organization}",
},
},
},
Principals = new AzureNative.IoTOperations.Inputs.PrincipalDefinitionArgs
{
Attributes = new[]
{
{
{ "building", "17" },
{ "organization", "contoso" },
},
},
Usernames = new[]
{
"temperature-sensor",
"humidity-sensor",
},
},
StateStoreResources = new[]
{
new AzureNative.IoTOperations.Inputs.StateStoreResourceRuleArgs
{
KeyType = AzureNative.IoTOperations.StateStoreResourceKeyTypes.Pattern,
Keys = new[]
{
"myreadkey",
"myotherkey?",
"mynumerickeysuffix[0-9]",
"clients:{principal.clientId}:*",
},
Method = AzureNative.IoTOperations.StateStoreResourceDefinitionMethods.Read,
},
new AzureNative.IoTOperations.Inputs.StateStoreResourceRuleArgs
{
KeyType = AzureNative.IoTOperations.StateStoreResourceKeyTypes.Binary,
Keys = new[]
{
"MTE2IDEwMSAxMTUgMTE2",
},
Method = AzureNative.IoTOperations.StateStoreResourceDefinitionMethods.ReadWrite,
},
},
},
},
},
},
ResourceGroupName = "rgiotoperations",
});
});Content copied to clipboard
package main
import (
iotoperations "github.com/pulumi/pulumi-azure-native-sdk/iotoperations/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := iotoperations.NewBrokerAuthorization(ctx, "brokerAuthorization", &iotoperations.BrokerAuthorizationArgs{
AuthorizationName: pulumi.String("resource-name123"),
BrokerName: pulumi.String("resource-name123"),
ExtendedLocation: &iotoperations.ExtendedLocationArgs{
Name: pulumi.String("qmbrfwcpwwhggszhrdjv"),
Type: pulumi.String(iotoperations.ExtendedLocationTypeCustomLocation),
},
InstanceName: pulumi.String("resource-name123"),
Properties: &iotoperations.BrokerAuthorizationPropertiesArgs{
AuthorizationPolicies: &iotoperations.AuthorizationConfigArgs{
Cache: pulumi.String(iotoperations.OperationalModeEnabled),
Rules: iotoperations.AuthorizationRuleArray{
&iotoperations.AuthorizationRuleArgs{
BrokerResources: iotoperations.BrokerResourceRuleArray{
&iotoperations.BrokerResourceRuleArgs{
ClientIds: pulumi.StringArray{
pulumi.String("{principal.attributes.building}*"),
},
Method: pulumi.String(iotoperations.BrokerResourceDefinitionMethodsConnect),
},
&iotoperations.BrokerResourceRuleArgs{
Method: pulumi.String(iotoperations.BrokerResourceDefinitionMethodsPublish),
Topics: pulumi.StringArray{
pulumi.String("sensors/{principal.attributes.building}/{principal.clientId}/telemetry/*"),
},
},
&iotoperations.BrokerResourceRuleArgs{
Method: pulumi.String(iotoperations.BrokerResourceDefinitionMethodsSubscribe),
Topics: pulumi.StringArray{
pulumi.String("commands/{principal.attributes.organization}"),
},
},
},
Principals: &iotoperations.PrincipalDefinitionArgs{
Attributes: pulumi.StringMapArray{
pulumi.StringMap{
"building": pulumi.String("17"),
"organization": pulumi.String("contoso"),
},
},
Usernames: pulumi.StringArray{
pulumi.String("temperature-sensor"),
pulumi.String("humidity-sensor"),
},
},
StateStoreResources: iotoperations.StateStoreResourceRuleArray{
&iotoperations.StateStoreResourceRuleArgs{
KeyType: pulumi.String(iotoperations.StateStoreResourceKeyTypesPattern),
Keys: pulumi.StringArray{
pulumi.String("myreadkey"),
pulumi.String("myotherkey?"),
pulumi.String("mynumerickeysuffix[0-9]"),
pulumi.String("clients:{principal.clientId}:*"),
},
Method: pulumi.String(iotoperations.StateStoreResourceDefinitionMethodsRead),
},
&iotoperations.StateStoreResourceRuleArgs{
KeyType: pulumi.String(iotoperations.StateStoreResourceKeyTypesBinary),
Keys: pulumi.StringArray{
pulumi.String("MTE2IDEwMSAxMTUgMTE2"),
},
Method: pulumi.String(iotoperations.StateStoreResourceDefinitionMethodsReadWrite),
},
},
},
},
},
},
ResourceGroupName: pulumi.String("rgiotoperations"),
})
if err != nil {
return err
}
return nil
})
}Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.iotoperations.BrokerAuthorization;
import com.pulumi.azurenative.iotoperations.BrokerAuthorizationArgs;
import com.pulumi.azurenative.iotoperations.inputs.ExtendedLocationArgs;
import com.pulumi.azurenative.iotoperations.inputs.BrokerAuthorizationPropertiesArgs;
import com.pulumi.azurenative.iotoperations.inputs.AuthorizationConfigArgs;
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 brokerAuthorization = new BrokerAuthorization("brokerAuthorization", BrokerAuthorizationArgs.builder()
.authorizationName("resource-name123")
.brokerName("resource-name123")
.extendedLocation(ExtendedLocationArgs.builder()
.name("qmbrfwcpwwhggszhrdjv")
.type("CustomLocation")
.build())
.instanceName("resource-name123")
.properties(BrokerAuthorizationPropertiesArgs.builder()
.authorizationPolicies(AuthorizationConfigArgs.builder()
.cache("Enabled")
.rules(AuthorizationRuleArgs.builder()
.brokerResources(
BrokerResourceRuleArgs.builder()
.clientIds("{principal.attributes.building}*")
.method("Connect")
.build(),
BrokerResourceRuleArgs.builder()
.method("Publish")
.topics("sensors/{principal.attributes.building}/{principal.clientId}/telemetry/*")
.build(),
BrokerResourceRuleArgs.builder()
.method("Subscribe")
.topics("commands/{principal.attributes.organization}")
.build())
.principals(PrincipalDefinitionArgs.builder()
.attributes(Map.ofEntries(
Map.entry("building", "17"),
Map.entry("organization", "contoso")
))
.usernames(
"temperature-sensor",
"humidity-sensor")
.build())
.stateStoreResources(
StateStoreResourceRuleArgs.builder()
.keyType("Pattern")
.keys(
"myreadkey",
"myotherkey?",
"mynumerickeysuffix[0-9]",
"clients:{principal.clientId}:*")
.method("Read")
.build(),
StateStoreResourceRuleArgs.builder()
.keyType("Binary")
.keys("MTE2IDEwMSAxMTUgMTE2")
.method("ReadWrite")
.build())
.build())
.build())
.build())
.resourceGroupName("rgiotoperations")
.build());
}
}Content copied to clipboard
BrokerAuthorization_CreateOrUpdate_Simple
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var brokerAuthorization = new AzureNative.IoTOperations.BrokerAuthorization("brokerAuthorization", new()
{
AuthorizationName = "resource-name123",
BrokerName = "resource-name123",
ExtendedLocation = new AzureNative.IoTOperations.Inputs.ExtendedLocationArgs
{
Name = "qmbrfwcpwwhggszhrdjv",
Type = AzureNative.IoTOperations.ExtendedLocationType.CustomLocation,
},
InstanceName = "resource-name123",
Properties = new AzureNative.IoTOperations.Inputs.BrokerAuthorizationPropertiesArgs
{
AuthorizationPolicies = new AzureNative.IoTOperations.Inputs.AuthorizationConfigArgs
{
Cache = AzureNative.IoTOperations.OperationalMode.Enabled,
Rules = new[]
{
new AzureNative.IoTOperations.Inputs.AuthorizationRuleArgs
{
BrokerResources = new[]
{
new AzureNative.IoTOperations.Inputs.BrokerResourceRuleArgs
{
Method = AzureNative.IoTOperations.BrokerResourceDefinitionMethods.Connect,
},
new AzureNative.IoTOperations.Inputs.BrokerResourceRuleArgs
{
Method = AzureNative.IoTOperations.BrokerResourceDefinitionMethods.Subscribe,
Topics = new[]
{
"topic",
"topic/with/wildcard/#",
},
},
},
Principals = new AzureNative.IoTOperations.Inputs.PrincipalDefinitionArgs
{
Attributes = new[]
{
{
{ "floor", "floor1" },
{ "site", "site1" },
},
},
ClientIds = new[]
{
"my-client-id",
},
},
StateStoreResources = new[]
{
new AzureNative.IoTOperations.Inputs.StateStoreResourceRuleArgs
{
KeyType = AzureNative.IoTOperations.StateStoreResourceKeyTypes.Pattern,
Keys = new[]
{
"*",
},
Method = AzureNative.IoTOperations.StateStoreResourceDefinitionMethods.ReadWrite,
},
},
},
},
},
},
ResourceGroupName = "rgiotoperations",
});
});Content copied to clipboard
package main
import (
iotoperations "github.com/pulumi/pulumi-azure-native-sdk/iotoperations/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := iotoperations.NewBrokerAuthorization(ctx, "brokerAuthorization", &iotoperations.BrokerAuthorizationArgs{
AuthorizationName: pulumi.String("resource-name123"),
BrokerName: pulumi.String("resource-name123"),
ExtendedLocation: &iotoperations.ExtendedLocationArgs{
Name: pulumi.String("qmbrfwcpwwhggszhrdjv"),
Type: pulumi.String(iotoperations.ExtendedLocationTypeCustomLocation),
},
InstanceName: pulumi.String("resource-name123"),
Properties: &iotoperations.BrokerAuthorizationPropertiesArgs{
AuthorizationPolicies: &iotoperations.AuthorizationConfigArgs{
Cache: pulumi.String(iotoperations.OperationalModeEnabled),
Rules: iotoperations.AuthorizationRuleArray{
&iotoperations.AuthorizationRuleArgs{
BrokerResources: iotoperations.BrokerResourceRuleArray{
&iotoperations.BrokerResourceRuleArgs{
Method: pulumi.String(iotoperations.BrokerResourceDefinitionMethodsConnect),
},
&iotoperations.BrokerResourceRuleArgs{
Method: pulumi.String(iotoperations.BrokerResourceDefinitionMethodsSubscribe),
Topics: pulumi.StringArray{
pulumi.String("topic"),
pulumi.String("topic/with/wildcard/#"),
},
},
},
Principals: &iotoperations.PrincipalDefinitionArgs{
Attributes: pulumi.StringMapArray{
pulumi.StringMap{
"floor": pulumi.String("floor1"),
"site": pulumi.String("site1"),
},
},
ClientIds: pulumi.StringArray{
pulumi.String("my-client-id"),
},
},
StateStoreResources: iotoperations.StateStoreResourceRuleArray{
&iotoperations.StateStoreResourceRuleArgs{
KeyType: pulumi.String(iotoperations.StateStoreResourceKeyTypesPattern),
Keys: pulumi.StringArray{
pulumi.String("*"),
},
Method: pulumi.String(iotoperations.StateStoreResourceDefinitionMethodsReadWrite),
},
},
},
},
},
},
ResourceGroupName: pulumi.String("rgiotoperations"),
})
if err != nil {
return err
}
return nil
})
}Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.iotoperations.BrokerAuthorization;
import com.pulumi.azurenative.iotoperations.BrokerAuthorizationArgs;
import com.pulumi.azurenative.iotoperations.inputs.ExtendedLocationArgs;
import com.pulumi.azurenative.iotoperations.inputs.BrokerAuthorizationPropertiesArgs;
import com.pulumi.azurenative.iotoperations.inputs.AuthorizationConfigArgs;
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 brokerAuthorization = new BrokerAuthorization("brokerAuthorization", BrokerAuthorizationArgs.builder()
.authorizationName("resource-name123")
.brokerName("resource-name123")
.extendedLocation(ExtendedLocationArgs.builder()
.name("qmbrfwcpwwhggszhrdjv")
.type("CustomLocation")
.build())
.instanceName("resource-name123")
.properties(BrokerAuthorizationPropertiesArgs.builder()
.authorizationPolicies(AuthorizationConfigArgs.builder()
.cache("Enabled")
.rules(AuthorizationRuleArgs.builder()
.brokerResources(
BrokerResourceRuleArgs.builder()
.method("Connect")
.build(),
BrokerResourceRuleArgs.builder()
.method("Subscribe")
.topics(
"topic",
"topic/with/wildcard/#")
.build())
.principals(PrincipalDefinitionArgs.builder()
.attributes(Map.ofEntries(
Map.entry("floor", "floor1"),
Map.entry("site", "site1")
))
.clientIds("my-client-id")
.build())
.stateStoreResources(StateStoreResourceRuleArgs.builder()
.keyType("Pattern")
.keys("*")
.method("ReadWrite")
.build())
.build())
.build())
.build())
.resourceGroupName("rgiotoperations")
.build());
}
}Content copied to clipboard
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:iotoperations:BrokerAuthorization anqrqsvrjmlvzkrbuav /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authorizations/{authorizationName}Content copied to clipboard
Constructors
Link copied to clipboard
constructor(authorizationName: Output<String>? = null, brokerName: Output<String>? = null, extendedLocation: Output<ExtendedLocationArgs>? = null, instanceName: Output<String>? = null, properties: Output<BrokerAuthorizationPropertiesArgs>? = null, resourceGroupName: Output<String>? = null)
Properties
Link copied to clipboard
Name of Instance broker authorization resource
Link copied to clipboard
Name of broker.
Link copied to clipboard
Edge location of the resource.
Link copied to clipboard
Name of instance.
Link copied to clipboard
The resource-specific properties for this resource.
Link copied to clipboard
The name of the resource group. The name is case insensitive. //*/