Web Pub Sub - Update

Servizio:

Azure Web PubSub Service

Versione API:

2024-03-01

Operazione per aggiornare una risorsa di uscita.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
resourceName	path	True	string	Nome della risorsa. Criterio di espressione regolare: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$
subscriptionId	path	True	string uuid	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
location	True	string	Posizione geografica in cui risiede la risorsa
identity		ManagedIdentity	Una classe rappresenta le identità gestite usate per la richiesta e la risposta
kind		ServiceKind	Tipo di servizio
properties.disableAadAuth		boolean	DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.
properties.disableLocalAuth		boolean	DisableLocalAuth Abilitare o disabilitare l'autenticazione locale con AccessKey Se impostato su true, la connessione con AccessKey=xxx non funzionerà.
properties.liveTraceConfiguration		LiveTraceConfiguration	Configurazione della traccia dinamica di una risorsa Microsoft.SignalRService.
properties.networkACLs		WebPubSubNetworkACLs	ACL di rete per la risorsa
properties.publicNetworkAccess		string	Abilitare o disabilitare l'accesso alla rete pubblica. Il valore predefinito è "Abilitato". Quando è Abilitato, gli elenchi di controllo di accesso di rete sono ancora validi. Quando è Disabilitato, l'accesso alla rete pubblica viene sempre disabilitato indipendentemente dall'impostazione negli elenchi di controllo di accesso di rete.
properties.regionEndpointEnabled		string	Abilitare o disabilitare l'endpoint a livello di area. Il valore predefinito è "Abilitato". Quando è Disabilitato, le nuove connessioni non verranno instradate a questo endpoint, ma le connessioni esistenti non saranno interessate. Questa proprietà è specifica della replica. Disabilitare l'endpoint a livello di area senza replica non è consentito.
properties.resourceLogConfiguration		ResourceLogConfiguration	Configurazione del log delle risorse di una risorsa Microsoft.SignalRService.
properties.resourceStopped		string	Arrestare o avviare la risorsa. Il valore predefinito è "False". Quando è vero, il piano dati della risorsa viene arrestato. Quando è false, viene avviato il piano dati della risorsa.
properties.socketIO		WebPubSubSocketIOSettings	Impostazioni socketIO per la risorsa
properties.tls		WebPubSubTlsSettings	Impostazioni TLS per la risorsa
sku		ResourceSku	Informazioni di fatturazione della risorsa.
tags		object	Tag delle risorse.

Risposte

Nome	Tipo	Descrizione
200 OK	WebPubSubResource	Operazione completata. La risposta descrive una risorsa.
202 Accepted		Accettato. La risposta indica che la risorsa di uscita è ora aggiornata e contiene un'intestazione Location per eseguire query sul risultato dell'operazione. Intestazioni Location: string
Other Status Codes	ErrorResponse	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

WebPubSub_Update

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Codice di stato:

202

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

Definizioni

Nome	Descrizione
ACLAction	Azione ACL di rete di Azure.
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
IPRule	Una regola IP
LiveTraceCategory	Configurazione della categoria di traccia dinamica di una risorsa Microsoft.SignalRService.
LiveTraceConfiguration	Configurazione della traccia dinamica di una risorsa Microsoft.SignalRService.
ManagedIdentity	Una classe rappresenta le identità gestite usate per la richiesta e la risposta
ManagedIdentityType	Rappresenta il tipo di identità: systemAssigned, userAssigned, None
NetworkACL	ACL rete
PrivateEndpoint	Endpoint privato
PrivateEndpointACL	ACL per un endpoint privato
PrivateEndpointConnection	Una connessione endpoint privato a una risorsa di Azure
PrivateLinkServiceConnectionState	Stato di connessione della connessione dell'endpoint privato
PrivateLinkServiceConnectionStatus	Indica se la connessione è stata approvata/rifiutata/rimossa dal proprietario del servizio.
ProvisioningState	Stato di provisioning della risorsa.
ResourceLogCategory	Configurazione della categoria di log delle risorse di una risorsa Microsoft.SignalRService.
ResourceLogConfiguration	Configurazione del log delle risorse di una risorsa Microsoft.SignalRService.
ResourceSku	Informazioni di fatturazione della risorsa.
ServiceKind	Tipo di servizio
SharedPrivateLinkResource	Descrive una risorsa di collegamento privato condivisa
SharedPrivateLinkResourceStatus	Stato della risorsa collegamento privato condiviso
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
UserAssignedIdentityProperty	Proprietà dell'identità assegnata dall'utente.
WebPubSubNetworkACLs	ACL di rete per la risorsa
WebPubSubRequestType	Tipo di richiesta in ingresso al servizio
WebPubSubResource	Una classe rappresenta una risorsa.
WebPubSubSkuTier	Livello facoltativo di questo SKU specifico. 'Standard' o 'Free'. Basic è deprecato, usare Standard invece .
WebPubSubSocketIOSettings	Impostazioni socketIO per la risorsa
WebPubSubTlsSettings	Impostazioni TLS per la risorsa

ACLAction

Enumeration

Azione ACL di rete di Azure.

Valore	Descrizione
Allow
Deny

createdByType

Enumeration

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

IPRule

Object

Una regola IP

Nome	Tipo	Descrizione
action	ACLAction	Azione ACL di rete di Azure.
value	string	Ip o CIDR o ServiceTag

LiveTraceCategory

Object

Configurazione della categoria di traccia dinamica di una risorsa Microsoft.SignalRService.

Nome	Tipo	Descrizione
enabled	string	Indica se o la categoria di traccia dinamica è abilitata. Valori disponibili: true, false. Senza distinzione tra maiuscole e minuscole.
name	string	Ottiene o imposta il nome della categoria di traccia attiva. Valori disponibili: ConnectivityLogs, MessagingLogs. Senza distinzione tra maiuscole e minuscole.

LiveTraceConfiguration

Object

Configurazione della traccia dinamica di una risorsa Microsoft.SignalRService.

Nome	Tipo	Valore predefinito	Descrizione
categories	LiveTraceCategory[]		Ottiene o imposta l'elenco di configurazioni di categoria.
enabled	string	false	Indica se abilitare o meno la traccia dinamica. Quando è impostata su true, il client di traccia dinamica può connettersi al servizio. In caso contrario, il client di traccia dinamica non può connettersi al servizio, in modo che non sia possibile ricevere alcun log, indipendentemente da ciò che si configura in "categorie". Valori disponibili: true, false. Senza distinzione tra maiuscole e minuscole.

ManagedIdentity

Object

Una classe rappresenta le identità gestite usate per la richiesta e la risposta

Nome	Tipo	Descrizione
principalId	string	Ottenere l'ID entità per l'identità assegnata dal sistema. Viene usato solo in risposta.
tenantId	string	Ottenere l'ID tenant per l'identità assegnata dal sistema. Essere usato solo in risposta
type	ManagedIdentityType	Rappresenta il tipo di identità: systemAssigned, userAssigned, None
userAssignedIdentities	<string,  UserAssignedIdentityProperty>	Ottenere o impostare le identità assegnate dall'utente

ManagedIdentityType

Enumeration

Rappresenta il tipo di identità: systemAssigned, userAssigned, None

Valore	Descrizione
None
SystemAssigned
UserAssigned

NetworkACL

Object

ACL rete

Nome	Tipo	Descrizione
allow	WebPubSubRequestType[]	Tipi di richiesta consentiti. Il valore può essere uno o più di: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Tipi di richiesta negati. Il valore può essere uno o più di: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpoint

Object

Endpoint privato

Nome	Tipo	Descrizione
id	string	ID completo completo dell'endpoint privato

PrivateEndpointACL

Object

ACL per un endpoint privato

Nome	Tipo	Descrizione
allow	WebPubSubRequestType[]	Tipi di richiesta consentiti. Il valore può essere uno o più di: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Tipi di richiesta negati. Il valore può essere uno o più di: ClientConnection, ServerConnection, RESTAPI.
name	string	Nome della connessione dell'endpoint privato

PrivateEndpointConnection

Object

Una connessione endpoint privato a una risorsa di Azure

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	nome della risorsa.
properties.groupIds	string[]	ID gruppo
properties.privateEndpoint	PrivateEndpoint	Endpoint privato
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stato di connessione della connessione dell'endpoint privato
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa.
systemData	systemData	Azure Resource Manager metadati contenenti le informazioni createdBy e modifiedBy.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateLinkServiceConnectionState

Object

Stato di connessione della connessione dell'endpoint privato

Nome	Tipo	Descrizione
actionsRequired	string	Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti nel consumer.
description	string	Motivo dell'approvazione/rifiuto della connessione.
status	PrivateLinkServiceConnectionStatus	Indica se la connessione è stata approvata/rifiutata/rimossa dal proprietario del servizio.

PrivateLinkServiceConnectionStatus

Enumeration

Indica se la connessione è stata approvata/rifiutata/rimossa dal proprietario del servizio.

Valore	Descrizione
Approved
Disconnected
Pending
Rejected

ProvisioningState

Enumeration

Stato di provisioning della risorsa.

Valore	Descrizione
Canceled
Creating
Deleting
Failed
Moving
Running
Succeeded
Unknown
Updating

ResourceLogCategory

Object

Configurazione della categoria di log delle risorse di una risorsa Microsoft.SignalRService.

Nome	Tipo	Descrizione
enabled	string	Indica se o la categoria del log delle risorse è abilitata. Valori disponibili: true, false. Senza distinzione tra maiuscole e minuscole.
name	string	Ottiene o imposta il nome della categoria del log delle risorse. Valori disponibili: ConnectivityLogs, MessagingLogs. Senza distinzione tra maiuscole e minuscole.

ResourceLogConfiguration

Object

Configurazione del log delle risorse di una risorsa Microsoft.SignalRService.

Nome	Tipo	Descrizione
categories	ResourceLogCategory[]	Ottiene o imposta l'elenco di configurazioni di categoria.

ResourceSku

Object

Informazioni di fatturazione della risorsa.

Nome	Tipo	Descrizione
capacity	integer	Valore integer facoltativo. Numero di unità della risorsa. 1 per Free_F1/Standard_S1/Premium_P1, 100 per Premium_P2 per impostazione predefinita. Se presente, sono consentiti i valori seguenti: 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	Non usato. Conservato per un uso futuro.
name	string	Il nome della SKU. Obbligatorio. Valori consentiti: Standard_S1, Free_F1, Premium_P1, Premium_P2
size	string	Non usato. Conservato per un uso futuro.
tier	WebPubSubSkuTier	Livello facoltativo di questo SKU specifico. 'Standard' o 'Free'. Basic è deprecato, usare Standard invece .

ServiceKind

Enumeration

Tipo di servizio

Valore	Descrizione
SocketIO
WebPubSub

SharedPrivateLinkResource

Object

Descrive una risorsa di collegamento privato condivisa

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	nome della risorsa.
properties.groupId	string	L'ID gruppo del provider della risorsa per la risorsa del collegamento privato condiviso è per
properties.privateLinkResourceId	string	L'ID risorsa della risorsa per la risorsa di collegamento privato condiviso è per
properties.provisioningState	ProvisioningState	Stato di provisioning della risorsa.
properties.requestMessage	string	Messaggio di richiesta per richiedere l'approvazione della risorsa di collegamento privato condiviso
properties.status	SharedPrivateLinkResourceStatus	Stato della risorsa collegamento privato condiviso
systemData	systemData	Azure Resource Manager metadati contenenti le informazioni createdBy e modifiedBy.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceStatus

Enumeration

Stato della risorsa collegamento privato condiviso

Valore	Descrizione
Approved
Disconnected
Pending
Rejected
Timeout

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

UserAssignedIdentityProperty

Object

Proprietà dell'identità assegnata dall'utente.

Nome	Tipo	Descrizione
clientId	string	Ottenere l'ID client per l'identità assegnata dall'utente
principalId	string	Ottenere l'ID entità per l'identità assegnata dall'utente

WebPubSubNetworkACLs

Object

ACL di rete per la risorsa

Nome	Tipo	Descrizione
defaultAction	ACLAction	Azione ACL di rete di Azure.
ipRules	IPRule[]	Regole IP per filtrare il traffico pubblico
privateEndpoints	PrivateEndpointACL[]	ACL per le richieste da endpoint privati
publicNetwork	NetworkACL	ACL rete

WebPubSubRequestType

Enumeration

Tipo di richiesta in ingresso al servizio

Valore	Descrizione
ClientConnection
RESTAPI
ServerConnection
Trace

WebPubSubResource

Object

Una classe rappresenta una risorsa.

Nome	Tipo	Valore predefinito	Descrizione
id	string		ID di risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedIdentity		Una classe rappresenta le identità gestite usate per la richiesta e la risposta
kind	ServiceKind		Tipo di servizio
location	string		Posizione geografica in cui risiede la risorsa
name	string		nome della risorsa.
properties.disableAadAuth	boolean	False	DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.
properties.disableLocalAuth	boolean	False	DisableLocalAuth Abilitare o disabilitare l'autenticazione locale con AccessKey Se impostato su true, la connessione con AccessKey=xxx non funzionerà.
properties.externalIP	string		INDIRIZZO IP accessibile pubblicamente della risorsa.
properties.hostName	string		FQDN dell'istanza del servizio.
properties.hostNamePrefix	string		Deprecato.
properties.liveTraceConfiguration	LiveTraceConfiguration		Configurazione della traccia dinamica di una risorsa Microsoft.SignalRService.
properties.networkACLs	WebPubSubNetworkACLs		ACL di rete per la risorsa
properties.privateEndpointConnections	PrivateEndpointConnection[]		Connessioni endpoint privato alla risorsa.
properties.provisioningState	ProvisioningState		Stato di provisioning della risorsa.
properties.publicNetworkAccess	string	Enabled	Abilitare o disabilitare l'accesso alla rete pubblica. Il valore predefinito è "Abilitato". Quando è Abilitato, gli elenchi di controllo di accesso di rete sono ancora validi. Quando è Disabilitato, l'accesso alla rete pubblica viene sempre disabilitato indipendentemente dall'impostazione negli elenchi di controllo di accesso di rete.
properties.publicPort	integer		Porta accessibile pubblicamente della risorsa progettata per l'utilizzo lato browser/client.
properties.regionEndpointEnabled	string	Enabled	Abilitare o disabilitare l'endpoint a livello di area. Il valore predefinito è "Abilitato". Quando è Disabilitato, le nuove connessioni non verranno instradate a questo endpoint, ma le connessioni esistenti non saranno interessate. Questa proprietà è specifica della replica. Disabilitare l'endpoint a livello di area senza replica non è consentito.
properties.resourceLogConfiguration	ResourceLogConfiguration		Configurazione del log delle risorse di una risorsa Microsoft.SignalRService.
properties.resourceStopped	string	false	Arrestare o avviare la risorsa. Il valore predefinito è "False". Quando è vero, il piano dati della risorsa viene arrestato. Quando è false, viene avviato il piano dati della risorsa.
properties.serverPort	integer		Porta accessibile pubblicamente della risorsa progettata per l'utilizzo lato server del cliente.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Elenco di risorse di collegamento privato condiviso.
properties.socketIO	WebPubSubSocketIOSettings		Impostazioni socketIO per la risorsa
properties.tls	WebPubSubTlsSettings		Impostazioni TLS per la risorsa
properties.version	string		Versione della risorsa. Probabilmente è necessaria la stessa versione o successiva degli SDK client.
sku	ResourceSku		Informazioni di fatturazione della risorsa.
systemData	systemData		Azure Resource Manager metadati contenenti le informazioni createdBy e modifiedBy.
tags	object		Tag delle risorse.
type	string		Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

WebPubSubSkuTier

Enumeration

Livello facoltativo di questo SKU specifico. 'Standard' o 'Free'.

Basic è deprecato, usare Standard invece .

Valore	Descrizione
Basic
Free
Premium
Standard

WebPubSubSocketIOSettings

Object

Impostazioni socketIO per la risorsa

Nome	Tipo	Descrizione
serviceMode	string	Modalità di servizio di Web PubSub per Socket.IO. Valori consentiti: "Default": have your own backend Socket.IO server "Serverless": l'applicazione non ha un server back-end

WebPubSubTlsSettings

Object

Impostazioni TLS per la risorsa

Nome	Tipo	Valore predefinito	Descrizione
clientCertEnabled	boolean	False	Richiedere il certificato client durante l'handshake TLS, se abilitato. Non supportato per il livello gratuito. Qualsiasi input verrà ignorato per il livello gratuito.