Partager via


Broker Authorization - List By Broker Resource

Répertorier les ressources BrokerAuthorizationResource par BrokerResource

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/broker/{brokerName}/authorization?api-version=2023-10-04-preview

Paramètres URI

Nom Dans Obligatoire Type Description
brokerName
path True

string

Nom de la ressource broker MQ

Modèle d’expression régulière: ^[a-zA-Z0-9-]{3,24}$

mqName
path True

string

Nom de la ressource MQ

Modèle d’expression régulière: ^[a-zA-Z0-9-]{3,24}$

resourceGroupName
path True

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

subscriptionId
path True

string

ID de l’abonnement cible.

api-version
query True

string

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

BrokerAuthorizationResourceListResult

L’opération Azure s’est terminée avec succès.

Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

BrokerAuthorization_ListByBrokerResource

Exemple de requête

GET https://management.azure.com/subscriptions/2408F1A7-C077-406C-814C-FBD93E129C00/resourceGroups/rgiotoperationsmq/providers/Microsoft.IoTOperationsMQ/mq/W27141/broker/-Qi3h9CDM5-B67/authorization?api-version=2023-10-04-preview

Exemple de réponse

{
  "value": [
    {
      "properties": {
        "authorizationPolicies": {
          "enableCache": true,
          "rules": [
            {
              "brokerResources": [
                {
                  "method": "Connect",
                  "topics": [
                    "v"
                  ]
                }
              ],
              "principals": {
                "attributes": [
                  {}
                ],
                "clientids": [
                  "smrfzvniq"
                ],
                "usernames": [
                  "jtwwmsrzriat"
                ]
              }
            }
          ]
        },
        "listenerRef": [
          "mxgpbyb"
        ],
        "provisioningState": "Succeeded"
      },
      "extendedLocation": {
        "name": "an",
        "type": "CustomLocation"
      },
      "tags": {},
      "location": "bvgohixie",
      "id": "gnadudsswgdraktcofmjipc",
      "name": "nwffklaehhtmhqcpjauqprvykdjzzd",
      "type": "opfsndejpcvspwlcmyhynhqc",
      "systemData": {
        "createdBy": "lsch",
        "createdByType": "User",
        "createdAt": "2023-10-06T15:04:36.253Z",
        "lastModifiedBy": "moncedixbtiffwcevatm",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2023-10-06T15:04:36.256Z"
      }
    }
  ],
  "nextLink": "https://microsoft.com/ale"
}

Définitions

Nom Description
AuthorizationBasicRule

Les règles BasicRules of AuthorizationConfig Polar ne sont pas prises en charge

AuthorizationConfig

Propriétés Broker AuthorizationConfig

BrokerAuthorizationResource

Ressource broker/autorisation MQ

BrokerAuthorizationResourceListResult

Réponse d’une opération de liste BrokerAuthorizationResource.

createdByType

Type d’identité qui a créé la ressource.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

ExtendedLocationProperty

Propriétés ExtendedLocation

ExtendedLocationType

Type de définition d’énumération de ExtendedLocation accepté.

PrincipalDefinition

Propriétés PrincipalDefinition de la règle de base

ProvisioningState

Enum définissant status de ressource.

ResourceInfoDefinition

Propriétés ResourceInfoDefinition de la règle de base. Cela définit les objets qui représentent les actions ou les rubriques, telles que - method. Connect, méthode. Publier, etc.

ResourceInfoDefinitionMethods

Méthodes ResourceInfoDefinition autorisées

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

AuthorizationBasicRule

Les règles BasicRules of AuthorizationConfig Polar ne sont pas prises en charge

Nom Type Description
brokerResources

ResourceInfoDefinition[]

Ce sous-champ définit les ressources broker auxquelles la règle de base est appliquée.

principals

PrincipalDefinition

Ce sous-champ définit les identités qui représentent les clients.

AuthorizationConfig

Propriétés Broker AuthorizationConfig

Nom Type Valeur par défaut Description
enableCache

boolean

True

Activez la mise en cache des règles d’autorisation.

rules

AuthorizationBasicRule[]

Règles d’autorisation à utiliser. Si aucune règle n’est définie, mais que la ressource d’autorisation est utilisée, cela signifie DenyAll.

BrokerAuthorizationResource

Ressource broker/autorisation MQ

Nom Type Description
extendedLocation

ExtendedLocationProperty

Emplacement étendu

id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Emplacement géographique où réside la ressource

name

string

nom de la ressource.

properties.authorizationPolicies

AuthorizationConfig

Liste des stratégies d’autorisation prises en charge par la ressource d’autorisation.

properties.listenerRef

string[]

Tableau des ressources de l’écouteur qu’il prend en charge.

properties.provisioningState

ProvisioningState

Status de la dernière opération.

systemData

systemData

Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.

tags

object

Balises de ressource.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

BrokerAuthorizationResourceListResult

Réponse d’une opération de liste BrokerAuthorizationResource.

Nom Type Description
nextLink

string

Lien vers la page d’éléments suivante

value

BrokerAuthorizationResource[]

Éléments BrokerAuthorizationResource de cette page

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires

type

string

Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d'erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet error.

ExtendedLocationProperty

Propriétés ExtendedLocation

Nom Type Description
name

string

Nom de l’emplacement étendu.

type

ExtendedLocationType

Type de ExtendedLocation.

ExtendedLocationType

Type de définition d’énumération de ExtendedLocation accepté.

Nom Type Description
CustomLocation

string

Type CustomLocation

PrincipalDefinition

Propriétés PrincipalDefinition de la règle de base

Nom Type Description
attributes

object[]

Liste de paires clé-valeur qui correspondent aux attributs des clients. Les attributs respectent la casse et doivent correspondre aux attributs fournis par les clients lors de l’authentification.

clientids

string[]

Liste des ID de client qui correspondent aux clients. Les ID client respectent la casse et doivent correspondre aux ID clients fournis par les clients lors de la connexion.

usernames

string[]

Liste des noms d’utilisateur qui correspondent aux clients. Les noms d’utilisateur respectent la casse et doivent correspondre aux noms d’utilisateur fournis par les clients lors de l’authentification.

ProvisioningState

Enum définissant status de ressource.

Nom Type Description
Accepted

string

La ressource a été acceptée.

Canceled

string

La création de la ressource a été annulée.

Deleting

string

La ressource est la suppression.

Failed

string

Échec de la création de la ressource.

Provisioning

string

La ressource est en cours d’approvisionnement.

Succeeded

string

La ressource a été créée.

Updating

string

La ressource est Mise à jour.

ResourceInfoDefinition

Propriétés ResourceInfoDefinition de la règle de base. Cela définit les objets qui représentent les actions ou les rubriques, telles que - method. Connect, méthode. Publier, etc.

Nom Type Description
method

ResourceInfoDefinitionMethods

Type d’action que les clients peuvent effectuer sur le répartiteur : Se connecter, publier ou s’abonner.

topics

string[]

Liste de rubriques ou de modèles de rubrique qui correspondent aux rubriques auxquelles les clients peuvent publier ou s’abonner. Ce sous-champ est obligatoire si la méthode est Publish ou Subscribe.

ResourceInfoDefinitionMethods

Méthodes ResourceInfoDefinition autorisées

Nom Type Description
Connect

string

Connexion autorisée à Broker

Publish

string

Publication autorisée sur Broker

Subscribe

string

Abonnement autorisé à Broker

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string

Horodatage de la dernière modification de la ressource (UTC)

lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.