Web Pub Sub - Update

Serviço:

Azure Web PubSub Service

Versão da API:

2024-03-01

Operação para atualizar um recurso de saída.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
resourceName	path	True	string	O nome do recurso. Padrão Regex: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$
subscriptionId	path	True	string uuid	O ID da subscrição de destino. O valor tem de ser um UUID.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
location	True	string	A localização geográfica onde o recurso se encontra
identity		ManagedIdentity	Uma classe representa identidades geridas utilizadas para pedido e resposta
kind		ServiceKind	O tipo de serviço
properties.disableAadAuth		boolean	DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.
properties.disableLocalAuth		boolean	DisableLocalAuth Ativar ou desativar a autenticação local com AccessKey Quando definida como verdadeira, a ligação com AccessKey=xxx não funcionará.
properties.liveTraceConfiguration		LiveTraceConfiguration	Configuração de rastreio dinâmico de um recurso Microsoft.SignalRService.
properties.networkACLs		WebPubSubNetworkACLs	ACLs de rede para o recurso
properties.publicNetworkAccess		string	Ativar ou desativar o acesso à rede pública. Predefinição para "Ativado". Quando estiver Ativado, as ACLs de rede ainda se aplicam. Quando está Desativado, o acesso à rede pública é sempre desativado independentemente do que definir em ACLs de rede.
properties.regionEndpointEnabled		string	Ative ou desative o ponto final regional. Predefinição para "Ativado". Quando estiver Desativado, as novas ligações não serão encaminhadas para este ponto final, no entanto, as ligações existentes não serão afetadas. Esta propriedade é específica da réplica. Não é permitido desativar o ponto final regional sem réplica.
properties.resourceLogConfiguration		ResourceLogConfiguration	Configuração do registo de recursos de um recurso Microsoft.SignalRService.
properties.resourceStopped		string	Pare ou inicie o recurso. Predefinição para "Falso". Quando é verdade, o plano de dados do recurso é encerrado. Quando for falso, o plano de dados do recurso é iniciado.
properties.socketIO		WebPubSubSocketIOSettings	Definições do SocketIO para o recurso
properties.tls		WebPubSubTlsSettings	Definições de TLS para o recurso
sku		ResourceSku	As informações de faturação do recurso.
tags		object	Etiquetas de recursos.

Respostas

Name	Tipo	Description
200 OK	WebPubSubResource	Com êxito. A resposta descreve um recurso.
202 Accepted		Aceite. A resposta indica que o recurso de saída está agora a atualizar e contém um cabeçalho localização para consultar o resultado da operação.. Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

WebPubSub_Update

Pedido de amostra

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

Resposta da amostra

Código de estado:

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

Código de estado:

202

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

Definições

Name	Description
ACLAction	Ação ACL de Rede do Azure.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
IPRule	Uma regra de IP
LiveTraceCategory	Configuração da categoria de rastreio dinâmico de um recurso Microsoft.SignalRService.
LiveTraceConfiguration	Configuração de rastreio em direto de um recurso Microsoft.SignalRService.
ManagedIdentity	Uma classe representa identidades geridas utilizadas para pedido e resposta
ManagedIdentityType	Representa o tipo de identidade: systemAssigned, userAssigned, None
NetworkACL	ACL de Rede
PrivateEndpoint	Ponto final privado
PrivateEndpointACL	ACL para um ponto final privado
PrivateEndpointConnection	Uma ligação de ponto final privado a um recurso do Azure
PrivateLinkServiceConnectionState	Estado de ligação da ligação de ponto final privado
PrivateLinkServiceConnectionStatus	Indica se a ligação foi Aprovada/Rejeitada/Removida pelo proprietário do serviço.
ProvisioningState	Estado de aprovisionamento do recurso.
ResourceLogCategory	Configuração da categoria de registo de recursos de um recurso Microsoft.SignalRService.
ResourceLogConfiguration	Configuração do registo de recursos de um recurso Microsoft.SignalRService.
ResourceSku	As informações de faturação do recurso.
ServiceKind	O tipo de serviço
SharedPrivateLinkResource	Descreve um Recurso de Private Link Partilhado
SharedPrivateLinkResourceStatus	Estado do recurso de ligação privada partilhado
systemData	Metadados relativos à criação e última modificação do recurso.
UserAssignedIdentityProperty	Propriedades da identidade atribuída pelo utilizador.
WebPubSubNetworkACLs	ACLs de rede para o recurso
WebPubSubRequestType	O tipo de pedido recebido para o serviço
WebPubSubResource	Uma classe representa um recurso.
WebPubSubSkuTier	Camada opcional deste SKU específico. "Standard" ou "Gratuito". Basic é preterido, utilize Standard em vez disso.
WebPubSubSocketIOSettings	Definições do SocketIO para o recurso
WebPubSubTlsSettings	Definições de TLS para o recurso

ACLAction

Ação ACL de Rede do Azure.

Name	Tipo	Description
Allow	string
Deny	string

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

IPRule

Uma regra de IP

Name	Tipo	Description
action	ACLAction	Ação ACL de Rede do Azure.
value	string	Um IP, CIDR ou ServiceTag

LiveTraceCategory

Configuração da categoria de rastreio dinâmico de um recurso Microsoft.SignalRService.

Name	Tipo	Description
enabled	string	Indica se ou a categoria de rastreio dinâmico está ativada. Valores disponíveis: verdadeiro, falso. Não sensível a maiúsculas e minúsculas
name	string	Obtém ou define o nome da categoria de rastreio dinâmico. Valores disponíveis: ConnectivityLogs, MessagingLogs. Não sensível a maiúsculas e minúsculas

LiveTraceConfiguration

Configuração de rastreio em direto de um recurso Microsoft.SignalRService.

Name	Tipo	Default value	Description
categories	LiveTraceCategory[]		Obtém ou define a lista de configurações de categorias.
enabled	string	false	Indica se ativa ou não o rastreio em direto. Quando estiver definido como verdadeiro, o cliente de rastreio em direto pode ligar-se ao serviço. Caso contrário, o cliente de rastreio dinâmico não consegue ligar-se ao serviço, pelo que não pode receber qualquer registo, independentemente do que configurar em "categorias". Valores disponíveis: true, false. Não sensível a maiúsculas e minúsculas

ManagedIdentity

Uma classe representa identidades geridas utilizadas para pedido e resposta

Name	Tipo	Description
principalId	string	Obtenha o ID principal da identidade atribuída pelo sistema. Só pode ser utilizado na resposta.
tenantId	string	Obtenha o ID do inquilino da identidade atribuída pelo sistema. Ser utilizado apenas na resposta
type	ManagedIdentityType	Representa o tipo de identidade: systemAssigned, userAssigned, None
userAssignedIdentities	<string,  UserAssignedIdentityProperty>	Obter ou definir as identidades atribuídas pelo utilizador

ManagedIdentityType

Representa o tipo de identidade: systemAssigned, userAssigned, None

Name	Tipo	Description
None	string
SystemAssigned	string
UserAssigned	string

NetworkACL

ACL de Rede

Name	Tipo	Description
allow	WebPubSubRequestType[]	Tipos de pedido permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Tipos de pedido negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpoint

Ponto final privado

Name	Tipo	Description
id	string	ID completamente qualificado do ponto final privado

PrivateEndpointACL

ACL para um ponto final privado

Name	Tipo	Description
allow	WebPubSubRequestType[]	Tipos de pedido permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Tipos de pedido negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI.
name	string	Nome da ligação de ponto final privado

PrivateEndpointConnection

Uma ligação de ponto final privado a um recurso do Azure

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.groupIds	string[]	IDs de Grupo
properties.privateEndpoint	PrivateEndpoint	Ponto final privado
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Estado de ligação da ligação do ponto final privado
properties.provisioningState	ProvisioningState	Estado de aprovisionamento do recurso.
systemData	systemData	O Azure Resource Manager metadados que contêm createdBy e modifiedBy information.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateLinkServiceConnectionState

Estado de ligação da ligação de ponto final privado

Name	Tipo	Description
actionsRequired	string	Uma mensagem a indicar se as alterações no fornecedor de serviços necessitam de atualizações no consumidor.
description	string	O motivo da aprovação/rejeição da ligação.
status	PrivateLinkServiceConnectionStatus	Indica se a ligação foi Aprovada/Rejeitada/Removida pelo proprietário do serviço.

PrivateLinkServiceConnectionStatus

Indica se a ligação foi Aprovada/Rejeitada/Removida pelo proprietário do serviço.

Name	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Estado de aprovisionamento do recurso.

Name	Tipo	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Moving	string
Running	string
Succeeded	string
Unknown	string
Updating	string

ResourceLogCategory

Configuração da categoria de registo de recursos de um recurso Microsoft.SignalRService.

Name	Tipo	Description
enabled	string	Indica se ou a categoria de registo de recursos está ativada. Valores disponíveis: verdadeiro, falso. Não sensível a maiúsculas e minúsculas
name	string	Obtém ou define o nome da categoria de registo de recursos. Valores disponíveis: ConnectivityLogs, MessagingLogs. Não sensível a maiúsculas e minúsculas

ResourceLogConfiguration

Configuração do registo de recursos de um recurso Microsoft.SignalRService.

Name	Tipo	Description
categories	ResourceLogCategory[]	Obtém ou define a lista de configurações de categorias.

ResourceSku

As informações de faturação do recurso.

Name	Tipo	Description
capacity	integer	Opcional, número inteiro. A contagem de unidades do recurso. 1 para Free_F1/Standard_S1/Premium_P1, 100 para Premium_P2 por predefinição. Se estiverem presentes, são permitidos os seguintes valores: 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	Não utilizado. Retido para utilização futura.
name	string	O nome do SKU. Obrigatório. Valores permitidos: Standard_S1, Free_F1, Premium_P1 Premium_P2
size	string	Não utilizado. Retido para utilização futura.
tier	WebPubSubSkuTier	Camada opcional deste SKU específico. "Standard" ou "Gratuito". Basic foi preterido, utilize Standard em vez disso.

ServiceKind

O tipo de serviço

Name	Tipo	Description
SocketIO	string
WebPubSub	string

SharedPrivateLinkResource

Descreve um Recurso de Private Link Partilhado

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.groupId	string	O ID de grupo do fornecedor do recurso para o qual o recurso de ligação privada partilhada se destina
properties.privateLinkResourceId	string	O ID de recurso do recurso para o recurso de ligação privada partilhada destina-se a
properties.provisioningState	ProvisioningState	Estado de aprovisionamento do recurso.
properties.requestMessage	string	A mensagem de pedido para pedir a aprovação do recurso de ligação privada partilhada
properties.status	SharedPrivateLinkResourceStatus	Estado do recurso de ligação privada partilhado
systemData	systemData	O Azure Resource Manager metadados que contêm createdBy e modifiedBy information.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceStatus

Estado do recurso de ligação privada partilhado

Name	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string
Timeout	string

systemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentityProperty

Propriedades da identidade atribuída pelo utilizador.

Name	Tipo	Description
clientId	string	Obter o ID do cliente para a identidade atribuída pelo utilizador
principalId	string	Obter o ID principal da identidade atribuída pelo utilizador

WebPubSubNetworkACLs

ACLs de rede para o recurso

Name	Tipo	Description
defaultAction	ACLAction	Ação da ACL de Rede do Azure.
ipRules	IPRule[]	Regras de IP para filtrar o tráfego público
privateEndpoints	PrivateEndpointACL[]	ACLs para pedidos de pontos finais privados
publicNetwork	NetworkACL	ACL de Rede

WebPubSubRequestType

O tipo de pedido recebido para o serviço

Name	Tipo	Description
ClientConnection	string
RESTAPI	string
ServerConnection	string
Trace	string

WebPubSubResource

Uma classe representa um recurso.

Name	Tipo	Default value	Description
id	string		ID de recurso completamente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedIdentity		Uma classe representa identidades geridas utilizadas para pedido e resposta
kind	ServiceKind		O tipo de serviço
location	string		A localização geográfica onde o recurso se encontra
name	string		O nome do recurso
properties.disableAadAuth	boolean	False	DisableLocalAuth Ativar ou desativar a autenticação de aad Quando definida como verdadeira, a ligação com AuthType=aad não funcionará.
properties.disableLocalAuth	boolean	False	DisableLocalAuth Ativar ou desativar a autenticação local com AccessKey Quando definido como verdadeiro, a ligação com AccessKey=xxx não funcionará.
properties.externalIP	string		O IP acessível publicamente do recurso.
properties.hostName	string		FQDN da instância de serviço.
properties.hostNamePrefix	string		Preterido.
properties.liveTraceConfiguration	LiveTraceConfiguration		Configuração de rastreio em direto de um recurso Microsoft.SignalRService.
properties.networkACLs	WebPubSubNetworkACLs		ACLs de rede para o recurso
properties.privateEndpointConnections	PrivateEndpointConnection[]		Ligações de ponto final privado ao recurso.
properties.provisioningState	ProvisioningState		Estado de aprovisionamento do recurso.
properties.publicNetworkAccess	string	Enabled	Ativar ou desativar o acesso à rede pública. A predefinição é "Ativado". Quando estiver Ativado, as ACLs de rede continuam a ser aplicadas. Quando está Desativado, o acesso à rede pública é sempre desativado independentemente do que definir nas ACLs de rede.
properties.publicPort	integer		A porta acessível publicamente do recurso que foi concebida para utilização do lado do browser/cliente.
properties.regionEndpointEnabled	string	Enabled	Ativar ou desativar o ponto final regional. A predefinição é "Ativado". Quando estiver Desativado, as novas ligações não serão encaminhadas para este ponto final, no entanto, as ligações existentes não serão afetadas. Esta propriedade é específica da réplica. Não é permitido desativar o ponto final regional sem réplica.
properties.resourceLogConfiguration	ResourceLogConfiguration		Configuração do registo de recursos de um recurso Microsoft.SignalRService.
properties.resourceStopped	string	false	Pare ou inicie o recurso. Predefinição para "Falso". Quando é verdade, o plano de dados do recurso é encerrado. Quando for falso, o plano de dados do recurso é iniciado.
properties.serverPort	integer		A porta acessível publicamente do recurso que foi concebida para utilização do lado do servidor do cliente.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		A lista de recursos de ligação privada partilhados.
properties.socketIO	WebPubSubSocketIOSettings		Definições do SocketIO para o recurso
properties.tls	WebPubSubTlsSettings		Definições de TLS para o recurso
properties.version	string		Versão do recurso. Provavelmente, precisa da mesma versão ou versão superior dos SDKs de cliente.
sku	ResourceSku		As informações de faturação do recurso.
systemData	systemData		O Azure Resource Manager metadados que contêm informações createdBy e modifiedBy.
tags	object		Etiquetas de recursos.
type	string		O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

WebPubSubSkuTier

Camada opcional deste SKU específico. "Standard" ou "Gratuito".

Basic é preterido, utilize Standard em vez disso.

Name	Tipo	Description
Basic	string
Free	string
Premium	string
Standard	string

WebPubSubSocketIOSettings

Definições do SocketIO para o recurso

Name	Tipo	Description
serviceMode	string	O modo de serviço do Web PubSub para Socket.IO. Valores permitidos: "Predefinição": tenha o seu próprio servidor de back-end Socket.IO "Sem servidor": a sua aplicação não tem um servidor de back-end

WebPubSubTlsSettings

Definições de TLS para o recurso

Name	Tipo	Default value	Description
clientCertEnabled	boolean	False	Peça o certificado de cliente durante o handshake TLS, se estiver ativado. Não suportado para o escalão gratuito. Qualquer entrada será ignorada para o escalão gratuito.