Docs Home Pulumi IaC Pulumi ESC 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 v1 docs if using the v1 version of this package.
Azure Native v2.89.3 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.iotoperations.BrokerAuthentication

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.3 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-azure-native

    Instance broker authentication resource Azure REST API version: 2024-07-01-preview.

    Other available API versions: 2024-08-15-preview, 2024-09-15-preview, 2024-11-01.

    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 = "aio-broker",
        ExtendedLocation = new AzureNative.IoTOperations.Inputs.ExtendedLocationArgs
        {
            Name = "ycsyubcxttlusbhfdqaynmkaatnbyv",
            Type = AzureNative.IoTOperations.ExtendedLocationType.CustomLocation,
        },
        InstanceName = "aio-instance",
        Properties = new AzureNative.IoTOperations.Inputs.BrokerAuthenticationPropertiesArgs
        {
            AuthenticationMethods = new[]
            {
                new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodsArgs
                {
                    Method = AzureNative.IoTOperations.BrokerAuthenticationMethod.ServiceAccountToken,
                    ServiceAccountToken = new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodSatArgs
                    {
                        Audiences = new[]
                        {
                            "aio-mq",
                        },
                    },
                },
            },
        },
        ResourceGroupName = "rgiotoperations",
    });

});

    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.NewBrokerAuthentication(ctx, "brokerAuthentication", &iotoperations.BrokerAuthenticationArgs{
			AuthenticationName: pulumi.String("resource-name123"),
			BrokerName:         pulumi.String("aio-broker"),
			ExtendedLocation: &iotoperations.ExtendedLocationArgs{
				Name: pulumi.String("ycsyubcxttlusbhfdqaynmkaatnbyv"),
				Type: pulumi.String(iotoperations.ExtendedLocationTypeCustomLocation),
			},
			InstanceName: pulumi.String("aio-instance"),
			Properties: &iotoperations.BrokerAuthenticationPropertiesArgs{
				AuthenticationMethods: iotoperations.BrokerAuthenticatorMethodsArray{
					&iotoperations.BrokerAuthenticatorMethodsArgs{
						Method: pulumi.String(iotoperations.BrokerAuthenticationMethodServiceAccountToken),
						ServiceAccountToken: &iotoperations.BrokerAuthenticatorMethodSatArgs{
							Audiences: pulumi.StringArray{
								pulumi.String("aio-mq"),
							},
						},
					},
				},
			},
			ResourceGroupName: pulumi.String("rgiotoperations"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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("aio-broker")
            .extendedLocation(ExtendedLocationArgs.builder()
                .name("ycsyubcxttlusbhfdqaynmkaatnbyv")
                .type("CustomLocation")
                .build())
            .instanceName("aio-instance")
            .properties(BrokerAuthenticationPropertiesArgs.builder()
                .authenticationMethods(BrokerAuthenticatorMethodsArgs.builder()
                    .method("ServiceAccountToken")
                    .serviceAccountToken(BrokerAuthenticatorMethodSatArgs.builder()
                        .audiences("aio-mq")
                        .build())
                    .build())
                .build())
            .resourceGroupName("rgiotoperations")
            .build());

    }
}

    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: "aio-broker",
    extendedLocation: {
        name: "ycsyubcxttlusbhfdqaynmkaatnbyv",
        type: azure_native.iotoperations.ExtendedLocationType.CustomLocation,
    },
    instanceName: "aio-instance",
    properties: {
        authenticationMethods: [{
            method: azure_native.iotoperations.BrokerAuthenticationMethod.ServiceAccountToken,
            serviceAccountToken: {
                audiences: ["aio-mq"],
            },
        }],
    },
    resourceGroupName: "rgiotoperations",
});

    import pulumi
import pulumi_azure_native as azure_native

broker_authentication = azure_native.iotoperations.BrokerAuthentication("brokerAuthentication",
    authentication_name="resource-name123",
    broker_name="aio-broker",
    extended_location={
        "name": "ycsyubcxttlusbhfdqaynmkaatnbyv",
        "type": azure_native.iotoperations.ExtendedLocationType.CUSTOM_LOCATION,
    },
    instance_name="aio-instance",
    properties={
        "authentication_methods": [{
            "method": azure_native.iotoperations.BrokerAuthenticationMethod.SERVICE_ACCOUNT_TOKEN,
            "service_account_token": {
                "audiences": ["aio-mq"],
            },
        }],
    },
    resource_group_name="rgiotoperations")

    resources:
  brokerAuthentication:
    type: azure-native:iotoperations:BrokerAuthentication
    properties:
      authenticationName: resource-name123
      brokerName: aio-broker
      extendedLocation:
        name: ycsyubcxttlusbhfdqaynmkaatnbyv
        type: CustomLocation
      instanceName: aio-instance
      properties:
        authenticationMethods:
          - method: ServiceAccountToken
            serviceAccountToken:
              audiences:
                - aio-mq
      resourceGroupName: rgiotoperations

    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 string
    The unique name of the resource.
    args BrokerAuthenticationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args BrokerAuthenticationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BrokerAuthenticationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
                Custom = 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" },
                    },
                },
                ServiceAccountToken = new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodSatArgs
                {
                    Audiences = new[]
                    {
                        "string",
                    },
                },
                X509Credentials = new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodX509Args
                {
                    AuthorizationAttributes = 
                    {
                        { "string", new AzureNative.IoTOperations.Inputs.BrokerAuthenticatorMethodX509AttributesArgs
                        {
                            Attributes = 
                            {
                                { "string", "string" },
                            },
                            Subject = "string",
                        } },
                    },
                    TrustedClientCaCert = "string",
                },
            },
        },
    },
});

    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"),
				Custom: &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"),
					},
				},
				ServiceAccountToken: &iotoperations.BrokerAuthenticatorMethodSatArgs{
					Audiences: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
				X509Credentials: &iotoperations.BrokerAuthenticatorMethodX509Args{
					AuthorizationAttributes: iotoperations.BrokerAuthenticatorMethodX509AttributesMap{
						"string": &iotoperations.BrokerAuthenticatorMethodX509AttributesArgs{
							Attributes: pulumi.StringMap{
								"string": pulumi.String("string"),
							},
							Subject: pulumi.String("string"),
						},
					},
					TrustedClientCaCert: pulumi.String("string"),
				},
			},
		},
	},
})

    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")
            .custom(BrokerAuthenticatorMethodCustomArgs.builder()
                .endpoint("string")
                .auth(BrokerAuthenticatorCustomAuthArgs.builder()
                    .x509(X509ManualCertificateArgs.builder()
                        .secretRef("string")
                        .build())
                    .build())
                .caCertConfigMap("string")
                .headers(Map.of("string", "string"))
                .build())
            .serviceAccountToken(BrokerAuthenticatorMethodSatArgs.builder()
                .audiences("string")
                .build())
            .x509Credentials(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());

    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": {
                "endpoint": "string",
                "auth": {
                    "x509": {
                        "secret_ref": "string",
                    },
                },
                "ca_cert_config_map": "string",
                "headers": {
                    "string": "string",
                },
            },
            "service_account_token": {
                "audiences": ["string"],
            },
            "x509_credentials": {
                "authorization_attributes": {
                    "string": {
                        "attributes": {
                            "string": "string",
                        },
                        "subject": "string",
                    },
                },
                "trusted_client_ca_cert": "string",
            },
        }],
    })

    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",
            custom: {
                endpoint: "string",
                auth: {
                    x509: {
                        secretRef: "string",
                    },
                },
                caCertConfigMap: "string",
                headers: {
                    string: "string",
                },
            },
            serviceAccountToken: {
                audiences: ["string"],
            },
            x509Credentials: {
                authorizationAttributes: {
                    string: {
                        attributes: {
                            string: "string",
                        },
                        subject: "string",
                    },
                },
                trustedClientCaCert: "string",
            },
        }],
    },
});

    type: azure-native:iotoperations:BrokerAuthentication
properties:
    authenticationName: string
    brokerName: string
    extendedLocation:
        name: string
        type: string
    instanceName: string
    properties:
        authenticationMethods:
            - custom:
                auth:
                    x509:
                        secretRef: string
                caCertConfigMap: string
                endpoint: string
                headers:
                    string: string
              method: string
              serviceAccountToken:
                audiences:
                    - string
              x509Credentials:
                authorizationAttributes:
                    string:
                        attributes:
                            string: string
                        subject: string
                trustedClientCaCert: string
    resourceGroupName: string

    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 string
    Name of broker.
    ExtendedLocation Pulumi.AzureNative.IoTOperations.Inputs.ExtendedLocation
    Edge location of the resource.
    InstanceName string
    Name of instance.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AuthenticationName string
    Name of Instance broker authentication resource
    Properties Pulumi.AzureNative.IoTOperations.Inputs.BrokerAuthenticationProperties
    The resource-specific properties for this resource.
    BrokerName string
    Name of broker.
    ExtendedLocation ExtendedLocationArgs
    Edge location of the resource.
    InstanceName string
    Name of instance.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AuthenticationName string
    Name of Instance broker authentication resource
    Properties BrokerAuthenticationPropertiesArgs
    The resource-specific properties for this resource.
    brokerName String
    Name of broker.
    extendedLocation ExtendedLocation
    Edge location of the resource.
    instanceName String
    Name of instance.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    authenticationName String
    Name of Instance broker authentication resource
    properties BrokerAuthenticationProperties
    The resource-specific properties for this resource.
    brokerName string
    Name of broker.
    extendedLocation ExtendedLocation
    Edge location of the resource.
    instanceName string
    Name of instance.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    authenticationName string
    Name of Instance broker authentication resource
    properties BrokerAuthenticationProperties
    The resource-specific properties for this resource.
    broker_name str
    Name of broker.
    extended_location ExtendedLocationArgs
    Edge location of the resource.
    instance_name str
    Name of instance.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    authentication_name str
    Name of Instance broker authentication resource
    properties BrokerAuthenticationPropertiesArgs
    The resource-specific properties for this resource.
    brokerName String
    Name of broker.
    extendedLocation Property Map
    Edge location of the resource.
    instanceName String
    Name of instance.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    authenticationName 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:

    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"
    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"
    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"
    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"
    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"
    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.
    X509Credentials
    X509CredentialsX.509 authentication configuration.
    BrokerAuthenticationMethodCustom
    CustomCustom authentication configuration.
    BrokerAuthenticationMethodServiceAccountToken
    ServiceAccountTokenServiceAccountToken authentication configuration.
    BrokerAuthenticationMethodX509Credentials
    X509CredentialsX.509 authentication configuration.
    Custom
    CustomCustom authentication configuration.
    ServiceAccountToken
    ServiceAccountTokenServiceAccountToken authentication configuration.
    X509Credentials
    X509CredentialsX.509 authentication configuration.
    Custom
    CustomCustom authentication configuration.
    ServiceAccountToken
    ServiceAccountTokenServiceAccountToken authentication configuration.
    X509Credentials
    X509CredentialsX.509 authentication configuration.
    CUSTOM
    CustomCustom authentication configuration.
    SERVICE_ACCOUNT_TOKEN
    ServiceAccountTokenServiceAccountToken authentication configuration.
    X509_CREDENTIALS
    X509CredentialsX.509 authentication configuration.
    "Custom"
    CustomCustom authentication configuration.
    "ServiceAccountToken"
    ServiceAccountTokenServiceAccountToken authentication configuration.
    "X509Credentials"
    X509CredentialsX.509 authentication configuration.

    BrokerAuthenticationProperties, BrokerAuthenticationPropertiesArgs

    AuthenticationMethods 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 []BrokerAuthenticatorMethods
    Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
    authenticationMethods List<BrokerAuthenticatorMethods>
    Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
    authenticationMethods BrokerAuthenticatorMethods[]
    Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
    authentication_methods Sequence[BrokerAuthenticatorMethods]
    Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
    authenticationMethods 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 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 string
    The status of the last operation.
    AuthenticationMethods []BrokerAuthenticatorMethodsResponse
    Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
    ProvisioningState string
    The status of the last operation.
    authenticationMethods List<BrokerAuthenticatorMethodsResponse>
    Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
    provisioningState String
    The status of the last operation.
    authenticationMethods BrokerAuthenticatorMethodsResponse[]
    Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
    provisioningState string
    The status of the last operation.
    authentication_methods Sequence[BrokerAuthenticatorMethodsResponse]
    Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
    provisioning_state str
    The status of the last operation.
    authenticationMethods List<Property Map>
    Defines a set of Broker authentication methods to be used on BrokerListeners. For each array element one authenticator type supported.
    provisioningState String
    The status of the last operation.

    BrokerAuthenticatorCustomAuth, BrokerAuthenticatorCustomAuthArgs

    X509 X509ManualCertificate
    X509 Custom Auth type details.
    x509 X509ManualCertificate
    X509 Custom Auth type details.
    x509 X509ManualCertificate
    X509 Custom Auth type details.
    x509 X509ManualCertificate
    X509 Custom Auth type details.
    x509 Property Map
    X509 Custom Auth type details.

    BrokerAuthenticatorCustomAuthResponse, BrokerAuthenticatorCustomAuthResponseArgs

    X509 X509ManualCertificateResponse
    X509 Custom Auth type details.
    x509 X509ManualCertificateResponse
    X509 Custom Auth type details.
    x509 X509ManualCertificateResponse
    X509 Custom Auth type details.
    x509 X509ManualCertificateResponse
    X509 Custom Auth type details.
    x509 Property Map
    X509 Custom Auth type details.

    BrokerAuthenticatorMethodCustom, BrokerAuthenticatorMethodCustomArgs

    Endpoint 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 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 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 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 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 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 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 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 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 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 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 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 List<string>
    List of allowed audience.
    Audiences []string
    List of allowed audience.
    audiences List<String>
    List of allowed audience.
    audiences string[]
    List of allowed audience.
    audiences Sequence[str]
    List of allowed audience.
    audiences List<String>
    List of allowed audience.

    BrokerAuthenticatorMethodSatResponse, BrokerAuthenticatorMethodSatResponseArgs

    Audiences List<string>
    List of allowed audience.
    Audiences []string
    List of allowed audience.
    audiences List<String>
    List of allowed audience.
    audiences string[]
    List of allowed audience.
    audiences Sequence[str]
    List of allowed audience.
    audiences 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 Dictionary<string, string>
    Attributes object.
    Subject string
    Subject of the X509 attribute.
    Attributes map[string]string
    Attributes object.
    Subject string
    Subject of the X509 attribute.
    attributes Map<String,String>
    Attributes object.
    subject String
    Subject of the X509 attribute.
    attributes {[key: string]: string}
    Attributes object.
    subject string
    Subject of the X509 attribute.
    attributes Mapping[str, str]
    Attributes object.
    subject str
    Subject of the X509 attribute.
    attributes Map<String>
    Attributes object.
    subject String
    Subject of the X509 attribute.

    BrokerAuthenticatorMethodX509AttributesResponse, BrokerAuthenticatorMethodX509AttributesResponseArgs

    Attributes Dictionary<string, string>
    Attributes object.
    Subject string
    Subject of the X509 attribute.
    Attributes map[string]string
    Attributes object.
    Subject string
    Subject of the X509 attribute.
    attributes Map<String,String>
    Attributes object.
    subject String
    Subject of the X509 attribute.
    attributes {[key: string]: string}
    Attributes object.
    subject string
    Subject of the X509 attribute.
    attributes Mapping[str, str]
    Attributes object.
    subject str
    Subject of the X509 attribute.
    attributes Map<String>
    Attributes object.
    subject 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 string | BrokerAuthenticationMethod
    Custom authentication configuration.
    Custom BrokerAuthenticatorMethodCustom
    Custom authentication configuration.
    ServiceAccountToken BrokerAuthenticatorMethodSat
    ServiceAccountToken authentication configuration.
    X509Credentials BrokerAuthenticatorMethodX509
    X.509 authentication configuration.
    method String | BrokerAuthenticationMethod
    Custom authentication configuration.
    custom BrokerAuthenticatorMethodCustom
    Custom authentication configuration.
    serviceAccountToken BrokerAuthenticatorMethodSat
    ServiceAccountToken authentication configuration.
    x509Credentials BrokerAuthenticatorMethodX509
    X.509 authentication configuration.
    method string | BrokerAuthenticationMethod
    Custom authentication configuration.
    custom BrokerAuthenticatorMethodCustom
    Custom authentication configuration.
    serviceAccountToken BrokerAuthenticatorMethodSat
    ServiceAccountToken authentication configuration.
    x509Credentials BrokerAuthenticatorMethodX509
    X.509 authentication configuration.
    method str | BrokerAuthenticationMethod
    Custom authentication configuration.
    custom BrokerAuthenticatorMethodCustom
    Custom authentication configuration.
    service_account_token BrokerAuthenticatorMethodSat
    ServiceAccountToken authentication configuration.
    x509_credentials BrokerAuthenticatorMethodX509
    X.509 authentication configuration.
    method String | "Custom" | "ServiceAccountToken" | "X509Credentials"
    Custom authentication configuration.
    custom Property Map
    Custom authentication configuration.
    serviceAccountToken Property Map
    ServiceAccountToken authentication configuration.
    x509Credentials Property Map
    X.509 authentication configuration.

    BrokerAuthenticatorMethodsResponse, BrokerAuthenticatorMethodsResponseArgs

    Method string
    Custom authentication configuration.
    Custom BrokerAuthenticatorMethodCustomResponse
    Custom authentication configuration.
    ServiceAccountToken BrokerAuthenticatorMethodSatResponse
    ServiceAccountToken authentication configuration.
    X509Credentials BrokerAuthenticatorMethodX509Response
    X.509 authentication configuration.
    method String
    Custom authentication configuration.
    custom BrokerAuthenticatorMethodCustomResponse
    Custom authentication configuration.
    serviceAccountToken BrokerAuthenticatorMethodSatResponse
    ServiceAccountToken authentication configuration.
    x509Credentials BrokerAuthenticatorMethodX509Response
    X.509 authentication configuration.
    method string
    Custom authentication configuration.
    custom BrokerAuthenticatorMethodCustomResponse
    Custom authentication configuration.
    serviceAccountToken BrokerAuthenticatorMethodSatResponse
    ServiceAccountToken authentication configuration.
    x509Credentials BrokerAuthenticatorMethodX509Response
    X.509 authentication configuration.
    method str
    Custom authentication configuration.
    custom BrokerAuthenticatorMethodCustomResponse
    Custom authentication configuration.
    service_account_token BrokerAuthenticatorMethodSatResponse
    ServiceAccountToken authentication configuration.
    x509_credentials BrokerAuthenticatorMethodX509Response
    X.509 authentication configuration.
    method String
    Custom authentication configuration.
    custom Property Map
    Custom authentication configuration.
    serviceAccountToken Property Map
    ServiceAccountToken authentication configuration.
    x509Credentials Property Map
    X.509 authentication configuration.

    ExtendedLocation, ExtendedLocationArgs

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

    ExtendedLocationResponse, ExtendedLocationResponseArgs

    Name string
    The name of the extended location.
    Type string
    Type of ExtendedLocation.
    Name string
    The name of the extended location.
    Type string
    Type of ExtendedLocation.
    name String
    The name of the extended location.
    type String
    Type of ExtendedLocation.
    name string
    The name of the extended location.
    type string
    Type of ExtendedLocation.
    name str
    The name of the extended location.
    type str
    Type of ExtendedLocation.
    name String
    The name of the extended location.
    type 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 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 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 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 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 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 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 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 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 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 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 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 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 gjfyvwhgwouiqfxml /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications/{authenticationName}

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.3 published on Thursday, Mar 20, 2025 by Pulumi
    pulumi/pulumi-azure-native