Dela via


Broker Authorization - List By Broker Resource

Lista BrokerAuthorizationResource-resurser från 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-parametrar

Name I Obligatorisk Typ Description
brokerName
path True

string

Namn på MQ-asynkron meddelandeköresurs

Reguljärt uttrycksmönster: ^[a-zA-Z0-9-]{3,24}$

mqName
path True

string

Namn på MQ-resurs

Reguljärt uttrycksmönster: ^[a-zA-Z0-9-]{3,24}$

resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

subscriptionId
path True

string

ID för målprenumerationen.

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

BrokerAuthorizationResourceListResult

Azure-åtgärden har slutförts.

Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

BrokerAuthorization_ListByBrokerResource

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
AuthorizationBasicRule

BasicRules för AuthorizationConfig Polar-regler stöds inte

AuthorizationConfig

Egenskaper för Broker AuthorizationConfig

BrokerAuthorizationResource

MQ-asynkron meddelandekö/auktoriseringsresurs

BrokerAuthorizationResourceListResult

Svaret från en BrokerAuthorizationResource-liståtgärd.

createdByType

Den typ av identitet som skapade resursen.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

ExtendedLocationProperty

ExtendedLocation-egenskaper

ExtendedLocationType

Uppräkningen som definierar typen av ExtendedLocation accepterades.

PrincipalDefinition

PrincipalDefinition-egenskaper för grundläggande regel

ProvisioningState

Uppräkningen som definierar status för resursen.

ResourceInfoDefinition

ResourceInfoDefinition-egenskaper för grundläggande regel. Detta definierar de objekt som representerar åtgärderna eller ämnena, till exempel - --metoden. Anslut, metod. Publicera osv.

ResourceInfoDefinitionMethods

ResourceInfoDefinition-metoder tillåts

systemData

Metadata som rör skapande och senaste ändring av resursen.

AuthorizationBasicRule

BasicRules för AuthorizationConfig Polar-regler stöds inte

Name Typ Description
brokerResources

ResourceInfoDefinition[]

Det här underfältet definierar de asynkrona resurser som grundregeln tillämpas på.

principals

PrincipalDefinition

Det här underfältet definierar de identiteter som representerar klienterna.

AuthorizationConfig

Egenskaper för Broker AuthorizationConfig

Name Typ Standardvärde Description
enableCache

boolean

True

Aktivera cachelagring av auktoriseringsreglerna.

rules

AuthorizationBasicRule[]

Auktoriseringsregler som ska användas. Om ingen regel har angetts, men auktoriseringsresursen används betyder det DenyAll.

BrokerAuthorizationResource

MQ-asynkron meddelandekö/auktoriseringsresurs

Name Typ Description
extendedLocation

ExtendedLocationProperty

Utökad plats

id

string

Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Den geo-plats där resursen finns

name

string

Namnet på resursen

properties.authorizationPolicies

AuthorizationConfig

Listan över auktoriseringsprinciper som stöds av auktoriseringsresursen.

properties.listenerRef

string[]

Matrisen med lyssnarresurser som stöds.

properties.provisioningState

ProvisioningState

Status för den senaste åtgärden.

systemData

systemData

Azure Resource Manager metadata som innehåller createdBy och modifiedBy-information.

tags

object

Resurstaggar.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

BrokerAuthorizationResourceListResult

Svaret från en BrokerAuthorizationResource-liståtgärd.

Name Typ Description
nextLink

string

Länken till nästa sida med objekt

value

BrokerAuthorizationResource[]

BrokerAuthorizationResource-objekten på den här sidan

createdByType

Den typ av identitet som skapade resursen.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Den ytterligare informationen.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

ExtendedLocationProperty

ExtendedLocation-egenskaper

Name Typ Description
name

string

Namnet på den utökade platsen.

type

ExtendedLocationType

Typ av ExtendedLocation.

ExtendedLocationType

Uppräkningen som definierar typen av ExtendedLocation accepterades.

Name Typ Description
CustomLocation

string

CustomLocation-typ

PrincipalDefinition

PrincipalDefinition-egenskaper för grundläggande regel

Name Typ Description
attributes

object[]

En lista över nyckel/värde-par som matchar klienternas attribut. Attributen är skiftlägeskänsliga och måste matcha de attribut som tillhandahålls av klienterna under autentiseringen.

clientids

string[]

En lista över klient-ID:t som matchar klienterna. Klient-ID:na är skiftlägeskänsliga och måste matcha klient-ID:na som tillhandahålls av klienterna under anslutningen.

usernames

string[]

En lista med användarnamn som matchar klienterna. Användarnamnen är skiftlägeskänsliga och måste matcha de användarnamn som tillhandahålls av klienterna under autentiseringen.

ProvisioningState

Uppräkningen som definierar status för resursen.

Name Typ Description
Accepted

string

Resursen har accepterats.

Canceled

string

Resursskapandet avbröts.

Deleting

string

Resursen tas bort.

Failed

string

Det gick inte att skapa resursen.

Provisioning

string

Resursen etableras.

Succeeded

string

Resursen har skapats.

Updating

string

Resursen uppdateras.

ResourceInfoDefinition

ResourceInfoDefinition-egenskaper för grundläggande regel. Detta definierar de objekt som representerar åtgärderna eller ämnena, till exempel - --metoden. Anslut, metod. Publicera osv.

Name Typ Description
method

ResourceInfoDefinitionMethods

Den typ av åtgärd som klienterna kan utföra på den asynkrona meddelandekön: Anslut, Publicera eller Prenumerera.

topics

string[]

En lista över ämnen eller ämnesmönster som matchar de ämnen som klienterna kan publicera eller prenumerera på. Det här underfältet krävs om metoden är Publicera eller Prenumerera.

ResourceInfoDefinitionMethods

ResourceInfoDefinition-metoder tillåts

Name Typ Description
Connect

string

Tillåten anslutning till asynkron meddelandekö

Publish

string

Tillåten publicering till asynkron meddelandekö

Subscribe

string

Tillåten prenumeration på asynkron meddelandekö

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.