Compartir a través de

Web Pub Sub - Get

  • Referencia
Service:
Azure Web PubSub Service
API Version:
2024-03-01

Obtenga el recurso y sus propiedades.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
resourceGroupName
 path True

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
resourceName
 path True

string

Nombre del recurso.

Regex pattern: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$
subscriptionId
 path True

string

uuid

Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version
 query True

string

Versión de API que se usará para la operación.

Respuestas

Nombre Tipo Description
200 OK

WebPubSubResource

Correcto. La respuesta describe el recurso correspondiente.
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_Get

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SignalRService/webPubSub/myWebPubSubService?api-version=2024-03-01

Sample Response

Status code:
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"
  }
}

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
IPRule

Una regla de IP
LiveTraceCategory

Configuración de la categoría 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 del 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.
ServiceKind

El tipo de servicio
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.
WebPubSubSkuTier

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

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

Configuración de SocketIO para el recurso
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.

IPRule

Una regla de IP

Nombre Tipo Description
action

ACLAction

Acción de ACL de redes de Azure.
value

string

Ip, CIDR o ServiceTag

LiveTraceCategory

Configuración de la categoría 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 del 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 del recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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 del punto de conexión privado
properties.provisioningState

ProvisioningState

Estado de aprovisionamiento del recurso.
systemData

systemData

Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.
type

string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateLinkServiceConnectionState

Estado de conexión de la conexión del 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

Entero opcional. Recuento de unidades del recurso. 1 para Free_F1/Standard_S1/Premium_P1, 100 para Premium_P2 de forma predeterminada.

Si está presente, se permiten los siguientes 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

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, Premium_P2
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.

ServiceKind

El tipo de servicio

Nombre Tipo Description
SocketIO

string

WebPubSub

string

SharedPrivateLinkResource

Describe un recurso de Private Link compartido

Nombre Tipo Description
id

string

Identificador de recurso completo del recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

Nombre del recurso.
properties.groupId

string

El identificador de grupo del proveedor del recurso para el recurso de vínculo privado compartido es para
properties.privateLinkResourceId

string

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 de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.
type

string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

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 de 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.
ipRules

IPRule[]

Reglas ip para filtrar el tráfico público
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 del recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity

ManagedIdentity

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

ServiceKind

El tipo de servicio
location

string

Ubicación geográfica donde reside el recurso
name

string

Nombre del recurso.
properties.disableAadAuth

boolean

False

DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.
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 accesible públicamente 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 del explorador o cliente.
properties.regionEndpointEnabled

string

Enabled

Habilite o deshabilite el punto de conexión regional. El valor predeterminado es "Habilitado". Cuando se trata de Deshabilitado, las nuevas conexiones no se enrutarán a este punto de conexión, pero las conexiones existentes no se verán afectadas. Esta propiedad es específica de la réplica. No se permite deshabilitar el punto de conexión regional sin réplica.
properties.resourceLogConfiguration

ResourceLogConfiguration

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

string

false

Detenga o inicie el recurso. El valor predeterminado es "False". Cuando es true, el plano de datos del recurso se cierra. Cuando es false, se inicia el plano de datos del recurso.
properties.serverPort

integer

Puerto accesible públicamente del recurso que está diseñado para el uso del lado servidor del cliente.
properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

Lista de recursos de vínculo privado compartidos.
properties.socketIO

WebPubSubSocketIOSettings

Configuración de SocketIO para el recurso
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 de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.
tags

object

Etiquetas del recurso.
type

string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

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

WebPubSubSocketIOSettings

Configuración de SocketIO para el recurso

Nombre Tipo Description
serviceMode

string

Modo de servicio de Web PubSub para Socket.IO. Valores permitidos: "Default": have your own backend Socket.IO server "Serverless": la aplicación no tiene un servidor back-end

WebPubSubTlsSettings

Configuración de TLS para el recurso

Nombre Tipo Valor predeterminado Description
clientCertEnabled

boolean

False

Solicite el certificado de cliente durante el protocolo de enlace TLS si está habilitado. No se admite para el nivel gratis. Cualquier entrada se omitirá para el nivel gratis.