Web Pub Sub - List By Subscription

サブスクリプション内のすべてのリソースを一覧表示する要求を処理します。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/webPubSub?api-version=2021-10-01

URI パラメーター

Name In Required Type Description
subscriptionId
path True
  • string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション ID を取得します。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

api-version
query True
  • string

クライアント API のバージョン。

応答

Name Type Description
200 OK

成功しました。 応答では、サブスクリプション内のリソースの一覧が記述されます。

Other Status Codes

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryする

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

WebPubSub_ListBySubscription

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/webPubSub?api-version=2021-10-01

Sample Response

{
  "value": [
    {
      "sku": {
        "name": "Standard_S1",
        "tier": "Standard",
        "size": "S1",
        "capacity": 1
      },
      "properties": {
        "provisioningState": "Succeeded",
        "externalIP": "10.0.0.1",
        "hostName": "mywebpubsubservice.webpubsub.azure.com",
        "publicPort": 443,
        "serverPort": 443,
        "version": "1.0",
        "privateEndpointConnections": [
          {
            "systemData": {
              "createdBy": "string",
              "createdByType": "User",
              "createdAt": "2015-02-03T04:05:06Z",
              "lastModifiedBy": "string",
              "lastModifiedByType": "User",
              "lastModifiedAt": "2015-02-03T04:05:06Z"
            },
            "properties": {
              "provisioningState": "Succeeded",
              "privateEndpoint": {
                "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
              },
              "privateLinkServiceConnectionState": {
                "status": "Approved",
                "actionsRequired": "None"
              }
            },
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
            "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
            "type": "Microsoft.SignalRService/WebPubSub/privateEndpointConnections"
          }
        ],
        "tls": {
          "clientCertEnabled": true
        },
        "liveTraceConfiguration": {
          "enabled": "false",
          "categories": [
            {
              "name": "ConnectivityLogs",
              "enabled": "true"
            }
          ]
        },
        "resourceLogConfiguration": {
          "categories": [
            {
              "name": "ConnectivityLogs",
              "enabled": "true"
            }
          ]
        },
        "networkACLs": {
          "defaultAction": "Deny",
          "publicNetwork": {
            "allow": [
              "ClientConnection"
            ]
          },
          "privateEndpoints": [
            {
              "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
              "allow": [
                "ServerConnection"
              ]
            }
          ]
        },
        "publicNetworkAccess": "Enabled",
        "disableLocalAuth": false,
        "disableAadAuth": false
      },
      "identity": {
        "type": "SystemAssigned",
        "principalId": "00000000-0000-0000-0000-000000000000",
        "tenantId": "00000000-0000-0000-0000-000000000000"
      },
      "systemData": {
        "createdBy": "string",
        "createdByType": "User",
        "createdAt": "2015-02-03T04:05:06Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2015-02-03T04:05:06Z"
      },
      "location": "eastus",
      "tags": {
        "key1": "value1"
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService",
      "name": "myWebPubSubService",
      "type": "Microsoft.SignalRService/WebPubSub"
    }
  ]
}

定義

ACLAction

Azure ネットワーク ACL アクション。

createdByType

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

ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

LiveTraceCategory

Microsoft.SignalRService リソースのライブ トレース カテゴリの構成。

LiveTraceConfiguration

Microsoft.SignalRService リソースのライブ トレース構成。

ManagedIdentity

クラスは、要求と応答に使用されるマネージド ID を表します

ManagedIdentityType

ID の種類を表します。systemAssigned、userAssigned、None

NetworkACL

Network ACL

PrivateEndpoint

プライベート エンドポイント

PrivateEndpointACL

プライベート エンドポイントの ACL

PrivateEndpointConnection

Azure リソースへのプライベート エンドポイント接続

PrivateLinkServiceConnectionState

プライベート エンドポイント接続の接続状態

PrivateLinkServiceConnectionStatus

接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。

ProvisioningState

リソースのプロビジョニング状態。

ResourceLogCategory

Microsoft.SignalRService リソースのリソース ログ カテゴリの構成。

ResourceLogConfiguration

Microsoft.SignalRService リソースのリソース ログ構成。

ResourceSku

リソースの課金情報。

SharedPrivateLinkResource

共有Private Link リソースについて説明します

SharedPrivateLinkResourceStatus

共有プライベート リンク リソースの状態

systemData

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

UserAssignedIdentityProperty

ユーザー割り当て ID のプロパティ。

WebPubSubNetworkACLs

リソースのネットワーク ACL

WebPubSubResource

クラスはリソースを表します。

WebPubSubResourceList

リソースの配列と、次のセットの可能なリンクを含むオブジェクト。

WebPubSubSkuTier

この特定の SKU のオプションレベル。 'Standard' または 'Free' です。

Basic は非推奨です。代わりに Standard を使用してください。

WebPubSubTlsSettings

リソースの TLS 設定

ACLAction

Azure ネットワーク ACL アクション。

Name Type Description
Allow
  • string
Deny
  • string

createdByType

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

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorAdditionalInfo

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

Name Type Description
info
  • object

追加情報。

type
  • string

追加情報の種類。

ErrorDetail

エラーの詳細。

Name Type Description
additionalInfo

エラーの追加情報。

code
  • string

エラー コード。

details

エラーの詳細です。

message
  • string

エラー メッセージ。

target
  • string

エラーターゲット。

ErrorResponse

エラー応答

Name Type Description
error

エラー オブジェクト。

LiveTraceCategory

Microsoft.SignalRService リソースのライブ トレース カテゴリの構成。

Name Type Description
enabled
  • string

ライブ トレース カテゴリが有効かどうかを示します。 使用可能な値: true、false。 大文字と小文字を区別しません。

name
  • string

ライブ トレース カテゴリの名前を取得または設定します。 使用可能な値: ConnectivityLogs、MessagingLogs。 大文字と小文字を区別しません。

LiveTraceConfiguration

Microsoft.SignalRService リソースのライブ トレース構成。

Name Type Default Value Description
categories

カテゴリ構成の一覧を取得または設定します。

enabled
  • string
false

ライブ トレースを有効にするかどうかを示します。 true に設定されている場合、ライブ トレース クライアントはサービスに接続できます。 それ以外の場合、ライブ トレース クライアントはサービスに接続できないため、"カテゴリ" で構成した内容に関係なく、ログを受信できなくなります。 使用可能な値: true、false。 大文字と小文字は区別されません。

ManagedIdentity

クラスは、要求と応答に使用されるマネージド ID を表します

Name Type Description
principalId
  • string

システム割り当て ID のプリンシパル ID を取得します。 応答でのみ使用できます。

tenantId
  • string

システム割り当て ID のテナント ID を取得します。 応答でのみ使用する

type

id の種類を表します:systemAssigned、userAssigned、None

userAssignedIdentities

ユーザー割り当て ID を取得または設定する

ManagedIdentityType

ID の種類を表します。systemAssigned、userAssigned、None

Name Type Description
None
  • string
SystemAssigned
  • string
UserAssigned
  • string

NetworkACL

Network ACL

Name Type Description
allow
  • string[]

許可される要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。

deny
  • string[]

拒否された要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。

PrivateEndpoint

プライベート エンドポイント

Name Type Description
id
  • string

プライベート エンドポイントの完全修飾 ID

PrivateEndpointACL

プライベート エンドポイントの ACL

Name Type Description
allow
  • string[]

許可される要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。

deny
  • string[]

拒否された要求の種類。 値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。

name
  • string

プライベート エンドポイント接続の名前

PrivateEndpointConnection

Azure リソースへのプライベート エンドポイント接続

Name Type Description
id
  • string

リソースの完全修飾リソース ID。

name
  • string

リソースの名前。

properties.groupIds
  • string[]

グループ ID

properties.privateEndpoint

プライベート エンドポイント

properties.privateLinkServiceConnectionState

プライベート エンドポイント接続の接続状態

properties.provisioningState

リソースのプロビジョニング状態。

systemData

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

type
  • string

リソースの種類 ("Microsoft.SignalRService/SignalR" など)

PrivateLinkServiceConnectionState

プライベート エンドポイント接続の接続状態

Name Type Description
actionsRequired
  • string

サービス プロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。

description
  • string

接続の承認/拒否の理由。

status

接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。

PrivateLinkServiceConnectionStatus

接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。

Name Type Description
Approved
  • string
Disconnected
  • string
Pending
  • string
Rejected
  • string

ProvisioningState

リソースのプロビジョニング状態。

Name Type Description
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Moving
  • string
Running
  • string
Succeeded
  • string
Unknown
  • string
Updating
  • string

ResourceLogCategory

Microsoft.SignalRService リソースのリソース ログ カテゴリの構成。

Name Type Description
enabled
  • string

リソース ログ カテゴリが有効かどうかを示します。 使用可能な値: true、false。 大文字と小文字を区別しません。

name
  • string

リソース ログ カテゴリの名前を取得または設定します。 使用可能な値: ConnectivityLogs、MessagingLogs。 大文字と小文字を区別しません。

ResourceLogConfiguration

Microsoft.SignalRService リソースのリソース ログ構成。

Name Type Description
categories

カテゴリ構成の一覧を取得または設定します。

ResourceSku

リソースの課金情報。

Name Type Description
capacity
  • integer

省略可能、整数。 リソースの単位数。 既定では 1。

存在する場合は、次の値を使用できます。Free: 1 Standard: 1,2,5,10,20,50,100

family
  • string

使用されていません。 将来の使用のために保持されます。

name
  • string

SKU の名前。 必須。

使用できる値: Standard_S1、Free_F1

size
  • string

使用されていません。 将来の使用のために保持されます。

tier

この特定の SKU のオプションレベル。 'Standard' または 'Free'。

Basic は非推奨です。代わりに Standard を使用してください。

SharedPrivateLinkResource

共有Private Link リソースについて説明します

Name Type Description
id
  • string

リソースの完全修飾リソース ID。

name
  • string

リソースの名前。

properties.groupId
  • string

共有プライベート リンク リソースの対象となるリソースのプロバイダーからのグループ ID

properties.privateLinkResourceId
  • string

共有プライベート リンク リソースが対象のリソースのリソース ID

properties.provisioningState

リソースのプロビジョニング状態。

properties.requestMessage
  • string

共有プライベート リンク リソースの承認を要求するための要求メッセージ

properties.status

共有プライベート リンク リソースの状態

systemData

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

type
  • string

リソースの種類 ("Microsoft.SignalRService/SignalR" など)

SharedPrivateLinkResourceStatus

共有プライベート リンク リソースの状態

Name Type Description
Approved
  • string
Disconnected
  • string
Pending
  • string
Rejected
  • string
Timeout
  • string

systemData

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

Name Type Description
createdAt
  • string

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

createdBy
  • string

リソースを作成した ID。

createdByType

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

lastModifiedAt
  • string

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

lastModifiedBy
  • string

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

lastModifiedByType

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

UserAssignedIdentityProperty

ユーザー割り当て ID のプロパティ。

Name Type Description
clientId
  • string

ユーザー割り当て ID のクライアント ID を取得する

principalId
  • string

ユーザー割り当て ID のプリンシパル ID を取得する

WebPubSubNetworkACLs

リソースのネットワーク ACL

Name Type Description
defaultAction

Azure ネットワーク ACL アクション。

privateEndpoints

プライベート エンドポイントからの要求の ACL

publicNetwork

Network ACL

WebPubSubResource

クラスはリソースを表します。

Name Type Default Value Description
id
  • string

リソースの完全修飾リソース ID。

identity

クラスは、要求と応答に使用されるマネージド ID を表します

location
  • string

リソースの GEO の場所。 例: 米国西部の|米国東部|米国中北部|米国中南部。

name
  • string

リソースの名前。

properties.disableAadAuth
  • boolean
False

DisableLocalAuth aad 認証を有効または無効にする true に設定すると、AuthType=aad との接続は機能しません。

properties.disableLocalAuth
  • boolean
False

DisableLocalAuth AccessKey でローカル認証を有効または無効にする True に設定すると、AccessKey=xxx との接続は機能しません。

properties.externalIP
  • string

リソースのパブリックにアクセス可能な IP。

properties.hostName
  • string

サービス インスタンスの FQDN。

properties.hostNamePrefix
  • string

非推奨になりました。

properties.liveTraceConfiguration

Microsoft.SignalRService リソースのライブ トレース構成。

properties.networkACLs

リソースのネットワーク ACL

properties.privateEndpointConnections

リソースへのプライベート エンドポイント接続。

properties.provisioningState

リソースのプロビジョニング状態。

properties.publicNetworkAccess
  • string
Enabled

パブリック ネットワーク アクセスを有効または無効にします。 既定値は "Enabled" です。 有効になっている場合でも、ネットワーク ACL が適用されます。 無効にすると、ネットワーク ACL で設定した内容に関係なく、パブリック ネットワーク アクセスは常に無効になります。

properties.publicPort
  • integer

ブラウザー/クライアント側の使用用に設計されたリソースのパブリックにアクセス可能なポート。

properties.resourceLogConfiguration

Microsoft.SignalRService リソースのリソース ログ構成。

properties.serverPort
  • integer

お客様のサーバー側の使用用に設計されたリソースのパブリックにアクセス可能なポート。

properties.sharedPrivateLinkResources

共有プライベート リンク リソースの一覧。

properties.tls

リソースの TLS 設定

properties.version
  • string

リソースのバージョン。 おそらく、同じバージョン以上のクライアント SDK が必要です。

sku

リソースの課金情報。

systemData

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

tags
  • object

リソースを記述するキー値ペアの一覧であるサービスのタグ。

type
  • string

リソースの種類 ("Microsoft.SignalRService/SignalR" など)

WebPubSubResourceList

リソースの配列と、次のセットの可能なリンクを含むオブジェクト。

Name Type Description
nextLink
  • string

クライアントが次のページをフェッチするために使用する URL (サーバー側のページングごと)。 現在は null であり、今後使用するために追加されます。

value

リソースの一覧

WebPubSubSkuTier

この特定の SKU のオプションレベル。 'Standard' または 'Free' です。

Basic は非推奨です。代わりに Standard を使用してください。

Name Type Description
Basic
  • string
Free
  • string
Premium
  • string
Standard
  • string

WebPubSubTlsSettings

リソースの TLS 設定

Name Type Default Value Description
clientCertEnabled
  • boolean
True

TLS ハンドシェイク中にクライアント証明書を要求する (有効な場合)