Compartilhar via

Web Pub Sub - Get

  • Referência
Serviço:
Azure Web PubSub Service
Versão da API:
2024-03-01

Obtenha o recurso e suas propriedades.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
 path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de 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

A ID da assinatura de destino. O valor deve ser um UUID.
api-version
 query True

string

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

WebPubSubResource

Êxito. A resposta descreve o recurso correspondente.
Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

WebPubSub_Get

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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"
  }
}

Definições

Nome Description
ACLAction

Ação de ACL de Rede do Azure.
createdByType

O tipo de identidade que criou o recurso.
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
IPRule

Uma regra de IP
LiveTraceCategory

Configuração de categoria de rastreamento dinâmico de um recurso Microsoft.SignalRService.
LiveTraceConfiguration

Configuração de rastreamento ao vivo de um recurso Microsoft.SignalRService.
ManagedIdentity

Uma classe representa identidades gerenciadas usadas para solicitação e resposta
ManagedIdentityType

Representa o tipo de identidade: systemAssigned, userAssigned, None
NetworkACL

Rede ACL
PrivateEndpoint

Ponto de extremidade privado
PrivateEndpointACL

ACL para um ponto de extremidade privado
PrivateEndpointConnection

Uma conexão de ponto de extremidade privado com um recurso do Azure
PrivateLinkServiceConnectionState

Estado de conexão da conexão de ponto de extremidade privado
PrivateLinkServiceConnectionStatus

Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço.
ProvisioningState

Estado de provisionamento do recurso.
ResourceLogCategory

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

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

As informações de cobrança do recurso.
ServiceKind

O tipo de serviço
SharedPrivateLinkResource

Descreve um recurso de Link Privado compartilhado
SharedPrivateLinkResourceStatus

Status do recurso de link privado compartilhado
systemData

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

Propriedades da identidade atribuída pelo usuário.
WebPubSubNetworkACLs

ACLs de rede para o recurso
WebPubSubRequestType

O tipo de solicitação de entrada para o serviço
WebPubSubResource

Uma classe representa um recurso.
WebPubSubSkuTier

Camada opcional desse SKU específico. 'Standard' ou 'Free'.

Basic é preterido, use Standard em vez disso.
WebPubSubSocketIOSettings

Configurações do SocketIO para o recurso
WebPubSubTlsSettings

Configurações de TLS para o recurso

ACLAction

Enumeration

Ação de ACL de Rede do Azure.

Valor Description
Allow
Deny

createdByType

Enumeration

O tipo de identidade que criou o recurso.

Valor Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Nome 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

Object

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

IPRule

Object

Uma regra de IP

Nome Tipo Description
action

ACLAction

Ação de ACL de Rede do Azure.
value

string

Um IP ou CIDR ou ServiceTag

LiveTraceCategory

Object

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

Nome Tipo Description
enabled

string

Indica se ou a categoria de rastreamento dinâmico está habilitada. Valores disponíveis: true, false. Não diferencia maiúsculas de minúsculas.
name

string

Obtém ou define o nome da categoria de rastreamento dinâmico. Valores disponíveis: ConnectivityLogs, MessagingLogs. Não diferencia maiúsculas de minúsculas.

LiveTraceConfiguration

Object

Configuração de rastreamento ao vivo de um recurso Microsoft.SignalRService.

Nome Tipo Valor padrão Description
categories

LiveTraceCategory[]

Obtém ou define a lista de configurações de categoria.
enabled

string

false

Indica se o rastreamento dinâmico é habilitado ou não. Quando definido como true, o cliente de rastreamento dinâmico pode se conectar ao serviço. Caso contrário, o cliente de rastreamento dinâmico não poderá se conectar ao serviço, para que você não possa receber nenhum log, independentemente do que você configurar em "categorias". Valores disponíveis: true, false. Não diferencia maiúsculas de minúsculas.

ManagedIdentity

Object

Uma classe representa identidades gerenciadas usadas para solicitação e resposta

Nome Tipo Description
principalId

string

Obtenha a ID da entidade de segurança para a identidade atribuída pelo sistema. Somente ser usado em resposta.
tenantId

string

Obtenha a ID do locatário para a identidade atribuída pelo sistema. Somente ser usado em resposta
type

ManagedIdentityType

Representa o tipo de identidade: systemAssigned, userAssigned, None
userAssignedIdentities

<string,  UserAssignedIdentityProperty>

Obter ou definir as identidades atribuídas pelo usuário

ManagedIdentityType

Enumeration

Representa o tipo de identidade: systemAssigned, userAssigned, None

Valor Description
None
SystemAssigned
UserAssigned

NetworkACL

Object

Rede ACL

Nome Tipo Description
allow

WebPubSubRequestType[]

Tipos de solicitação permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI.
deny

WebPubSubRequestType[]

Tipos de solicitação negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpoint

Object

Ponto de extremidade privado

Nome Tipo Description
id

string

ID qualificada completa do ponto de extremidade privado

PrivateEndpointACL

Object

ACL para um ponto de extremidade privado

Nome Tipo Description
allow

WebPubSubRequestType[]

Tipos de solicitação permitidos. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI.
deny

WebPubSubRequestType[]

Tipos de solicitação negados. O valor pode ser um ou mais de: ClientConnection, ServerConnection, RESTAPI.
name

string

Nome da conexão de ponto de extremidade privado

PrivateEndpointConnection

Object

Uma conexão de ponto de extremidade privado com um recurso do Azure

Nome Tipo Description
id

string

ID de recurso totalmente qualificada 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 de extremidade privado
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Estado de conexão da conexão de ponto de extremidade privado
properties.provisioningState

ProvisioningState

Estado de provisionamento do recurso.
systemData

systemData

Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.
type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateLinkServiceConnectionState

Object

Estado de conexão da conexão de ponto de extremidade privado

Nome Tipo Description
actionsRequired

string

Uma mensagem indicando se as alterações no provedor de serviços exigem atualizações no consumidor.
description

string

O motivo da aprovação/rejeição da conexão.
status

PrivateLinkServiceConnectionStatus

Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço.

PrivateLinkServiceConnectionStatus

Enumeration

Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço.

Valor Description
Approved
Disconnected
Pending
Rejected

ProvisioningState

Enumeration

Estado de provisionamento do recurso.

Valor Description
Canceled
Creating
Deleting
Failed
Moving
Running
Succeeded
Unknown
Updating

ResourceLogCategory

Object

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

Nome Tipo Description
enabled

string

Indica se ou a categoria de log de recursos está habilitada. Valores disponíveis: true, false. Não diferencia maiúsculas de minúsculas.
name

string

Obtém ou define o nome da categoria do log de recursos. Valores disponíveis: ConnectivityLogs, MessagingLogs. Não diferencia maiúsculas de minúsculas.

ResourceLogConfiguration

Object

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

Nome Tipo Description
categories

ResourceLogCategory[]

Obtém ou define a lista de configurações de categoria.

ResourceSku

Object

As informações de cobrança do recurso.

Nome Tipo Description
capacity

integer

Opcional, inteiro. A contagem de unidades do recurso. 1 para Free_F1/Standard_S1/Premium_P1, 100 para Premium_P2 por padrão.

Se presente, os seguintes valores são permitidos: 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 usado. Retido para uso futuro.
name

string

O nome da SKU. Obrigatórios.

Valores permitidos: Standard_S1, Free_F1, Premium_P1 Premium_P2
size

string

Não usado. Retido para uso futuro.
tier

WebPubSubSkuTier

Camada opcional desse SKU específico. 'Standard' ou 'Free'.

Basic é preterido, use Standard em vez disso.

ServiceKind

Enumeration

O tipo de serviço

Valor Description
SocketIO
WebPubSub

SharedPrivateLinkResource

Object

Descreve um recurso de Link Privado compartilhado

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

O nome do recurso
properties.groupId

string

A ID do grupo do provedor de recursos para o qual o recurso de link privado compartilhado se destina
properties.privateLinkResourceId

string

A ID do recurso para o qual o recurso de link privado compartilhado é
properties.provisioningState

ProvisioningState

Estado de provisionamento do recurso.
properties.requestMessage

string

A mensagem de solicitação para solicitar a aprovação do recurso de link privado compartilhado
properties.status

SharedPrivateLinkResourceStatus

Status do recurso de link privado compartilhado
systemData

systemData

Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.
type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceStatus

Enumeration

Status do recurso de link privado compartilhado

Valor Description
Approved
Disconnected
Pending
Rejected
Timeout

systemData

Object

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

Nome 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

Object

Propriedades da identidade atribuída pelo usuário.

Nome Tipo Description
clientId

string

Obter a ID do cliente para a identidade atribuída pelo usuário
principalId

string

Obter a ID da entidade de segurança para a identidade atribuída pelo usuário

WebPubSubNetworkACLs

Object

ACLs de rede para o recurso

Nome Tipo Description
defaultAction

ACLAction

Ação de ACL de Rede do Azure.
ipRules

IPRule[]

Regras de IP para filtrar o tráfego público
privateEndpoints

PrivateEndpointACL[]

ACLs para solicitações de pontos de extremidade privados
publicNetwork

NetworkACL

Rede ACL

WebPubSubRequestType

Enumeration

O tipo de solicitação de entrada para o serviço

Valor Description
ClientConnection
RESTAPI
ServerConnection
Trace

WebPubSubResource

Object

Uma classe representa um recurso.

Nome Tipo Valor padrão Description
id

string

ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity

ManagedIdentity

Uma classe representa identidades gerenciadas usadas para solicitação e resposta
kind

ServiceKind

O tipo de serviço
location

string

A localização geográfica em que o recurso reside
name

string

O nome do recurso
properties.disableAadAuth

boolean

False

DisableLocalAuth Habilitar ou desabilitar aad auth Quando definido como true, a conexão com AuthType=aad não funcionará.
properties.disableLocalAuth

boolean

False

DisableLocalAuth Habilitar ou desabilitar a autenticação local com AccessKey Quando definido como true, a conexã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 rastreamento ao vivo de um recurso Microsoft.SignalRService.
properties.networkACLs

WebPubSubNetworkACLs

ACLs de rede para o recurso
properties.privateEndpointConnections

PrivateEndpointConnection[]

Conexões de ponto de extremidade privado com o recurso.
properties.provisioningState

ProvisioningState

Estado de provisionamento do recurso.
properties.publicNetworkAccess

string

Enabled

Habilitar ou desabilitar o acesso à rede pública. O padrão é "Habilitado". Quando está Habilitado, as ACLs de rede ainda se aplicam. Quando estiver Desabilitado, o acesso à rede pública sempre será desabilitado, independentemente do que você definir nas ACLs de rede.
properties.publicPort

integer

A porta publicamente acessível do recurso que foi projetada para uso do lado do navegador/cliente.
properties.regionEndpointEnabled

string

Enabled

Habilitar ou desabilitar o ponto de extremidade regional. O padrão é "Habilitado". Quando estiver Desabilitado, novas conexões não serão roteadas para esse ponto de extremidade, no entanto, as conexões existentes não serão afetadas. Essa propriedade é réplica específica. Não é permitido desabilitar o ponto de extremidade regional sem réplica.
properties.resourceLogConfiguration

ResourceLogConfiguration

Configuração do log de recursos de um recurso Microsoft.SignalRService.
properties.resourceStopped

string

false

Pare ou inicie o recurso. O padrão é "False". Quando for true, o plano de dados do recurso será desligado. Quando for falso, o plano de dados do recurso será iniciado.
properties.serverPort

integer

A porta publicamente acessível do recurso que foi projetada para uso do lado do servidor do cliente.
properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

A lista de recursos de link privado compartilhado.
properties.socketIO

WebPubSubSocketIOSettings

Configurações de soquete para o recurso
properties.tls

WebPubSubTlsSettings

Configurações de TLS para o recurso
properties.version

string

Versão do recurso. Provavelmente, você precisa da mesma versão ou superior dos SDKs do cliente.
sku

ResourceSku

As informações de cobrança do recurso.
systemData

systemData

Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.
tags

object

Marcas de recurso.
type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

WebPubSubSkuTier

Enumeration

Camada opcional desse SKU específico. 'Standard' ou 'Free'.

Basic é preterido, use Standard em vez disso.

Valor Description
Basic
Free
Premium
Standard

WebPubSubSocketIOSettings

Object

Configurações do SocketIO para o recurso

Nome Tipo Description
serviceMode

string

O modo de serviço do Web PubSub para Socket.IO. Valores permitidos: "Padrão": tenha seu próprio back-end Socket.IO servidor "Sem servidor": seu aplicativo não tem um servidor de back-end

WebPubSubTlsSettings

Object

Configurações de TLS para o recurso

Nome Tipo Valor padrão Description
clientCertEnabled

boolean

False

Solicite o certificado do cliente durante o handshake do TLS, se habilitado. Não há suporte para a camada gratuita. Qualquer entrada será ignorada para a camada gratuita.