Udostępnij za pośrednictwem


Broker Authorization - List By Broker Resource

Wyświetlanie listy zasobów BrokerAuthorizationResource według brokeraResource

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
brokerName
path True

string

Nazwa zasobu brokera MQ

Wzorzec wyrażenia regularnego: ^[a-zA-Z0-9-]{3,24}$

mqName
path True

string

Nazwa zasobu MQ

Wzorzec wyrażenia regularnego: ^[a-zA-Z0-9-]{3,24}$

resourceGroupName
path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

subscriptionId
path True

string

Identyfikator subskrypcji docelowej.

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

BrokerAuthorizationResourceListResult

Operacja platformy Azure została zakończona pomyślnie.

Other Status Codes

ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

BrokerAuthorization_ListByBrokerResource

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
AuthorizationBasicRule

Reguły polarne BasicRules of AuthorizationConfig nie są obsługiwane

AuthorizationConfig

Właściwości autoryzacji brokera

BrokerAuthorizationResource

Zasób brokera/autoryzacji MQ

BrokerAuthorizationResourceListResult

Odpowiedź operacji listy BrokerAuthorizationResource.

createdByType

Typ tożsamości, która utworzyła zasób.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd

ExtendedLocationProperty

Właściwości extendedLocation

ExtendedLocationType

Wyliczenie definiujące typ zaakceptowanej funkcji ExtendedLocation.

PrincipalDefinition

Właściwości principalDefinition reguły podstawowej

ProvisioningState

Wyliczenie definiujące stan zasobu.

ResourceInfoDefinition

Właściwości resourceInfoDefinition reguły podstawowej. Definiuje obiekty reprezentujące akcje lub tematy, takie jak - metoda. Connect, metoda. Publikowanie itp.

ResourceInfoDefinitionMethods

Dozwolone metody ResourceInfoDefinition

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

AuthorizationBasicRule

Reguły polarne BasicRules of AuthorizationConfig nie są obsługiwane

Nazwa Typ Opis
brokerResources

ResourceInfoDefinition[]

To pole podrzędne definiuje zasoby brokera stosowane przez regułę podstawową.

principals

PrincipalDefinition

To pole podrzędne definiuje tożsamości reprezentujące klientów.

AuthorizationConfig

Właściwości autoryzacji brokera

Nazwa Typ Domyślna wartość Opis
enableCache

boolean

True

Włącz buforowanie reguł autoryzacji.

rules

AuthorizationBasicRule[]

Reguły autoryzacji do użycia. Jeśli żadna reguła nie jest ustawiona, ale używany jest zasób autoryzacji, oznacza to odmowęAll.

BrokerAuthorizationResource

Zasób brokera/autoryzacji MQ

Nazwa Typ Opis
extendedLocation

ExtendedLocationProperty

Lokalizacja rozszerzona

id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Lokalizacja geograficzna, w której znajduje się zasób

name

string

Nazwa zasobu

properties.authorizationPolicies

AuthorizationConfig

Lista zasad autoryzacji obsługiwanych przez zasób autoryzacji.

properties.listenerRef

string[]

Tablica zasobów odbiornika, które obsługuje.

properties.provisioningState

ProvisioningState

Stan ostatniej operacji.

systemData

systemData

Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.

tags

object

Tagi zasobów.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

BrokerAuthorizationResourceListResult

Odpowiedź operacji listy BrokerAuthorizationResource.

Nazwa Typ Opis
nextLink

string

Link do następnej strony elementów

value

BrokerAuthorizationResource[]

Elementy BrokerAuthorizationResource na tej stronie

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

code

string

Kod błędu.

details

ErrorDetail[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

ExtendedLocationProperty

Właściwości extendedLocation

Nazwa Typ Opis
name

string

Nazwa lokalizacji rozszerzonej.

type

ExtendedLocationType

Typ extendedLocation.

ExtendedLocationType

Wyliczenie definiujące typ zaakceptowanej funkcji ExtendedLocation.

Nazwa Typ Opis
CustomLocation

string

Typ customLocation

PrincipalDefinition

Właściwości principalDefinition reguły podstawowej

Nazwa Typ Opis
attributes

object[]

Lista par klucz-wartość, które pasują do atrybutów klientów. Atrybuty są uwzględniane w wielkości liter i muszą być zgodne z atrybutami udostępnianymi przez klientów podczas uwierzytelniania.

clientids

string[]

Lista identyfikatorów klientów pasujących do klientów. Identyfikatory klientów są uwzględniane w wielkości liter i muszą być zgodne z identyfikatorami klienta dostarczonymi przez klientów podczas nawiązywania połączenia.

usernames

string[]

Lista nazw użytkowników pasujących do klientów. Nazwy użytkowników są uwzględniane w wielkości liter i muszą być zgodne z nazwami użytkownika podanymi przez klientów podczas uwierzytelniania.

ProvisioningState

Wyliczenie definiujące stan zasobu.

Nazwa Typ Opis
Accepted

string

Zasób został zaakceptowany.

Canceled

string

Tworzenie zasobów zostało anulowane.

Deleting

string

Zasób jest usuwany.

Failed

string

Tworzenie zasobu nie powiodło się.

Provisioning

string

Zasób jest aprowizacja.

Succeeded

string

Zasób został utworzony.

Updating

string

Zasób jest aktualizowany.

ResourceInfoDefinition

Właściwości resourceInfoDefinition reguły podstawowej. Definiuje obiekty reprezentujące akcje lub tematy, takie jak - metoda. Connect, metoda. Publikowanie itp.

Nazwa Typ Opis
method

ResourceInfoDefinitionMethods

Typ akcji, którą klienci mogą wykonać na brokerze: Połącz, Opublikuj lub Subskrybuj.

topics

string[]

Lista tematów lub wzorców tematów pasujących do tematów, do których klienci mogą publikować lub subskrybować. To pole podrzędne jest wymagane, jeśli metoda to Publikuj lub Subskrybuj.

ResourceInfoDefinitionMethods

Dozwolone metody ResourceInfoDefinition

Nazwa Typ Opis
Connect

string

Dozwolone nawiązywanie połączenia z brokerem

Publish

string

Dozwolone publikowanie w brokerze

Subscribe

string

Dozwolone subskrybowanie brokera

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobu (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.