Web Pub Sub - Get

リファレンス

サービス:: Azure Web PubSub Service

API バージョン:: 2024-03-01

リソースとそのプロパティを取得します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
resourceName	path	True	string	リソースの名前。正規表現パターン: `^[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	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	WebPubSubResource	正常終了しました。応答では、対応するリソースについて説明します。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

例

WebPubSub_Get

要求のサンプル

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


/**
 * Samples for WebPubSub GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSub_Get.json
     */
    /**
     * Sample code: WebPubSub_Get.
     * 
     * @param manager Entry point to WebPubSubManager.
     */
    public static void webPubSubGet(com.azure.resourcemanager.webpubsub.WebPubSubManager manager) {
        manager.webPubSubs().getByResourceGroupWithResponse("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

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_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.get(
        resource_group_name="myResourceGroup",
        resource_name="myWebPubSubService",
    )
    print(response)


# x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSub_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

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/WebPubSub_Get.json
func ExampleClient_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.NewClient().Get(ctx, "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.ResourceInfo = armwebpubsub.ResourceInfo{
	// 	Name: to.Ptr("myWebPubSubService"),
	// 	Type: to.Ptr("Microsoft.SignalRService/WebPubSub"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService"),
	// 	SystemData: &armwebpubsub.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-02-03T04:05:06.000Z"); return t}()),
	// 		CreatedBy: to.Ptr("string"),
	// 		CreatedByType: to.Ptr(armwebpubsub.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-02-03T04:05:06.000Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("string"),
	// 		LastModifiedByType: to.Ptr(armwebpubsub.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("eastus"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 	},
	// 	Identity: &armwebpubsub.ManagedIdentity{
	// 		Type: to.Ptr(armwebpubsub.ManagedIdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 	},
	// 	Kind: to.Ptr(armwebpubsub.ServiceKindWebPubSub),
	// 	Properties: &armwebpubsub.Properties{
	// 		DisableAADAuth: to.Ptr(false),
	// 		DisableLocalAuth: to.Ptr(false),
	// 		ExternalIP: to.Ptr("10.0.0.1"),
	// 		HostName: to.Ptr("mywebpubsubservice.webpubsub.azure.com"),
	// 		LiveTraceConfiguration: &armwebpubsub.LiveTraceConfiguration{
	// 			Categories: []*armwebpubsub.LiveTraceCategory{
	// 				{
	// 					Name: to.Ptr("ConnectivityLogs"),
	// 					Enabled: to.Ptr("true"),
	// 			}},
	// 			Enabled: to.Ptr("false"),
	// 		},
	// 		NetworkACLs: &armwebpubsub.NetworkACLs{
	// 			DefaultAction: to.Ptr(armwebpubsub.ACLActionDeny),
	// 			IPRules: []*armwebpubsub.IPRule{
	// 				{
	// 					Action: to.Ptr(armwebpubsub.ACLActionAllow),
	// 					Value: to.Ptr("123.456.789.123/24"),
	// 				},
	// 				{
	// 					Action: to.Ptr(armwebpubsub.ACLActionAllow),
	// 					Value: to.Ptr("123.456.789.123"),
	// 				},
	// 				{
	// 					Action: to.Ptr(armwebpubsub.ACLActionAllow),
	// 					Value: to.Ptr("AppService"),
	// 			}},
	// 			PrivateEndpoints: []*armwebpubsub.PrivateEndpointACL{
	// 				{
	// 					Allow: []*armwebpubsub.WebPubSubRequestType{
	// 						to.Ptr(armwebpubsub.WebPubSubRequestTypeServerConnection)},
	// 						Name: to.Ptr("mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e"),
	// 				}},
	// 				PublicNetwork: &armwebpubsub.NetworkACL{
	// 					Allow: []*armwebpubsub.WebPubSubRequestType{
	// 						to.Ptr(armwebpubsub.WebPubSubRequestTypeClientConnection)},
	// 					},
	// 				},
	// 				PrivateEndpointConnections: []*armwebpubsub.PrivateEndpointConnection{
	// 					{
	// 						Name: to.Ptr("mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e"),
	// 						Type: to.Ptr("Microsoft.SignalRService/WebPubSub/privateEndpointConnections"),
	// 						ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e"),
	// 						SystemData: &armwebpubsub.SystemData{
	// 							CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-02-03T04:05:06.000Z"); return t}()),
	// 							CreatedBy: to.Ptr("string"),
	// 							CreatedByType: to.Ptr(armwebpubsub.CreatedByTypeUser),
	// 							LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-02-03T04:05:06.000Z"); return t}()),
	// 							LastModifiedBy: to.Ptr("string"),
	// 							LastModifiedByType: to.Ptr(armwebpubsub.CreatedByTypeUser),
	// 						},
	// 						Properties: &armwebpubsub.PrivateEndpointConnectionProperties{
	// 							PrivateEndpoint: &armwebpubsub.PrivateEndpoint{
	// 								ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"),
	// 							},
	// 							PrivateLinkServiceConnectionState: &armwebpubsub.PrivateLinkServiceConnectionState{
	// 								ActionsRequired: to.Ptr("None"),
	// 								Status: to.Ptr(armwebpubsub.PrivateLinkServiceConnectionStatusApproved),
	// 							},
	// 							ProvisioningState: to.Ptr(armwebpubsub.ProvisioningStateSucceeded),
	// 						},
	// 				}},
	// 				ProvisioningState: to.Ptr(armwebpubsub.ProvisioningStateSucceeded),
	// 				PublicNetworkAccess: to.Ptr("Enabled"),
	// 				PublicPort: to.Ptr[int32](443),
	// 				RegionEndpointEnabled: to.Ptr("Enabled"),
	// 				ResourceLogConfiguration: &armwebpubsub.ResourceLogConfiguration{
	// 					Categories: []*armwebpubsub.ResourceLogCategory{
	// 						{
	// 							Name: to.Ptr("ConnectivityLogs"),
	// 							Enabled: to.Ptr("true"),
	// 					}},
	// 				},
	// 				ResourceStopped: to.Ptr("false"),
	// 				ServerPort: to.Ptr[int32](443),
	// 				SocketIO: &armwebpubsub.SocketIOSettings{
	// 					ServiceMode: to.Ptr("Serverless"),
	// 				},
	// 				TLS: &armwebpubsub.TLSSettings{
	// 					ClientCertEnabled: to.Ptr(true),
	// 				},
	// 				Version: to.Ptr("1.0"),
	// 			},
	// 			SKU: &armwebpubsub.ResourceSKU{
	// 				Name: to.Ptr("Premium_P1"),
	// 				Capacity: to.Ptr[int32](1),
	// 				Size: to.Ptr("P1"),
	// 				Tier: to.Ptr(armwebpubsub.WebPubSubSKUTierPremium),
	// 			},
	// 		}
}

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

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

/**
 * This sample demonstrates how to Get the resource and its properties.
 *
 * @summary Get the resource and its properties.
 * x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSub_Get.json
 */
async function webPubSubGet() {
  const subscriptionId =
    process.env["WEB-PUBSUB_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  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.webPubSub.get(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

{
  "sku": {
    "name": "Premium_P1",
    "tier": "Premium",
    "size": "P1",
    "capacity": 1
  },
  "properties": {
    "provisioningState": "Succeeded",
    "externalIP": "10.0.0.1",
    "hostName": "mywebpubsubservice.webpubsub.azure.com",
    "publicPort": 443,
    "serverPort": 443,
    "version": "1.0",
    "privateEndpointConnections": [
      {
        "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",
        "systemData": {
          "createdBy": "string",
          "createdByType": "User",
          "createdAt": "2015-02-03T04:05:06Z",
          "lastModifiedBy": "string",
          "lastModifiedByType": "User",
          "lastModifiedAt": "2015-02-03T04:05:06Z"
        }
      }
    ],
    "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"
          ]
        }
      ],
      "ipRules": [
        {
          "value": "123.456.789.123/24",
          "action": "Allow"
        },
        {
          "value": "123.456.789.123",
          "action": "Allow"
        },
        {
          "value": "AppService",
          "action": "Allow"
        }
      ]
    },
    "publicNetworkAccess": "Enabled",
    "disableLocalAuth": false,
    "disableAadAuth": false,
    "regionEndpointEnabled": "Enabled",
    "resourceStopped": "false",
    "socketIO": {
      "serviceMode": "Serverless"
    }
  },
  "kind": "WebPubSub",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "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",
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2015-02-03T04:05:06Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2015-02-03T04:05:06Z"
  }
}

定義

名前	説明
ACLAction	Azure ネットワーク ACL アクション。
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
IPRule	IP ルール
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	リソースの課金情報。
ServiceKind	サービスの種類
SharedPrivateLinkResource	共有Private Link リソースについて説明します
SharedPrivateLinkResourceStatus	共有プライベートリンクリソースの状態
systemData	リソースの作成と最後の変更に関連するメタデータ。
UserAssignedIdentityProperty	ユーザー割り当て ID のプロパティ。
WebPubSubNetworkACLs	リソースのネットワーク ACL
WebPubSubRequestType	サービスへの受信要求の種類
WebPubSubResource	クラスはリソースを表します。
WebPubSubSkuTier	この特定の SKU のオプションレベル。 'Standard' または 'Free' です。 `Basic` は非推奨です。代わりに `Standard` を使用してください。
WebPubSubSocketIOSettings	リソースの SocketIO 設定
WebPubSubTlsSettings	リソースの TLS 設定

ACLAction

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

名前	型	説明
Allow	string
Deny	string

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 オブジェクト。

IPRule

IP ルール

名前	型	説明
action	ACLAction	Azure ネットワーク ACL アクション。
value	string	IP または CIDR または ServiceTag

LiveTraceCategory

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

名前	型	説明
enabled	string	ライブトレースカテゴリが有効かどうかを示します。使用可能な値: true、false。大文字と小文字は区別されません。
name	string	ライブトレースカテゴリの名前を取得または設定します。使用可能な値: ConnectivityLogs、MessagingLogs。大文字と小文字は区別されません。

LiveTraceConfiguration

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

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

ManagedIdentity

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

名前	型	説明
principalId	string	システム割り当て ID のプリンシパル ID を取得します。応答でのみ使用されます。
tenantId	string	システム割り当て ID のテナント ID を取得します。応答でのみ使用されます
type	ManagedIdentityType	id の種類を表します: systemAssigned、userAssigned、None
userAssignedIdentities	<string, UserAssignedIdentityProperty>	ユーザー割り当て ID を取得または設定する

ManagedIdentityType

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

名前	型	説明
None	string
SystemAssigned	string
UserAssigned	string

NetworkACL

Network ACL

名前	型	説明
allow	WebPubSubRequestType[]	許可される要求の種類。値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。
deny	WebPubSubRequestType[]	拒否された要求の種類。値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。

PrivateEndpoint

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

名前	型	説明
id	string	プライベートエンドポイントの完全修飾 ID

PrivateEndpointACL

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

名前	型	説明
allow	WebPubSubRequestType[]	許可される要求の種類。値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。
deny	WebPubSubRequestType[]	拒否された要求の種類。値には、ClientConnection、ServerConnection、RESTAPI の 1 つ以上を指定できます。
name	string	プライベートエンドポイント接続の名前

PrivateEndpointConnection

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

名前	型	説明
id	string	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.groupIds	string[]	グループ ID
properties.privateEndpoint	PrivateEndpoint	プライベートエンドポイント
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	プライベートエンドポイント接続の接続状態
properties.provisioningState	ProvisioningState	リソースのプロビジョニング状態。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PrivateLinkServiceConnectionState

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

名前	型	説明
actionsRequired	string	サービスプロバイダーの変更でコンシューマーに対する更新が必要かどうかを示すメッセージ。
description	string	接続の承認/拒否の理由。
status	PrivateLinkServiceConnectionStatus	接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。

PrivateLinkServiceConnectionStatus

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

名前	型	説明
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

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

名前	型	説明
Canceled	string
Creating	string
Deleting	string
Failed	string
Moving	string
Running	string
Succeeded	string
Unknown	string
Updating	string

ResourceLogCategory

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

名前	型	説明
enabled	string	リソースログカテゴリが有効かどうかを示します。使用可能な値: true、false。大文字と小文字は区別されません。
name	string	リソースログカテゴリの名前を取得または設定します。使用可能な値: ConnectivityLogs、MessagingLogs。大文字と小文字は区別されません。

ResourceLogConfiguration

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

名前	型	説明
categories	ResourceLogCategory[]	カテゴリ構成の一覧を取得または設定します。

ResourceSku

リソースの課金情報。

名前	型	説明
capacity	integer	省略可能、整数。リソースの単位数。 Free_F1/Standard_S1/Premium_P1の場合は 1、既定では Premium_P2 の場合は 100。存在する場合は、次の値を使用できます: Free_F1: 1;Standard_S1: 1,2,3,4,5,6,7,7,8,9,10,20,30,40,50,60,70,80,90,100;Premium_P1: 1,2,3,4,5,6,7,7,8,9,10,20,30,40,50,60,70,80,90,100;Premium_P2: 100,200,300,400,500,600,700,800,900,1000;
family	string	使用されていません。今後の使用のために保持されます。
name	string	SKU の名前。必須。使用できる値: Standard_S1、Free_F1、Premium_P1、Premium_P2
size	string	使用されていません。今後の使用のために保持されます。
tier	WebPubSubSkuTier	この特定の SKU のオプションレベル。 'Standard' または 'Free' です。 `Basic` は非推奨です。代わりに `Standard` を使用してください。

ServiceKind

サービスの種類

名前	型	説明
SocketIO	string
WebPubSub	string

SharedPrivateLinkResource

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

名前	型	説明
id	string	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.groupId	string	共有プライベートリンクリソースの対象となるリソースのプロバイダーからのグループ ID
properties.privateLinkResourceId	string	共有プライベートリンクリソースのリソース ID
properties.provisioningState	ProvisioningState	リソースのプロビジョニング状態。
properties.requestMessage	string	共有プライベートリンクリソースの承認を要求するための要求メッセージ
properties.status	SharedPrivateLinkResourceStatus	共有プライベートリンクリソースの状態
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceStatus

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

名前	型	説明
Approved	string
Disconnected	string
Pending	string
Rejected	string
Timeout	string

systemData

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

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

UserAssignedIdentityProperty

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

名前	型	説明
clientId	string	ユーザー割り当て ID のクライアント ID を取得する
principalId	string	ユーザー割り当て ID のプリンシパル ID を取得する

WebPubSubNetworkACLs

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

名前	型	説明
defaultAction	ACLAction	Azure ネットワーク ACL アクション。
ipRules	IPRule[]	パブリックトラフィックをフィルター処理するための IP 規則
privateEndpoints	PrivateEndpointACL[]	プライベートエンドポイントからの要求の ACL
publicNetwork	NetworkACL	Network ACL

WebPubSubRequestType

サービスへの受信要求の種類

名前	型	説明
ClientConnection	string
RESTAPI	string
ServerConnection	string
Trace	string

WebPubSubResource

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

名前	型	規定値	説明
id	string		リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedIdentity		クラスは、要求と応答に使用されるマネージド ID を表します
kind	ServiceKind		サービスの種類
location	string		リソースが保存されている地理的な場所
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	LiveTraceConfiguration		Microsoft.SignalRService リソースのライブトレース構成。
properties.networkACLs	WebPubSubNetworkACLs		リソースのネットワーク ACL
properties.privateEndpointConnections	PrivateEndpointConnection[]		リソースへのプライベートエンドポイント接続。
properties.provisioningState	ProvisioningState		リソースのプロビジョニング状態。
properties.publicNetworkAccess	string	Enabled	パブリックネットワークアクセスを有効または無効にします。既定値は "Enabled" です。有効になっている場合でも、ネットワーク ACL が適用されます。 [無効] にすると、ネットワーク ACL で設定した内容に関係なく、パブリックネットワークアクセスは常に無効になります。
properties.publicPort	integer		ブラウザー/クライアント側の使用用に設計されたリソースのパブリックにアクセス可能なポート。
properties.regionEndpointEnabled	string	Enabled	リージョンエンドポイントを有効または無効にします。既定値は "Enabled" です。 [無効] の場合、新しい接続はこのエンドポイントにルーティングされませんが、既存の接続は影響を受けません。このプロパティはレプリカ固有です。レプリカのないリージョンエンドポイントを無効にすることはできません。
properties.resourceLogConfiguration	ResourceLogConfiguration		Microsoft.SignalRService リソースのリソースログ構成。
properties.resourceStopped	string	false	リソースを停止または開始します。既定値は "False" です。 true の場合、リソースのデータプレーンはシャットダウンされます。 false の場合、リソースのデータプレーンが開始されます。
properties.serverPort	integer		お客様のサーバー側の使用用に設計されたリソースのパブリックにアクセス可能なポート。
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		共有プライベートリンクリソースの一覧。
properties.socketIO	WebPubSubSocketIOSettings		リソースの SocketIO 設定
properties.tls	WebPubSubTlsSettings		リソースの TLS 設定
properties.version	string		リソースのバージョン。同じバージョン以上のクライアント SDK が必要な場合があります。
sku	ResourceSku		リソースの課金情報。
systemData	systemData		createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object		リソースタグ。
type	string		リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

WebPubSubSkuTier

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

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

名前	型	説明
Basic	string
Free	string
Premium	string
Standard	string

WebPubSubSocketIOSettings

リソースの SocketIO 設定

名前	型	説明
serviceMode	string	Socket.IO の Web PubSub のサービスモード。許可される値: "Default": 独自のバックエンド Socket.IO サーバー "サーバーレス" を使用します。アプリケーションにバックエンドサーバーがありません

WebPubSubTlsSettings

リソースの TLS 設定

名前	型	規定値	説明
clientCertEnabled	boolean	False	有効になっている場合は、TLS ハンドシェイク中にクライアント証明書を要求します。 Free レベルではサポートされていません。 Free レベルでは、入力はすべて無視されます。

次の方法で共有

Web Pub Sub - Get

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

WebPubSub_Get

要求のサンプル

応答のサンプル

定義

ACLAction

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IPRule

LiveTraceCategory

LiveTraceConfiguration

ManagedIdentity

ManagedIdentityType

NetworkACL

PrivateEndpoint

PrivateEndpointACL

PrivateEndpointConnection

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningState

ResourceLogCategory

ResourceLogConfiguration

ResourceSku

ServiceKind

SharedPrivateLinkResource

SharedPrivateLinkResourceStatus

systemData

UserAssignedIdentityProperty

WebPubSubNetworkACLs

WebPubSubRequestType

WebPubSubResource

WebPubSubSkuTier

WebPubSubSocketIOSettings

WebPubSubTlsSettings

その他のリソース