Web Pub Sub - Update

Usługa:

Azure Web PubSub Service

Wersja interfejsu API:

2024-03-01

Operacja aktualizowania zasobu zakończenia.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
resourceName	path	True	string	Nazwa zasobu. Wzorzec wyrażenia regularnego: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$
subscriptionId	path	True	string uuid	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja geograficzna, w której znajduje się zasób
identity		ManagedIdentity	Klasa reprezentuje tożsamości zarządzane używane do obsługi żądań i odpowiedzi
kind		ServiceKind	Rodzaj usługi
properties.disableAadAuth		boolean	DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad nie będzie działać.
properties.disableLocalAuth		boolean	DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work.DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx't work.
properties.liveTraceConfiguration		LiveTraceConfiguration	Konfiguracja śledzenia na żywo zasobu Microsoft.SignalRService.
properties.networkACLs		WebPubSubNetworkACLs	Listy ACL sieci dla zasobu
properties.publicNetworkAccess		string	Włączanie lub wyłączanie dostępu do sieci publicznej. Wartość domyślna to "Włączone". Po włączeniu listy ACL sieci nadal mają zastosowanie. Po wyłączeniu dostęp do sieci publicznej jest zawsze wyłączony niezależnie od tego, co zostało ustawione w listach ACL sieci.
properties.regionEndpointEnabled		string	Włącz lub wyłącz regionalny punkt końcowy. Wartość domyślna to "Włączone". Po wyłączeniu nowe połączenia nie będą kierowane do tego punktu końcowego, jednak istniejące połączenia nie będą miały wpływu. Ta właściwość jest specyficzna dla repliki. Wyłącz regionalny punkt końcowy bez niedozwolonej repliki.
properties.resourceLogConfiguration		ResourceLogConfiguration	Konfiguracja dziennika zasobów zasobu Microsoft.SignalRService.
properties.resourceStopped		string	Zatrzymaj lub uruchom zasób. Wartość domyślna to "False". Gdy to prawda, płaszczyzna danych zasobu jest zamykana. Gdy jest to fałsz, płaszczyzna danych zasobu jest uruchamiana.
properties.socketIO		WebPubSubSocketIOSettings	Ustawienia socketIO dla zasobu
properties.tls		WebPubSubTlsSettings	Ustawienia protokołu TLS dla zasobu
sku		ResourceSku	Informacje dotyczące rozliczeń zasobu.
tags		object	Tagi zasobów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	WebPubSubResource	Powodzenie. Odpowiedź opisuje zasób.
202 Accepted		Akceptowane. Odpowiedź wskazuje, że zasób zakończenia jest teraz aktualizowany i zawiera nagłówek Lokalizacja w celu wykonania zapytania względem wyniku operacji. Nagłówki Location: string
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

WebPubSub_Update

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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"
  }
}

Kod stanu:

202

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

Definicje

Nazwa	Opis
ACLAction	Akcja listy ACL sieci platformy Azure.
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
IPRule	Reguła adresu IP
LiveTraceCategory	Konfiguracja kategorii śledzenia na żywo zasobu Microsoft.SignalRService.
LiveTraceConfiguration	Konfiguracja śledzenia na żywo zasobu Microsoft.SignalRService.
ManagedIdentity	Klasa reprezentuje tożsamości zarządzane używane do żądania i odpowiedzi
ManagedIdentityType	Reprezentuje typ tożsamości: systemAssigned, userAssigned, None
NetworkACL	Lista ACL sieci
PrivateEndpoint	Prywatny punkt końcowy
PrivateEndpointACL	Lista ACL dla prywatnego punktu końcowego
PrivateEndpointConnection	Połączenie prywatnego punktu końcowego z zasobem platformy Azure
PrivateLinkServiceConnectionState	Stan połączenia prywatnego punktu końcowego
PrivateLinkServiceConnectionStatus	Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi.
ProvisioningState	Stan aprowizacji zasobu.
ResourceLogCategory	Konfiguracja kategorii dziennika zasobów zasobu Microsoft.SignalRService.
ResourceLogConfiguration	Konfiguracja dziennika zasobów zasobu Microsoft.SignalRService.
ResourceSku	Informacje dotyczące rozliczeń zasobu.
ServiceKind	Rodzaj usługi
SharedPrivateLinkResource	Opisuje udostępniony zasób Private Link
SharedPrivateLinkResourceStatus	Stan zasobu udostępnionego łącza prywatnego
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
UserAssignedIdentityProperty	Właściwości tożsamości przypisanej przez użytkownika.
WebPubSubNetworkACLs	Listy ACL sieci dla zasobu
WebPubSubRequestType	Typ żądania przychodzącego do usługi
WebPubSubResource	Klasa reprezentuje zasób.
WebPubSubSkuTier	Opcjonalna warstwa tej konkretnej jednostki SKU. "Standardowa" lub "Bezpłatna". Basic jest przestarzały, zamiast tego użyj polecenia Standard .
WebPubSubSocketIOSettings	Ustawienia socketIO zasobu
WebPubSubTlsSettings	Ustawienia protokołu TLS dla zasobu

ACLAction

Akcja listy ACL sieci platformy Azure.

Nazwa	Typ	Opis
Allow	string
Deny	string

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt error.

IPRule

Reguła adresu IP

Nazwa	Typ	Opis
action	ACLAction	Akcja listy ACL sieci platformy Azure.
value	string	Adres IP lub CIDR lub element ServiceTag

LiveTraceCategory

Konfiguracja kategorii śledzenia na żywo zasobu Microsoft.SignalRService.

Nazwa	Typ	Opis
enabled	string	Wskazuje, czy kategoria śledzenia na żywo jest włączona. Dostępne wartości: true, false. Bez uwzględniania wielkości liter.
name	string	Pobiera lub ustawia nazwę kategorii śledzenia na żywo. Dostępne wartości: ConnectivityLogs, MessagingLogs. Bez uwzględniania wielkości liter.

LiveTraceConfiguration

Konfiguracja śledzenia na żywo zasobu Microsoft.SignalRService.

Nazwa	Typ	Domyślna wartość	Opis
categories	LiveTraceCategory[]		Pobiera lub ustawia listę konfiguracji kategorii.
enabled	string	false	Wskazuje, czy włączyć śledzenie na żywo. Po ustawieniu wartości true klient śledzenia na żywo może nawiązać połączenie z usługą. W przeciwnym razie klient śledzenia na żywo nie może nawiązać połączenia z usługą, aby nie można było odebrać żadnego dziennika, bez względu na to, co konfigurujesz w "kategoriach". Dostępne wartości: true, false. Bez uwzględniania wielkości liter.

ManagedIdentity

Klasa reprezentuje tożsamości zarządzane używane do żądania i odpowiedzi

Nazwa	Typ	Opis
principalId	string	Pobierz identyfikator podmiotu zabezpieczeń dla tożsamości przypisanej przez system. Należy używać tylko w odpowiedzi.
tenantId	string	Pobierz identyfikator dzierżawy dla tożsamości przypisanej przez system. Tylko być używane w odpowiedzi
type	ManagedIdentityType	Reprezentuje typ tożsamości: systemAssigned, userAssigned, None
userAssignedIdentities	<string,  UserAssignedIdentityProperty>	Pobieranie lub ustawianie tożsamości przypisanych przez użytkownika

ManagedIdentityType

Reprezentuje typ tożsamości: systemAssigned, userAssigned, None

Nazwa	Typ	Opis
None	string
SystemAssigned	string
UserAssigned	string

NetworkACL

Lista ACL sieci

Nazwa	Typ	Opis
allow	WebPubSubRequestType[]	Dozwolone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Niedozwolone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpoint

Prywatny punkt końcowy

Nazwa	Typ	Opis
id	string	Pełny kwalifikowany identyfikator prywatnego punktu końcowego

PrivateEndpointACL

Lista ACL dla prywatnego punktu końcowego

Nazwa	Typ	Opis
allow	WebPubSubRequestType[]	Dozwolone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Niedozwolone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI.
name	string	Nazwa połączenia prywatnego punktu końcowego

PrivateEndpointConnection

Połączenie prywatnego punktu końcowego z zasobem platformy Azure

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nazwa zasobu
properties.groupIds	string[]	Identyfikatory grup
properties.privateEndpoint	PrivateEndpoint	Prywatny punkt końcowy
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stan połączenia prywatnego punktu końcowego
properties.provisioningState	ProvisioningState	Stan aprowizacji zasobu.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

PrivateLinkServiceConnectionState

Stan połączenia prywatnego punktu końcowego

Nazwa	Typ	Opis
actionsRequired	string	Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji u konsumenta.
description	string	Przyczyna zatwierdzenia/odrzucenia połączenia.
status	PrivateLinkServiceConnectionStatus	Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi.

PrivateLinkServiceConnectionStatus

Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi.

Nazwa	Typ	Opis
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Stan aprowizacji zasobu.

Nazwa	Typ	Opis
Canceled	string
Creating	string
Deleting	string
Failed	string
Moving	string
Running	string
Succeeded	string
Unknown	string
Updating	string

ResourceLogCategory

Konfiguracja kategorii dziennika zasobów zasobu Microsoft.SignalRService.

Nazwa	Typ	Opis
enabled	string	Wskazuje, czy kategoria dziennika zasobów jest włączona. Dostępne wartości: true, false. Bez uwzględniania wielkości liter.
name	string	Pobiera lub ustawia nazwę kategorii dziennika zasobów. Dostępne wartości: ConnectivityLogs, MessagingLogs. Bez uwzględniania wielkości liter.

ResourceLogConfiguration

Konfiguracja dziennika zasobów zasobu Microsoft.SignalRService.

Nazwa	Typ	Opis
categories	ResourceLogCategory[]	Pobiera lub ustawia listę konfiguracji kategorii.

ResourceSku

Informacje dotyczące rozliczeń zasobu.

Nazwa	Typ	Opis
capacity	integer	Opcjonalnie, liczba całkowita. Liczba jednostek zasobu. 1 dla Free_F1/Standard_S1/Premium_P1, 100 dla Premium_P2 domyślnie. Jeśli są obecne, dozwolone są następujące wartości: 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	Nie używany. Zachowywane do użytku w przyszłości.
name	string	Nazwa jednostki SKU. Wymagane. Dozwolone wartości: Standard_S1, Free_F1, Premium_P1, Premium_P2
size	string	Nie używany. Zachowywane do użytku w przyszłości.
tier	WebPubSubSkuTier	Opcjonalna warstwa tej konkretnej jednostki SKU. "Standardowa" lub "Bezpłatna". Basic jest przestarzały, zamiast tego użyj polecenia Standard .

ServiceKind

Rodzaj usługi

Nazwa	Typ	Opis
SocketIO	string
WebPubSub	string

SharedPrivateLinkResource

Opisuje udostępniony zasób Private Link

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nazwa zasobu
properties.groupId	string	Identyfikator grupy od dostawcy zasobu, dla których znajduje się udostępniony zasób łącza prywatnego
properties.privateLinkResourceId	string	Identyfikator zasobu zasobu, dla których znajduje się udostępniony zasób łącza prywatnego
properties.provisioningState	ProvisioningState	Stan aprowizacji zasobu.
properties.requestMessage	string	Komunikat żądania żądania żądania zatwierdzenia udostępnionego zasobu łącza prywatnego
properties.status	SharedPrivateLinkResourceStatus	Stan zasobu udostępnionego łącza prywatnego
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceStatus

Stan zasobu udostępnionego łącza prywatnego

Nazwa	Typ	Opis
Approved	string
Disconnected	string
Pending	string
Rejected	string
Timeout	string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

UserAssignedIdentityProperty

Właściwości tożsamości przypisanej przez użytkownika.

Nazwa	Typ	Opis
clientId	string	Pobieranie identyfikatora klienta dla tożsamości przypisanej przez użytkownika
principalId	string	Pobieranie identyfikatora podmiotu zabezpieczeń dla tożsamości przypisanej przez użytkownika

WebPubSubNetworkACLs

Listy ACL sieci dla zasobu

Nazwa	Typ	Opis
defaultAction	ACLAction	Akcja listy ACL sieci platformy Azure.
ipRules	IPRule[]	Reguły adresów IP do filtrowania ruchu publicznego
privateEndpoints	PrivateEndpointACL[]	Listy ACL dla żądań z prywatnych punktów końcowych
publicNetwork	NetworkACL	Lista ACL sieci

WebPubSubRequestType

Typ żądania przychodzącego do usługi

Nazwa	Typ	Opis
ClientConnection	string
RESTAPI	string
ServerConnection	string
Trace	string

WebPubSubResource

Klasa reprezentuje zasób.

Nazwa	Typ	Domyślna wartość	Opis
id	string		W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedIdentity		Klasa reprezentuje tożsamości zarządzane używane do żądania i odpowiedzi
kind	ServiceKind		Rodzaj usługi
location	string		Lokalizacja geograficzna, w której znajduje się zasób
name	string		Nazwa zasobu
properties.disableAadAuth	boolean	False	DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad nie będzie działać.
properties.disableLocalAuth	boolean	False	DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx't work.DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx't work.
properties.externalIP	string		Publiczny adres IP zasobu.
properties.hostName	string		Nazwa FQDN wystąpienia usługi.
properties.hostNamePrefix	string		Przestarzałe.
properties.liveTraceConfiguration	LiveTraceConfiguration		Konfiguracja śledzenia na żywo zasobu Microsoft.SignalRService.
properties.networkACLs	WebPubSubNetworkACLs		Listy ACL sieci dla zasobu
properties.privateEndpointConnections	PrivateEndpointConnection[]		Połączenia prywatnego punktu końcowego z zasobem.
properties.provisioningState	ProvisioningState		Stan aprowizacji zasobu.
properties.publicNetworkAccess	string	Enabled	Włącz lub wyłącz dostęp do sieci publicznej. Wartość domyślna to "Włączone". Po włączeniu listy ACL sieci nadal mają zastosowanie. Po wyłączeniu dostęp do sieci publicznej jest zawsze wyłączony niezależnie od tego, co zostało ustawione w listach ACL sieci.
properties.publicPort	integer		Publicznie dostępny port zasobu, który jest przeznaczony do użycia po stronie przeglądarki/klienta.
properties.regionEndpointEnabled	string	Enabled	Włącz lub wyłącz regionalny punkt końcowy. Wartość domyślna to "Włączone". Po wyłączeniu nowe połączenia nie będą kierowane do tego punktu końcowego, jednak istniejące połączenia nie będą miały wpływu. Ta właściwość jest specyficzna dla repliki. Wyłącz regionalny punkt końcowy bez niedozwolonej repliki.
properties.resourceLogConfiguration	ResourceLogConfiguration		Konfiguracja dziennika zasobów zasobu Microsoft.SignalRService.
properties.resourceStopped	string	false	Zatrzymaj lub uruchom zasób. Wartość domyślna to "False". Gdy to prawda, płaszczyzna danych zasobu jest zamykana. Gdy jest to fałsz, płaszczyzna danych zasobu jest uruchamiana.
properties.serverPort	integer		Publicznie dostępny port zasobu, który jest przeznaczony do użycia po stronie serwera klienta.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Lista udostępnionych zasobów łącza prywatnego.
properties.socketIO	WebPubSubSocketIOSettings		Ustawienia socketIO dla zasobu
properties.tls	WebPubSubTlsSettings		Ustawienia protokołu TLS dla zasobu
properties.version	string		Wersja zasobu. Prawdopodobnie potrzebujesz tej samej lub nowszej wersji zestawów SDK klienta.
sku	ResourceSku		Informacje dotyczące rozliczeń zasobu.
systemData	systemData		Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
tags	object		Tagi zasobów.
type	string		Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

WebPubSubSkuTier

Opcjonalna warstwa tej konkretnej jednostki SKU. "Standardowa" lub "Bezpłatna".

Basic jest przestarzały, zamiast tego użyj polecenia Standard .

Nazwa	Typ	Opis
Basic	string
Free	string
Premium	string
Standard	string

WebPubSubSocketIOSettings

Ustawienia socketIO zasobu

Nazwa	Typ	Opis
serviceMode	string	Tryb usługi Web PubSub dla Socket.IO. Dozwolone wartości: "Default": have your own backend Socket.IO server "Serverless": Twoja aplikacja nie ma serwera zaplecza

WebPubSubTlsSettings

Ustawienia protokołu TLS dla zasobu

Nazwa	Typ	Domyślna wartość	Opis
clientCertEnabled	boolean	False	Zażądaj certyfikatu klienta podczas uzgadniania protokołu TLS, jeśli jest włączona. Nieobsługiwane w warstwie Bezpłatna. Wszystkie dane wejściowe zostaną zignorowane dla warstwy Bezpłatna.