Compartir a través de


Broker Authorization - List By Broker Resource

Enumeración de recursos BrokerAuthorizationResource por BrokerResource

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
brokerName
path True

string

Nombre del recurso de agente mq

Patrón de Regex: ^[a-zA-Z0-9-]{3,24}$

mqName
path True

string

Nombre del recurso MQ

Patrón de Regex: ^[a-zA-Z0-9-]{3,24}$

resourceGroupName
path True

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

subscriptionId
path True

string

Identificador de la suscripción de destino.

api-version
query True

string

Versión de API que se usará para la operación.

Respuestas

Nombre Tipo Description
200 OK

BrokerAuthorizationResourceListResult

La operación de Azure se completó correctamente.

Other Status Codes

ErrorResponse

Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

BrokerAuthorization_ListByBrokerResource

Solicitud de ejemplo

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

Respuesta de muestra

{
  "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"
}

Definiciones

Nombre Description
AuthorizationBasicRule

Las reglas BasicRules de AuthorizationConfig Polar no se admiten

AuthorizationConfig

Propiedades de Broker AuthorizationConfig

BrokerAuthorizationResource

Recurso de agente y autorización de MQ

BrokerAuthorizationResourceListResult

Respuesta de una operación de lista BrokerAuthorizationResource.

createdByType

Tipo de identidad que creó el recurso.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta de error

ExtendedLocationProperty

Propiedades ExtendedLocation

ExtendedLocationType

Enumeración que define el tipo de ExtendedLocation aceptado.

PrincipalDefinition

Propiedades PrincipalDefinition de la regla básica

ProvisioningState

Enumeración que define el estado del recurso.

ResourceInfoDefinition

Propiedades ResourceInfoDefinition de la regla básica. Esto define los objetos que representan las acciones o temas, como - method. Connect, método. Publicar, etc.

ResourceInfoDefinitionMethods

Métodos ResourceInfoDefinition permitidos

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

AuthorizationBasicRule

Las reglas BasicRules de AuthorizationConfig Polar no se admiten

Nombre Tipo Description
brokerResources

ResourceInfoDefinition[]

Este subcampo define los recursos del agente en los que se aplica la regla básica.

principals

PrincipalDefinition

Este subcampo define las identidades que representan a los clientes.

AuthorizationConfig

Propiedades de Broker AuthorizationConfig

Nombre Tipo Valor predeterminado Description
enableCache

boolean

True

Habilite el almacenamiento en caché de las reglas de autorización.

rules

AuthorizationBasicRule[]

Reglas de autorización que se van a usar. Si no se establece ninguna regla, pero se usa el recurso de autorización que significaría DenyAll.

BrokerAuthorizationResource

Recurso de agente y autorización de MQ

Nombre Tipo Description
extendedLocation

ExtendedLocationProperty

Ubicación extendida

id

string

Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Ubicación geográfica donde reside el recurso

name

string

Nombre del recurso.

properties.authorizationPolicies

AuthorizationConfig

Lista de directivas de autorización admitidas por el recurso de autorización.

properties.listenerRef

string[]

Matriz de recursos del agente de escucha que admite.

properties.provisioningState

ProvisioningState

Estado de la última operación.

systemData

systemData

Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.

tags

object

Etiquetas del recurso.

type

string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

BrokerAuthorizationResourceListResult

Respuesta de una operación de lista BrokerAuthorizationResource.

Nombre Tipo Description
nextLink

string

Vínculo a la página siguiente de elementos

value

BrokerAuthorizationResource[]

Elementos BrokerAuthorizationResource de esta página

createdByType

Tipo de identidad que creó el recurso.

Nombre Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.

type

string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorDetail[]

Los detalles del error.

message

string

El mensaje de error.

target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

ExtendedLocationProperty

Propiedades ExtendedLocation

Nombre Tipo Description
name

string

Nombre de la ubicación extendida.

type

ExtendedLocationType

Tipo de ExtendedLocation.

ExtendedLocationType

Enumeración que define el tipo de ExtendedLocation aceptado.

Nombre Tipo Description
CustomLocation

string

Tipo CustomLocation

PrincipalDefinition

Propiedades PrincipalDefinition de la regla básica

Nombre Tipo Description
attributes

object[]

Lista de pares clave-valor que coinciden con los atributos de los clientes. Los atributos distinguen mayúsculas de minúsculas y deben coincidir con los atributos proporcionados por los clientes durante la autenticación.

clientids

string[]

Lista de identificadores de cliente que coinciden con los clientes. Los identificadores de cliente distinguen mayúsculas de minúsculas y deben coincidir con los identificadores de cliente proporcionados por los clientes durante la conexión.

usernames

string[]

Lista de nombres de usuario que coinciden con los clientes. Los nombres de usuario distinguen mayúsculas de minúsculas y deben coincidir con los nombres de usuario proporcionados por los clientes durante la autenticación.

ProvisioningState

Enumeración que define el estado del recurso.

Nombre Tipo Description
Accepted

string

Se ha aceptado el recurso.

Canceled

string

Se canceló la creación de recursos.

Deleting

string

El recurso se está eliminando.

Failed

string

Error en la creación de recursos.

Provisioning

string

El recurso se aprovisiona.

Succeeded

string

Se ha creado el recurso.

Updating

string

El recurso es Actualizar.

ResourceInfoDefinition

Propiedades ResourceInfoDefinition de la regla básica. Esto define los objetos que representan las acciones o temas, como - method. Connect, método. Publicar, etc.

Nombre Tipo Description
method

ResourceInfoDefinitionMethods

Tipo de acción que los clientes pueden realizar en el agente: Conectar, Publicar o Suscribir.

topics

string[]

Lista de temas o patrones de tema que coinciden con los temas a los que los clientes pueden publicar o suscribirse. Este subcampo es necesario si el método es Publish o Subscribe.

ResourceInfoDefinitionMethods

Métodos ResourceInfoDefinition permitidos

Nombre Tipo Description
Connect

string

Se permite la conexión a Broker

Publish

string

Publicación permitida en Broker

Subscribe

string

Se permite suscribirse al agente

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre Tipo Description
createdAt

string

Marca de tiempo de creación de recursos (UTC).

createdBy

string

Identidad que creó el recurso.

createdByType

createdByType

Tipo de identidad que creó el recurso.

lastModifiedAt

string

Marca de tiempo de la última modificación del recurso (UTC)

lastModifiedBy

string

Identidad que modificó por última vez el recurso.

lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.