Web Pub Sub - List By Subscription

Referencia

Service:: Azure Web PubSub Service

API Version:: 2023-02-01

Controla las solicitudes para enumerar todos los recursos de una suscripción.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/webPubSub?api-version=2023-02-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Obtiene el identificador de suscripción que identifica de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de api de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	WebPubSubResourceList	Correcto. La respuesta describe la lista de recursos de la suscripción.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

WebPubSub_ListBySubscription

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/webPubSub?api-version=2023-02-01

/** Samples for WebPubSub List. */
public final class Main {
    /*
     * x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/WebPubSub_ListBySubscription.json
     */
    /**
     * Sample code: WebPubSub_ListBySubscription.
     *
     * @param manager Entry point to WebPubSubManager.
     */
    public static void webPubSubListBySubscription(com.azure.resourcemanager.webpubsub.WebPubSubManager manager) {
        manager.webPubSubs().list(com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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_list_by_subscription.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.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/WebPubSub_ListBySubscription.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

package armwebpubsub_test

import (
	"context"
	"log"

	"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/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/WebPubSub_ListBySubscription.json
func ExampleClient_NewListBySubscriptionPager() {
	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)
	}
	pager := clientFactory.NewClient().NewListBySubscriptionPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ResourceInfoList = armwebpubsub.ResourceInfoList{
		// 	Value: []*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"),
		// 			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"),
		// 			},
		// 			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),
		// 					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"),
		// 								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),
		// 								},
		// 								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),
		// 								},
		// 						}},
		// 						ProvisioningState: to.Ptr(armwebpubsub.ProvisioningStateSucceeded),
		// 						PublicNetworkAccess: to.Ptr("Enabled"),
		// 						PublicPort: to.Ptr[int32](443),
		// 						ResourceLogConfiguration: &armwebpubsub.ResourceLogConfiguration{
		// 							Categories: []*armwebpubsub.ResourceLogCategory{
		// 								{
		// 									Name: to.Ptr("ConnectivityLogs"),
		// 									Enabled: to.Ptr("true"),
		// 							}},
		// 						},
		// 						ServerPort: to.Ptr[int32](443),
		// 						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),
		// 					},
		// 					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),
		// 					},
		// 			}},
		// 		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

/**
 * This sample demonstrates how to Handles requests to list all resources in a subscription.
 *
 * @summary Handles requests to list all resources in a subscription.
 * x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/WebPubSub_ListBySubscription.json
 */
async function webPubSubListBySubscription() {
  const subscriptionId =
    process.env["WEB-PUBSUB_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new WebPubSubManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.webPubSub.listBySubscription()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "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": [
          {
            "systemData": {
              "createdBy": "string",
              "createdByType": "User",
              "createdAt": "2015-02-03T04:05:06Z",
              "lastModifiedBy": "string",
              "lastModifiedByType": "User",
              "lastModifiedAt": "2015-02-03T04:05:06Z"
            },
            "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"
          }
        ],
        "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"
              ]
            }
          ]
        },
        "publicNetworkAccess": "Enabled",
        "disableLocalAuth": false,
        "disableAadAuth": false
      },
      "identity": {
        "type": "SystemAssigned",
        "principalId": "00000000-0000-0000-0000-000000000000",
        "tenantId": "00000000-0000-0000-0000-000000000000"
      },
      "systemData": {
        "createdBy": "string",
        "createdByType": "User",
        "createdAt": "2015-02-03T04:05:06Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2015-02-03T04:05:06Z"
      },
      "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"
    }
  ]
}

Definiciones

Nombre	Description
ACLAction	Acción de ACL de redes de Azure.
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
LiveTraceCategory	Configuración de categoría de seguimiento activo de un recurso Microsoft.SignalRService.
LiveTraceConfiguration	Configuración de seguimiento activo de un recurso Microsoft.SignalRService.
ManagedIdentity	Una clase representa las identidades administradas usadas para la solicitud y la respuesta.
ManagedIdentityType	Representa el tipo de identidad: systemAssigned, userAssigned, None
NetworkACL	ACL de red
PrivateEndpoint	Punto de conexión privado
PrivateEndpointACL	ACL para un punto de conexión privado
PrivateEndpointConnection	Una conexión de punto de conexión privado a un recurso de Azure
PrivateLinkServiceConnectionState	Estado de conexión de la conexión de punto de conexión privado
PrivateLinkServiceConnectionStatus	Indica si el propietario del servicio ha aprobado, rechazado o quitado la conexión.
ProvisioningState	Estado de aprovisionamiento del recurso.
ResourceLogCategory	Configuración de categoría de registro de recursos de un recurso Microsoft.SignalRService.
ResourceLogConfiguration	Configuración del registro de recursos de un recurso Microsoft.SignalRService.
ResourceSku	Información de facturación del recurso.
SharedPrivateLinkResource	Describe un recurso de Private Link compartido
SharedPrivateLinkResourceStatus	Estado del recurso de vínculo privado compartido
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
UserAssignedIdentityProperty	Propiedades de la identidad asignada por el usuario.
WebPubSubNetworkACLs	ACL de red para el recurso
WebPubSubRequestType	El tipo de solicitud entrante al servicio
WebPubSubResource	Una clase representa un recurso.
WebPubSubResourceList	Objeto que incluye una matriz de recursos y un posible vínculo para el siguiente conjunto.
WebPubSubSkuTier	Nivel opcional de esta SKU determinada. 'Estándar' o 'Gratis'. `Basic` está en desuso, use `Standard` en su lugar.
WebPubSubTlsSettings	Configuración de TLS para el recurso

ACLAction

Acción de ACL de redes de Azure.

Nombre	Tipo	Description
Allow	string
Deny	string

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

LiveTraceCategory

Configuración de categoría de seguimiento activo de un recurso Microsoft.SignalRService.

Nombre	Tipo	Description
enabled	string	Indica si o la categoría de seguimiento activo está habilitada. Valores disponibles: true, false. No hay distinción de mayúsculas y minúsculas.
name	string	Obtiene o establece el nombre de la categoría de seguimiento activo. Valores disponibles: ConnectivityLogs, MessagingLogs. No hay distinción de mayúsculas y minúsculas.

LiveTraceConfiguration

Configuración de seguimiento activo de un recurso Microsoft.SignalRService.

Nombre	Tipo	Valor predeterminado	Description
categories	LiveTraceCategory[]		Obtiene o establece la lista de configuraciones de categoría.
enabled	string	false	Indica si habilita o no el seguimiento activo. Cuando se establece en true, el cliente de seguimiento activo puede conectarse al servicio. De lo contrario, el cliente de seguimiento activo no puede conectarse al servicio, de modo que no pueda recibir ningún registro, independientemente de lo que configure en "categorías". Valores disponibles: true, false. No hay distinción de mayúsculas y minúsculas.

ManagedIdentity

Una clase representa las identidades administradas usadas para la solicitud y la respuesta.

Nombre	Tipo	Description
principalId	string	Obtenga el identificador de entidad de seguridad de la identidad asignada por el sistema. Solo se usará en respuesta.
tenantId	string	Obtenga el identificador de inquilino de la identidad asignada por el sistema. Solo se usa en respuesta
type	ManagedIdentityType	Representa el tipo de identidad: systemAssigned, userAssigned, None
userAssignedIdentities	<string, UserAssignedIdentityProperty>	Obtener o establecer las identidades asignadas por el usuario

ManagedIdentityType

Representa el tipo de identidad: systemAssigned, userAssigned, None

Nombre	Tipo	Description
None	string
SystemAssigned	string
UserAssigned	string

NetworkACL

ACL de red

Nombre	Tipo	Description
allow	WebPubSubRequestType[]	Tipos de solicitud permitidos. El valor puede ser uno o varios de: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Tipos de solicitud denegados. El valor puede ser uno o varios de: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpoint

Punto de conexión privado

Nombre	Tipo	Description
id	string	Identificador completo del punto de conexión privado

PrivateEndpointACL

ACL para un punto de conexión privado

Nombre	Tipo	Description
allow	WebPubSubRequestType[]	Tipos de solicitud permitidos. El valor puede ser uno o varios de: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Tipos de solicitud denegados. El valor puede ser uno o varios de: ClientConnection, ServerConnection, RESTAPI.
name	string	Nombre de la conexión de punto de conexión privado

PrivateEndpointConnection

Una conexión de punto de conexión privado a un recurso de Azure

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso.
name	string	Nombre del recurso.
properties.groupIds	string[]	Identificadores de grupo
properties.privateEndpoint	PrivateEndpoint	Punto de conexión privado
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Estado de conexión de la conexión de punto de conexión privado
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso.
systemData	systemData	Metadatos relacionados con la creación y la última modificación del recurso.
type	string	Tipo del recurso, por ejemplo, "Microsoft.SignalRService/SignalR"

PrivateLinkServiceConnectionState

Estado de conexión de la conexión de punto de conexión privado

Nombre	Tipo	Description
actionsRequired	string	Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.
description	string	Motivo de aprobación o rechazo de la conexión.
status	PrivateLinkServiceConnectionStatus	Indica si el propietario del servicio ha aprobado, rechazado o quitado la conexión.

PrivateLinkServiceConnectionStatus

Indica si el propietario del servicio ha aprobado, rechazado o quitado la conexión.

Nombre	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Estado de aprovisionamiento del recurso.

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

ResourceLogCategory

Configuración de categoría de registro de recursos de un recurso Microsoft.SignalRService.

Nombre	Tipo	Description
enabled	string	Indica si o la categoría de registro de recursos está habilitada. Valores disponibles: true, false. No hay distinción de mayúsculas y minúsculas.
name	string	Obtiene o establece el nombre de la categoría del registro de recursos. Valores disponibles: ConnectivityLogs, MessagingLogs. No hay distinción de mayúsculas y minúsculas.

ResourceLogConfiguration

Configuración del registro de recursos de un recurso Microsoft.SignalRService.

Nombre	Tipo	Description
categories	ResourceLogCategory[]	Obtiene o establece la lista de configuraciones de categoría.

ResourceSku

Información de facturación del recurso.

Nombre	Tipo	Description
capacity	integer	Opcional, entero. Recuento de unidades del recurso. 1 de forma predeterminada. Si está presente, se permiten los siguientes valores: Gratis: 1; Estándar: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;
family	string	No se usa. Se conserva para su uso futuro.
name	string	El nombre de la SKU. Necesario. Valores permitidos: Standard_S1, Free_F1, Premium_P1
size	string	No se usa. Se conserva para su uso futuro.
tier	WebPubSubSkuTier	Nivel opcional de esta SKU determinada. 'Estándar' o 'Gratis'. `Basic` está en desuso, use `Standard` en su lugar.

SharedPrivateLinkResource

Describe un recurso de Private Link compartido

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso.
name	string	Nombre del recurso.
properties.groupId	string	El identificador de grupo del proveedor de recursos para el recurso de vínculo privado compartido es para .
properties.privateLinkResourceId	string	El identificador de recurso del recurso para el que está el recurso de vínculo privado compartido.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso.
properties.requestMessage	string	Mensaje de solicitud para solicitar la aprobación del recurso de vínculo privado compartido.
properties.status	SharedPrivateLinkResourceStatus	Estado del recurso de vínculo privado compartido
systemData	systemData	Metadatos relacionados con la creación y la última modificación del recurso.
type	string	Tipo del recurso, por ejemplo, "Microsoft.SignalRService/SignalR"

SharedPrivateLinkResourceStatus

Estado del recurso de vínculo privado compartido

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

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

UserAssignedIdentityProperty

Propiedades de la identidad asignada por el usuario.

Nombre	Tipo	Description
clientId	string	Obtención del identificador de cliente para la identidad asignada por el usuario
principalId	string	Obtención del identificador de entidad de seguridad para la identidad asignada por el usuario

WebPubSubNetworkACLs

ACL de red para el recurso

Nombre	Tipo	Description
defaultAction	ACLAction	Acción de ACL de redes de Azure.
privateEndpoints	PrivateEndpointACL[]	ACL para solicitudes de puntos de conexión privados
publicNetwork	NetworkACL	ACL de red

WebPubSubRequestType

El tipo de solicitud entrante al servicio

Nombre	Tipo	Description
ClientConnection	string
RESTAPI	string
ServerConnection	string
Trace	string

WebPubSubResource

Una clase representa un recurso.

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador de recurso completo para el recurso.
identity	ManagedIdentity		Una clase representa las identidades administradas usadas para la solicitud y la respuesta.
location	string		Ubicación GEOGRÁFICA del recurso. Por ejemplo, Oeste de EE. UU. \| Este de EE. UU. \| Centro-norte de EE. UU. \| Centro-sur de EE. UU.
name	string		Nombre del recurso.
properties.disableAadAuth	boolean	False	DisableLocalAuth Habilitar o deshabilitar la autenticación de aad Cuando se establece como true, la conexión con AuthType=aad no funcionará.
properties.disableLocalAuth	boolean	False	DisableLocalAuth Habilitar o deshabilitar la autenticación local con AccessKey Cuando se establece como true, la conexión con AccessKey=xxx no funcionará.
properties.externalIP	string		Dirección IP de acceso público del recurso.
properties.hostName	string		FQDN de la instancia de servicio.
properties.hostNamePrefix	string		Desusado.
properties.liveTraceConfiguration	LiveTraceConfiguration		Configuración de seguimiento activo de un recurso Microsoft.SignalRService.
properties.networkACLs	WebPubSubNetworkACLs		ACL de red para el recurso
properties.privateEndpointConnections	PrivateEndpointConnection[]		Conexiones de punto de conexión privado al recurso.
properties.provisioningState	ProvisioningState		Estado de aprovisionamiento del recurso.
properties.publicNetworkAccess	string	Enabled	Habilite o deshabilite el acceso a la red pública. El valor predeterminado es "Habilitado". Cuando está habilitado, se siguen aplicando las ACL de red. Cuando está deshabilitado, el acceso a la red pública siempre está deshabilitado independientemente de lo que establezca en las ACL de red.
properties.publicPort	integer		Puerto accesible públicamente del recurso que está diseñado para el uso del lado cliente o del explorador.
properties.resourceLogConfiguration	ResourceLogConfiguration		Configuración del registro de recursos de un recurso Microsoft.SignalRService.
properties.serverPort	integer		Puerto accesible públicamente del recurso que está diseñado para el uso del lado del servidor del cliente.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Lista de recursos de vínculo privado compartido.
properties.tls	WebPubSubTlsSettings		Configuración de TLS para el recurso
properties.version	string		Versión del recurso. Probablemente necesite la misma versión o posterior de los SDK de cliente.
sku	ResourceSku		Información de facturación del recurso.
systemData	systemData		Metadatos relacionados con la creación y la última modificación del recurso.
tags	object		Etiquetas del servicio que es una lista de pares clave-valor que describen el recurso.
type	string		Tipo del recurso, por ejemplo, "Microsoft.SignalRService/SignalR"

WebPubSubResourceList

Objeto que incluye una matriz de recursos y un posible vínculo para el siguiente conjunto.

Nombre	Tipo	Description
nextLink	string	La dirección URL que el cliente debe usar para capturar la página siguiente (por paginación del lado servidor). Es null por ahora, agregado para su uso futuro.
value	WebPubSubResource[]	Lista de los recursos

WebPubSubSkuTier

Nivel opcional de esta SKU determinada. 'Estándar' o 'Gratis'.

Basic está en desuso, use Standard en su lugar.

Nombre	Tipo	Description
Basic	string
Free	string
Premium	string
Standard	string

WebPubSubTlsSettings

Configuración de TLS para el recurso

Nombre	Tipo	Valor predeterminado	Description
clientCertEnabled	boolean	True	Solicitar certificado de cliente durante el protocolo de enlace TLS si está habilitado

Web Pub Sub - List By Subscription

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

WebPubSub_ListBySubscription

Sample Request

Sample Response

Definiciones

ACLAction

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LiveTraceCategory

LiveTraceConfiguration

ManagedIdentity

ManagedIdentityType

NetworkACL

PrivateEndpoint

PrivateEndpointACL

PrivateEndpointConnection

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningState

ResourceLogCategory

ResourceLogConfiguration

ResourceSku

SharedPrivateLinkResource

SharedPrivateLinkResourceStatus

systemData

UserAssignedIdentityProperty

WebPubSubNetworkACLs

WebPubSubRequestType

WebPubSubResource

WebPubSubResourceList

WebPubSubSkuTier

WebPubSubTlsSettings

Recursos adicionales