1. Packages
  2. Azure Native
  3. API Docs
  4. iotoperationsmq
  5. getBrokerAuthorization
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.getBrokerAuthorization

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 BrokerAuthorizationResource Azure REST API version: 2023-10-04-preview.

    Using getBrokerAuthorization

    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 getBrokerAuthorization(args: GetBrokerAuthorizationArgs, opts?: InvokeOptions): Promise<GetBrokerAuthorizationResult>
    function getBrokerAuthorizationOutput(args: GetBrokerAuthorizationOutputArgs, opts?: InvokeOptions): Output<GetBrokerAuthorizationResult>
    def get_broker_authorization(authorization_name: Optional[str] = None,
                                 broker_name: Optional[str] = None,
                                 mq_name: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetBrokerAuthorizationResult
    def get_broker_authorization_output(authorization_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[GetBrokerAuthorizationResult]
    func LookupBrokerAuthorization(ctx *Context, args *LookupBrokerAuthorizationArgs, opts ...InvokeOption) (*LookupBrokerAuthorizationResult, error)
    func LookupBrokerAuthorizationOutput(ctx *Context, args *LookupBrokerAuthorizationOutputArgs, opts ...InvokeOption) LookupBrokerAuthorizationResultOutput

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

    public static class GetBrokerAuthorization 
    {
        public static Task<GetBrokerAuthorizationResult> InvokeAsync(GetBrokerAuthorizationArgs args, InvokeOptions? opts = null)
        public static Output<GetBrokerAuthorizationResult> Invoke(GetBrokerAuthorizationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBrokerAuthorizationResult> getBrokerAuthorization(GetBrokerAuthorizationArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:iotoperationsmq:getBrokerAuthorization
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AuthorizationName string
    Name of MQ broker/authorization 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.
    AuthorizationName string
    Name of MQ broker/authorization 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.
    authorizationName String
    Name of MQ broker/authorization 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.
    authorizationName string
    Name of MQ broker/authorization 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.
    authorization_name str
    Name of MQ broker/authorization 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.
    authorizationName String
    Name of MQ broker/authorization 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.

    getBrokerAuthorization Result

    The following output properties are available:

    AuthorizationPolicies Pulumi.AzureNative.IoTOperationsMQ.Outputs.AuthorizationConfigResponse
    The list of authorization policies supported by the Authorization Resource.
    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.
    AuthorizationPolicies AuthorizationConfigResponse
    The list of authorization policies supported by the Authorization Resource.
    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.
    authorizationPolicies AuthorizationConfigResponse
    The list of authorization policies supported by the Authorization Resource.
    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.
    authorizationPolicies AuthorizationConfigResponse
    The list of authorization policies supported by the Authorization Resource.
    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.
    authorization_policies AuthorizationConfigResponse
    The list of authorization policies supported by the Authorization Resource.
    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.
    authorizationPolicies Property Map
    The list of authorization policies supported by the Authorization Resource.
    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

    AuthorizationBasicRuleResponse

    BrokerResources List<Pulumi.AzureNative.IoTOperationsMQ.Inputs.ResourceInfoDefinitionResponse>
    This subfield defines the broker resources that the Basic Rule is applied on.
    Principals Pulumi.AzureNative.IoTOperationsMQ.Inputs.PrincipalDefinitionResponse
    This subfield defines the identities that represent the clients.
    BrokerResources []ResourceInfoDefinitionResponse
    This subfield defines the broker resources that the Basic Rule is applied on.
    Principals PrincipalDefinitionResponse
    This subfield defines the identities that represent the clients.
    brokerResources List<ResourceInfoDefinitionResponse>
    This subfield defines the broker resources that the Basic Rule is applied on.
    principals PrincipalDefinitionResponse
    This subfield defines the identities that represent the clients.
    brokerResources ResourceInfoDefinitionResponse[]
    This subfield defines the broker resources that the Basic Rule is applied on.
    principals PrincipalDefinitionResponse
    This subfield defines the identities that represent the clients.
    broker_resources Sequence[ResourceInfoDefinitionResponse]
    This subfield defines the broker resources that the Basic Rule is applied on.
    principals PrincipalDefinitionResponse
    This subfield defines the identities that represent the clients.
    brokerResources List<Property Map>
    This subfield defines the broker resources that the Basic Rule is applied on.
    principals Property Map
    This subfield defines the identities that represent the clients.

    AuthorizationConfigResponse

    EnableCache bool
    Enable caching of the authorization rules.
    Rules List<Pulumi.AzureNative.IoTOperationsMQ.Inputs.AuthorizationBasicRuleResponse>
    Authorization Rules to be used. If no rule is set, but Authorization Resource is used that would mean DenyAll.
    EnableCache bool
    Enable caching of the authorization rules.
    Rules []AuthorizationBasicRuleResponse
    Authorization Rules to be used. If no rule is set, but Authorization Resource is used that would mean DenyAll.
    enableCache Boolean
    Enable caching of the authorization rules.
    rules List<AuthorizationBasicRuleResponse>
    Authorization Rules to be used. If no rule is set, but Authorization Resource is used that would mean DenyAll.
    enableCache boolean
    Enable caching of the authorization rules.
    rules AuthorizationBasicRuleResponse[]
    Authorization Rules to be used. If no rule is set, but Authorization Resource is used that would mean DenyAll.
    enable_cache bool
    Enable caching of the authorization rules.
    rules Sequence[AuthorizationBasicRuleResponse]
    Authorization Rules to be used. If no rule is set, but Authorization Resource is used that would mean DenyAll.
    enableCache Boolean
    Enable caching of the authorization rules.
    rules List<Property Map>
    Authorization Rules to be used. If no rule is set, but Authorization Resource is used that would mean DenyAll.

    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.

    PrincipalDefinitionResponse

    Attributes List<ImmutableDictionary<string, string>>
    A list of key-value pairs that match the attributes of the clients. The attributes are case-sensitive and must match the attributes provided by the clients during authentication.
    Clientids List<string>
    A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection.
    Usernames List<string>
    A list of usernames that match the clients. The usernames are case-sensitive and must match the usernames provided by the clients during authentication.
    Attributes []map[string]string
    A list of key-value pairs that match the attributes of the clients. The attributes are case-sensitive and must match the attributes provided by the clients during authentication.
    Clientids []string
    A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection.
    Usernames []string
    A list of usernames that match the clients. The usernames are case-sensitive and must match the usernames provided by the clients during authentication.
    attributes List<Map<String,String>>
    A list of key-value pairs that match the attributes of the clients. The attributes are case-sensitive and must match the attributes provided by the clients during authentication.
    clientids List<String>
    A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection.
    usernames List<String>
    A list of usernames that match the clients. The usernames are case-sensitive and must match the usernames provided by the clients during authentication.
    attributes {[key: string]: string}[]
    A list of key-value pairs that match the attributes of the clients. The attributes are case-sensitive and must match the attributes provided by the clients during authentication.
    clientids string[]
    A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection.
    usernames string[]
    A list of usernames that match the clients. The usernames are case-sensitive and must match the usernames provided by the clients during authentication.
    attributes Sequence[Mapping[str, str]]
    A list of key-value pairs that match the attributes of the clients. The attributes are case-sensitive and must match the attributes provided by the clients during authentication.
    clientids Sequence[str]
    A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection.
    usernames Sequence[str]
    A list of usernames that match the clients. The usernames are case-sensitive and must match the usernames provided by the clients during authentication.
    attributes List<Map<String>>
    A list of key-value pairs that match the attributes of the clients. The attributes are case-sensitive and must match the attributes provided by the clients during authentication.
    clientids List<String>
    A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection.
    usernames List<String>
    A list of usernames that match the clients. The usernames are case-sensitive and must match the usernames provided by the clients during authentication.

    ResourceInfoDefinitionResponse

    Method string
    The type of action that the clients can perform on the broker: Connect, Publish or Subscribe.
    Topics List<string>
    A list of topics or topic patterns that match the topics that the clients can publish or subscribe to. This subfield is required if the method is Publish or Subscribe.
    Method string
    The type of action that the clients can perform on the broker: Connect, Publish or Subscribe.
    Topics []string
    A list of topics or topic patterns that match the topics that the clients can publish or subscribe to. This subfield is required if the method is Publish or Subscribe.
    method String
    The type of action that the clients can perform on the broker: Connect, Publish or Subscribe.
    topics List<String>
    A list of topics or topic patterns that match the topics that the clients can publish or subscribe to. This subfield is required if the method is Publish or Subscribe.
    method string
    The type of action that the clients can perform on the broker: Connect, Publish or Subscribe.
    topics string[]
    A list of topics or topic patterns that match the topics that the clients can publish or subscribe to. This subfield is required if the method is Publish or Subscribe.
    method str
    The type of action that the clients can perform on the broker: Connect, Publish or Subscribe.
    topics Sequence[str]
    A list of topics or topic patterns that match the topics that the clients can publish or subscribe to. This subfield is required if the method is Publish or Subscribe.
    method String
    The type of action that the clients can perform on the broker: Connect, Publish or Subscribe.
    topics List<String>
    A list of topics or topic patterns that match the topics that the clients can publish or subscribe to. This subfield is required if the method is Publish or Subscribe.

    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