Web Pub Sub - List By Subscription

Kezeli az előfizetés összes erőforrásának listázására vonatkozó kéréseket.

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

URI-paraméterek

Name In Required Type Description
subscriptionId
path True
  • string

Lekéri az előfizetés azonosítóját, amely egyedileg azonosítja az Microsoft Azure-előfizetést. Az előfizetés-azonosító minden szolgáltatáshívás URI-jának részét képezi.

api-version
query True
  • string

Ügyfél API-verziója.

Válaszok

Name Type Description
200 OK

Sikeres művelet. A válasz az előfizetésben található erőforrások listáját írja le.

Other Status Codes

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

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 felhasználói fiók megszemélyesítése

Példák

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

Definíciók

ACLAction

Azure Hálózatkezelési ACL-művelet.

createdByType

Az erőforrást létrehozó identitás típusa.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

ErrorDetail

A hiba részletei.

ErrorResponse

Hibaválasz

LiveTraceCategory

Egy Microsoft.SignalRService-erőforrás élő nyomkövetési kategóriakonfigurációja.

LiveTraceConfiguration

Egy Microsoft.SignalRService-erőforrás élő nyomkövetési konfigurációja.

ManagedIdentity

Az osztály a kérelmekhez és válaszokhoz használt felügyelt identitásokat jelöli

ManagedIdentityType

Az identitástípust jelöli: systemAssigned, userAssigned, None

NetworkACL

Hálózati ACL

PrivateEndpoint

Privát végpont

PrivateEndpointACL

ACL privát végponthoz

PrivateEndpointConnection

Privát végpontkapcsolat egy Azure-erőforráshoz

PrivateLinkServiceConnectionState

A privát végpont kapcsolati állapota

PrivateLinkServiceConnectionStatus

Azt jelzi, hogy a szolgáltatás tulajdonosa jóváhagyta/elutasította/eltávolította-e a kapcsolatot.

ProvisioningState

Az erőforrás kiépítési állapota.

ResourceLogCategory

Egy Microsoft.SignalRService-erőforrás erőforrásnapló-kategóriakonfigurációja.

ResourceLogConfiguration

Egy Microsoft.SignalRService-erőforrás erőforrásnapló-konfigurációja.

ResourceSku

Az erőforrás számlázási adatai.

SharedPrivateLinkResource

Megosztott Private Link-erőforrás leírása

SharedPrivateLinkResourceStatus

A megosztott privát kapcsolat erőforrásának állapota

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

UserAssignedIdentityProperty

A felhasználó által hozzárendelt identitás tulajdonságai.

WebPubSubNetworkACLs

Az erőforrás hálózati ACL-címei

WebPubSubResource

Az osztály egy erőforrást jelöl.

WebPubSubResourceList

Egy erőforrástömböt és egy lehetséges hivatkozást tartalmazó objektum a következő készlethez.

WebPubSubSkuTier

Az adott termékváltozat választható szintje. "Standard" vagy "Ingyenes".

Basic elavult, használja Standard helyette.

WebPubSubTlsSettings

Az erőforrás TLS-beállításai

ACLAction

Azure Hálózatkezelési ACL-művelet.

Name Type Description
Allow
  • string
Deny
  • string

createdByType

Az erőforrást létrehozó identitás típusa.

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

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name Type Description
info
  • object

A további információk.

type
  • string

A további információtípus.

ErrorDetail

A hiba részletei.

Name Type Description
additionalInfo

A hiba további információi.

code
  • string

A hibakód.

details

A hiba részletei.

message
  • string

A hibaüzenet.

target
  • string

A hiba célja.

ErrorResponse

Hibaválasz

Name Type Description
error

A hibaobjektum.

LiveTraceCategory

Egy Microsoft.SignalRService-erőforrás élő nyomkövetési kategóriakonfigurációja.

Name Type Description
enabled
  • string

Azt jelzi, hogy az élő nyomkövetési kategória engedélyezve van-e. Elérhető értékek: true, false. A kis- és nagybetűk nem érzékenek.

name
  • string

Lekéri vagy beállítja az élő nyomkövetési kategória nevét. Elérhető értékek: ConnectivityLogs, MessagingLogs. A kis- és nagybetűk nem érzékenek.

LiveTraceConfiguration

Egy Microsoft.SignalRService-erőforrás élő nyomkövetési konfigurációja.

Name Type Default Value Description
categories

Lekéri vagy beállítja a kategóriakonfigurációk listáját.

enabled
  • string
false

Azt jelzi, hogy engedélyezve van-e az élő nyomkövetés. Ha igaz értékre van állítva, az élő nyomkövetési ügyfél csatlakozhat a szolgáltatáshoz. Ellenkező esetben az élő nyomkövetési ügyfél nem tud csatlakozni a szolgáltatáshoz, így nem tud naplót fogadni, függetlenül attól, hogy mit konfigurál a "kategóriákban". Elérhető értékek: true, false. A kis- és nagybetűk nem érzékenek.

ManagedIdentity

Az osztály a kérelmekhez és válaszokhoz használt felügyelt identitásokat jelöli

Name Type Description
principalId
  • string

Kérje le a rendszer által hozzárendelt identitás egyszerű azonosítóját. Csak válaszként használható.

tenantId
  • string

Kérje le a rendszer által hozzárendelt identitás bérlőazonosítóját. Csak válaszként használható

type

Az identitástípust jelöli: systemAssigned, userAssigned, None

userAssignedIdentities

A felhasználó által hozzárendelt identitások lekérése vagy beállítása

ManagedIdentityType

Az identitástípust jelöli: systemAssigned, userAssigned, None

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

NetworkACL

Hálózati ACL

Name Type Description
allow
  • string[]

Engedélyezett kéréstípusok. Az érték lehet egy vagy több: ClientConnection, ServerConnection, RESTAPI.

deny
  • string[]

Megtagadva a kéréstípusok. Az érték lehet egy vagy több: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpoint

Privát végpont

Name Type Description
id
  • string

A privát végpont teljes minősített azonosítója

PrivateEndpointACL

ACL privát végponthoz

Name Type Description
allow
  • string[]

Engedélyezett kéréstípusok. Az érték lehet egy vagy több: ClientConnection, ServerConnection, RESTAPI.

deny
  • string[]

Megtagadva a kéréstípusok. Az érték lehet egy vagy több: ClientConnection, ServerConnection, RESTAPI.

name
  • string

A privát végpontkapcsolat neve

PrivateEndpointConnection

Privát végpontkapcsolat egy Azure-erőforráshoz

Name Type Description
id
  • string

Az erőforrás teljes erőforrás-azonosítója.

name
  • string

Az erőforrás neve.

properties.groupIds
  • string[]

Csoportazonosítók

properties.privateEndpoint

Privát végpont

properties.privateLinkServiceConnectionState

A privát végpont kapcsolati állapota

properties.provisioningState

Az erőforrás kiépítési állapota.

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

type
  • string

Az erőforrás típusa – pl. "Microsoft.SignalRService/SignalR"

PrivateLinkServiceConnectionState

A privát végpont kapcsolati állapota

Name Type Description
actionsRequired
  • string

Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére.

description
  • string

A kapcsolat jóváhagyásának/elutasításának oka.

status

Azt jelzi, hogy a szolgáltatás tulajdonosa jóváhagyta/elutasította/eltávolította-e a kapcsolatot.

PrivateLinkServiceConnectionStatus

Azt jelzi, hogy a szolgáltatás tulajdonosa jóváhagyta/elutasította/eltávolította-e a kapcsolatot.

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

ProvisioningState

Az erőforrás kiépítési állapota.

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

ResourceLogCategory

Egy Microsoft.SignalRService-erőforrás erőforrásnapló-kategóriakonfigurációja.

Name Type Description
enabled
  • string

Azt jelzi, hogy az erőforrásnapló-kategória engedélyezve van-e. Elérhető értékek: true, false. A kis- és nagybetűk nem érzékenek.

name
  • string

Lekéri vagy beállítja az erőforrásnapló-kategória nevét. Elérhető értékek: ConnectivityLogs, MessagingLogs. A kis- és nagybetűk nem érzékenek.

ResourceLogConfiguration

Egy Microsoft.SignalRService-erőforrás erőforrásnapló-konfigurációja.

Name Type Description
categories

Lekéri vagy beállítja a kategóriakonfigurációk listáját.

ResourceSku

Az erőforrás számlázási adatai.

Name Type Description
capacity
  • integer

Nem kötelező, egész szám. Az erőforrás egységszáma. Alapértelmezés szerint 1.

Ha van ilyen, a következő értékek engedélyezettek: Ingyenes: 1 Standard: 1,2,5,10,20,50,100

family
  • string

Nincs használatban. Későbbi használatra megőrzve.

name
  • string

A termékváltozat neve. Kötelező.

Engedélyezett értékek: Standard_S1, Free_F1

size
  • string

Nincs használatban. Későbbi használatra megőrzve.

tier

Az adott termékváltozat választható szintje. "Standard" vagy "Ingyenes".

Basic elavult, használja Standard helyette.

SharedPrivateLinkResource

Megosztott Private Link-erőforrás leírása

Name Type Description
id
  • string

Az erőforrás teljes erőforrás-azonosítója.

name
  • string

Az erőforrás neve.

properties.groupId
  • string

Annak az erőforrásnak a csoportazonosítója, amelynek a megosztott privát kapcsolati erőforrása a következőhöz tartozik:

properties.privateLinkResourceId
  • string

Annak az erőforrásnak az erőforrás-azonosítója, amelyre a megosztott privát kapcsolati erőforrás tartozik

properties.provisioningState

Az erőforrás kiépítési állapota.

properties.requestMessage
  • string

A megosztott privát kapcsolat erőforrásának jóváhagyását kérő üzenet

properties.status

A megosztott privát kapcsolat erőforrásának állapota

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

type
  • string

Az erőforrás típusa – pl. "Microsoft.SignalRService/SignalR"

SharedPrivateLinkResourceStatus

A megosztott privát kapcsolat erőforrásának állapota

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

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name Type Description
createdAt
  • string

Az erőforrás-létrehozás időbélyege (UTC).

createdBy
  • string

Az erőforrást létrehozó identitás.

createdByType

Az erőforrást létrehozó identitás típusa.

lastModifiedAt
  • string

Az erőforrás utolsó módosításának időbélyege (UTC)

lastModifiedBy
  • string

Az erőforrást utoljára módosító identitás.

lastModifiedByType

Az erőforrást utoljára módosító identitás típusa.

UserAssignedIdentityProperty

A felhasználó által hozzárendelt identitás tulajdonságai.

Name Type Description
clientId
  • string

A felhasználó által hozzárendelt identitás ügyfél-azonosítójának lekérése

principalId
  • string

A felhasználó által hozzárendelt identitás egyszerű azonosítójának lekérése

WebPubSubNetworkACLs

Az erőforrás hálózati ACL-címei

Name Type Description
defaultAction

Azure Hálózatkezelési ACL-művelet.

privateEndpoints

ACL-ek privát végpontokról érkező kérésekhez

publicNetwork

Hálózati ACL

WebPubSubResource

Az osztály egy erőforrást jelöl.

Name Type Default Value Description
id
  • string

Az erőforrás teljes erőforrás-azonosítója.

identity

Az osztály a kérelmekhez és válaszokhoz használt felügyelt identitásokat jelöli

location
  • string

Az erőforrás GEO helye. például az USA nyugati | USA keleti | USA északi középső | Az USA déli középső régiója.

name
  • string

Az erőforrás neve.

properties.disableAadAuth
  • boolean
False

DisableLocalAuth – Aad-hitelesítés engedélyezése vagy letiltása Ha igaz értékre van állítva, az AuthType=aad kapcsolat nem fog működni.

properties.disableLocalAuth
  • boolean
False

DisableLocalAuth – Helyi hitelesítés engedélyezése vagy letiltása az AccessKey használatával Ha igaz értékre van állítva, az AccessKey=xxx kapcsolat nem fog működni.

properties.externalIP
  • string

Az erőforrás nyilvánosan elérhető IP-címe.

properties.hostName
  • string

A szolgáltatáspéldány teljes tartománynevét.

properties.hostNamePrefix
  • string

Elavult.

properties.liveTraceConfiguration

Egy Microsoft.SignalRService-erőforrás élő nyomkövetési konfigurációja.

properties.networkACLs

Az erőforrás hálózati ACL-címei

properties.privateEndpointConnections

Privát végpontkapcsolatok az erőforráshoz.

properties.provisioningState

Az erőforrás kiépítési állapota.

properties.publicNetworkAccess
  • string
Enabled

Nyilvános hálózati hozzáférés engedélyezése vagy letiltása. Alapértelmezés szerint "Engedélyezve". Ha engedélyezve van, a hálózati ACL-ek továbbra is érvényesek. Ha le van tiltva, a nyilvános hálózati hozzáférés mindig le van tiltva, függetlenül attól, hogy mi van beállítva a hálózati ACL-ben.

properties.publicPort
  • integer

Az erőforrás nyilvánosan elérhető portja, amelyet böngésző-/ügyféloldali használatra terveztek.

properties.resourceLogConfiguration

Egy Microsoft.SignalRService-erőforrás erőforrásnapló-konfigurációja.

properties.serverPort
  • integer

Az erőforrás nyilvánosan elérhető portja, amelyet az ügyfélkiszolgálói oldal használatára terveztek.

properties.sharedPrivateLinkResources

A megosztott privát kapcsolat erőforrásainak listája.

properties.tls

Az erőforrás TLS-beállításai

properties.version
  • string

Az erőforrás verziója. Valószínűleg az ügyféloldali SDK-k azonos vagy magasabb verziójára van szüksége.

sku

Az erőforrás számlázási adatai.

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

tags
  • object

A szolgáltatás címkéi, amelyek az erőforrást leíró kulcsértékpárok listája.

type
  • string

Az erőforrás típusa – pl. "Microsoft.SignalRService/SignalR"

WebPubSubResourceList

Egy erőforrástömböt és egy lehetséges hivatkozást tartalmazó objektum a következő készlethez.

Name Type Description
nextLink
  • string

Az az URL-cím, amelyet az ügyfélnek használnia kell a következő oldal lekéréséhez (kiszolgálóoldali lapozásonként). Egyelőre null értékű, későbbi használatra hozzáadva.

value

Az erőforrások listája

WebPubSubSkuTier

Az adott termékváltozat választható szintje. "Standard" vagy "Ingyenes".

Basic elavult, használja Standard helyette.

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

WebPubSubTlsSettings

Az erőforrás TLS-beállításai

Name Type Default Value Description
clientCertEnabled
  • boolean
True

Ügyféltanúsítvány kérése a TLS-kézfogás során, ha engedélyezve van