Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. iotoperations
  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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.iotoperations.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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get a BrokerAuthorizationResource Azure REST API version: 2024-07-01-preview.

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

    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,
                             instance_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,
                             instance_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)
public static Output<GetBrokerAuthorizationResult> getBrokerAuthorization(GetBrokerAuthorizationArgs args, InvokeOptions options)

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

    The following arguments are supported:

    AuthorizationName string
    Name of Instance broker authorization resource
    BrokerName string
    Name of broker.
    InstanceName string
    Name of instance.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AuthorizationName string
    Name of Instance broker authorization resource
    BrokerName string
    Name of broker.
    InstanceName string
    Name of instance.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    authorizationName String
    Name of Instance broker authorization resource
    brokerName String
    Name of broker.
    instanceName String
    Name of instance.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    authorizationName string
    Name of Instance broker authorization resource
    brokerName string
    Name of broker.
    instanceName string
    Name of instance.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    authorization_name str
    Name of Instance broker authorization 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.
    authorizationName String
    Name of Instance broker authorization resource
    brokerName String
    Name of broker.
    instanceName String
    Name of instance.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getBrokerAuthorization Result

    The following output properties are available:

    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.BrokerAuthorizationPropertiesResponse
    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"
    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 BrokerAuthorizationPropertiesResponse
    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"
    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 BrokerAuthorizationPropertiesResponse
    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"
    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 BrokerAuthorizationPropertiesResponse
    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"
    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 BrokerAuthorizationPropertiesResponse
    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"
    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

    AuthorizationConfigResponse

    Cache string
    Enable caching of the authorization rules.
    Rules List<Pulumi.AzureNative.IoTOperations.Inputs.AuthorizationRuleResponse>
    The authorization rules to follow. If no rule is set, but Authorization Resource is used that would mean DenyAll.
    Cache string
    Enable caching of the authorization rules.
    Rules []AuthorizationRuleResponse
    The authorization rules to follow. If no rule is set, but Authorization Resource is used that would mean DenyAll.
    cache String
    Enable caching of the authorization rules.
    rules List<AuthorizationRuleResponse>
    The authorization rules to follow. If no rule is set, but Authorization Resource is used that would mean DenyAll.
    cache string
    Enable caching of the authorization rules.
    rules AuthorizationRuleResponse[]
    The authorization rules to follow. If no rule is set, but Authorization Resource is used that would mean DenyAll.
    cache str
    Enable caching of the authorization rules.
    rules Sequence[AuthorizationRuleResponse]
    The authorization rules to follow. If no rule is set, but Authorization Resource is used that would mean DenyAll.
    cache String
    Enable caching of the authorization rules.
    rules List<Property Map>
    The authorization rules to follow. If no rule is set, but Authorization Resource is used that would mean DenyAll.

    AuthorizationRuleResponse

    BrokerResources []BrokerResourceRuleResponse
    Give access to Broker methods and topics.
    Principals PrincipalDefinitionResponse
    Give access to clients based on the following properties.
    StateStoreResources []StateStoreResourceRuleResponse
    Give access to state store resources.
    brokerResources List<BrokerResourceRuleResponse>
    Give access to Broker methods and topics.
    principals PrincipalDefinitionResponse
    Give access to clients based on the following properties.
    stateStoreResources List<StateStoreResourceRuleResponse>
    Give access to state store resources.
    brokerResources BrokerResourceRuleResponse[]
    Give access to Broker methods and topics.
    principals PrincipalDefinitionResponse
    Give access to clients based on the following properties.
    stateStoreResources StateStoreResourceRuleResponse[]
    Give access to state store resources.
    broker_resources Sequence[BrokerResourceRuleResponse]
    Give access to Broker methods and topics.
    principals PrincipalDefinitionResponse
    Give access to clients based on the following properties.
    state_store_resources Sequence[StateStoreResourceRuleResponse]
    Give access to state store resources.
    brokerResources List<Property Map>
    Give access to Broker methods and topics.
    principals Property Map
    Give access to clients based on the following properties.
    stateStoreResources List<Property Map>
    Give access to state store resources.

    BrokerAuthorizationPropertiesResponse

    AuthorizationPolicies Pulumi.AzureNative.IoTOperations.Inputs.AuthorizationConfigResponse
    The list of authorization policies supported by the Authorization Resource.
    ProvisioningState string
    The status of the last operation.
    AuthorizationPolicies AuthorizationConfigResponse
    The list of authorization policies supported by the Authorization Resource.
    ProvisioningState string
    The status of the last operation.
    authorizationPolicies AuthorizationConfigResponse
    The list of authorization policies supported by the Authorization Resource.
    provisioningState String
    The status of the last operation.
    authorizationPolicies AuthorizationConfigResponse
    The list of authorization policies supported by the Authorization Resource.
    provisioningState string
    The status of the last operation.
    authorization_policies AuthorizationConfigResponse
    The list of authorization policies supported by the Authorization Resource.
    provisioning_state str
    The status of the last operation.
    authorizationPolicies Property Map
    The list of authorization policies supported by the Authorization Resource.
    provisioningState String
    The status of the last operation.

    BrokerResourceRuleResponse

    Method string
    Give access for a Broker method (i.e., Connect, Subscribe, or Publish).
    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
    Give access for a Broker method (i.e., Connect, Subscribe, or Publish).
    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
    Give access for a Broker method (i.e., Connect, Subscribe, or Publish).
    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
    Give access for a Broker method (i.e., Connect, Subscribe, or Publish).
    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
    Give access for a Broker method (i.e., Connect, Subscribe, or Publish).
    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
    Give access for a Broker method (i.e., Connect, Subscribe, or Publish).
    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.

    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.

    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.
    client_ids 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.

    StateStoreResourceRuleResponse

    KeyType string
    Allowed keyTypes pattern, string, binary. The key type used for matching, for example pattern tries to match the key to a glob-style pattern and string checks key is equal to value provided in keys.
    Keys List<string>
    Give access to state store keys for the corresponding principals defined. When key type is pattern set glob-style pattern (e.g., '', 'clients/').
    Method string
    Give access for Read, Write and ReadWrite access level.
    KeyType string
    Allowed keyTypes pattern, string, binary. The key type used for matching, for example pattern tries to match the key to a glob-style pattern and string checks key is equal to value provided in keys.
    Keys []string
    Give access to state store keys for the corresponding principals defined. When key type is pattern set glob-style pattern (e.g., '', 'clients/').
    Method string
    Give access for Read, Write and ReadWrite access level.
    keyType String
    Allowed keyTypes pattern, string, binary. The key type used for matching, for example pattern tries to match the key to a glob-style pattern and string checks key is equal to value provided in keys.
    keys List<String>
    Give access to state store keys for the corresponding principals defined. When key type is pattern set glob-style pattern (e.g., '', 'clients/').
    method String
    Give access for Read, Write and ReadWrite access level.
    keyType string
    Allowed keyTypes pattern, string, binary. The key type used for matching, for example pattern tries to match the key to a glob-style pattern and string checks key is equal to value provided in keys.
    keys string[]
    Give access to state store keys for the corresponding principals defined. When key type is pattern set glob-style pattern (e.g., '', 'clients/').
    method string
    Give access for Read, Write and ReadWrite access level.
    key_type str
    Allowed keyTypes pattern, string, binary. The key type used for matching, for example pattern tries to match the key to a glob-style pattern and string checks key is equal to value provided in keys.
    keys Sequence[str]
    Give access to state store keys for the corresponding principals defined. When key type is pattern set glob-style pattern (e.g., '', 'clients/').
    method str
    Give access for Read, Write and ReadWrite access level.
    keyType String
    Allowed keyTypes pattern, string, binary. The key type used for matching, for example pattern tries to match the key to a glob-style pattern and string checks key is equal to value provided in keys.
    keys List<String>
    Give access to state store keys for the corresponding principals defined. When key type is pattern set glob-style pattern (e.g., '', 'clients/').
    method String
    Give access for Read, Write and ReadWrite access level.

    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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native