Web Pub Sub - List By Subscription

Manipula solicitações para listar todos os recursos em uma assinatura.

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

Parâmetros de URI

Name In Required Type Description
subscriptionId
path True
  • string

Obtém a ID da assinatura que identifica exclusivamente a assinatura Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

Versão da API do Cliente.

Respostas

Name Type Description
200 OK

Êxito. A resposta descreve a lista de recursos na assinatura.

Other Status Codes

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

Segurança

azure_auth

Flow Azure Active Directory OAuth2

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

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

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

Definições

ACLAction

Ação acl de rede do Azure.

createdByType

O tipo de identidade que criou o recurso.

ErrorAdditionalInfo

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

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

LiveTraceCategory

Configuração de categoria de rastreamento ao vivo 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.

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

WebPubSubResource

Uma classe representa um recurso.

WebPubSubResourceList

Objeto que inclui uma matriz de recursos e um possível link para o próximo conjunto.

WebPubSubSkuTier

Camada opcional dessa SKU específica. 'Standard' ou 'Free'.

Basic é preterido, use Standard em vez disso.

WebPubSubTlsSettings

Configurações de TLS para o recurso

ACLAction

Ação acl de rede do Azure.

Name Type Description
Allow
  • string
Deny
  • string

createdByType

O tipo de identidade que criou o recurso.

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

ErrorAdditionalInfo

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

Name Type Description
info
  • object

As informações adicionais.

type
  • string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Type Description
additionalInfo

As informações adicionais do erro.

code
  • string

O código de erro.

details

Os detalhes do erro.

message
  • string

A mensagem de erro.

target
  • string

O destino do erro.

ErrorResponse

Resposta de erro

Name Type Description
error

O objeto de erro.

LiveTraceCategory

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

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

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

Name Type Default Value Description
categories

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

enabled
  • string
false

Indica se habilitar ou não o rastreamento dinâmico. Quando ele é 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 pode se conectar ao serviço, de modo 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

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

Name Type 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. Ser usado apenas em resposta

type

Representa o tipo de identidade: systemAssigned, userAssigned, None

userAssignedIdentities

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

ManagedIdentityType

Representa o tipo de identidade: systemAssigned, userAssigned, None

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

NetworkACL

Rede ACL

Name Type Description
allow
  • string[]

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

deny
  • string[]

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

PrivateEndpoint

Ponto de extremidade privado

Name Type Description
id
  • string

ID qualificada completa do ponto de extremidade privado

PrivateEndpointACL

ACL para um ponto de extremidade privado

Name Type Description
allow
  • string[]

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

deny
  • string[]

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

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

Name Type Description
id
  • string

ID de recurso totalmente qualificada para o recurso.

name
  • string

O nome do recurso.

properties.groupIds
  • string[]

IDs de grupo

properties.privateEndpoint

Ponto de extremidade privado

properties.privateLinkServiceConnectionState

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

properties.provisioningState

Estado de provisionamento do recurso.

systemData

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

type
  • string

O tipo do recurso - por exemplo, "Microsoft.SignalRService/SignalR"

PrivateLinkServiceConnectionState

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

Name Type Description
actionsRequired
  • string

Uma mensagem que indica 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

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

PrivateLinkServiceConnectionStatus

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

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

ProvisioningState

Estado de provisionamento do recurso.

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

ResourceLogCategory

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

Name Type 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 de log de recursos. Valores disponíveis: ConnectivityLogs, MessagingLogs. Não diferencia maiúsculas de minúsculas.

ResourceLogConfiguration

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

Name Type Description
categories

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

ResourceSku

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

Name Type Description
capacity
  • integer

Opcional, inteiro. A contagem de unidades do recurso. 1 por padrão.

Se presentes, os seguintes valores serão permitidos: Gratuito: 1 Padrão: 1,2,5,10,20,50.100

family
  • string

Não usado. Retido para uso futuro.

name
  • string

O nome da SKU. Obrigatórios.

Valores permitidos: Standard_S1, Free_F1

size
  • string

Não usado. Retido para uso futuro.

tier

Camada opcional dessa SKU específica. 'Standard' ou 'Free'.

Basic é preterido, use Standard em vez disso.

SharedPrivateLinkResource

Descreve um recurso de Link Privado compartilhado

Name Type Description
id
  • string

ID de recurso totalmente qualificada para o recurso.

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 é

properties.privateLinkResourceId
  • string

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

properties.provisioningState

Estado de provisionamento do recurso.

properties.requestMessage
  • string

A mensagem de solicitação para solicitar aprovação do recurso de link privado compartilhado

properties.status

Status do recurso de link privado compartilhado

systemData

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

type
  • string

O tipo do recurso - por exemplo, "Microsoft.SignalRService/SignalR"

SharedPrivateLinkResourceStatus

Status do recurso de link privado compartilhado

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

systemData

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

Name Type Description
createdAt
  • string

O carimbo de data/hora da criação de recursos (UTC).

createdBy
  • string

A identidade que criou o recurso.

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

O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentityProperty

Propriedades da identidade atribuída pelo usuário.

Name Type Description
clientId
  • string

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

principalId
  • string

Obter a ID principal da identidade atribuída pelo usuário

WebPubSubNetworkACLs

ACLs de rede para o recurso

Name Type Description
defaultAction

Ação acl de rede do Azure.

privateEndpoints

ACLs para solicitações de pontos de extremidade privados

publicNetwork

Rede ACL

WebPubSubResource

Uma classe representa um recurso.

Name Type Default Value Description
id
  • string

ID de recurso totalmente qualificada para o recurso.

identity

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

location
  • string

A localização GEO do recurso. por exemplo, oeste dos EUA | Leste dos EUA | Centro-Norte dos EUA | Centro-Sul dos EUA.

name
  • string

O nome do recurso.

properties.disableAadAuth
  • boolean
False

DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad não funcionará.

properties.disableLocalAuth
  • boolean
False

DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work.

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

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

properties.networkACLs

ACLs de rede para o recurso

properties.privateEndpointConnections

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

properties.provisioningState

Estado de provisionamento do recurso.

properties.publicNetworkAccess
  • string
Enabled

Habilitar ou desabilitar o acesso à rede pública. Padrão para "Habilitado". Quando está habilitado, as ACLs de rede ainda se aplicam. Quando ele está desabilitado, o acesso à rede pública sempre é desabilitado, independentemente do que você definir em ACLs de rede.

properties.publicPort
  • integer

A porta publicamente acessível do recurso que foi projetado para uso do navegador/cliente.

properties.resourceLogConfiguration

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

properties.serverPort
  • integer

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

properties.sharedPrivateLinkResources

A lista de recursos de link privado compartilhados.

properties.tls

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

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

systemData

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

tags
  • object

Marcas do serviço que é uma lista de pares de valores de chave que descrevem o recurso.

type
  • string

O tipo do recurso - por exemplo, "Microsoft.SignalRService/SignalR"

WebPubSubResourceList

Objeto que inclui uma matriz de recursos e um possível link para o próximo conjunto.

Name Type Description
nextLink
  • string

A URL que o cliente deve usar para buscar a próxima página (por paginação do lado do servidor). É nulo por enquanto, adicionado para uso futuro.

value

Lista dos recursos

WebPubSubSkuTier

Camada opcional dessa SKU específica. 'Standard' ou 'Free'.

Basic é preterido, use Standard em vez disso.

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

WebPubSubTlsSettings

Configurações de TLS para o recurso

Name Type Default Value Description
clientCertEnabled
  • boolean
True

Solicitar certificado do cliente durante o handshake do TLS se habilitado