Web Pub Sub - List By Subscription

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=2021-10-01

Parámetros de identificador URI

Name In Required Type 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

Name Type Description
200 OK

Correcto. La respuesta describe la lista de recursos de la suscripción.

Other Status Codes

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation suplantar la 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=2021-10-01

Sample Response

{
  "value": [
    {
      "sku": {
        "name": "Standard_S1",
        "tier": "Standard",
        "size": "S1",
        "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

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

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.

Name Type Description
Allow
  • string
Deny
  • string

createdByType

Tipo de identidad que creó el recurso.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorAdditionalInfo

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

Name Type Description
info
  • object

Información adicional.

type
  • string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Name Type Description
additionalInfo

Información adicional del error.

code
  • string

Código de error.

details

Los detalles del error.

message
  • string

El mensaje de error.

target
  • string

Destino del error.

ErrorResponse

Respuesta de error

Name Type Description
error

Objeto de error.

LiveTraceCategory

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

Name Type 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.

Name Type Default Value Description
categories

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.

Name Type 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

Representa el tipo de identidad: systemAssigned, userAssigned, None

userAssignedIdentities

Obtener o establecer las identidades asignadas por el usuario

ManagedIdentityType

Representa el tipo de identidad: systemAssigned, userAssigned, None

Name Type Description
None
  • string
SystemAssigned
  • string
UserAssigned
  • string

NetworkACL

ACL de red

Name Type Description
allow
  • string[]

Tipos de solicitud permitidos. El valor puede ser uno o varios de: ClientConnection, ServerConnection, RESTAPI.

deny
  • string[]

Tipos de solicitud denegados. El valor puede ser uno o varios de: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpoint

Punto de conexión privado

Name Type Description
id
  • string

Identificador completo del punto de conexión privado

PrivateEndpointACL

ACL para un punto de conexión privado

Name Type Description
allow
  • string[]

Tipos de solicitud permitidos. El valor puede ser uno o varios de: ClientConnection, ServerConnection, RESTAPI.

deny
  • string[]

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

Name Type Description
id
  • string

Identificador de recurso completo para el recurso.

name
  • string

Nombre del recurso.

properties.groupIds
  • string[]

Identificadores de grupo

properties.privateEndpoint

Punto de conexión privado

properties.privateLinkServiceConnectionState

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

properties.provisioningState

Estado de aprovisionamiento del recurso.

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

Name Type 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

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.

Name Type Description
Approved
  • string
Disconnected
  • string
Pending
  • string
Rejected
  • string

ProvisioningState

Estado de aprovisionamiento del recurso.

Name Type 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.

Name Type 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.

Name Type Description
categories

Obtiene o establece la lista de configuraciones de categoría.

ResourceSku

Información de facturación del recurso.

Name Type 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,5,10,20,50,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

size
  • string

No se usa. Se conserva para su uso futuro.

tier

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

Name Type 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

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

Estado del recurso de vínculo privado compartido

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

Name Type 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.

Name Type Description
createdAt
  • string

Marca de tiempo de creación de recursos (UTC).

createdBy
  • string

Identidad que creó el recurso.

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

Tipo de identidad que modificó por última vez el recurso.

UserAssignedIdentityProperty

Propiedades de la identidad asignada por el usuario.

Name Type 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

Name Type Description
defaultAction

Acción de ACL de redes de Azure.

privateEndpoints

ACL para solicitudes de puntos de conexión privados

publicNetwork

ACL de red

WebPubSubResource

Una clase representa un recurso.

Name Type Default Value Description
id
  • string

Identificador de recurso completo para el recurso.

identity

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

En desuso.

properties.liveTraceConfiguration

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

properties.networkACLs

ACL de red para el recurso

properties.privateEndpointConnections

Conexiones de punto de conexión privado al recurso.

properties.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

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

Lista de recursos de vínculo privado compartido.

properties.tls

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

Información de facturación del recurso.

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.

Name Type 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

Lista de los recursos

WebPubSubSkuTier

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

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

Name Type Description
Basic
  • string
Free
  • string
Premium
  • string
Standard
  • string

WebPubSubTlsSettings

Configuración de TLS para el recurso

Name Type Default Value Description
clientCertEnabled
  • boolean
True

Solicitar certificado de cliente durante el protocolo de enlace TLS si está habilitado