1. Packages
  2. Azure Native
  3. API Docs
  4. iotoperationsmq
  5. getBrokerAuthentication
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.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.iotoperationsmq.getBrokerAuthentication

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.37.0 published on Monday, Apr 15, 2024 by Pulumi

    Get a BrokerAuthenticationResource Azure REST API version: 2023-10-04-preview.

    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,
                                  mq_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,
                                  mq_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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:iotoperationsmq:getBrokerAuthentication
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AuthenticationName string
    Name of MQ broker/authentication resource
    BrokerName string
    Name of MQ broker resource
    MqName string
    Name of MQ resource
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AuthenticationName string
    Name of MQ broker/authentication resource
    BrokerName string
    Name of MQ broker resource
    MqName string
    Name of MQ resource
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    authenticationName String
    Name of MQ broker/authentication resource
    brokerName String
    Name of MQ broker resource
    mqName String
    Name of MQ resource
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    authenticationName string
    Name of MQ broker/authentication resource
    brokerName string
    Name of MQ broker resource
    mqName string
    Name of MQ resource
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    authentication_name str
    Name of MQ broker/authentication resource
    broker_name str
    Name of MQ broker resource
    mq_name str
    Name of MQ resource
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    authenticationName String
    Name of MQ broker/authentication resource
    brokerName String
    Name of MQ broker resource
    mqName String
    Name of MQ resource
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getBrokerAuthentication Result

    The following output properties are available:

    AuthenticationMethods List<Pulumi.AzureNative.IoTOperationsMQ.Outputs.BrokerAuthenticatorMethodsResponse>
    The list of authentication methods supported by the Authentication Resource. For each array element, NOTE - Enum only authenticator type supported.
    ExtendedLocation Pulumi.AzureNative.IoTOperationsMQ.Outputs.ExtendedLocationPropertyResponse
    Extended Location
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    ListenerRef List<string>
    The array of listener Resources it supports.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    The status of the last operation.
    SystemData Pulumi.AzureNative.IoTOperationsMQ.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"
    Tags Dictionary<string, string>
    Resource tags.
    AuthenticationMethods []BrokerAuthenticatorMethodsResponse
    The list of authentication methods supported by the Authentication Resource. For each array element, NOTE - Enum only authenticator type supported.
    ExtendedLocation ExtendedLocationPropertyResponse
    Extended Location
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    ListenerRef []string
    The array of listener Resources it supports.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    The status of the last operation.
    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"
    Tags map[string]string
    Resource tags.
    authenticationMethods List<BrokerAuthenticatorMethodsResponse>
    The list of authentication methods supported by the Authentication Resource. For each array element, NOTE - Enum only authenticator type supported.
    extendedLocation ExtendedLocationPropertyResponse
    Extended Location
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    listenerRef List<String>
    The array of listener Resources it supports.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    The status of the last operation.
    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"
    tags Map<String,String>
    Resource tags.
    authenticationMethods BrokerAuthenticatorMethodsResponse[]
    The list of authentication methods supported by the Authentication Resource. For each array element, NOTE - Enum only authenticator type supported.
    extendedLocation ExtendedLocationPropertyResponse
    Extended Location
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    listenerRef string[]
    The array of listener Resources it supports.
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    provisioningState string
    The status of the last operation.
    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"
    tags {[key: string]: string}
    Resource tags.
    authentication_methods Sequence[BrokerAuthenticatorMethodsResponse]
    The list of authentication methods supported by the Authentication Resource. For each array element, NOTE - Enum only authenticator type supported.
    extended_location ExtendedLocationPropertyResponse
    Extended Location
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    listener_ref Sequence[str]
    The array of listener Resources it supports.
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    provisioning_state str
    The status of the last operation.
    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"
    tags Mapping[str, str]
    Resource tags.
    authenticationMethods List<Property Map>
    The list of authentication methods supported by the Authentication Resource. For each array element, NOTE - Enum only authenticator type supported.
    extendedLocation Property Map
    Extended Location
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    listenerRef List<String>
    The array of listener Resources it supports.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    The status of the last operation.
    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"
    tags Map<String>
    Resource tags.

    Supporting Types

    BrokerAuthenticatorCustomAuthResponse

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

    BrokerAuthenticatorCustomAuthX509Response

    KeyVault Pulumi.AzureNative.IoTOperationsMQ.Inputs.KeyVaultCertificatePropertiesResponse
    Keyvault X509 secret properties.
    SecretName string
    Secret where cert details are stored.
    KeyVault KeyVaultCertificatePropertiesResponse
    Keyvault X509 secret properties.
    SecretName string
    Secret where cert details are stored.
    keyVault KeyVaultCertificatePropertiesResponse
    Keyvault X509 secret properties.
    secretName String
    Secret where cert details are stored.
    keyVault KeyVaultCertificatePropertiesResponse
    Keyvault X509 secret properties.
    secretName string
    Secret where cert details are stored.
    key_vault KeyVaultCertificatePropertiesResponse
    Keyvault X509 secret properties.
    secret_name str
    Secret where cert details are stored.
    keyVault Property Map
    Keyvault X509 secret properties.
    secretName String
    Secret where cert details are stored.

    BrokerAuthenticatorMethodCustomResponse

    Endpoint string
    Endpoint to connect to.
    Auth Pulumi.AzureNative.IoTOperationsMQ.Inputs.BrokerAuthenticatorCustomAuthResponse
    Custom Broker Authentication Method.
    CaCertConfigMap string
    CA cert config map to use.
    Headers Dictionary<string, string>
    Configuration Headers to use.
    Endpoint string
    Endpoint to connect to.
    Auth BrokerAuthenticatorCustomAuthResponse
    Custom Broker Authentication Method.
    CaCertConfigMap string
    CA cert config map to use.
    Headers map[string]string
    Configuration Headers to use.
    endpoint String
    Endpoint to connect to.
    auth BrokerAuthenticatorCustomAuthResponse
    Custom Broker Authentication Method.
    caCertConfigMap String
    CA cert config map to use.
    headers Map<String,String>
    Configuration Headers to use.
    endpoint string
    Endpoint to connect to.
    auth BrokerAuthenticatorCustomAuthResponse
    Custom Broker Authentication Method.
    caCertConfigMap string
    CA cert config map to use.
    headers {[key: string]: string}
    Configuration Headers to use.
    endpoint str
    Endpoint to connect to.
    auth BrokerAuthenticatorCustomAuthResponse
    Custom Broker Authentication Method.
    ca_cert_config_map str
    CA cert config map to use.
    headers Mapping[str, str]
    Configuration Headers to use.
    endpoint String
    Endpoint to connect to.
    auth Property Map
    Custom Broker Authentication Method.
    caCertConfigMap String
    CA cert config map to use.
    headers Map<String>
    Configuration Headers to use.

    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.

    BrokerAuthenticatorMethodSvidResponse

    AgentSocketPath string
    Mounted socket path for spiffe agent.
    IdentityMaxRetry double
    Maximum number of re-tries to fetch identity.
    IdentityWaitRetryMs double
    Maximum time to wait before fetching identity again.
    AgentSocketPath string
    Mounted socket path for spiffe agent.
    IdentityMaxRetry float64
    Maximum number of re-tries to fetch identity.
    IdentityWaitRetryMs float64
    Maximum time to wait before fetching identity again.
    agentSocketPath String
    Mounted socket path for spiffe agent.
    identityMaxRetry Double
    Maximum number of re-tries to fetch identity.
    identityWaitRetryMs Double
    Maximum time to wait before fetching identity again.
    agentSocketPath string
    Mounted socket path for spiffe agent.
    identityMaxRetry number
    Maximum number of re-tries to fetch identity.
    identityWaitRetryMs number
    Maximum time to wait before fetching identity again.
    agent_socket_path str
    Mounted socket path for spiffe agent.
    identity_max_retry float
    Maximum number of re-tries to fetch identity.
    identity_wait_retry_ms float
    Maximum time to wait before fetching identity again.
    agentSocketPath String
    Mounted socket path for spiffe agent.
    identityMaxRetry Number
    Maximum number of re-tries to fetch identity.
    identityWaitRetryMs Number
    Maximum time to wait before fetching identity again.

    BrokerAuthenticatorMethodUsernamePasswordResponse

    KeyVault Pulumi.AzureNative.IoTOperationsMQ.Inputs.KeyVaultSecretPropertiesResponse
    Keyvault username password secret properties.
    SecretName string
    Secret where username and password are stored.
    KeyVault KeyVaultSecretPropertiesResponse
    Keyvault username password secret properties.
    SecretName string
    Secret where username and password are stored.
    keyVault KeyVaultSecretPropertiesResponse
    Keyvault username password secret properties.
    secretName String
    Secret where username and password are stored.
    keyVault KeyVaultSecretPropertiesResponse
    Keyvault username password secret properties.
    secretName string
    Secret where username and password are stored.
    key_vault KeyVaultSecretPropertiesResponse
    Keyvault username password secret properties.
    secret_name str
    Secret where username and password are stored.
    keyVault Property Map
    Keyvault username password secret properties.
    secretName String
    Secret where username and password are stored.

    BrokerAuthenticatorMethodX509AttributesResponse

    KeyVault Pulumi.AzureNative.IoTOperationsMQ.Inputs.KeyVaultSecretPropertiesResponse
    Keyvault x509 attributes secret properties.
    SecretName string
    Secret where x509 attributes are stored.
    KeyVault KeyVaultSecretPropertiesResponse
    Keyvault x509 attributes secret properties.
    SecretName string
    Secret where x509 attributes are stored.
    keyVault KeyVaultSecretPropertiesResponse
    Keyvault x509 attributes secret properties.
    secretName String
    Secret where x509 attributes are stored.
    keyVault KeyVaultSecretPropertiesResponse
    Keyvault x509 attributes secret properties.
    secretName string
    Secret where x509 attributes are stored.
    key_vault KeyVaultSecretPropertiesResponse
    Keyvault x509 attributes secret properties.
    secret_name str
    Secret where x509 attributes are stored.
    keyVault Property Map
    Keyvault x509 attributes secret properties.
    secretName String
    Secret where x509 attributes are stored.

    BrokerAuthenticatorMethodX509Response

    Attributes Pulumi.AzureNative.IoTOperationsMQ.Inputs.BrokerAuthenticatorMethodX509AttributesResponse
    K8S Secret name to mount for username and password.
    TrustedClientCaCertConfigMap string
    Trusted client ca cert config map.
    Attributes BrokerAuthenticatorMethodX509AttributesResponse
    K8S Secret name to mount for username and password.
    TrustedClientCaCertConfigMap string
    Trusted client ca cert config map.
    attributes BrokerAuthenticatorMethodX509AttributesResponse
    K8S Secret name to mount for username and password.
    trustedClientCaCertConfigMap String
    Trusted client ca cert config map.
    attributes BrokerAuthenticatorMethodX509AttributesResponse
    K8S Secret name to mount for username and password.
    trustedClientCaCertConfigMap string
    Trusted client ca cert config map.
    attributes BrokerAuthenticatorMethodX509AttributesResponse
    K8S Secret name to mount for username and password.
    trusted_client_ca_cert_config_map str
    Trusted client ca cert config map.
    attributes Property Map
    K8S Secret name to mount for username and password.
    trustedClientCaCertConfigMap String
    Trusted client ca cert config map.

    BrokerAuthenticatorMethodsResponse

    custom Property Map
    Custom Authentication Method.
    sat Property Map
    Service Account Token Method.
    svid Property Map
    Service Account Token Method.
    usernamePassword Property Map
    UsernamePassword Method.
    x509 Property Map
    X509 Method.

    ExtendedLocationPropertyResponse

    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.

    KeyVaultCertificatePropertiesResponse

    Vault KeyVaultConnectionPropertiesResponse
    KeyVault properties.
    VaultCert KeyVaultSecretObjectResponse
    KeyVault Cert secret details.
    VaultCaChainSecret KeyVaultSecretObjectResponse
    KeyVault CA chain secret details.
    vault KeyVaultConnectionPropertiesResponse
    KeyVault properties.
    vaultCert KeyVaultSecretObjectResponse
    KeyVault Cert secret details.
    vaultCaChainSecret KeyVaultSecretObjectResponse
    KeyVault CA chain secret details.
    vault KeyVaultConnectionPropertiesResponse
    KeyVault properties.
    vaultCert KeyVaultSecretObjectResponse
    KeyVault Cert secret details.
    vaultCaChainSecret KeyVaultSecretObjectResponse
    KeyVault CA chain secret details.
    vault Property Map
    KeyVault properties.
    vaultCert Property Map
    KeyVault Cert secret details.
    vaultCaChainSecret Property Map
    KeyVault CA chain secret details.

    KeyVaultConnectionPropertiesResponse

    Credentials Pulumi.AzureNative.IoTOperationsMQ.Inputs.KeyVaultCredentialsPropertiesResponse
    KeyVault credentials.
    DirectoryId string
    KeyVault directoryId.
    Name string
    KeyVault name.
    Credentials KeyVaultCredentialsPropertiesResponse
    KeyVault credentials.
    DirectoryId string
    KeyVault directoryId.
    Name string
    KeyVault name.
    credentials KeyVaultCredentialsPropertiesResponse
    KeyVault credentials.
    directoryId String
    KeyVault directoryId.
    name String
    KeyVault name.
    credentials KeyVaultCredentialsPropertiesResponse
    KeyVault credentials.
    directoryId string
    KeyVault directoryId.
    name string
    KeyVault name.
    credentials KeyVaultCredentialsPropertiesResponse
    KeyVault credentials.
    directory_id str
    KeyVault directoryId.
    name str
    KeyVault name.
    credentials Property Map
    KeyVault credentials.
    directoryId String
    KeyVault directoryId.
    name String
    KeyVault name.

    KeyVaultCredentialsPropertiesResponse

    ServicePrincipalLocalSecretName string
    KeyVault service principal local secret name.
    ServicePrincipalLocalSecretName string
    KeyVault service principal local secret name.
    servicePrincipalLocalSecretName String
    KeyVault service principal local secret name.
    servicePrincipalLocalSecretName string
    KeyVault service principal local secret name.
    service_principal_local_secret_name str
    KeyVault service principal local secret name.
    servicePrincipalLocalSecretName String
    KeyVault service principal local secret name.

    KeyVaultSecretObjectResponse

    Name string
    KeyVault secret name.
    Version string
    KeyVault secret version.
    Name string
    KeyVault secret name.
    Version string
    KeyVault secret version.
    name String
    KeyVault secret name.
    version String
    KeyVault secret version.
    name string
    KeyVault secret name.
    version string
    KeyVault secret version.
    name str
    KeyVault secret name.
    version str
    KeyVault secret version.
    name String
    KeyVault secret name.
    version String
    KeyVault secret version.

    KeyVaultSecretPropertiesResponse

    vault Property Map
    KeyVault properties.
    vaultSecret Property Map
    KeyVault secret details.

    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.

    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.37.0 published on Monday, Apr 15, 2024 by Pulumi