Web Pub Sub - List By Subscription

Obsługuje żądania, aby wyświetlić listę wszystkich zasobów w subskrypcji.

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

Parametry identyfikatora URI

Name In Required Type Description
subscriptionId
path True
  • string

Pobiera identyfikator subskrypcji, który jednoznacznie identyfikuje subskrypcję Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

api-version
query True
  • string

Wersja interfejsu API klienta.

Odpowiedzi

Name Type Description
200 OK

Powodzenie. Odpowiedź opisuje listę zasobów w subskrypcji.

Other Status Codes

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation personifikacja konta użytkownika

Przykłady

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

Definicje

ACLAction

Akcja listy ACL sieci platformy Azure.

createdByType

Typ tożsamości, która utworzyła zasób.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd

LiveTraceCategory

Konfiguracja kategorii śledzenia na żywo zasobu Microsoft.SignalRService.

LiveTraceConfiguration

Konfiguracja śledzenia na żywo zasobu Microsoft.SignalRService.

ManagedIdentity

Klasa reprezentuje tożsamości zarządzane używane do obsługi żądań i odpowiedzi

ManagedIdentityType

Reprezentuje typ tożsamości: systemAssigned, userAssigned, None

NetworkACL

Lista ACL sieci

PrivateEndpoint

Prywatny punkt końcowy

PrivateEndpointACL

Lista ACL dla prywatnego punktu końcowego

PrivateEndpointConnection

Połączenie prywatnego punktu końcowego z zasobem platformy Azure

PrivateLinkServiceConnectionState

Stan połączenia prywatnego punktu końcowego

PrivateLinkServiceConnectionStatus

Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi.

ProvisioningState

Stan aprowizacji zasobu.

ResourceLogCategory

Konfiguracja kategorii dzienników zasobów zasobu Microsoft.SignalRService.

ResourceLogConfiguration

Konfiguracja dziennika zasobów zasobu Microsoft.SignalRService.

ResourceSku

Informacje dotyczące rozliczeń zasobu.

SharedPrivateLinkResource

Opisuje udostępniony zasób Private Link

SharedPrivateLinkResourceStatus

Stan zasobu udostępnionego łącza prywatnego

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

UserAssignedIdentityProperty

Właściwości tożsamości przypisanej przez użytkownika.

WebPubSubNetworkACLs

Listy ACL sieci dla zasobu

WebPubSubResource

Klasa reprezentuje zasób.

WebPubSubResourceList

Obiekt, który zawiera tablicę zasobów i możliwy link do następnego zestawu.

WebPubSubSkuTier

Opcjonalna warstwa tej konkretnej jednostki SKU. "Standardowa" lub "Bezpłatna".

Basic jest przestarzały, zamiast tego użyj polecenia Standard .

WebPubSubTlsSettings

Ustawienia protokołu TLS dla zasobu

ACLAction

Akcja listy ACL sieci platformy Azure.

Name Type Description
Allow
  • string
Deny
  • string

createdByType

Typ tożsamości, która utworzyła zasób.

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

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Name Type Description
info
  • object

Dodatkowe informacje.

type
  • string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Name Type Description
additionalInfo

Dodatkowe informacje o błędzie.

code
  • string

Kod błędu.

details

Szczegóły błędu.

message
  • string

Komunikat o błędzie.

target
  • string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Name Type Description
error

Obiekt error.

LiveTraceCategory

Konfiguracja kategorii śledzenia na żywo zasobu Microsoft.SignalRService.

Name Type Description
enabled
  • string

Wskazuje, czy kategoria śledzenia na żywo jest włączona. Dostępne wartości: true, false. Bez uwzględniania wielkości liter.

name
  • string

Pobiera lub ustawia nazwę kategorii śledzenia na żywo. Dostępne wartości: ConnectivityLogs, MessagingLogs. Bez uwzględniania wielkości liter.

LiveTraceConfiguration

Konfiguracja śledzenia na żywo zasobu Microsoft.SignalRService.

Name Type Default Value Description
categories

Pobiera lub ustawia listę konfiguracji kategorii.

enabled
  • string
false

Wskazuje, czy włączono śledzenie na żywo. Po ustawieniu wartości true klient śledzenia na żywo może nawiązać połączenie z usługą. W przeciwnym razie klient śledzenia na żywo nie może nawiązać połączenia z usługą, aby nie można było odebrać żadnego dziennika, niezależnie od konfiguracji w "kategoriach". Dostępne wartości: true, false. Bez uwzględniania wielkości liter.

ManagedIdentity

Klasa reprezentuje tożsamości zarządzane używane do obsługi żądań i odpowiedzi

Name Type Description
principalId
  • string

Pobierz identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez system. Należy używać tylko w odpowiedzi.

tenantId
  • string

Pobierz identyfikator dzierżawy dla tożsamości przypisanej przez system. Należy używać tylko w odpowiedzi

type

Reprezentuje typ tożsamości: systemAssigned, userAssigned, None

userAssignedIdentities

Pobieranie lub ustawianie tożsamości przypisanych przez użytkownika

ManagedIdentityType

Reprezentuje typ tożsamości: systemAssigned, userAssigned, None

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

NetworkACL

Lista ACL sieci

Name Type Description
allow
  • string[]

Dozwolone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI.

deny
  • string[]

Odrzucone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpoint

Prywatny punkt końcowy

Name Type Description
id
  • string

Pełny kwalifikowany identyfikator prywatnego punktu końcowego

PrivateEndpointACL

Lista ACL dla prywatnego punktu końcowego

Name Type Description
allow
  • string[]

Dozwolone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI.

deny
  • string[]

Odrzucone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI.

name
  • string

Nazwa połączenia prywatnego punktu końcowego

PrivateEndpointConnection

Połączenie prywatnego punktu końcowego z zasobem platformy Azure

Name Type Description
id
  • string

W pełni kwalifikowany identyfikator zasobu dla zasobu.

name
  • string

Nazwa zasobu.

properties.groupIds
  • string[]

Identyfikatory grup

properties.privateEndpoint

Prywatny punkt końcowy

properties.privateLinkServiceConnectionState

Stan połączenia prywatnego punktu końcowego

properties.provisioningState

Stan aprowizacji zasobu.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

type
  • string

Typ zasobu — np. "Microsoft.SignalRService/SignalR"

PrivateLinkServiceConnectionState

Stan połączenia prywatnego punktu końcowego

Name Type Description
actionsRequired
  • string

Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji dla konsumenta.

description
  • string

Przyczyna zatwierdzenia/odrzucenia połączenia.

status

Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi.

PrivateLinkServiceConnectionStatus

Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi.

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

ProvisioningState

Stan aprowizacji zasobu.

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

ResourceLogCategory

Konfiguracja kategorii dzienników zasobów zasobu Microsoft.SignalRService.

Name Type Description
enabled
  • string

Wskazuje, czy kategoria dziennika zasobów jest włączona. Dostępne wartości: true, false. Bez uwzględniania wielkości liter.

name
  • string

Pobiera lub ustawia nazwę kategorii dziennika zasobów. Dostępne wartości: ConnectivityLogs, MessagingLogs. Bez uwzględniania wielkości liter.

ResourceLogConfiguration

Konfiguracja dziennika zasobów zasobu Microsoft.SignalRService.

Name Type Description
categories

Pobiera lub ustawia listę konfiguracji kategorii.

ResourceSku

Informacje dotyczące rozliczeń zasobu.

Name Type Description
capacity
  • integer

Opcjonalnie, liczba całkowita. Liczba jednostek zasobu. Domyślnie 1.

Jeśli są obecne, dozwolone są następujące wartości: Bezpłatna: 1 Standardowa: 1,2,5,10,20,50,100

family
  • string

Nie używany. Zachowywane do użytku w przyszłości.

name
  • string

Nazwa jednostki SKU. Wymagane.

Dozwolone wartości: Standard_S1, Free_F1

size
  • string

Nie używany. Zachowywane do użytku w przyszłości.

tier

Opcjonalna warstwa tej konkretnej jednostki SKU. "Standardowa" lub "Bezpłatna".

Basic jest przestarzały, zamiast tego użyj polecenia Standard .

SharedPrivateLinkResource

Opisuje udostępniony zasób Private Link

Name Type Description
id
  • string

W pełni kwalifikowany identyfikator zasobu dla zasobu.

name
  • string

Nazwa zasobu.

properties.groupId
  • string

Identyfikator grupy od dostawcy zasobu, dla których znajduje się zasób udostępnionego łącza prywatnego

properties.privateLinkResourceId
  • string

Identyfikator zasobu zasobu, dla których znajduje się zasób udostępnionego łącza prywatnego

properties.provisioningState

Stan aprowizacji zasobu.

properties.requestMessage
  • string

Komunikat żądania żądania żądania zatwierdzenia zasobu udostępnionego łącza prywatnego

properties.status

Stan zasobu udostępnionego łącza prywatnego

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

type
  • string

Typ zasobu — np. "Microsoft.SignalRService/SignalR"

SharedPrivateLinkResourceStatus

Stan zasobu udostępnionego łącza prywatnego

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

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Name Type Description
createdAt
  • string

Sygnatura czasowa tworzenia zasobów (UTC).

createdBy
  • string

Tożsamość, która utworzyła zasób.

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt
  • string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)

lastModifiedBy
  • string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

UserAssignedIdentityProperty

Właściwości tożsamości przypisanej przez użytkownika.

Name Type Description
clientId
  • string

Uzyskiwanie identyfikatora klienta dla tożsamości przypisanej przez użytkownika

principalId
  • string

Pobieranie identyfikatora podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika

WebPubSubNetworkACLs

Listy ACL sieci dla zasobu

Name Type Description
defaultAction

Akcja listy ACL sieci platformy Azure.

privateEndpoints

Listy ACL dla żądań z prywatnych punktów końcowych

publicNetwork

Lista ACL sieci

WebPubSubResource

Klasa reprezentuje zasób.

Name Type Default Value Description
id
  • string

W pełni kwalifikowany identyfikator zasobu dla zasobu.

identity

Klasa reprezentuje tożsamości zarządzane używane do obsługi żądań i odpowiedzi

location
  • string

Lokalizacja GEOGRAFICZNa zasobu. np. zachodnie stany USA | Wschodnie stany USA | Północno-środkowe stany USA | Południowo-środkowe stany USA.

name
  • string

Nazwa zasobu.

properties.disableAadAuth
  • boolean
False

DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad nie będzie działać.

properties.disableLocalAuth
  • boolean
False

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

properties.externalIP
  • string

Publicznie dostępny adres IP zasobu.

properties.hostName
  • string

Nazwa FQDN wystąpienia usługi.

properties.hostNamePrefix
  • string

Przestarzałe.

properties.liveTraceConfiguration

Konfiguracja śledzenia na żywo zasobu Microsoft.SignalRService.

properties.networkACLs

Listy ACL sieci dla zasobu

properties.privateEndpointConnections

Połączenia prywatnego punktu końcowego z zasobem.

properties.provisioningState

Stan aprowizacji zasobu.

properties.publicNetworkAccess
  • string
Enabled

Włączanie lub wyłączanie dostępu do sieci publicznej. Wartość domyślna to "Włączone". Po włączeniu listy ACL sieci nadal mają zastosowanie. Po wyłączeniu dostęp do sieci publicznej jest zawsze wyłączony niezależnie od tego, co zostało ustawione w listach ACL sieci.

properties.publicPort
  • integer

Publicznie dostępny port zasobu, który jest przeznaczony do użycia po stronie przeglądarki/klienta.

properties.resourceLogConfiguration

Konfiguracja dziennika zasobów zasobu Microsoft.SignalRService.

properties.serverPort
  • integer

Publicznie dostępny port zasobu, który jest przeznaczony do użycia po stronie serwera klienta.

properties.sharedPrivateLinkResources

Lista udostępnionych zasobów łącza prywatnego.

properties.tls

Ustawienia protokołu TLS dla zasobu

properties.version
  • string

Wersja zasobu. Prawdopodobnie potrzebujesz tej samej lub nowszej wersji zestawów SDK klienta.

sku

Informacje dotyczące rozliczeń zasobu.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

tags
  • object

Tagi usługi, która jest listą par klucz-wartość, które opisują zasób.

type
  • string

Typ zasobu — np. "Microsoft.SignalRService/SignalR"

WebPubSubResourceList

Obiekt, który zawiera tablicę zasobów i możliwy link do następnego zestawu.

Name Type Description
nextLink
  • string

Adres URL, który klient powinien użyć do pobrania następnej strony (na stronicowanie po stronie serwera). Na razie ma wartość null, dodaną do użytku w przyszłości.

value

Lista zasobów

WebPubSubSkuTier

Opcjonalna warstwa tej konkretnej jednostki SKU. "Standardowa" lub "Bezpłatna".

Basic jest przestarzały, zamiast tego użyj polecenia Standard .

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

WebPubSubTlsSettings

Ustawienia protokołu TLS dla zasobu

Name Type Default Value Description
clientCertEnabled
  • boolean
True

Żądanie certyfikatu klienta podczas uzgadniania protokołu TLS, jeśli jest włączone