Sdílet prostřednictvím


Broker Authorization - List By Broker Resource

Výpis prostředků BrokerAuthorizationResource podle BrokerResource

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
brokerName
path True

string

Název prostředku zprostředkovatele MQ

Vzor regulárního výrazu: ^[a-zA-Z0-9-]{3,24}$

mqName
path True

string

Název prostředku MQ

Vzor regulárního výrazu: ^[a-zA-Z0-9-]{3,24}$

resourceGroupName
path True

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

subscriptionId
path True

string

ID cílového předplatného.

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name Typ Description
200 OK

BrokerAuthorizationResourceListResult

Operace Azure se úspěšně dokončila.

Other Status Codes

ErrorResponse

Neočekávaná chybová odpověď.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

BrokerAuthorization_ListByBrokerResource

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
AuthorizationBasicRule

Základní pravidla AuthorizationConfig Polar se nepodporují.

AuthorizationConfig

Vlastnosti Broker AuthorizationConfig

BrokerAuthorizationResource

Prostředek pro zprostředkovatel/autorizaci MQ

BrokerAuthorizationResourceListResult

Odpověď operace seznamu BrokerAuthorizationResource.

createdByType

Typ identity, která vytvořila prostředek.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorDetail

Podrobnosti o chybě.

ErrorResponse

Odpověď na chybu

ExtendedLocationProperty

Vlastnosti ExtendedLocation

ExtendedLocationType

Výčet definující typ ExtendedLocation akceptuje.

PrincipalDefinition

Vlastnosti PrincipalDefinition základního pravidla

ProvisioningState

Výčet definující stav prostředku.

ResourceInfoDefinition

Vlastnosti ResourceInfoDefinition základního pravidla. Tím se definují objekty, které představují akce nebo témata, jako je například metoda - . Connect, metoda. Publikovat atd.

ResourceInfoDefinitionMethods

Povolené metody ResourceInfoDefinition

systemData

Metadata týkající se vytvoření a poslední změny prostředku

AuthorizationBasicRule

Základní pravidla AuthorizationConfig Polar se nepodporují.

Name Typ Description
brokerResources

ResourceInfoDefinition[]

Toto dílčí pole definuje prostředky zprostředkovatele, na které se použije základní pravidlo.

principals

PrincipalDefinition

Toto dílčí pole definuje identity, které představují klienty.

AuthorizationConfig

Vlastnosti Broker AuthorizationConfig

Name Typ Default value Description
enableCache

boolean

True

Povolte ukládání autorizačních pravidel do mezipaměti.

rules

AuthorizationBasicRule[]

Autorizační pravidla, která se mají použít. Pokud není nastaveno žádné pravidlo, ale použije se prostředek autorizace, znamená to, že je možné odepřít vše.

BrokerAuthorizationResource

Prostředek pro zprostředkovatel/autorizaci MQ

Name Typ Description
extendedLocation

ExtendedLocationProperty

Rozšířené umístění

id

string

Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Geografické umístění, ve kterém se nachází prostředek

name

string

Název prostředku

properties.authorizationPolicies

AuthorizationConfig

Seznam zásad autorizace podporovaných autorizačním prostředkem

properties.listenerRef

string[]

Pole prostředků naslouchacího procesu, které podporuje.

properties.provisioningState

ProvisioningState

Stav poslední operace.

systemData

systemData

Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.

tags

object

Značky prostředků.

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

BrokerAuthorizationResourceListResult

Odpověď operace seznamu BrokerAuthorizationResource.

Name Typ Description
nextLink

string

Odkaz na další stránku položek

value

BrokerAuthorizationResource[]

Položky BrokerAuthorizationResource na této stránce

createdByType

Typ identity, která vytvořila prostředek.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.

type

string

Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě

code

string

Kód chyby

details

ErrorDetail[]

Podrobnosti o chybě

message

string

Chybová zpráva

target

string

Cíl chyby.

ErrorResponse

Odpověď na chybu

Name Typ Description
error

ErrorDetail

Objekt chyby.

ExtendedLocationProperty

Vlastnosti ExtendedLocation

Name Typ Description
name

string

Název rozšířeného umístění.

type

ExtendedLocationType

Typ ExtendedLocation.

ExtendedLocationType

Výčet definující typ ExtendedLocation akceptuje.

Name Typ Description
CustomLocation

string

Typ CustomLocation

PrincipalDefinition

Vlastnosti PrincipalDefinition základního pravidla

Name Typ Description
attributes

object[]

Seznam párů klíč-hodnota, které odpovídají atributům klientů. V atributech se rozlišují malá a velká písmena a musí odpovídat atributům poskytnutým klienty během ověřování.

clientids

string[]

Seznam ID klientů, která odpovídají klientům. U ID klientů se rozlišují velká a malá písmena a musí odpovídat ID klientů, které klienti poskytli během připojení.

usernames

string[]

Seznam uživatelských jmen, která odpovídají klientům. U uživatelských jmen se rozlišují velká a malá písmena a musí odpovídat uživatelským jménům zadaným klienty během ověřování.

ProvisioningState

Výčet definující stav prostředku.

Name Typ Description
Accepted

string

Prostředek byl přijat.

Canceled

string

Vytváření prostředků se zrušilo.

Deleting

string

Prostředek se odstraňuje.

Failed

string

Vytvoření prostředku se nezdařilo.

Provisioning

string

Zřizují se prostředky.

Succeeded

string

Prostředek byl vytvořen.

Updating

string

Prostředek se aktualizuje.

ResourceInfoDefinition

Vlastnosti ResourceInfoDefinition základního pravidla. Tím se definují objekty, které představují akce nebo témata, jako je například metoda - . Connect, metoda. Publikovat atd.

Name Typ Description
method

ResourceInfoDefinitionMethods

Typ akce, kterou můžou klienti na zprostředkovatele provést: Připojit, Publikovat nebo Přihlásit k odběru.

topics

string[]

Seznam témat nebo vzorů témat, které odpovídají tématům, která můžou klienti publikovat nebo odebírat. Toto dílčí pole je vyžadováno, pokud je metoda Publish nebo Přihlásit k odběru.

ResourceInfoDefinitionMethods

Povolené metody ResourceInfoDefinition

Name Typ Description
Connect

string

Povolené připojení ke zprostředkovateli

Publish

string

Povolené publikování do zprostředkovatele

Subscribe

string

Povolené přihlášení k odběru služby Broker

systemData

Metadata týkající se vytvoření a poslední změny prostředku

Name Typ Description
createdAt

string

Časové razítko vytvoření prostředku (UTC)

createdBy

string

Identita, která prostředek vytvořila.

createdByType

createdByType

Typ identity, která vytvořila prostředek.

lastModifiedAt

string

Časové razítko poslední změny prostředku (UTC)

lastModifiedBy

string

Identita, která naposledy změnila prostředek.

lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.