Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. iotoperations
  5. getBrokerAuthentication
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.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.iotoperations.getBrokerAuthentication

Explore with Pulumi AI

azure-native logo
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.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get a BrokerAuthenticationResource

    Uses Azure REST API version 2024-11-01.

    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.

    Using getBrokerAuthentication

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBrokerAuthentication(args: GetBrokerAuthenticationArgs, opts?: InvokeOptions): Promise<GetBrokerAuthenticationResult>
function getBrokerAuthenticationOutput(args: GetBrokerAuthenticationOutputArgs, opts?: InvokeOptions): Output<GetBrokerAuthenticationResult>
    def get_broker_authentication(authentication_name: Optional[str] = None,
                              broker_name: Optional[str] = None,
                              instance_name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetBrokerAuthenticationResult
def get_broker_authentication_output(authentication_name: Optional[pulumi.Input[str]] = None,
                              broker_name: Optional[pulumi.Input[str]] = None,
                              instance_name: Optional[pulumi.Input[str]] = None,
                              resource_group_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetBrokerAuthenticationResult]
    func LookupBrokerAuthentication(ctx *Context, args *LookupBrokerAuthenticationArgs, opts ...InvokeOption) (*LookupBrokerAuthenticationResult, error)
func LookupBrokerAuthenticationOutput(ctx *Context, args *LookupBrokerAuthenticationOutputArgs, opts ...InvokeOption) LookupBrokerAuthenticationResultOutput

    > Note: This function is named LookupBrokerAuthentication in the Go SDK.

    public static class GetBrokerAuthentication 
{
    public static Task<GetBrokerAuthenticationResult> InvokeAsync(GetBrokerAuthenticationArgs args, InvokeOptions? opts = null)
    public static Output<GetBrokerAuthenticationResult> Invoke(GetBrokerAuthenticationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBrokerAuthenticationResult> getBrokerAuthentication(GetBrokerAuthenticationArgs args, InvokeOptions options)
public static Output<GetBrokerAuthenticationResult> getBrokerAuthentication(GetBrokerAuthenticationArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:iotoperations:getBrokerAuthentication
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AuthenticationName string
    Name of Instance broker authentication resource
    BrokerName string
    Name of broker.
    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
    BrokerName string
    Name of broker.
    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
    brokerName String
    Name of broker.
    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
    brokerName string
    Name of broker.
    instanceName string
    Name of instance.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    authentication_name str
    Name of Instance broker authentication resource
    broker_name str
    Name of broker.
    instance_name str
    Name of instance.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    authenticationName String
    Name of Instance broker authentication resource
    brokerName String
    Name of broker.
    instanceName String
    Name of instance.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getBrokerAuthentication Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    ExtendedLocation Pulumi.AzureNative.IoTOperations.Outputs.ExtendedLocationResponse
    Edge location of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.IoTOperations.Outputs.BrokerAuthenticationPropertiesResponse
    The resource-specific properties for this 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.
    ExtendedLocation ExtendedLocationResponse
    Edge location of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties BrokerAuthenticationPropertiesResponse
    The resource-specific properties for this 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.
    extendedLocation ExtendedLocationResponse
    Edge location of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties BrokerAuthenticationPropertiesResponse
    The resource-specific properties for this 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.
    extendedLocation ExtendedLocationResponse
    Edge location of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    properties BrokerAuthenticationPropertiesResponse
    The resource-specific properties for this 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.
    extended_location ExtendedLocationResponse
    Edge location of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    properties BrokerAuthenticationPropertiesResponse
    The resource-specific properties for this 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.
    extendedLocation Property Map
    Edge location of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties Property Map
    The resource-specific properties for this 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

    BrokerAuthenticationPropertiesResponse

    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.

    BrokerAuthenticatorCustomAuthResponse

    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.

    BrokerAuthenticatorMethodCustomResponse

    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.

    BrokerAuthenticatorMethodSatResponse

    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.

    BrokerAuthenticatorMethodX509AttributesResponse

    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

    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.

    BrokerAuthenticatorMethodsResponse

    Method string
    Custom authentication configuration.
    CustomSettings BrokerAuthenticatorMethodCustomResponse
    Custom authentication configuration.
    ServiceAccountTokenSettings BrokerAuthenticatorMethodSatResponse
    ServiceAccountToken authentication configuration.
    X509Settings BrokerAuthenticatorMethodX509Response
    X.509 authentication configuration.
    method String
    Custom authentication configuration.
    customSettings BrokerAuthenticatorMethodCustomResponse
    Custom authentication configuration.
    serviceAccountTokenSettings BrokerAuthenticatorMethodSatResponse
    ServiceAccountToken authentication configuration.
    x509Settings BrokerAuthenticatorMethodX509Response
    X.509 authentication configuration.
    method string
    Custom authentication configuration.
    customSettings BrokerAuthenticatorMethodCustomResponse
    Custom authentication configuration.
    serviceAccountTokenSettings BrokerAuthenticatorMethodSatResponse
    ServiceAccountToken authentication configuration.
    x509Settings BrokerAuthenticatorMethodX509Response
    X.509 authentication configuration.
    method 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 String
    Custom authentication configuration.
    customSettings Property Map
    Custom authentication configuration.
    serviceAccountTokenSettings Property Map
    ServiceAccountToken authentication configuration.
    x509Settings Property Map
    X.509 authentication configuration.

    ExtendedLocationResponse

    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.

    SystemDataResponse

    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.

    X509ManualCertificateResponse

    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.

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
    pulumi/pulumi-azure-native