Web Pub Sub Hubs - Get

サービス:

Azure Web PubSub Service

API バージョン:

2024-03-01

ハブ設定を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName}?api-version=2024-03-01

URI パラメーター

名前	/	必須	型	説明
hubName	path	True	string	ハブ名。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前では大文字と小文字が区別されません。
resourceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$	リソースの名前。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	WebPubSubHub	成功。 応答は、対応するハブ設定を記述します。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

WebPubSubHubs_Get

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SignalRService/webPubSub/myWebPubSubService/hubs/exampleHub?api-version=2024-03-01

Java

/**
 * Samples for WebPubSubHubs Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSubHubs_Get.
     * json
     */
    /**
     * Sample code: WebPubSubHubs_Get.
     * 
     * @param manager Entry point to WebPubSubManager.
     */
    public static void webPubSubHubsGet(com.azure.resourcemanager.webpubsub.WebPubSubManager manager) {
        manager.webPubSubHubs().getWithResponse("exampleHub", "myResourceGroup", "myWebPubSubService",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.webpubsub import WebPubSubManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-webpubsub
# USAGE
    python web_pub_sub_hubs_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebPubSubManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.web_pub_sub_hubs.get(
        hub_name="exampleHub",
        resource_group_name="myResourceGroup",
        resource_name="myWebPubSubService",
    )
    print(response)


# x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSubHubs_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armwebpubsub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/webpubsub/armwebpubsub"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7189fb57f69468c56df76f9a4d68dd9ff04ab100/specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSubHubs_Get.json
func ExampleHubsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armwebpubsub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewHubsClient().Get(ctx, "exampleHub", "myResourceGroup", "myWebPubSubService", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Hub = armwebpubsub.Hub{
	// 	Name: to.Ptr("exampleHub"),
	// 	Type: to.Ptr("Microsoft.SignalRService/WebPubSub/hubs"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub"),
	// 	Properties: &armwebpubsub.HubProperties{
	// 		AnonymousConnectPolicy: to.Ptr("allow"),
	// 		EventHandlers: []*armwebpubsub.EventHandler{
	// 			{
	// 				Auth: &armwebpubsub.UpstreamAuthSettings{
	// 					Type: to.Ptr(armwebpubsub.UpstreamAuthTypeManagedIdentity),
	// 					ManagedIdentity: &armwebpubsub.ManagedIdentitySettings{
	// 						Resource: to.Ptr("abc"),
	// 					},
	// 				},
	// 				SystemEvents: []*string{
	// 					to.Ptr("connect"),
	// 					to.Ptr("connected")},
	// 					URLTemplate: to.Ptr("http://host.com"),
	// 					UserEventPattern: to.Ptr("*"),
	// 			}},
	// 			EventListeners: []*armwebpubsub.EventListener{
	// 				{
	// 					Endpoint: &armwebpubsub.EventHubEndpoint{
	// 						Type: to.Ptr(armwebpubsub.EventListenerEndpointDiscriminatorEventHub),
	// 						EventHubName: to.Ptr("eventHubName1"),
	// 						FullyQualifiedNamespace: to.Ptr("example.servicebus.windows.net"),
	// 					},
	// 					Filter: &armwebpubsub.EventNameFilter{
	// 						Type: to.Ptr(armwebpubsub.EventListenerFilterDiscriminatorEventName),
	// 						SystemEvents: []*string{
	// 							to.Ptr("connected"),
	// 							to.Ptr("disconnected")},
	// 							UserEventPattern: to.Ptr("*"),
	// 						},
	// 				}},
	// 				WebSocketKeepAliveIntervalInSeconds: to.Ptr[int32](50),
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { WebPubSubManagementClient } = require("@azure/arm-webpubsub");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get a hub setting.
 *
 * @summary Get a hub setting.
 * x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSubHubs_Get.json
 */
async function webPubSubHubsGet() {
  const subscriptionId =
    process.env["WEB-PUBSUB_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const hubName = "exampleHub";
  const resourceGroupName = process.env["WEB-PUBSUB_RESOURCE_GROUP"] || "myResourceGroup";
  const resourceName = "myWebPubSubService";
  const credential = new DefaultAzureCredential();
  const client = new WebPubSubManagementClient(credential, subscriptionId);
  const result = await client.webPubSubHubs.get(hubName, resourceGroupName, resourceName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

200

{
  "properties": {
    "eventHandlers": [
      {
        "urlTemplate": "http://host.com",
        "userEventPattern": "*",
        "systemEvents": [
          "connect",
          "connected"
        ],
        "auth": {
          "type": "ManagedIdentity",
          "managedIdentity": {
            "resource": "abc"
          }
        }
      }
    ],
    "eventListeners": [
      {
        "filter": {
          "type": "EventName",
          "systemEvents": [
            "connected",
            "disconnected"
          ],
          "userEventPattern": "*"
        },
        "endpoint": {
          "type": "EventHub",
          "fullyQualifiedNamespace": "example.servicebus.windows.net",
          "eventHubName": "eventHubName1"
        }
      }
    ],
    "anonymousConnectPolicy": "allow",
    "webSocketKeepAliveIntervalInSeconds": 50
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/hubs/exampleHub",
  "name": "exampleHub",
  "type": "Microsoft.SignalRService/WebPubSub/hubs"
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
EventHandler	イベント ハンドラーのプロパティ。
EventHubEndpoint	イベント ハブ エンドポイント。 Web PubSub サービスのマネージド ID を有効にする必要があり、ID には Event Hub にアクセスするための "Azure Event Hubs Data sender" ロールが必要です。
EventListener	設定では、どの種類のイベントをどのエンドポイントに送信するかを定義します。
EventNameFilter	イベントを名前でフィルター処理します。
ManagedIdentitySettings	アップストリームのマネージド ID 設定。
systemData	リソースの作成と最後の変更に関連するメタデータ。
UpstreamAuthSettings	アップストリーム認証設定。 設定しない場合、アップストリーム メッセージには認証は使用されません。
UpstreamAuthType	アップストリーム認証の種類列挙型。
WebPubSubHub	ハブの設定
WebPubSubHubProperties	ハブのプロパティ。

createdByType

列挙

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

値	説明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

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

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

EventHandler

Object

イベント ハンドラーのプロパティ。

名前	型	説明
auth	UpstreamAuthSettings	アップストリーム認証設定。 設定しない場合、アップストリーム メッセージには認証は使用されません。
systemEvents	string[]	システム イベントの一覧を取得または設定します。
urlTemplate	string	EventHandler URL テンプレートを取得または設定します。 テンプレート内で定義済みのパラメーター {hub} と {event} を使用できます。EventHandler URL の値は、クライアント要求が入ったときに動的に計算されます。 たとえば、UrlTemplate を http://example.com/api/{hub}/{event}できます。 ホスト パーツにパラメーターを含めることはできません。
userEventPattern	string	イベント名の一致パターンを取得または設定します。 サポートされているパターンは 3 種類あります。1."*" は、任意のイベント名 2 に一致します。複数のイベントを "," ("event1,event2" など) と組み合わせると、イベント "event1" と "event2" 3 と一致します。1 つのイベント名 (例: "event1")、"event1" と一致する

EventHubEndpoint

Object

イベント ハブ エンドポイント。 Web PubSub サービスのマネージド ID を有効にする必要があり、ID には Event Hub にアクセスするための "Azure Event Hubs Data sender" ロールが必要です。

名前	型	説明
eventHubName	string	イベント ハブの名前。
fullyQualifiedNamespace	string	イベント ハブ リソースの完全修飾名前空間名。 たとえば、"example.servicebus.windows.net" などです。
type	string: EventHub

EventListener

Object

設定では、どの種類のイベントをどのエンドポイントに送信するかを定義します。

名前	型	説明
endpoint	EventListenerEndpoint: EventHubEndpoint	Web PubSub がイベントを送信する場所を指定するエンドポイント。
filter	EventListenerFilter: EventNameFilter	イベント リスナーにイベントを送信するかどうかを決定するイベント フィルターの基本クラス。

EventNameFilter

Object

イベントを名前でフィルター処理します。

名前	型	説明
systemEvents	string[]	システム イベントの一覧を取得または設定します。 サポートされているイベント: "接続済み" と "切断済み" です。 ブロック イベント "connect" は応答を必要とするためサポートされていません。
type	string: EventName
userEventPattern	string	イベント名の一致パターンを取得または設定します。 サポートされているパターンは 3 種類あります。1."*" は、任意のイベント名 2 に一致します。複数のイベントを "," ("event1,event2" など) と組み合わせると、イベント "event1" と "event2" 3 が一致します。1 つのイベント名 (例: "event1")、"event1" と一致する

ManagedIdentitySettings

Object

アップストリームのマネージド ID 設定。

名前	型	説明
resource	string	ターゲット リソースのアプリ ID URI を示すリソース。 また、発行されたトークンの aud (対象ユーザー) 要求にも表示されます。

systemData

Object

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

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

UpstreamAuthSettings

Object

アップストリーム認証設定。 設定しない場合、アップストリーム メッセージには認証は使用されません。

名前	型	説明
managedIdentity	ManagedIdentitySettings	アップストリームのマネージド ID 設定。
type	UpstreamAuthType	アップストリーム認証の種類列挙型。

UpstreamAuthType

列挙

アップストリーム認証の種類列挙型。

値	説明
ManagedIdentity
None

WebPubSubHub

Object

ハブの設定

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties	WebPubSubHubProperties	ハブのプロパティ。
systemData	systemData	createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

WebPubSubHubProperties

Object

ハブのプロパティ。

名前	型	規定値	説明
anonymousConnectPolicy	string	deny	このハブに対して匿名接続を許可するかどうかを構成するための設定: "許可" または "拒否"。 既定値は "deny" です。
eventHandlers	EventHandler[]		ハブのイベント ハンドラー。
eventListeners	EventListener[]		クライアント イベントをリスナーに転送するためのイベント リスナー設定。 イベント リスナーは Web PubSub クライアントに対して透過的であり、クライアントに結果を返したり、クライアントの有効期間を中断したりすることはありません。 1 つのイベントは、それらのリスナー内のフィルターと一致する限り、複数のリスナーに送信できます。 配列要素の順序は関係ありません。 すべてのハブのイベント リスナーの最大数は 10 です。
webSocketKeepAliveIntervalInSeconds	integer (int32) minimum: 1 maximum: 120	20	ハブ内のすべてのクライアントに対して WebSocket ping-pong 間隔を構成するための設定 (秒単位)。 有効な範囲: 1 ~ 120。 既定値は 20 秒です。