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	Имя группы ресурсов. Регистр букв в имени не учитывается.
resourceName	path	True	string	Имя ресурса. Шаблон регулярного выражения: ^[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, используемая для данной операции.

Текст запроса

Имя	Обязательно	Тип	Описание
location	True	string	Географическое расположение, в котором находится ресурс
identity		ManagedIdentity	Класс представляет управляемые удостоверения, используемые для запроса и ответа.
kind		ServiceKind	Тип службы
properties.disableAadAuth		boolean	DisableLocalAuth Включение или отключение проверки подлинности aad. Если задано значение true, подключение с AuthType=aad не будет работать.
properties.disableLocalAuth		boolean	DisableLocalAuth. Включение или отключение локальной проверки подлинности с помощью AccessKey. Если задано значение true, подключение с accessKey=xxx не будет работать.
properties.liveTraceConfiguration		LiveTraceConfiguration	Динамическая конфигурация трассировки ресурса Microsoft.SignalRService.
properties.networkACLs		WebPubSubNetworkACLs	Списки управления доступом к сети для ресурса
properties.publicNetworkAccess		string	Включение или отключение доступа к общедоступной сети. Значение по умолчанию — "Включено". Если параметр включен, списки управления доступом к сети по-прежнему применяются. Если параметр отключен, доступ к общедоступной сети всегда отключается независимо от того, что вы задали в списках управления доступом к сети.
properties.regionEndpointEnabled		string	Включите или отключите региональную конечную точку. Значение по умолчанию — "Включено". Если параметр отключен, новые подключения не будут направляться в эту конечную точку, однако существующие подключения не будут затронуты. Это свойство реплика специфично. Отключить региональную конечную точку без реплика не разрешено.
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

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: 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	Действие ACL сети Azure.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
IPRule	Правило IP-адресов
LiveTraceCategory	Динамическая конфигурация категории трассировки ресурса Microsoft.SignalRService.
LiveTraceConfiguration	Динамическая конфигурация трассировки ресурса Microsoft.SignalRService.
ManagedIdentity	Класс представляет управляемые удостоверения, используемые для запроса и ответа.
ManagedIdentityType	Представляет тип удостоверения: systemAssigned, userAssigned, None
NetworkACL	Список управления сетевым доступом
PrivateEndpoint	Частная конечная точка
PrivateEndpointACL	ACL для частной конечной точки
PrivateEndpointConnection	Подключение частной конечной точки к ресурсу Azure
PrivateLinkServiceConnectionState	Состояние подключения к частной конечной точке
PrivateLinkServiceConnectionStatus	Указывает, было ли подключение утверждено, отклонено или удалено владельцем службы.
ProvisioningState	Состояние подготовки ресурса.
ResourceLogCategory	Конфигурация категории журнала ресурсов для ресурса Microsoft.SignalRService.
ResourceLogConfiguration	Конфигурация журнала ресурсов ресурса Microsoft.SignalRService.
ResourceSku	Сведения о выставлении счетов ресурса.
ServiceKind	Тип службы
SharedPrivateLinkResource	Описание общего ресурса Приватный канал
SharedPrivateLinkResourceStatus	Состояние общего ресурса приватного канала
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
UserAssignedIdentityProperty	Свойства удостоверения, назначаемого пользователем.
WebPubSubNetworkACLs	Списки управления доступом к сети для ресурса
WebPubSubRequestType	Тип входящего запроса к службе
WebPubSubResource	Класс представляет ресурс.
WebPubSubSkuTier	Необязательный уровень конкретного номера SKU. "Стандартный" или "Бесплатный". Basic является нерекомендуемой, вместо него используйте Standard .
WebPubSubSocketIOSettings	Параметры SocketIO для ресурса
WebPubSubTlsSettings	Параметры TLS для ресурса

ACLAction

Действие ACL сети Azure.

Имя	Тип	Описание
Allow	string
Deny	string

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
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	Действие ACL сети Azure.
value	string	IP-адрес, CIDR или ServiceTag

LiveTraceCategory

Динамическая конфигурация категории трассировки ресурса Microsoft.SignalRService.

Имя	Тип	Описание
enabled	string	Указывает, включена ли категория динамической трассировки или . Доступные значения: true, false. Без учета регистра.
name	string	Возвращает или задает имя категории динамической трассировки. Доступные значения: ConnectivityLogs, MessagingLogs. Без учета регистра.

LiveTraceConfiguration

Динамическая конфигурация трассировки ресурса Microsoft.SignalRService.

Имя	Тип	Default value	Описание
categories	LiveTraceCategory[]		Возвращает или задает список конфигураций категорий.
enabled	string	false	Указывает, включена ли динамическая трассировка. Если задано значение true, клиент динамической трассировки может подключиться к службе. В противном случае клиент динамической трассировки не сможет подключиться к службе, поэтому вы не сможете получить журнал независимо от того, что вы настроите в "категориях". Доступные значения: true, false. Регистр не учитывается.

ManagedIdentity

Класс представляет управляемые удостоверения, используемые для запроса и ответа.

Имя	Тип	Описание
principalId	string	Получите идентификатор субъекта для удостоверения, назначаемого системой. Используется только в ответе.
tenantId	string	Получите идентификатор клиента для удостоверения, назначаемого системой. Используется только в ответе
type	ManagedIdentityType	Представляет тип удостоверения: systemAssigned, userAssigned, None
userAssignedIdentities	<string,  UserAssignedIdentityProperty>	Получение или настройка удостоверений, назначаемых пользователем

ManagedIdentityType

Представляет тип удостоверения: systemAssigned, userAssigned, None

Имя	Тип	Описание
None	string
SystemAssigned	string
UserAssigned	string

NetworkACL

Список управления сетевым доступом

Имя	Тип	Описание
allow	WebPubSubRequestType[]	Разрешенные типы запросов. Значение может быть одним или несколькими из следующих значений: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Отклоненные типы запросов. Значение может быть одним или несколькими из следующих значений: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpoint

Частная конечная точка

Имя	Тип	Описание
id	string	Полный идентификатор частной конечной точки

PrivateEndpointACL

ACL для частной конечной точки

Имя	Тип	Описание
allow	WebPubSubRequestType[]	Разрешенные типы запросов. Значение может быть одним или несколькими из следующих значений: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Отклоненные типы запросов. Значение может быть одним или несколькими из следующих значений: ClientConnection, ServerConnection, RESTAPI.
name	string	Имя подключения к частной конечной точке

PrivateEndpointConnection

Подключение частной конечной точки к ресурсу Azure

Имя	Тип	Описание
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

Состояние подключения к частной конечной точке

Имя	Тип	Описание
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	Необязательно, целое число. Количество единиц ресурса. 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. "Стандартный" или "Бесплатный". Basic является нерекомендуемой, вместо него используйте Standard .

ServiceKind

Тип службы

Имя	Тип	Описание
SocketIO	string
WebPubSub	string

SharedPrivateLinkResource

Описание общего ресурса Приватный канал

Имя	Тип	Описание
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

Состояние общего ресурса приватного канала

Имя	Тип	Описание
Approved	string
Disconnected	string
Pending	string
Rejected	string
Timeout	string

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Удостоверение, которое в последний раз изменял ресурс.
lastModifiedByType	createdByType	Тип удостоверения, изменяющего ресурс в последний раз.

UserAssignedIdentityProperty

Свойства удостоверения, назначаемого пользователем.

Имя	Тип	Описание
clientId	string	Получение идентификатора клиента для удостоверения, назначаемого пользователем
principalId	string	Получение идентификатора субъекта для удостоверения, назначаемого пользователем

WebPubSubNetworkACLs

Списки управления доступом к сети для ресурса

Имя	Тип	Описание
defaultAction	ACLAction	Действие ACL сети Azure.
ipRules	IPRule[]	Правила IP-адресов для фильтрации общедоступного трафика
privateEndpoints	PrivateEndpointACL[]	Списки управления доступом для запросов от частных конечных точек
publicNetwork	NetworkACL	Список управления сетевым доступом

WebPubSubRequestType

Тип входящего запроса к службе

Имя	Тип	Описание
ClientConnection	string
RESTAPI	string
ServerConnection	string
Trace	string

WebPubSubResource

Класс представляет ресурс.

Имя	Тип	Default value	Описание
id	string		Полный идентификатор ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedIdentity		Класс представляет управляемые удостоверения, используемые для запроса и ответа.
kind	ServiceKind		Тип службы
location	string		Географическое расположение, в котором находится ресурс
name	string		Имя ресурса.
properties.disableAadAuth	boolean	False	DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad не будет работать.
properties.disableLocalAuth	boolean	False	DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx не будет работать.
properties.externalIP	string		Общедоступный IP-адрес ресурса.
properties.hostName	string		Полное доменное имя экземпляра службы.
properties.hostNamePrefix	string		Не рекомендуется.
properties.liveTraceConfiguration	LiveTraceConfiguration		Динамическая конфигурация трассировки ресурса Microsoft.SignalRService.
properties.networkACLs	WebPubSubNetworkACLs		Списки управления доступом к сети для ресурса
properties.privateEndpointConnections	PrivateEndpointConnection[]		Подключения частной конечной точки к ресурсу.
properties.provisioningState	ProvisioningState		Состояние подготовки ресурса.
properties.publicNetworkAccess	string	Enabled	Включение или отключение доступа к общедоступной сети. Значение по умолчанию — "Включено". Если параметр включен, сетевые списки управления доступом по-прежнему применяются. Если параметр отключен, доступ к общедоступной сети всегда отключается независимо от того, что вы задали в сетевых списках управления доступом.
properties.publicPort	integer		Общедоступный порт ресурса, предназначенный для использования на стороне браузера или клиента.
properties.regionEndpointEnabled	string	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. "Стандартный" или "Бесплатный".

Basic является нерекомендуемой, вместо него используйте Standard .

Имя	Тип	Описание
Basic	string
Free	string
Premium	string
Standard	string

WebPubSubSocketIOSettings

Параметры SocketIO для ресурса

Имя	Тип	Описание
serviceMode	string	Режим службы Web PubSub для Socket.IO. Допустимые значения: "Default": имеете собственный сервер Socket.IO "Бессерверный": у приложения нет внутреннего сервера.

WebPubSubTlsSettings

Параметры TLS для ресурса

Имя	Тип	Default value	Описание
clientCertEnabled	boolean	False	Запрос сертификата клиента во время подтверждения TLS, если он включен. Не поддерживается для уровня "Бесплатный". Все входные данные будут игнорироваться для уровня "Бесплатный".