次の方法で共有


Broker Authorization - List By Broker Resource

BrokerResource による BrokerAuthorizationResource リソースの一覧表示

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

ターゲット サブスクリプションの ID。

api-version
query True

string

この操作に使用する API バージョン。

応答

名前 説明
200 OK

BrokerAuthorizationResourceListResult

Azure 操作は正常に完了しました。

Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 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

AuthorizationConfig Polar ルールの BasicRules はサポートされていません

AuthorizationConfig

Broker AuthorizationConfig プロパティ

BrokerAuthorizationResource

MQ ブローカー/認可リソース

BrokerAuthorizationResourceListResult

BrokerAuthorizationResource リスト操作の応答。

createdByType

リソースを作成した ID の種類。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

ExtendedLocationProperty

ExtendedLocation プロパティ

ExtendedLocationType

ExtendedLocation の型を定義する列挙型が受け入れられます。

PrincipalDefinition

基本ルールの PrincipalDefinition プロパティ

ProvisioningState

リソースの状態を定義する列挙型。

ResourceInfoDefinition

基本ルールの ResourceInfoDefinition プロパティ。 これにより、 メソッドなどのアクションまたはトピックを表すオブジェクトが定義されます。接続、メソッド。発行など

ResourceInfoDefinitionMethods

ResourceInfoDefinition メソッドを使用できます

systemData

リソースの作成と最後の変更に関連するメタデータ。

AuthorizationBasicRule

AuthorizationConfig Polar ルールの BasicRules はサポートされていません

名前 説明
brokerResources

ResourceInfoDefinition[]

このサブフィールドは、基本ルールが適用されるブローカー リソースを定義します。

principals

PrincipalDefinition

このサブフィールドは、クライアントを表す ID を定義します。

AuthorizationConfig

Broker AuthorizationConfig プロパティ

名前 規定値 説明
enableCache

boolean

True

承認規則のキャッシュを有効にします。

rules

AuthorizationBasicRule[]

使用する承認規則。 ルールが設定されていないが、DenyAll を意味する承認リソースが使用される場合。

BrokerAuthorizationResource

MQ ブローカー/認可リソース

名前 説明
extendedLocation

ExtendedLocationProperty

拡張された場所

id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

リソースが保存されている地理的な場所

name

string

リソースの名前

properties.authorizationPolicies

AuthorizationConfig

承認リソースでサポートされている承認ポリシーの一覧。

properties.listenerRef

string[]

サポートされているリスナー リソースの配列。

properties.provisioningState

ProvisioningState

最後の操作の状態。

systemData

systemData

createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。

tags

object

リソース タグ。

type

string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

BrokerAuthorizationResourceListResult

BrokerAuthorizationResource リスト操作の応答。

名前 説明
nextLink

string

アイテムの次のページへのリンク

value

BrokerAuthorizationResource[]

このページの BrokerAuthorizationResource 項目

createdByType

リソースを作成した ID の種類。

名前 説明
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[]

クライアントと一致するクライアント ID の一覧。 クライアント ID は大文字と小文字が区別され、接続中にクライアントによって提供されるクライアント ID と一致する必要があります。

usernames

string[]

クライアントに一致するユーザー名の一覧。 ユーザー名は大文字と小文字が区別され、認証時にクライアントによって提供されるユーザー名と一致する必要があります。

ProvisioningState

リソースの状態を定義する列挙型。

名前 説明
Accepted

string

リソースが受け入れ済み。

Canceled

string

リソースの作成が取り消されました。

Deleting

string

リソースは削除中です。

Failed

string

リソースの作成に失敗しました。

Provisioning

string

リソースがプロビジョニングされています。

Succeeded

string

リソースが作成されました。

Updating

string

リソースが更新中です。

ResourceInfoDefinition

基本ルールの ResourceInfoDefinition プロパティ。 これにより、 メソッドなどのアクションまたはトピックを表すオブジェクトが定義されます。接続、メソッド。発行など

名前 説明
method

ResourceInfoDefinitionMethods

クライアントがブローカーで実行できるアクションの種類(Connect、Publish、Subscribe)。

topics

string[]

クライアントが発行またはサブスクライブできるトピックに一致するトピックまたはトピック パターンの一覧。 このサブフィールドは、メソッドが Publish または Subscribe の場合に必要です。

ResourceInfoDefinitionMethods

ResourceInfoDefinition メソッドを使用できます

名前 説明
Connect

string

ブローカーへの接続を許可

Publish

string

ブローカーへの発行が許可されている

Subscribe

string

ブローカーへのサブスクライブが許可されている

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前 説明
createdAt

string

リソース作成のタイムスタンプ (UTC)。

createdBy

string

リソースを作成した ID。

createdByType

createdByType

リソースを作成した ID の種類。

lastModifiedAt

string

リソースの最終変更のタイムスタンプ (UTC)

lastModifiedBy

string

リソースを最後に変更した ID。

lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。