你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Web Pub Sub - Update

服务:

Azure Web PubSub Service

API 版本:

2024-03-01

更新退出资源的作。

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

URI 参数

名称	在	必需	类型	说明
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 版本。

请求正文

名称	必需	类型	说明
location	True	string	资源所在的地理位置
identity		ManagedIdentity	一个类表示用于请求和响应的托管标识
kind		ServiceKind	服务类型
properties.disableAadAuth		boolean	DisableLocalAuth 启用或禁用 aad 身份验证 设置为 true 时，与 AuthType=aad 的连接将不起作用。
properties.disableLocalAuth		boolean	DisableLocalAuth Enable or disable localauth with AccessKey When set as true， connection with AccessKey=xxx is t work.
properties.liveTraceConfiguration		LiveTraceConfiguration	Microsoft.SignalRService 资源的实时跟踪配置。
properties.networkACLs		WebPubSubNetworkACLs	资源的网络 ACL
properties.publicNetworkAccess		string	启用或禁用公用网络访问。 默认值为“Enabled”。 启用后，网络 ACL 仍适用。 禁用后，无论在网络 ACL 中设置什么，都会禁用公用网络访问。
properties.regionEndpointEnabled		string	启用或禁用区域终结点。 默认值为“Enabled”。 禁用时，不会将新连接路由到此终结点，但现有连接不会受到影响。 此属性特定于副本。 不允许禁用没有副本的区域终结点。
properties.resourceLogConfiguration		ResourceLogConfiguration	Microsoft.SignalRService 资源的资源日志配置。
properties.resourceStopped		string	停止或启动资源。 默认值为“False”。 如果为 true，资源的数据平面将关闭。 如果为 false，则会启动资源的数据平面。
properties.socketIO		WebPubSubSocketIOSettings	资源的 SocketIO 设置
properties.tls		WebPubSubTlsSettings	资源的 TLS 设置
sku		ResourceSku	资源的计费信息。
tags		object	资源标记。

响应

名称	类型	说明
200 OK	WebPubSubResource	成功。 响应描述资源。
202 Accepted		已接受。 响应指示退出的资源正在更新，并包含一个 Location 标头来查询操作结果。 标头 Location: string
Other Status Codes	ErrorResponse	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

WebPubSub_Update

示例请求

HTTP

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

{
  "sku": {
    "name": "Premium_P1",
    "tier": "Premium",
    "capacity": 1
  },
  "properties": {
    "tls": {
      "clientCertEnabled": false
    },
    "liveTraceConfiguration": {
      "enabled": "false",
      "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,
    "socketIO": {
      "serviceMode": "Serverless"
    }
  },
  "kind": "WebPubSub",
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "eastus",
  "tags": {
    "key1": "value1"
  }
}

Java

import com.azure.resourcemanager.webpubsub.models.AclAction;
import com.azure.resourcemanager.webpubsub.models.LiveTraceCategory;
import com.azure.resourcemanager.webpubsub.models.LiveTraceConfiguration;
import com.azure.resourcemanager.webpubsub.models.ManagedIdentity;
import com.azure.resourcemanager.webpubsub.models.ManagedIdentityType;
import com.azure.resourcemanager.webpubsub.models.NetworkAcl;
import com.azure.resourcemanager.webpubsub.models.PrivateEndpointAcl;
import com.azure.resourcemanager.webpubsub.models.ResourceSku;
import com.azure.resourcemanager.webpubsub.models.WebPubSubNetworkACLs;
import com.azure.resourcemanager.webpubsub.models.WebPubSubRequestType;
import com.azure.resourcemanager.webpubsub.models.WebPubSubResource;
import com.azure.resourcemanager.webpubsub.models.WebPubSubSkuTier;
import com.azure.resourcemanager.webpubsub.models.WebPubSubSocketIOSettings;
import com.azure.resourcemanager.webpubsub.models.WebPubSubTlsSettings;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for WebPubSub Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSub_Update.
     * json
     */
    /**
     * Sample code: WebPubSub_Update.
     * 
     * @param manager Entry point to WebPubSubManager.
     */
    public static void webPubSubUpdate(com.azure.resourcemanager.webpubsub.WebPubSubManager manager) {
        WebPubSubResource resource = manager.webPubSubs()
            .getByResourceGroupWithResponse("myResourceGroup", "myWebPubSubService", com.azure.core.util.Context.NONE)
            .getValue();
        resource.update().withTags(mapOf("key1", "fakeTokenPlaceholder"))
            .withSku(new ResourceSku().withName("Premium_P1").withTier(WebPubSubSkuTier.PREMIUM).withCapacity(1))
            .withIdentity(new ManagedIdentity().withType(ManagedIdentityType.SYSTEM_ASSIGNED))
            .withTls(new WebPubSubTlsSettings().withClientCertEnabled(false))
            .withLiveTraceConfiguration(new LiveTraceConfiguration().withEnabled("false").withCategories(
                Arrays.asList(new LiveTraceCategory().withName("ConnectivityLogs").withEnabled("true"))))
            .withNetworkACLs(new WebPubSubNetworkACLs().withDefaultAction(AclAction.DENY)
                .withPublicNetwork(new NetworkAcl().withAllow(Arrays.asList(WebPubSubRequestType.CLIENT_CONNECTION)))
                .withPrivateEndpoints(Arrays
                    .asList(new PrivateEndpointAcl().withAllow(Arrays.asList(WebPubSubRequestType.SERVER_CONNECTION))
                        .withName("mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e"))))
            .withPublicNetworkAccess("Enabled").withDisableLocalAuth(false).withDisableAadAuth(false)
            .withSocketIO(new WebPubSubSocketIOSettings().withServiceMode("Serverless")).apply();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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_update.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.begin_update(
        resource_group_name="myResourceGroup",
        resource_name="myWebPubSubService",
        parameters={
            "identity": {"type": "SystemAssigned"},
            "kind": "WebPubSub",
            "location": "eastus",
            "properties": {
                "disableAadAuth": False,
                "disableLocalAuth": False,
                "liveTraceConfiguration": {
                    "categories": [{"enabled": "true", "name": "ConnectivityLogs"}],
                    "enabled": "false",
                },
                "networkACLs": {
                    "defaultAction": "Deny",
                    "privateEndpoints": [
                        {
                            "allow": ["ServerConnection"],
                            "name": "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
                        }
                    ],
                    "publicNetwork": {"allow": ["ClientConnection"]},
                },
                "publicNetworkAccess": "Enabled",
                "socketIO": {"serviceMode": "Serverless"},
                "tls": {"clientCertEnabled": False},
            },
            "sku": {"capacity": 1, "name": "Premium_P1", "tier": "Premium"},
            "tags": {"key1": "value1"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSub_Update.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/azcore/to"
	"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_Update.json
func ExampleClient_BeginUpdate() {
	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)
	}
	poller, err := clientFactory.NewClient().BeginUpdate(ctx, "myResourceGroup", "myWebPubSubService", armwebpubsub.ResourceInfo{
		Location: to.Ptr("eastus"),
		Tags: map[string]*string{
			"key1": to.Ptr("value1"),
		},
		Identity: &armwebpubsub.ManagedIdentity{
			Type: to.Ptr(armwebpubsub.ManagedIdentityTypeSystemAssigned),
		},
		Kind: to.Ptr(armwebpubsub.ServiceKindWebPubSub),
		Properties: &armwebpubsub.Properties{
			DisableAADAuth:   to.Ptr(false),
			DisableLocalAuth: to.Ptr(false),
			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),
				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)},
				},
			},
			PublicNetworkAccess: to.Ptr("Enabled"),
			SocketIO: &armwebpubsub.SocketIOSettings{
				ServiceMode: to.Ptr("Serverless"),
			},
			TLS: &armwebpubsub.TLSSettings{
				ClientCertEnabled: to.Ptr(false),
			},
		},
		SKU: &armwebpubsub.ResourceSKU{
			Name:     to.Ptr("Premium_P1"),
			Capacity: to.Ptr[int32](1),
			Tier:     to.Ptr(armwebpubsub.WebPubSubSKUTierPremium),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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

JavaScript

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

/**
 * This sample demonstrates how to Operation to update an exiting resource.
 *
 * @summary Operation to update an exiting resource.
 * x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSub_Update.json
 */
async function webPubSubUpdate() {
  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 parameters = {
    disableAadAuth: false,
    disableLocalAuth: false,
    identity: { type: "SystemAssigned" },
    kind: "WebPubSub",
    liveTraceConfiguration: {
      categories: [{ name: "ConnectivityLogs", enabled: "true" }],
      enabled: "false",
    },
    location: "eastus",
    networkACLs: {
      defaultAction: "Deny",
      privateEndpoints: [
        {
          name: "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
          allow: ["ServerConnection"],
        },
      ],
      publicNetwork: { allow: ["ClientConnection"] },
    },
    publicNetworkAccess: "Enabled",
    sku: { name: "Premium_P1", capacity: 1, tier: "Premium" },
    socketIO: { serviceMode: "Serverless" },
    tags: { key1: "value1" },
    tls: { clientCertEnabled: false },
  };
  const credential = new DefaultAzureCredential();
  const client = new WebPubSubManagementClient(credential, subscriptionId);
  const result = await client.webPubSub.beginUpdateAndWait(
    resourceGroupName,
    resourceName,
    parameters,
  );
  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"
  }
}

状态代码:

202

Location: https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus...

定义

名称	说明
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	描述共享专用链接资源
SharedPrivateLinkResourceStatus	共享专用链接资源的状态
systemData	与创建和上次修改资源相关的元数据。
UserAssignedIdentityProperty	用户分配标识的属性。
WebPubSubNetworkACLs	资源的网络 ACL
WebPubSubRequestType	服务传入的请求类型
WebPubSubResource	一个类表示资源。
WebPubSubSkuTier	此特定 SKU 的可选层。 “Standard”或“Free”。 Basic 已弃用，请改用 Standard。
WebPubSubSocketIOSettings	资源的 SocketIO 设置
WebPubSubTlsSettings	资源的 TLS 设置

ACLAction

枚举

Azure 网络 ACL 操作。

值	说明
Allow
Deny

createdByType

枚举

创建资源的标识的类型。

值	说明
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	错误对象。

IPRule

Object

IP 规则

名称	类型	说明
action	ACLAction	Azure 网络 ACL 操作。
value	string	IP 或 CIDR 或 ServiceTag

LiveTraceCategory

Object

Microsoft.SignalRService 资源的实时跟踪类别配置。

名称	类型	说明
enabled	string	指示是否启用了实时跟踪类别。 可用值：true、false。 不区分大小写。
name	string	获取或设置实时跟踪类别的名称。 可用值：ConnectivityLogs、MessagingLogs。 不区分大小写。

LiveTraceConfiguration

Object

Microsoft.SignalRService 资源的实时跟踪配置。

名称	类型	默认值	说明
categories	LiveTraceCategory[]		获取或设置类别配置的列表。
enabled	string	false	指示是否启用实时跟踪。 如果设置为 true，实时跟踪客户端可以连接到服务。 否则，实时跟踪客户端无法连接到服务，因此无论在“类别”中配置什么，都无法接收任何日志。 可用值：true、false。 不区分大小写。

ManagedIdentity

Object

一个类表示用于请求和响应的托管标识

名称	类型	说明
principalId	string	获取系统分配标识的主体 ID。 仅用于响应。
tenantId	string	获取系统分配标识的租户 ID。 仅在响应中使用
type	ManagedIdentityType	表示标识类型：systemAssigned、userAssigned、None
userAssignedIdentities	<string,  UserAssignedIdentityProperty>	获取或设置用户分配的标识

ManagedIdentityType

枚举

表示标识类型：systemAssigned、userAssigned、None

值	说明
None
SystemAssigned
UserAssigned

NetworkACL

Object

网络 ACL

名称	类型	说明
allow	WebPubSubRequestType[]	允许的请求类型。 该值可以是一个或多个：ClientConnection、ServerConnection、RESTAPI。
deny	WebPubSubRequestType[]	被拒绝的请求类型。 该值可以是一个或多个：ClientConnection、ServerConnection、RESTAPI。

PrivateEndpoint

Object

专用终结点

名称	类型	说明
id	string	专用终结点的完整限定 ID

PrivateEndpointACL

Object

专用终结点的 ACL

名称	类型	说明
allow	WebPubSubRequestType[]	允许的请求类型。 该值可以是一个或多个：ClientConnection、ServerConnection、RESTAPI。
deny	WebPubSubRequestType[]	被拒绝的请求类型。 该值可以是一个或多个：ClientConnection、ServerConnection、RESTAPI。
name	string	专用终结点连接的名称

PrivateEndpointConnection

Object

与 Azure 资源的专用终结点连接

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 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 资源管理器元数据。
type	string	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PrivateLinkServiceConnectionState

Object

专用终结点连接的连接状态

名称	类型	说明
actionsRequired	string	一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。
description	string	批准/拒绝连接的原因。
status	PrivateLinkServiceConnectionStatus	指示连接是否已被服务的所有者批准/拒绝/删除。

PrivateLinkServiceConnectionStatus

枚举

指示连接是否已被服务的所有者批准/拒绝/删除。

值	说明
Approved
Disconnected
Pending
Rejected

ProvisioningState

枚举

资源的预配状态。

值	说明
Canceled
Creating
Deleting
Failed
Moving
Running
Succeeded
Unknown
Updating

ResourceLogCategory

Object

Microsoft.SignalRService 资源的资源日志类别配置。

名称	类型	说明
enabled	string	指示是否启用资源日志类别。 可用值：true、false。 不区分大小写。
name	string	获取或设置资源日志类别的名称。 可用值：ConnectivityLogs、MessagingLogs。 不区分大小写。

ResourceLogConfiguration

Object

Microsoft.SignalRService 资源的资源日志配置。

名称	类型	说明
categories	ResourceLogCategory[]	获取或设置类别配置的列表。

ResourceSku

Object

资源的计费信息。

名称	类型	说明
capacity	integer (int32)	可选，整数。 资源的单位计数。 1（对于 Free_F1/Standard_S1/Premium_P1，默认为 100，对于Premium_P2）。 如果存在，则允许以下值：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

枚举

服务类型

值	说明
SocketIO
WebPubSub

SharedPrivateLinkResource

Object

描述共享专用链接资源

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 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 资源管理器元数据。
type	string	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

SharedPrivateLinkResourceStatus

枚举

共享专用链接资源的状态

值	说明
Approved
Disconnected
Pending
Rejected
Timeout

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

UserAssignedIdentityProperty

Object

用户分配标识的属性。

名称	类型	说明
clientId	string	获取用户分配标识的客户端 ID
principalId	string	获取用户分配标识的主体 ID

WebPubSubNetworkACLs

Object

资源的网络 ACL

名称	类型	说明
defaultAction	ACLAction	Azure 网络 ACL 操作。
ipRules	IPRule[]	用于筛选公共流量的 IP 规则
privateEndpoints	PrivateEndpointACL[]	来自专用终结点的请求 ACL
publicNetwork	NetworkACL	网络 ACL

WebPubSubRequestType

枚举

服务传入的请求类型

值	说明
ClientConnection
RESTAPI
ServerConnection
Trace

WebPubSubResource

Object

一个类表示资源。

名称	类型	默认值	说明
id	string (arm-id)		资源的完全限定资源 ID。 例如“/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 Enable or disable localauth with AccessKey When set as true， connection with AccessKey=xxx is t work.
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 (int32)		专为浏览器/客户端使用而设计的资源的可公开访问端口。
properties.regionEndpointEnabled	string	Enabled	启用或禁用区域终结点。 默认值为“Enabled”。 禁用时，不会将新连接路由到此终结点，但现有连接不会受到影响。 此属性特定于副本。 不允许禁用没有副本的区域终结点。
properties.resourceLogConfiguration	ResourceLogConfiguration		Microsoft.SignalRService 资源的资源日志配置。
properties.resourceStopped	string	false	停止或启动资源。 默认值为“False”。 如果为 true，资源的数据平面将关闭。 如果为 false，则会启动资源的数据平面。
properties.serverPort	integer (int32)		专为客户服务器端使用而设计的资源的可公开访问端口。
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		共享专用链接资源的列表。
properties.socketIO	WebPubSubSocketIOSettings		资源的 SocketIO 设置
properties.tls	WebPubSubTlsSettings		资源的 TLS 设置
properties.version	string		资源的版本。 可能需要相同或更高版本的客户端 SDK。
sku	ResourceSku		资源的计费信息。
systemData	systemData		包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object		资源标记。
type	string		资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

WebPubSubSkuTier

枚举

此特定 SKU 的可选层。 “Standard”或“Free”。

Basic 已弃用，请改用 Standard。

值	说明
Basic
Free
Premium
Standard

WebPubSubSocketIOSettings

Object

资源的 SocketIO 设置

名称	类型	说明
serviceMode	string	用于 Socket.IO 的 Web PubSub 的服务模式。 允许的值：“Default”：具有自己的后端 Socket.IO 服务器“无服务器”：应用程序没有后端服务器

WebPubSubTlsSettings

Object

资源的 TLS 设置

名称	类型	默认值	说明
clientCertEnabled	boolean	False	如果启用，请在 TLS 握手期间请求客户端证书。 免费层不支持。 对于免费层，将忽略任何输入。