Поделиться через


Broker Authorization - List By Broker Resource

Перечисление ресурсов BrokerAuthorizationResource по brokerResource

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

Параметры URI

Имя В Обязательно Тип Описание
brokerName
path True

string

Имя ресурса брокера MQ

Шаблон регулярного выражения: ^[a-zA-Z0-9-]{3,24}$

mqName
path True

string

Имя ресурса MQ

Шаблон регулярного выражения: ^[a-zA-Z0-9-]{3,24}$

resourceGroupName
path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

subscriptionId
path True

string

Идентификатор целевой подписки.

api-version
query True

string

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
200 OK

BrokerAuthorizationResourceListResult

Операция Azure успешно завершена.

Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

BrokerAuthorization_ListByBrokerResource

Образец запроса

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

Пример ответа

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

Определения

Имя Описание
AuthorizationBasicRule

Правила BasicRules authorizationConfig Polar не поддерживаются

AuthorizationConfig

Свойства broker AuthorizationConfig

BrokerAuthorizationResource

Ресурс брокера/авторизации MQ

BrokerAuthorizationResourceListResult

Ответ операции со списком BrokerAuthorizationResource.

createdByType

Тип удостоверения, создавшего ресурс.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Сообщение об ошибке

ExtendedLocationProperty

Свойства ExtendedLocation

ExtendedLocationType

Перечисление, определяющее тип Объекта ExtendedLocation принято.

PrincipalDefinition

Свойства PrincipalDefinition базового правила

ProvisioningState

Перечисление, определяющее состояние ресурса.

ResourceInfoDefinition

Свойства ResourceInfoDefinition базового правила. Он определяет объекты, представляющие действия или разделы, например метод - . Connect, метод. Публикация и т. д.

ResourceInfoDefinitionMethods

Разрешены методы ResourceInfoDefinition

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

AuthorizationBasicRule

Правила BasicRules authorizationConfig Polar не поддерживаются

Имя Тип Описание
brokerResources

ResourceInfoDefinition[]

Это подполе определяет ресурсы брокера, к которым применяется базовое правило.

principals

PrincipalDefinition

Это подполе определяет удостоверения, представляющие клиентов.

AuthorizationConfig

Свойства broker AuthorizationConfig

Имя Тип Default value Описание
enableCache

boolean

True

Включите кэширование правил авторизации.

rules

AuthorizationBasicRule[]

Используемые правила авторизации. Если правило не задано, но используется ресурс авторизации, это означает DenyAll.

BrokerAuthorizationResource

Ресурс брокера/авторизации MQ

Имя Тип Описание
extendedLocation

ExtendedLocationProperty

Расширенное расположение

id

string

Полный идентификатор ресурса. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Географическое расположение, в котором находится ресурс

name

string

Имя ресурса.

properties.authorizationPolicies

AuthorizationConfig

Список политик авторизации, поддерживаемых ресурсом авторизации.

properties.listenerRef

string[]

Массив ресурсов прослушивателя, которые он поддерживает.

properties.provisioningState

ProvisioningState

Состояние последней операции.

systemData

systemData

Azure Resource Manager метаданные, содержащие сведения createdBy и modifiedBy.

tags

object

Теги ресурсов.

type

string

Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

BrokerAuthorizationResourceListResult

Ответ операции со списком BrokerAuthorizationResource.

Имя Тип Описание
nextLink

string

Ссылка на следующую страницу элементов

value

BrokerAuthorizationResource[]

Элементы BrokerAuthorizationResource на этой странице

createdByType

Тип удостоверения, создавшего ресурс.

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
error

ErrorDetail

Объект error.

ExtendedLocationProperty

Свойства ExtendedLocation

Имя Тип Описание
name

string

Имя расширенного расположения.

type

ExtendedLocationType

Тип Объекта ExtendedLocation.

ExtendedLocationType

Перечисление, определяющее тип Объекта ExtendedLocation принято.

Имя Тип Описание
CustomLocation

string

Тип CustomLocation

PrincipalDefinition

Свойства PrincipalDefinition базового правила

Имя Тип Описание
attributes

object[]

Список пар "ключ-значение", соответствующих атрибутам клиентов. Атрибуты чувствительны к регистру и должны соответствовать атрибутам, предоставленным клиентами во время проверки подлинности.

clientids

string[]

Список идентификаторов клиентов, соответствующих клиентам. Идентификаторы клиентов чувствительны к регистру и должны соответствовать идентификаторам клиентов, предоставленным клиентами во время подключения.

usernames

string[]

Список имен пользователей, соответствующих клиентам. Имена пользователей чувствительны к регистру и должны соответствовать именам пользователей, предоставленным клиентами во время проверки подлинности.

ProvisioningState

Перечисление, определяющее состояние ресурса.

Имя Тип Описание
Accepted

string

Ресурс принят.

Canceled

string

Создание ресурса было отменено.

Deleting

string

Ресурс удаляется.

Failed

string

Не удалось создать ресурс.

Provisioning

string

Ресурс подготавливается.

Succeeded

string

Ресурс создан.

Updating

string

Ресурс обновляется.

ResourceInfoDefinition

Свойства ResourceInfoDefinition базового правила. Он определяет объекты, представляющие действия или разделы, например метод - . Connect, метод. Публикация и т. д.

Имя Тип Описание
method

ResourceInfoDefinitionMethods

Тип действия, которое клиенты могут выполнять с брокером: Connect, Publish или Subscribe.

topics

string[]

Список разделов или шаблонов тем, которые соответствуют тем, на которые клиенты могут публиковать или подписываться. Это подполе является обязательным, если используется метод Publish или Subscribe.

ResourceInfoDefinitionMethods

Разрешены методы ResourceInfoDefinition

Имя Тип Описание
Connect

string

Разрешено подключение к брокеру

Publish

string

Разрешенная публикация в брокере

Subscribe

string

Разрешенная подписка на брокер

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).

createdBy

string

Удостоверение, создающее ресурс.

createdByType

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt

string

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy

string

Удостоверение, которое последним изменял ресурс.

lastModifiedByType

createdByType

Тип удостоверения, которое последним изменял ресурс.