Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. iotoperations
  5. BrokerAuthentication
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.iotoperations.BrokerAuthentication

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Instance broker authentication 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 for details.

Example Usage

BrokerAuthentication_CreateOrUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var brokerAuthentication = new AzureNative.IoTOperations.BrokerAuthentication("brokerAuthentication", new()
    {
        AuthenticationName = "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.BrokerAuthenticationPropertiesArgs
        {
            AuthenticationMethods = new[]
            {
                new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodsArgs
                {
                    CustomSettings = new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodCustomArgs
                    {
                        Auth = new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorCustomAuthArgs
                        {
                            X509 = new AzureNative.IoTOperations.Inputs.X509ManualCertificateArgs
                            {
                                SecretRef = "secret-name",
                            },
                        },
                        CaCertConfigMap = "pdecudefqyolvncbus",
                        Endpoint = "https://www.example.com",
                        Headers = 
                        {
                            { "key8518", "bwityjy" },
                        },
                    },
                    Method = AzureNative.IoTOperations.BrokerAuthenticationMethod.Custom,
                    ServiceAccountTokenSettings = new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodSatArgs
                    {
                        Audiences = new[]
                        {
                            "jqyhyqatuydg",
                        },
                    },
                    X509Settings = new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodX509Args
                    {
                        AuthorizationAttributes = 
                        {
                            { "key3384", new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodX509AttributesArgs
                            {
                                Attributes = 
                                {
                                    { "key186", "ucpajramsz" },
                                },
                                Subject = "jpgwctfeixitptfgfnqhua",
                            } },
                        },
                        TrustedClientCaCert = "vlctsqddl",
                    },
                },
            },
        },
        ResourceGroupName = "rgiotoperations",
    });

});
Copy
package main

import (
	iotoperations "github.com/pulumi/pulumi-azure-native-sdk/iotoperations/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iotoperations.NewBrokerAuthentication(ctx, "brokerAuthentication", &iotoperations.BrokerAuthenticationArgs{
			AuthenticationName: 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.BrokerAuthenticationPropertiesArgs{
				AuthenticationMethods: iotoperations.BrokerAuthenticatorMethodsArray{
					&iotoperations.BrokerAuthenticatorMethodsArgs{
						CustomSettings: &iotoperations.BrokerAuthenticatorMethodCustomArgs{
							Auth: &iotoperations.BrokerAuthenticatorCustomAuthArgs{
								X509: &iotoperations.X509ManualCertificateArgs{
									SecretRef: pulumi.String("secret-name"),
								},
							},
							CaCertConfigMap: pulumi.String("pdecudefqyolvncbus"),
							Endpoint:        pulumi.String("https://www.example.com"),
							Headers: pulumi.StringMap{
								"key8518": pulumi.String("bwityjy"),
							},
						},
						Method: pulumi.String(iotoperations.BrokerAuthenticationMethodCustom),
						ServiceAccountTokenSettings: &iotoperations.BrokerAuthenticatorMethodSatArgs{
							Audiences: pulumi.StringArray{
								pulumi.String("jqyhyqatuydg"),
							},
						},
						X509Settings: &iotoperations.BrokerAuthenticatorMethodX509Args{
							AuthorizationAttributes: iotoperations.BrokerAuthenticatorMethodX509AttributesMap{
								"key3384": &iotoperations.BrokerAuthenticatorMethodX509AttributesArgs{
									Attributes: pulumi.StringMap{
										"key186": pulumi.String("ucpajramsz"),
									},
									Subject: pulumi.String("jpgwctfeixitptfgfnqhua"),
								},
							},
							TrustedClientCaCert: pulumi.String("vlctsqddl"),
						},
					},
				},
			},
			ResourceGroupName: pulumi.String("rgiotoperations"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.iotoperations.BrokerAuthentication;
import com.pulumi.azurenative.iotoperations.BrokerAuthenticationArgs;
import com.pulumi.azurenative.iotoperations.inputs.ExtendedLocationArgs;
import com.pulumi.azurenative.iotoperations.inputs.BrokerAuthenticationPropertiesArgs;
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 brokerAuthentication = new BrokerAuthentication("brokerAuthentication", BrokerAuthenticationArgs.builder()
            .authenticationName("resource-name123")
            .brokerName("resource-name123")
            .extendedLocation(ExtendedLocationArgs.builder()
                .name("qmbrfwcpwwhggszhrdjv")
                .type("CustomLocation")
                .build())
            .instanceName("resource-name123")
            .properties(BrokerAuthenticationPropertiesArgs.builder()
                .authenticationMethods(BrokerAuthenticatorMethodsArgs.builder()
                    .customSettings(BrokerAuthenticatorMethodCustomArgs.builder()
                        .auth(BrokerAuthenticatorCustomAuthArgs.builder()
                            .x509(X509ManualCertificateArgs.builder()
                                .secretRef("secret-name")
                                .build())
                            .build())
                        .caCertConfigMap("pdecudefqyolvncbus")
                        .endpoint("https://www.example.com")
                        .headers(Map.of("key8518", "bwityjy"))
                        .build())
                    .method("Custom")
                    .serviceAccountTokenSettings(BrokerAuthenticatorMethodSatArgs.builder()
                        .audiences("jqyhyqatuydg")
                        .build())
                    .x509Settings(BrokerAuthenticatorMethodX509Args.builder()
                        .authorizationAttributes(Map.of("key3384", BrokerAuthenticatorMethodX509AttributesArgs.builder()
                            .attributes(Map.of("key186", "ucpajramsz"))
                            .subject("jpgwctfeixitptfgfnqhua")
                            .build()))
                        .trustedClientCaCert("vlctsqddl")
                        .build())
                    .build())
                .build())
            .resourceGroupName("rgiotoperations")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const brokerAuthentication = new azure_native.iotoperations.BrokerAuthentication("brokerAuthentication", {
    authenticationName: "resource-name123",
    brokerName: "resource-name123",
    extendedLocation: {
        name: "qmbrfwcpwwhggszhrdjv",
        type: azure_native.iotoperations.ExtendedLocationType.CustomLocation,
    },
    instanceName: "resource-name123",
    properties: {
        authenticationMethods: [{
            customSettings: {
                auth: {
                    x509: {
                        secretRef: "secret-name",
                    },
                },
                caCertConfigMap: "pdecudefqyolvncbus",
                endpoint: "https://www.example.com",
                headers: {
                    key8518: "bwityjy",
                },
            },
            method: azure_native.iotoperations.BrokerAuthenticationMethod.Custom,
            serviceAccountTokenSettings: {
                audiences: ["jqyhyqatuydg"],
            },
            x509Settings: {
                authorizationAttributes: {
                    key3384: {
                        attributes: {
                            key186: "ucpajramsz",
                        },
                        subject: "jpgwctfeixitptfgfnqhua",
                    },
                },
                trustedClientCaCert: "vlctsqddl",
            },
        }],
    },
    resourceGroupName: "rgiotoperations",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

broker_authentication = azure_native.iotoperations.BrokerAuthentication("brokerAuthentication",
    authentication_name="resource-name123",
    broker_name="resource-name123",
    extended_location={
        "name": "qmbrfwcpwwhggszhrdjv",
        "type": azure_native.iotoperations.ExtendedLocationType.CUSTOM_LOCATION,
    },
    instance_name="resource-name123",
    properties={
        "authentication_methods": [{
            "custom_settings": {
                "auth": {
                    "x509": {
                        "secret_ref": "secret-name",
                    },
                },
                "ca_cert_config_map": "pdecudefqyolvncbus",
                "endpoint": "https://www.example.com",
                "headers": {
                    "key8518": "bwityjy",
                },
            },
            "method": azure_native.iotoperations.BrokerAuthenticationMethod.CUSTOM,
            "service_account_token_settings": {
                "audiences": ["jqyhyqatuydg"],
            },
            "x509_settings": {
                "authorization_attributes": {
                    "key3384": {
                        "attributes": {
                            "key186": "ucpajramsz",
                        },
                        "subject": "jpgwctfeixitptfgfnqhua",
                    },
                },
                "trusted_client_ca_cert": "vlctsqddl",
            },
        }],
    },
    resource_group_name="rgiotoperations")
Copy
resources:
  brokerAuthentication:
    type: azure-native:iotoperations:BrokerAuthentication
    properties:
      authenticationName: resource-name123
      brokerName: resource-name123
      extendedLocation:
        name: qmbrfwcpwwhggszhrdjv
        type: CustomLocation
      instanceName: resource-name123
      properties:
        authenticationMethods:
          - customSettings:
              auth:
                x509:
                  secretRef: secret-name
              caCertConfigMap: pdecudefqyolvncbus
              endpoint: https://www.example.com
              headers:
                key8518: bwityjy
            method: Custom
            serviceAccountTokenSettings:
              audiences:
                - jqyhyqatuydg
            x509Settings:
              authorizationAttributes:
                key3384:
                  attributes:
                    key186: ucpajramsz
                  subject: jpgwctfeixitptfgfnqhua
              trustedClientCaCert: vlctsqddl
      resourceGroupName: rgiotoperations
Copy

BrokerAuthentication_CreateOrUpdate_Complex

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var brokerAuthentication = new AzureNative.IoTOperations.BrokerAuthentication("brokerAuthentication", new()
    {
        AuthenticationName = "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.BrokerAuthenticationPropertiesArgs
        {
            AuthenticationMethods = new[]
            {
                new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodsArgs
                {
                    Method = AzureNative.IoTOperations.BrokerAuthenticationMethod.ServiceAccountToken,
                    ServiceAccountTokenSettings = new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodSatArgs
                    {
                        Audiences = new[]
                        {
                            "aio-internal",
                        },
                    },
                },
                new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodsArgs
                {
                    Method = AzureNative.IoTOperations.BrokerAuthenticationMethod.X509,
                    X509Settings = new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodX509Args
                    {
                        AuthorizationAttributes = 
                        {
                            { "intermediate", new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodX509AttributesArgs
                            {
                                Attributes = 
                                {
                                    { "city", "seattle" },
                                    { "foo", "bar" },
                                },
                                Subject = "CN = Contoso Intermediate CA",
                            } },
                            { "root", new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodX509AttributesArgs
                            {
                                Attributes = 
                                {
                                    { "organization", "contoso" },
                                },
                                Subject = "CN = Contoso Root CA Cert, OU = Engineering, C = US",
                            } },
                            { "smart-fan", new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodX509AttributesArgs
                            {
                                Attributes = 
                                {
                                    { "building", "17" },
                                },
                                Subject = "CN = smart-fan",
                            } },
                        },
                        TrustedClientCaCert = "my-ca",
                    },
                },
            },
        },
        ResourceGroupName = "rgiotoperations",
    });

});
Copy
package main

import (
	iotoperations "github.com/pulumi/pulumi-azure-native-sdk/iotoperations/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iotoperations.NewBrokerAuthentication(ctx, "brokerAuthentication", &iotoperations.BrokerAuthenticationArgs{
			AuthenticationName: 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.BrokerAuthenticationPropertiesArgs{
				AuthenticationMethods: iotoperations.BrokerAuthenticatorMethodsArray{
					&iotoperations.BrokerAuthenticatorMethodsArgs{
						Method: pulumi.String(iotoperations.BrokerAuthenticationMethodServiceAccountToken),
						ServiceAccountTokenSettings: &iotoperations.BrokerAuthenticatorMethodSatArgs{
							Audiences: pulumi.StringArray{
								pulumi.String("aio-internal"),
							},
						},
					},
					&iotoperations.BrokerAuthenticatorMethodsArgs{
						Method: pulumi.String(iotoperations.BrokerAuthenticationMethodX509),
						X509Settings: &iotoperations.BrokerAuthenticatorMethodX509Args{
							AuthorizationAttributes: iotoperations.BrokerAuthenticatorMethodX509AttributesMap{
								"intermediate": &iotoperations.BrokerAuthenticatorMethodX509AttributesArgs{
									Attributes: pulumi.StringMap{
										"city": pulumi.String("seattle"),
										"foo":  pulumi.String("bar"),
									},
									Subject: pulumi.String("CN = Contoso Intermediate CA"),
								},
								"root": &iotoperations.BrokerAuthenticatorMethodX509AttributesArgs{
									Attributes: pulumi.StringMap{
										"organization": pulumi.String("contoso"),
									},
									Subject: pulumi.String("CN = Contoso Root CA Cert, OU = Engineering, C = US"),
								},
								"smart-fan": &iotoperations.BrokerAuthenticatorMethodX509AttributesArgs{
									Attributes: pulumi.StringMap{
										"building": pulumi.String("17"),
									},
									Subject: pulumi.String("CN = smart-fan"),
								},
							},
							TrustedClientCaCert: pulumi.String("my-ca"),
						},
					},
				},
			},
			ResourceGroupName: pulumi.String("rgiotoperations"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.iotoperations.BrokerAuthentication;
import com.pulumi.azurenative.iotoperations.BrokerAuthenticationArgs;
import com.pulumi.azurenative.iotoperations.inputs.ExtendedLocationArgs;
import com.pulumi.azurenative.iotoperations.inputs.BrokerAuthenticationPropertiesArgs;
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 brokerAuthentication = new BrokerAuthentication("brokerAuthentication", BrokerAuthenticationArgs.builder()
            .authenticationName("resource-name123")
            .brokerName("resource-name123")
            .extendedLocation(ExtendedLocationArgs.builder()
                .name("qmbrfwcpwwhggszhrdjv")
                .type("CustomLocation")
                .build())
            .instanceName("resource-name123")
            .properties(BrokerAuthenticationPropertiesArgs.builder()
                .authenticationMethods(                
                    BrokerAuthenticatorMethodsArgs.builder()
                        .method("ServiceAccountToken")
                        .serviceAccountTokenSettings(BrokerAuthenticatorMethodSatArgs.builder()
                            .audiences("aio-internal")
                            .build())
                        .build(),
                    BrokerAuthenticatorMethodsArgs.builder()
                        .method("X509")
                        .x509Settings(BrokerAuthenticatorMethodX509Args.builder()
                            .authorizationAttributes(Map.ofEntries(
                                Map.entry("intermediate", BrokerAuthenticatorMethodX509AttributesArgs.builder()
                                    .attributes(Map.ofEntries(
                                        Map.entry("city", "seattle"),
                                        Map.entry("foo", "bar")
                                    ))
                                    .subject("CN = Contoso Intermediate CA")
                                    .build()),
                                Map.entry("root", BrokerAuthenticatorMethodX509AttributesArgs.builder()
                                    .attributes(Map.of("organization", "contoso"))
                                    .subject("CN = Contoso Root CA Cert, OU = Engineering, C = US")
                                    .build()),
                                Map.entry("smart-fan", BrokerAuthenticatorMethodX509AttributesArgs.builder()
                                    .attributes(Map.of("building", "17"))
                                    .subject("CN = smart-fan")
                                    .build())
                            ))
                            .trustedClientCaCert("my-ca")
                            .build())
                        .build())
                .build())
            .resourceGroupName("rgiotoperations")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const brokerAuthentication = new azure_native.iotoperations.BrokerAuthentication("brokerAuthentication", {
    authenticationName: "resource-name123",
    brokerName: "resource-name123",
    extendedLocation: {
        name: "qmbrfwcpwwhggszhrdjv",
        type: azure_native.iotoperations.ExtendedLocationType.CustomLocation,
    },
    instanceName: "resource-name123",
    properties: {
        authenticationMethods: [
            {
                method: azure_native.iotoperations.BrokerAuthenticationMethod.ServiceAccountToken,
                serviceAccountTokenSettings: {
                    audiences: ["aio-internal"],
                },
            },
            {
                method: azure_native.iotoperations.BrokerAuthenticationMethod.X509,
                x509Settings: {
                    authorizationAttributes: {
                        intermediate: {
                            attributes: {
                                city: "seattle",
                                foo: "bar",
                            },
                            subject: "CN = Contoso Intermediate CA",
                        },
                        root: {
                            attributes: {
                                organization: "contoso",
                            },
                            subject: "CN = Contoso Root CA Cert, OU = Engineering, C = US",
                        },
                        "smart-fan": {
                            attributes: {
                                building: "17",
                            },
                            subject: "CN = smart-fan",
                        },
                    },
                    trustedClientCaCert: "my-ca",
                },
            },
        ],
    },
    resourceGroupName: "rgiotoperations",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

broker_authentication = azure_native.iotoperations.BrokerAuthentication("brokerAuthentication",
    authentication_name="resource-name123",
    broker_name="resource-name123",
    extended_location={
        "name": "qmbrfwcpwwhggszhrdjv",
        "type": azure_native.iotoperations.ExtendedLocationType.CUSTOM_LOCATION,
    },
    instance_name="resource-name123",
    properties={
        "authentication_methods": [
            {
                "method": azure_native.iotoperations.BrokerAuthenticationMethod.SERVICE_ACCOUNT_TOKEN,
                "service_account_token_settings": {
                    "audiences": ["aio-internal"],
                },
            },
            {
                "method": azure_native.iotoperations.BrokerAuthenticationMethod.X509,
                "x509_settings": {
                    "authorization_attributes": {
                        "intermediate": {
                            "attributes": {
                                "city": "seattle",
                                "foo": "bar",
                            },
                            "subject": "CN = Contoso Intermediate CA",
                        },
                        "root": {
                            "attributes": {
                                "organization": "contoso",
                            },
                            "subject": "CN = Contoso Root CA Cert, OU = Engineering, C = US",
                        },
                        "smart-fan": {
                            "attributes": {
                                "building": "17",
                            },
                            "subject": "CN = smart-fan",
                        },
                    },
                    "trusted_client_ca_cert": "my-ca",
                },
            },
        ],
    },
    resource_group_name="rgiotoperations")
Copy
resources:
  brokerAuthentication:
    type: azure-native:iotoperations:BrokerAuthentication
    properties:
      authenticationName: resource-name123
      brokerName: resource-name123
      extendedLocation:
        name: qmbrfwcpwwhggszhrdjv
        type: CustomLocation
      instanceName: resource-name123
      properties:
        authenticationMethods:
          - method: ServiceAccountToken
            serviceAccountTokenSettings:
              audiences:
                - aio-internal
          - method: X509
            x509Settings:
              authorizationAttributes:
                intermediate:
                  attributes:
                    city: seattle
                    foo: bar
                  subject: CN = Contoso Intermediate CA
                root:
                  attributes:
                    organization: contoso
                  subject: CN = Contoso Root CA Cert, OU = Engineering, C = US
                smart-fan:
                  attributes:
                    building: '17'
                  subject: CN = smart-fan
              trustedClientCaCert: my-ca
      resourceGroupName: rgiotoperations
Copy

Create BrokerAuthentication Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new BrokerAuthentication(name: string, args: BrokerAuthenticationArgs, opts?: CustomResourceOptions);
@overload
def BrokerAuthentication(resource_name: str,
                         args: BrokerAuthenticationArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def BrokerAuthentication(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         broker_name: Optional[str] = None,
                         extended_location: Optional[ExtendedLocationArgs] = None,
                         instance_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         authentication_name: Optional[str] = None,
                         properties: Optional[BrokerAuthenticationPropertiesArgs] = None)
func NewBrokerAuthentication(ctx *Context, name string, args BrokerAuthenticationArgs, opts ...ResourceOption) (*BrokerAuthentication, error)
public BrokerAuthentication(string name, BrokerAuthenticationArgs args, CustomResourceOptions? opts = null)
public BrokerAuthentication(String name, BrokerAuthenticationArgs args)
public BrokerAuthentication(String name, BrokerAuthenticationArgs args, CustomResourceOptions options)

type: azure-native:iotoperations:BrokerAuthentication
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BrokerAuthenticationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BrokerAuthenticationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BrokerAuthenticationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BrokerAuthenticationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BrokerAuthenticationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var brokerAuthenticationResource = new AzureNative.IoTOperations.BrokerAuthentication("brokerAuthenticationResource", new()
{
    BrokerName = "string",
    ExtendedLocation = new AzureNative.IoTOperations.Inputs.ExtendedLocationArgs
    {
        Name = "string",
        Type = "string",
    },
    InstanceName = "string",
    ResourceGroupName = "string",
    AuthenticationName = "string",
    Properties = new AzureNative.IoTOperations.Inputs.BrokerAuthenticationPropertiesArgs
    {
        AuthenticationMethods = new[]
        {
            new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodsArgs
            {
                Method = "string",
                CustomSettings = new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodCustomArgs
                {
                    Endpoint = "string",
                    Auth = new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorCustomAuthArgs
                    {
                        X509 = new AzureNative.IoTOperations.Inputs.X509ManualCertificateArgs
                        {
                            SecretRef = "string",
                        },
                    },
                    CaCertConfigMap = "string",
                    Headers = 
                    {
                        { "string", "string" },
                    },
                },
                ServiceAccountTokenSettings = new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodSatArgs
                {
                    Audiences = new[]
                    {
                        "string",
                    },
                },
                X509Settings = new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodX509Args
                {
                    AuthorizationAttributes = 
                    {
                        { "string", new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodX509AttributesArgs
                        {
                            Attributes = 
                            {
                                { "string", "string" },
                            },
                            Subject = "string",
                        } },
                    },
                    TrustedClientCaCert = "string",
                },
            },
        },
    },
});
Copy
example, err := iotoperations.NewBrokerAuthentication(ctx, "brokerAuthenticationResource", &iotoperations.BrokerAuthenticationArgs{
	BrokerName: pulumi.String("string"),
	ExtendedLocation: &iotoperations.ExtendedLocationArgs{
		Name: pulumi.String("string"),
		Type: pulumi.String("string"),
	},
	InstanceName:       pulumi.String("string"),
	ResourceGroupName:  pulumi.String("string"),
	AuthenticationName: pulumi.String("string"),
	Properties: &iotoperations.BrokerAuthenticationPropertiesArgs{
		AuthenticationMethods: iotoperations.BrokerAuthenticatorMethodsArray{
			&iotoperations.BrokerAuthenticatorMethodsArgs{
				Method: pulumi.String("string"),
				CustomSettings: &iotoperations.BrokerAuthenticatorMethodCustomArgs{
					Endpoint: pulumi.String("string"),
					Auth: &iotoperations.BrokerAuthenticatorCustomAuthArgs{
						X509: &iotoperations.X509ManualCertificateArgs{
							SecretRef: pulumi.String("string"),
						},
					},
					CaCertConfigMap: pulumi.String("string"),
					Headers: pulumi.StringMap{
						"string": pulumi.String("string"),
					},
				},
				ServiceAccountTokenSettings: &iotoperations.BrokerAuthenticatorMethodSatArgs{
					Audiences: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
				X509Settings: &iotoperations.BrokerAuthenticatorMethodX509Args{
					AuthorizationAttributes: iotoperations.BrokerAuthenticatorMethodX509AttributesMap{
						"string": &iotoperations.BrokerAuthenticatorMethodX509AttributesArgs{
							Attributes: pulumi.StringMap{
								"string": pulumi.String("string"),
							},
							Subject: pulumi.String("string"),
						},
					},
					TrustedClientCaCert: pulumi.String("string"),
				},
			},
		},
	},
})
Copy
var brokerAuthenticationResource = new BrokerAuthentication("brokerAuthenticationResource", BrokerAuthenticationArgs.builder()
    .brokerName("string")
    .extendedLocation(ExtendedLocationArgs.builder()
        .name("string")
        .type("string")
        .build())
    .instanceName("string")
    .resourceGroupName("string")
    .authenticationName("string")
    .properties(BrokerAuthenticationPropertiesArgs.builder()
        .authenticationMethods(BrokerAuthenticatorMethodsArgs.builder()
            .method("string")
            .customSettings(BrokerAuthenticatorMethodCustomArgs.builder()
                .endpoint("string")
                .auth(BrokerAuthenticatorCustomAuthArgs.builder()
                    .x509(X509ManualCertificateArgs.builder()
                        .secretRef("string")
                        .build())
                    .build())
                .caCertConfigMap("string")
                .headers(Map.of("string", "string"))
                .build())
            .serviceAccountTokenSettings(BrokerAuthenticatorMethodSatArgs.builder()
                .audiences("string")
                .build())
            .x509Settings(BrokerAuthenticatorMethodX509Args.builder()
                .authorizationAttributes(Map.of("string", Map.ofEntries(
                    Map.entry("attributes", Map.of("string", "string")),
                    Map.entry("subject", "string")
                )))
                .trustedClientCaCert("string")
                .build())
            .build())
        .build())
    .build());
Copy
broker_authentication_resource = azure_native.iotoperations.BrokerAuthentication("brokerAuthenticationResource",
    broker_name="string",
    extended_location={
        "name": "string",
        "type": "string",
    },
    instance_name="string",
    resource_group_name="string",
    authentication_name="string",
    properties={
        "authentication_methods": [{
            "method": "string",
            "custom_settings": {
                "endpoint": "string",
                "auth": {
                    "x509": {
                        "secret_ref": "string",
                    },
                },
                "ca_cert_config_map": "string",
                "headers": {
                    "string": "string",
                },
            },
            "service_account_token_settings": {
                "audiences": ["string"],
            },
            "x509_settings": {
                "authorization_attributes": {
                    "string": {
                        "attributes": {
                            "string": "string",
                        },
                        "subject": "string",
                    },
                },
                "trusted_client_ca_cert": "string",
            },
        }],
    })
Copy
const brokerAuthenticationResource = new azure_native.iotoperations.BrokerAuthentication("brokerAuthenticationResource", {
    brokerName: "string",
    extendedLocation: {
        name: "string",
        type: "string",
    },
    instanceName: "string",
    resourceGroupName: "string",
    authenticationName: "string",
    properties: {
        authenticationMethods: [{
            method: "string",
            customSettings: {
                endpoint: "string",
                auth: {
                    x509: {
                        secretRef: "string",
                    },
                },
                caCertConfigMap: "string",
                headers: {
                    string: "string",
                },
            },
            serviceAccountTokenSettings: {
                audiences: ["string"],
            },
            x509Settings: {
                authorizationAttributes: {
                    string: {
                        attributes: {
                            string: "string",
                        },
                        subject: "string",
                    },
                },
                trustedClientCaCert: "string",
            },
        }],
    },
});
Copy
type: azure-native:iotoperations:BrokerAuthentication
properties:
    authenticationName: string
    brokerName: string
    extendedLocation:
        name: string
        type: string
    instanceName: string
    properties:
        authenticationMethods:
            - customSettings:
                auth:
                    x509:
                        secretRef: string
                caCertConfigMap: string
                endpoint: string
                headers:
                    string: string
              method: string
              serviceAccountTokenSettings:
                audiences:
                    - string
              x509Settings:
                authorizationAttributes:
                    string:
                        attributes:
                            string: string
                        subject: string
                trustedClientCaCert: string
    resourceGroupName: string
Copy

BrokerAuthentication Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The BrokerAuthentication resource accepts the following input properties:

BrokerName
This property is required.
Changes to this property will trigger replacement.
string
Name of broker.
ExtendedLocation
This property is required.
Changes to this property will trigger replacement.
Pulumi.AzureNative.IoTOperations.Inputs.ExtendedLocation
Edge location of the resource.
InstanceName
This property is required.
Changes to this property will trigger replacement.
string
Name of instance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AuthenticationName Changes to this property will trigger replacement. string
Name of Instance broker authentication resource
Properties Pulumi.AzureNative.IoTOperations.Inputs.BrokerAuthenticationProperties
The resource-specific properties for this resource.
BrokerName
This property is required.
Changes to this property will trigger replacement.
string
Name of broker.
ExtendedLocation
This property is required.
Changes to this property will trigger replacement.
ExtendedLocationArgs
Edge location of the resource.
InstanceName
This property is required.
Changes to this property will trigger replacement.
string
Name of instance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AuthenticationName Changes to this property will trigger replacement. string
Name of Instance broker authentication resource
Properties BrokerAuthenticationPropertiesArgs
The resource-specific properties for this resource.
brokerName
This property is required.
Changes to this property will trigger replacement.
String
Name of broker.
extendedLocation
This property is required.
Changes to this property will trigger replacement.
ExtendedLocation
Edge location of the resource.
instanceName
This property is required.
Changes to this property will trigger replacement.
String
Name of instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
authenticationName Changes to this property will trigger replacement. String
Name of Instance broker authentication resource
properties BrokerAuthenticationProperties
The resource-specific properties for this resource.
brokerName
This property is required.
Changes to this property will trigger replacement.
string
Name of broker.
extendedLocation
This property is required.
Changes to this property will trigger replacement.
ExtendedLocation
Edge location of the resource.
instanceName
This property is required.
Changes to this property will trigger replacement.
string
Name of instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
authenticationName Changes to this property will trigger replacement. string
Name of Instance broker authentication resource
properties BrokerAuthenticationProperties
The resource-specific properties for this resource.
broker_name
This property is required.
Changes to this property will trigger replacement.
str
Name of broker.
extended_location
This property is required.
Changes to this property will trigger replacement.
ExtendedLocationArgs
Edge location of the resource.
instance_name
This property is required.
Changes to this property will trigger replacement.
str
Name of instance.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
authentication_name Changes to this property will trigger replacement. str
Name of Instance broker authentication resource
properties BrokerAuthenticationPropertiesArgs
The resource-specific properties for this resource.
brokerName
This property is required.
Changes to this property will trigger replacement.
String
Name of broker.
extendedLocation
This property is required.
Changes to this property will trigger replacement.
Property Map
Edge location of the resource.
instanceName
This property is required.
Changes to this property will trigger replacement.
String
Name of instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
authenticationName Changes to this property will trigger replacement. String
Name of Instance broker authentication resource
properties Property Map
The resource-specific properties for this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the BrokerAuthentication resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
SystemData Pulumi.AzureNative.IoTOperations.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

BrokerAuthenticationMethod
, BrokerAuthenticationMethodArgs

Custom
CustomCustom authentication configuration.
ServiceAccountToken
ServiceAccountTokenServiceAccountToken authentication configuration.
X509
X509X.509 authentication configuration.
BrokerAuthenticationMethodCustom
CustomCustom authentication configuration.
BrokerAuthenticationMethodServiceAccountToken
ServiceAccountTokenServiceAccountToken authentication configuration.
BrokerAuthenticationMethodX509
X509X.509 authentication configuration.
Custom
CustomCustom authentication configuration.
ServiceAccountToken
ServiceAccountTokenServiceAccountToken authentication configuration.
X509
X509X.509 authentication configuration.
Custom
CustomCustom authentication configuration.
ServiceAccountToken
ServiceAccountTokenServiceAccountToken authentication configuration.
X509
X509X.509 authentication configuration.
CUSTOM
CustomCustom authentication configuration.
SERVICE_ACCOUNT_TOKEN
ServiceAccountTokenServiceAccountToken authentication configuration.
X509
X509X.509 authentication configuration.
"Custom"
CustomCustom authentication configuration.
"ServiceAccountToken"
ServiceAccountTokenServiceAccountToken authentication configuration.
"X509"
X509X.509 authentication configuration.

BrokerAuthenticationProperties
, BrokerAuthenticationPropertiesArgs

AuthenticationMethods This property is required. List<Pulumi.AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethods>
Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
AuthenticationMethods This property is required. []BrokerAuthenticatorMethods
Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
authenticationMethods This property is required. List<BrokerAuthenticatorMethods>
Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
authenticationMethods This property is required. BrokerAuthenticatorMethods[]
Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
authentication_methods This property is required. Sequence[BrokerAuthenticatorMethods]
Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
authenticationMethods This property is required. List<Property Map>
Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.

BrokerAuthenticationPropertiesResponse
, BrokerAuthenticationPropertiesResponseArgs

AuthenticationMethods This property is required. List<Pulumi.AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodsResponse>
Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
ProvisioningState This property is required. string
The status of the last operation.
AuthenticationMethods This property is required. []BrokerAuthenticatorMethodsResponse
Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
ProvisioningState This property is required. string
The status of the last operation.
authenticationMethods This property is required. List<BrokerAuthenticatorMethodsResponse>
Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
provisioningState This property is required. String
The status of the last operation.
authenticationMethods This property is required. BrokerAuthenticatorMethodsResponse[]
Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
provisioningState This property is required. string
The status of the last operation.
authentication_methods This property is required. Sequence[BrokerAuthenticatorMethodsResponse]
Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
provisioning_state This property is required. str
The status of the last operation.
authenticationMethods This property is required. List<Property Map>
Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
provisioningState This property is required. String
The status of the last operation.

BrokerAuthenticatorCustomAuth
, BrokerAuthenticatorCustomAuthArgs

X509 This property is required. Pulumi.AzureNative.IoTOperations.Inputs.X509ManualCertificate
X509 Custom Auth type details.
X509 This property is required. X509ManualCertificate
X509 Custom Auth type details.
x509 This property is required. X509ManualCertificate
X509 Custom Auth type details.
x509 This property is required. X509ManualCertificate
X509 Custom Auth type details.
x509 This property is required. X509ManualCertificate
X509 Custom Auth type details.
x509 This property is required. Property Map
X509 Custom Auth type details.

BrokerAuthenticatorCustomAuthResponse
, BrokerAuthenticatorCustomAuthResponseArgs

X509 This property is required. Pulumi.AzureNative.IoTOperations.Inputs.X509ManualCertificateResponse
X509 Custom Auth type details.
X509 This property is required. X509ManualCertificateResponse
X509 Custom Auth type details.
x509 This property is required. X509ManualCertificateResponse
X509 Custom Auth type details.
x509 This property is required. X509ManualCertificateResponse
X509 Custom Auth type details.
x509 This property is required. X509ManualCertificateResponse
X509 Custom Auth type details.
x509 This property is required. Property Map
X509 Custom Auth type details.

BrokerAuthenticatorMethodCustom
, BrokerAuthenticatorMethodCustomArgs

Endpoint This property is required. string
Endpoint of the custom authentication server. Must be an HTTPS endpoint.
Auth Pulumi.AzureNative.IoTOperations.Inputs.BrokerAuthenticatorCustomAuth
Optional authentication needed for authenticating with the custom authentication server.
CaCertConfigMap string
Optional CA certificate for validating the custom authentication server's certificate.
Headers Dictionary<string, string>
Additional HTTP headers to pass to the custom authentication server.
Endpoint This property is required. string
Endpoint of the custom authentication server. Must be an HTTPS endpoint.
Auth BrokerAuthenticatorCustomAuth
Optional authentication needed for authenticating with the custom authentication server.
CaCertConfigMap string
Optional CA certificate for validating the custom authentication server's certificate.
Headers map[string]string
Additional HTTP headers to pass to the custom authentication server.
endpoint This property is required. String
Endpoint of the custom authentication server. Must be an HTTPS endpoint.
auth BrokerAuthenticatorCustomAuth
Optional authentication needed for authenticating with the custom authentication server.
caCertConfigMap String
Optional CA certificate for validating the custom authentication server's certificate.
headers Map<String,String>
Additional HTTP headers to pass to the custom authentication server.
endpoint This property is required. string
Endpoint of the custom authentication server. Must be an HTTPS endpoint.
auth BrokerAuthenticatorCustomAuth
Optional authentication needed for authenticating with the custom authentication server.
caCertConfigMap string
Optional CA certificate for validating the custom authentication server's certificate.
headers {[key: string]: string}
Additional HTTP headers to pass to the custom authentication server.
endpoint This property is required. str
Endpoint of the custom authentication server. Must be an HTTPS endpoint.
auth BrokerAuthenticatorCustomAuth
Optional authentication needed for authenticating with the custom authentication server.
ca_cert_config_map str
Optional CA certificate for validating the custom authentication server's certificate.
headers Mapping[str, str]
Additional HTTP headers to pass to the custom authentication server.
endpoint This property is required. String
Endpoint of the custom authentication server. Must be an HTTPS endpoint.
auth Property Map
Optional authentication needed for authenticating with the custom authentication server.
caCertConfigMap String
Optional CA certificate for validating the custom authentication server's certificate.
headers Map<String>
Additional HTTP headers to pass to the custom authentication server.

BrokerAuthenticatorMethodCustomResponse
, BrokerAuthenticatorMethodCustomResponseArgs

Endpoint This property is required. string
Endpoint of the custom authentication server. Must be an HTTPS endpoint.
Auth Pulumi.AzureNative.IoTOperations.Inputs.BrokerAuthenticatorCustomAuthResponse
Optional authentication needed for authenticating with the custom authentication server.
CaCertConfigMap string
Optional CA certificate for validating the custom authentication server's certificate.
Headers Dictionary<string, string>
Additional HTTP headers to pass to the custom authentication server.
Endpoint This property is required. string
Endpoint of the custom authentication server. Must be an HTTPS endpoint.
Auth BrokerAuthenticatorCustomAuthResponse
Optional authentication needed for authenticating with the custom authentication server.
CaCertConfigMap string
Optional CA certificate for validating the custom authentication server's certificate.
Headers map[string]string
Additional HTTP headers to pass to the custom authentication server.
endpoint This property is required. String
Endpoint of the custom authentication server. Must be an HTTPS endpoint.
auth BrokerAuthenticatorCustomAuthResponse
Optional authentication needed for authenticating with the custom authentication server.
caCertConfigMap String
Optional CA certificate for validating the custom authentication server's certificate.
headers Map<String,String>
Additional HTTP headers to pass to the custom authentication server.
endpoint This property is required. string
Endpoint of the custom authentication server. Must be an HTTPS endpoint.
auth BrokerAuthenticatorCustomAuthResponse
Optional authentication needed for authenticating with the custom authentication server.
caCertConfigMap string
Optional CA certificate for validating the custom authentication server's certificate.
headers {[key: string]: string}
Additional HTTP headers to pass to the custom authentication server.
endpoint This property is required. str
Endpoint of the custom authentication server. Must be an HTTPS endpoint.
auth BrokerAuthenticatorCustomAuthResponse
Optional authentication needed for authenticating with the custom authentication server.
ca_cert_config_map str
Optional CA certificate for validating the custom authentication server's certificate.
headers Mapping[str, str]
Additional HTTP headers to pass to the custom authentication server.
endpoint This property is required. String
Endpoint of the custom authentication server. Must be an HTTPS endpoint.
auth Property Map
Optional authentication needed for authenticating with the custom authentication server.
caCertConfigMap String
Optional CA certificate for validating the custom authentication server's certificate.
headers Map<String>
Additional HTTP headers to pass to the custom authentication server.

BrokerAuthenticatorMethodSat
, BrokerAuthenticatorMethodSatArgs

Audiences This property is required. List<string>
List of allowed audience.
Audiences This property is required. []string
List of allowed audience.
audiences This property is required. List<String>
List of allowed audience.
audiences This property is required. string[]
List of allowed audience.
audiences This property is required. Sequence[str]
List of allowed audience.
audiences This property is required. List<String>
List of allowed audience.

BrokerAuthenticatorMethodSatResponse
, BrokerAuthenticatorMethodSatResponseArgs

Audiences This property is required. List<string>
List of allowed audience.
Audiences This property is required. []string
List of allowed audience.
audiences This property is required. List<String>
List of allowed audience.
audiences This property is required. string[]
List of allowed audience.
audiences This property is required. Sequence[str]
List of allowed audience.
audiences This property is required. List<String>
List of allowed audience.

BrokerAuthenticatorMethodX509
, BrokerAuthenticatorMethodX509Args

AuthorizationAttributes Dictionary<string, Pulumi.AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodX509Attributes>
X509 authorization attributes properties.
TrustedClientCaCert string
Name of the trusted client ca cert resource.
AuthorizationAttributes map[string]BrokerAuthenticatorMethodX509Attributes
X509 authorization attributes properties.
TrustedClientCaCert string
Name of the trusted client ca cert resource.
authorizationAttributes Map<String,BrokerAuthenticatorMethodX509Attributes>
X509 authorization attributes properties.
trustedClientCaCert String
Name of the trusted client ca cert resource.
authorizationAttributes {[key: string]: BrokerAuthenticatorMethodX509Attributes}
X509 authorization attributes properties.
trustedClientCaCert string
Name of the trusted client ca cert resource.
authorization_attributes Mapping[str, BrokerAuthenticatorMethodX509Attributes]
X509 authorization attributes properties.
trusted_client_ca_cert str
Name of the trusted client ca cert resource.
authorizationAttributes Map<Property Map>
X509 authorization attributes properties.
trustedClientCaCert String
Name of the trusted client ca cert resource.

BrokerAuthenticatorMethodX509Attributes
, BrokerAuthenticatorMethodX509AttributesArgs

Attributes This property is required. Dictionary<string, string>
Attributes object.
Subject This property is required. string
Subject of the X509 attribute.
Attributes This property is required. map[string]string
Attributes object.
Subject This property is required. string
Subject of the X509 attribute.
attributes This property is required. Map<String,String>
Attributes object.
subject This property is required. String
Subject of the X509 attribute.
attributes This property is required. {[key: string]: string}
Attributes object.
subject This property is required. string
Subject of the X509 attribute.
attributes This property is required. Mapping[str, str]
Attributes object.
subject This property is required. str
Subject of the X509 attribute.
attributes This property is required. Map<String>
Attributes object.
subject This property is required. String
Subject of the X509 attribute.

BrokerAuthenticatorMethodX509AttributesResponse
, BrokerAuthenticatorMethodX509AttributesResponseArgs

Attributes This property is required. Dictionary<string, string>
Attributes object.
Subject This property is required. string
Subject of the X509 attribute.
Attributes This property is required. map[string]string
Attributes object.
Subject This property is required. string
Subject of the X509 attribute.
attributes This property is required. Map<String,String>
Attributes object.
subject This property is required. String
Subject of the X509 attribute.
attributes This property is required. {[key: string]: string}
Attributes object.
subject This property is required. string
Subject of the X509 attribute.
attributes This property is required. Mapping[str, str]
Attributes object.
subject This property is required. str
Subject of the X509 attribute.
attributes This property is required. Map<String>
Attributes object.
subject This property is required. String
Subject of the X509 attribute.

BrokerAuthenticatorMethodX509Response
, BrokerAuthenticatorMethodX509ResponseArgs

AuthorizationAttributes Dictionary<string, Pulumi.AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodX509AttributesResponse>
X509 authorization attributes properties.
TrustedClientCaCert string
Name of the trusted client ca cert resource.
AuthorizationAttributes map[string]BrokerAuthenticatorMethodX509AttributesResponse
X509 authorization attributes properties.
TrustedClientCaCert string
Name of the trusted client ca cert resource.
authorizationAttributes Map<String,BrokerAuthenticatorMethodX509AttributesResponse>
X509 authorization attributes properties.
trustedClientCaCert String
Name of the trusted client ca cert resource.
authorizationAttributes {[key: string]: BrokerAuthenticatorMethodX509AttributesResponse}
X509 authorization attributes properties.
trustedClientCaCert string
Name of the trusted client ca cert resource.
authorization_attributes Mapping[str, BrokerAuthenticatorMethodX509AttributesResponse]
X509 authorization attributes properties.
trusted_client_ca_cert str
Name of the trusted client ca cert resource.
authorizationAttributes Map<Property Map>
X509 authorization attributes properties.
trustedClientCaCert String
Name of the trusted client ca cert resource.

BrokerAuthenticatorMethods
, BrokerAuthenticatorMethodsArgs

Method This property is required. string | BrokerAuthenticationMethod
Custom authentication configuration.
CustomSettings BrokerAuthenticatorMethodCustom
Custom authentication configuration.
ServiceAccountTokenSettings BrokerAuthenticatorMethodSat
ServiceAccountToken authentication configuration.
X509Settings BrokerAuthenticatorMethodX509
X.509 authentication configuration.
method This property is required. String | BrokerAuthenticationMethod
Custom authentication configuration.
customSettings BrokerAuthenticatorMethodCustom
Custom authentication configuration.
serviceAccountTokenSettings BrokerAuthenticatorMethodSat
ServiceAccountToken authentication configuration.
x509Settings BrokerAuthenticatorMethodX509
X.509 authentication configuration.
method This property is required. string | BrokerAuthenticationMethod
Custom authentication configuration.
customSettings BrokerAuthenticatorMethodCustom
Custom authentication configuration.
serviceAccountTokenSettings BrokerAuthenticatorMethodSat
ServiceAccountToken authentication configuration.
x509Settings BrokerAuthenticatorMethodX509
X.509 authentication configuration.
method This property is required. str | BrokerAuthenticationMethod
Custom authentication configuration.
custom_settings BrokerAuthenticatorMethodCustom
Custom authentication configuration.
service_account_token_settings BrokerAuthenticatorMethodSat
ServiceAccountToken authentication configuration.
x509_settings BrokerAuthenticatorMethodX509
X.509 authentication configuration.
method This property is required. String | "Custom" | "ServiceAccountToken" | "X509"
Custom authentication configuration.
customSettings Property Map
Custom authentication configuration.
serviceAccountTokenSettings Property Map
ServiceAccountToken authentication configuration.
x509Settings Property Map
X.509 authentication configuration.

BrokerAuthenticatorMethodsResponse
, BrokerAuthenticatorMethodsResponseArgs

Method This property is required. string
Custom authentication configuration.
CustomSettings BrokerAuthenticatorMethodCustomResponse
Custom authentication configuration.
ServiceAccountTokenSettings BrokerAuthenticatorMethodSatResponse
ServiceAccountToken authentication configuration.
X509Settings BrokerAuthenticatorMethodX509Response
X.509 authentication configuration.
method This property is required. String
Custom authentication configuration.
customSettings BrokerAuthenticatorMethodCustomResponse
Custom authentication configuration.
serviceAccountTokenSettings BrokerAuthenticatorMethodSatResponse
ServiceAccountToken authentication configuration.
x509Settings BrokerAuthenticatorMethodX509Response
X.509 authentication configuration.
method This property is required. string
Custom authentication configuration.
customSettings BrokerAuthenticatorMethodCustomResponse
Custom authentication configuration.
serviceAccountTokenSettings BrokerAuthenticatorMethodSatResponse
ServiceAccountToken authentication configuration.
x509Settings BrokerAuthenticatorMethodX509Response
X.509 authentication configuration.
method This property is required. str
Custom authentication configuration.
custom_settings BrokerAuthenticatorMethodCustomResponse
Custom authentication configuration.
service_account_token_settings BrokerAuthenticatorMethodSatResponse
ServiceAccountToken authentication configuration.
x509_settings BrokerAuthenticatorMethodX509Response
X.509 authentication configuration.
method This property is required. String
Custom authentication configuration.
customSettings Property Map
Custom authentication configuration.
serviceAccountTokenSettings Property Map
ServiceAccountToken authentication configuration.
x509Settings Property Map
X.509 authentication configuration.

ExtendedLocation
, ExtendedLocationArgs

Name This property is required. string
The name of the extended location.
Type This property is required. string | Pulumi.AzureNative.IoTOperations.ExtendedLocationType
Type of ExtendedLocation.
Name This property is required. string
The name of the extended location.
Type This property is required. string | ExtendedLocationType
Type of ExtendedLocation.
name This property is required. String
The name of the extended location.
type This property is required. String | ExtendedLocationType
Type of ExtendedLocation.
name This property is required. string
The name of the extended location.
type This property is required. string | ExtendedLocationType
Type of ExtendedLocation.
name This property is required. str
The name of the extended location.
type This property is required. str | ExtendedLocationType
Type of ExtendedLocation.
name This property is required. String
The name of the extended location.
type This property is required. String | "CustomLocation"
Type of ExtendedLocation.

ExtendedLocationResponse
, ExtendedLocationResponseArgs

Name This property is required. string
The name of the extended location.
Type This property is required. string
Type of ExtendedLocation.
Name This property is required. string
The name of the extended location.
Type This property is required. string
Type of ExtendedLocation.
name This property is required. String
The name of the extended location.
type This property is required. String
Type of ExtendedLocation.
name This property is required. string
The name of the extended location.
type This property is required. string
Type of ExtendedLocation.
name This property is required. str
The name of the extended location.
type This property is required. str
Type of ExtendedLocation.
name This property is required. String
The name of the extended location.
type This property is required. String
Type of ExtendedLocation.

ExtendedLocationType
, ExtendedLocationTypeArgs

CustomLocation
CustomLocationCustomLocation type
ExtendedLocationTypeCustomLocation
CustomLocationCustomLocation type
CustomLocation
CustomLocationCustomLocation type
CustomLocation
CustomLocationCustomLocation type
CUSTOM_LOCATION
CustomLocationCustomLocation type
"CustomLocation"
CustomLocationCustomLocation type

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

X509ManualCertificate
, X509ManualCertificateArgs

SecretRef This property is required. string
Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.
SecretRef This property is required. string
Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.
secretRef This property is required. String
Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.
secretRef This property is required. string
Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.
secret_ref This property is required. str
Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.
secretRef This property is required. String
Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.

X509ManualCertificateResponse
, X509ManualCertificateResponseArgs

SecretRef This property is required. string
Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.
SecretRef This property is required. string
Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.
secretRef This property is required. String
Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.
secretRef This property is required. string
Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.
secret_ref This property is required. str
Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.
secretRef This property is required. String
Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:iotoperations:BrokerAuthentication lwucizfvtsdpx /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications/{authenticationName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native