Partilhar via


Broker Authorization - List By Broker Resource

List BrokerAuthorizationResource resources by 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 do URI

Name Em Necessário Tipo Description
brokerName
path True

string

Nome do recurso de mediador MQ

Padrão Regex: ^[a-zA-Z0-9-]{3,24}$

mqName
path True

string

Nome do recurso MQ

Padrão Regex: ^[a-zA-Z0-9-]{3,24}$

resourceGroupName
path True

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

subscriptionId
path True

string

O ID da subscrição de destino.

api-version
query True

string

A versão da API a utilizar para esta operação.

Respostas

Name Tipo Description
200 OK

BrokerAuthorizationResourceListResult

A operação do Azure foi concluída com êxito.

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

BrokerAuthorization_ListByBrokerResource

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
AuthorizationBasicRule

BasicRules of AuthorizationConfig Polar rules are not supported (BasicRules of AuthorizationConfig Polar rules are not supported) (BasicRules of AuthorizationConfig Polar rules are not support

AuthorizationConfig

Propriedades do Broker AuthorizationConfig

BrokerAuthorizationResource

Mediador/recurso de autorização do MQ

BrokerAuthorizationResourceListResult

A resposta de uma operação de lista BrokerAuthorizationResource.

createdByType

O tipo de identidade que criou o recurso.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta a erros

ExtendedLocationProperty

Propriedades ExtendedLocation

ExtendedLocationType

O tipo de definição de enumeração de ExtendedLocation aceite.

PrincipalDefinition

Propriedades de PrincipalDefinition da Regra Básica

ProvisioningState

A enumeração que define o estado do recurso.

ResourceInfoDefinition

Propriedades resourceInfoDefinition da Regra Básica. Isto define os objetos que representam as ações ou tópicos, como - método . Connect, method. Publicar, etc.

ResourceInfoDefinitionMethods

Métodos ResourceInfoDefinition permitidos

systemData

Metadados relativos à criação e última modificação do recurso.

AuthorizationBasicRule

BasicRules of AuthorizationConfig Polar rules are not supported (BasicRules of AuthorizationConfig Polar rules are not supported) (BasicRules of AuthorizationConfig Polar rules are not support

Name Tipo Description
brokerResources

ResourceInfoDefinition[]

Este subcampo define os recursos de mediador nos quais a Regra Básica é aplicada.

principals

PrincipalDefinition

Este subcampo define as identidades que representam os clientes.

AuthorizationConfig

Propriedades do Broker AuthorizationConfig

Name Tipo Default value Description
enableCache

boolean

True

Ative a colocação em cache das regras de autorização.

rules

AuthorizationBasicRule[]

Regras de Autorização a utilizar. Se não estiver definida nenhuma regra, mas for utilizado o Recurso de Autorização, isso significará DenyAll.

BrokerAuthorizationResource

Mediador/recurso de autorização do MQ

Name Tipo Description
extendedLocation

ExtendedLocationProperty

Localização Expandida

id

string

ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

A localização geográfica onde reside o recurso

name

string

O nome do recurso

properties.authorizationPolicies

AuthorizationConfig

A lista de políticas de autorização suportadas pelo Recurso de Autorização.

properties.listenerRef

string[]

A matriz de Recursos do serviço de escuta que suporta.

properties.provisioningState

ProvisioningState

O estado da última operação.

systemData

systemData

O Azure Resource Manager metadados que contêm createdBy e modifiedBy information.

tags

object

Etiquetas de recursos.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

BrokerAuthorizationResourceListResult

A resposta de uma operação de lista BrokerAuthorizationResource.

Name Tipo Description
nextLink

string

A ligação para a página seguinte de itens

value

BrokerAuthorizationResource[]

Os itens BrokerAuthorizationResource nesta página

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta a erros

Name Tipo Description
error

ErrorDetail

O objeto de erro.

ExtendedLocationProperty

Propriedades ExtendedLocation

Name Tipo Description
name

string

O nome da localização expandida.

type

ExtendedLocationType

Tipo de ExtendedLocation.

ExtendedLocationType

O tipo de definição de enumeração de ExtendedLocation aceite.

Name Tipo Description
CustomLocation

string

Tipo de CustomLocation

PrincipalDefinition

Propriedades de PrincipalDefinition da Regra Básica

Name Tipo Description
attributes

object[]

Uma lista de pares chave-valor que correspondem aos atributos dos clientes. Os atributos são sensíveis a maiúsculas e minúsculas e têm de corresponder aos atributos fornecidos pelos clientes durante a autenticação.

clientids

string[]

Uma lista de IDs de cliente que correspondem aos clientes. Os IDs de cliente são sensíveis a maiúsculas e minúsculas e têm de corresponder aos IDs de cliente fornecidos pelos clientes durante a ligação.

usernames

string[]

Uma lista de nomes de utilizador que correspondem aos clientes. Os nomes de utilizador são sensíveis a maiúsculas e minúsculas e têm de corresponder aos nomes de utilizador fornecidos pelos clientes durante a autenticação.

ProvisioningState

A enumeração que define o estado do recurso.

Name Tipo Description
Accepted

string

O recurso foi aceite.

Canceled

string

A criação de recursos foi cancelada.

Deleting

string

O recurso está a eliminar.

Failed

string

Falha na criação de recursos.

Provisioning

string

O recurso está a ser aprovisionado.

Succeeded

string

O recurso foi criado.

Updating

string

O recurso está a atualizar.

ResourceInfoDefinition

Propriedades resourceInfoDefinition da Regra Básica. Isto define os objetos que representam as ações ou tópicos, como - método . Connect, method. Publicar, etc.

Name Tipo Description
method

ResourceInfoDefinitionMethods

O tipo de ação que os clientes podem executar no mediador: Ligar, Publicar ou Subscrever.

topics

string[]

Uma lista de tópicos ou padrões de tópico que correspondem aos tópicos que os clientes podem publicar ou subscrever. Este subcampo é necessário se o método for Publicar ou Subscrever.

ResourceInfoDefinitionMethods

Métodos ResourceInfoDefinition permitidos

Name Tipo Description
Connect

string

Ligação Permitida ao Mediador

Publish

string

Publicação Permitida no Mediador

Subscribe

string

Subscrição Permitida do Mediador

systemData

Metadados relativos à criação e última modificação do recurso.

Name Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).

createdBy

string

A identidade que criou o recurso.

createdByType

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt

string

O carimbo de data/hora da última modificação do recurso (UTC)

lastModifiedBy

string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.