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 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
resourceName	path	True	string	資源名稱。 Regex 模式: `^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$`
subscriptionId	path	True	string uuid	目標訂用帳戶的標識碼。此值必須是 UUID。
api-version	query	True	string	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	WebPubSubResource	成功。回應描述對應的資源。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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"
  }
}

定義

名稱	Description
ACLAction	Azure 網路 ACL 動作。
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
IPRule	IP 規則
LiveTraceCategory	Microsoft.SignalRService 資源的即時追蹤類別設定。
LiveTraceConfiguration	Microsoft.SignalRService 資源的實時追蹤設定。
ManagedIdentity	類別代表用於要求和回應的受控識別
ManagedIdentityType	代表身分識別類型：systemAssigned、userAssigned、None
NetworkACL	網路 ACL
PrivateEndpoint	私人端點
PrivateEndpointACL	私人端點的 ACL
PrivateEndpointConnection	Azure 資源的私人端點連線
PrivateLinkServiceConnectionState	私人端點連線的連接狀態
PrivateLinkServiceConnectionStatus	指出連線是否已由服務的擁有者核准/拒絕/移除。
ProvisioningState	資源的布建狀態。
ResourceLogCategory	Microsoft.SignalRService 資源的資源記錄類別設定。
ResourceLogConfiguration	Microsoft.SignalRService 資源的資源記錄組態。
ResourceSku	資源的計費資訊。
ServiceKind	服務的種類
SharedPrivateLinkResource	描述共用 Private Link 資源
SharedPrivateLinkResourceStatus	共用私人鏈接資源的狀態
systemData	與建立和上次修改資源相關的元數據。
UserAssignedIdentityProperty	使用者指派身分識別的屬性。
WebPubSubNetworkACLs	資源的網路 ACL
WebPubSubRequestType	服務的連入要求類型
WebPubSubResource	類別代表資源。
WebPubSubSkuTier	這個特定 SKU 的選擇性層。 'Standard' 或 'Free'。 `Basic` 已被取代，請改用 `Standard` 。
WebPubSubSocketIOSettings	資源的SocketIO設定
WebPubSubTlsSettings	資源的 TLS 設定

ACLAction

Azure 網路 ACL 動作。

名稱	類型	Description
Allow	string
Deny	string

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

IPRule

IP 規則

名稱	類型	Description
action	ACLAction	Azure 網路 ACL 動作。
value	string	IP 或 CIDR 或服務Tag

LiveTraceCategory

Microsoft.SignalRService 資源的即時追蹤類別設定。

名稱	類型	Description
enabled	string	指出是否啟用即時追蹤類別。可用值：true、false。不區分大小寫。
name	string	取得或設定即時追蹤類別的名稱。可用的值：ConnectivityLogs、MessagingLogs。不區分大小寫。

LiveTraceConfiguration

Microsoft.SignalRService 資源的實時追蹤設定。

名稱	類型	預設值	Description
categories	LiveTraceCategory[]		取得或設定類別設定的清單。
enabled	string	false	指出是否啟用即時追蹤。當設定為 true 時，即時追蹤用戶端可以連線到服務。否則，即時追蹤客戶端無法連線到服務，因此不論您在「類別」中設定什麼，都無法接收任何記錄。可用值：true、false。不區分大小寫。

ManagedIdentity

類別代表用於要求和回應的受控識別

名稱	類型	Description
principalId	string	取得系統指派身分識別的主體標識碼。僅用於回應。
tenantId	string	取得系統指派身分識別的租用戶標識碼。僅用於回應
type	ManagedIdentityType	代表身分識別類型：systemAssigned、userAssigned、None
userAssignedIdentities	<string, UserAssignedIdentityProperty>	取得或設定使用者指派的身分識別

ManagedIdentityType

代表身分識別類型：systemAssigned、userAssigned、None

名稱	類型	Description
None	string
SystemAssigned	string
UserAssigned	string

NetworkACL

網路 ACL

名稱	類型	Description
allow	WebPubSubRequestType[]	允許的要求類型。此值可以是一或多個：ClientConnection、ServerConnection、RESTAPI。
deny	WebPubSubRequestType[]	拒絕的要求類型。此值可以是一或多個：ClientConnection、ServerConnection、RESTAPI。

PrivateEndpoint

私人端點

名稱	類型	Description
id	string	私人端點的完整標識碼

PrivateEndpointACL

私人端點的 ACL

名稱	類型	Description
allow	WebPubSubRequestType[]	允許的要求類型。此值可以是一或多個：ClientConnection、ServerConnection、RESTAPI。
deny	WebPubSubRequestType[]	拒絕的要求類型。此值可以是一或多個：ClientConnection、ServerConnection、RESTAPI。
name	string	私人端點連線的名稱

PrivateEndpointConnection

Azure 資源的私人端點連線

名稱	類型	Description
id	string	資源的完整資源識別碼。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	資源的名稱
properties.groupIds	string[]	群組標識碼
properties.privateEndpoint	PrivateEndpoint	私人端點
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	私人端點連線的連線狀態
properties.provisioningState	ProvisioningState	資源的布建狀態。
systemData	systemData	Azure Resource Manager 包含 createdBy 和 modifiedBy 資訊的中繼資料。
type	string	資源類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

PrivateLinkServiceConnectionState

私人端點連線的連接狀態

名稱	類型	Description
actionsRequired	string	訊息，指出服務提供者上的變更是否需要取用者的任何更新。
description	string	核准/拒絕連線的原因。
status	PrivateLinkServiceConnectionStatus	指出連線是否已由服務的擁有者核准/拒絕/移除。

PrivateLinkServiceConnectionStatus

指出連線是否已由服務的擁有者核准/拒絕/移除。

名稱	類型	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

資源的布建狀態。

名稱	類型	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Moving	string
Running	string
Succeeded	string
Unknown	string
Updating	string

ResourceLogCategory

Microsoft.SignalRService 資源的資源記錄類別設定。

名稱	類型	Description
enabled	string	指出是否啟用資源記錄類別目錄。可用值：true、false。不區分大小寫。
name	string	取得或設定資源記錄類別的名稱。可用的值：ConnectivityLogs、MessagingLogs。不區分大小寫。

ResourceLogConfiguration

Microsoft.SignalRService 資源的資源記錄組態。

名稱	類型	Description
categories	ResourceLogCategory[]	取得或設定類別設定的清單。

ResourceSku

資源的計費資訊。

名稱	類型	Description
capacity	integer	選擇性的整數。資源的單位計數。 1 用於Free_F1/Standard_S1/Premium_P1，預設為 Premium_P2 100。如果存在，則允許下列值：Free_F1：1;Standard_S1：1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;Premium_P1：1,2,3,4,5,6,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

服務的種類

名稱	類型	Description
SocketIO	string
WebPubSub	string

SharedPrivateLinkResource

描述共用 Private Link 資源

名稱	類型	Description
id	string	資源的完整資源識別碼。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	資源的名稱
properties.groupId	string	共用私人鏈接資源提供者的群組標識碼
properties.privateLinkResourceId	string	共用私人鏈接資源的資源資源識別碼
properties.provisioningState	ProvisioningState	資源的布建狀態。
properties.requestMessage	string	要求核准共用私人鏈接資源的要求訊息
properties.status	SharedPrivateLinkResourceStatus	共用私人鏈接資源的狀態
systemData	systemData	Azure Resource Manager 包含 createdBy 和 modifiedBy 資訊的中繼資料。
type	string	資源類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

SharedPrivateLinkResourceStatus

共用私人鏈接資源的狀態

名稱	類型	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string
Timeout	string

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳 (UTC) 。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳 (UTC)
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

UserAssignedIdentityProperty

使用者指派身分識別的屬性。

名稱	類型	Description
clientId	string	取得使用者指派身分識別的用戶端標識碼
principalId	string	取得使用者指派身分識別的主體標識碼

WebPubSubNetworkACLs

資源的網路 ACL

名稱	類型	Description
defaultAction	ACLAction	Azure 網路 ACL 動作。
ipRules	IPRule[]	篩選公用流量的IP規則
privateEndpoints	PrivateEndpointACL[]	來自私人端點的要求 ACL
publicNetwork	NetworkACL	網路 ACL

WebPubSubRequestType

服務的連入要求類型

名稱	類型	Description
ClientConnection	string
RESTAPI	string
ServerConnection	string
Trace	string

WebPubSubResource

類別代表資源。

名稱	類型	預設值	Description
id	string		資源的完整資源識別碼。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
identity	ManagedIdentity		類別代表用於要求和回應的受控識別
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		Azure Resource Manager 包含 createdBy 和 modifiedBy 資訊的中繼資料。
tags	object		資源標籤。
type	string		資源類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

WebPubSubSkuTier

這個特定 SKU 的選擇性層。 'Standard' 或 'Free'。

Basic 已被取代，請改用 Standard 。

名稱	類型	Description
Basic	string
Free	string
Premium	string
Standard	string

WebPubSubSocketIOSettings

資源的SocketIO設定

名稱	類型	Description
serviceMode	string	適用於 Socket.IO 的 Web PubSub 服務模式。允許的值：「Default」：擁有您自己的後端 Socket.IO 伺服器「Serverless」：您的應用程式沒有後端伺服器

WebPubSubTlsSettings

資源的 TLS 設定

名稱	類型	預設值	Description
clientCertEnabled	boolean	False	如果已啟用，請在 TLS 交握期間要求客戶端憑證。免費層不支援。免費層將會忽略任何輸入。

共用方式為

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

其他資源