Web Pub Sub - List By Subscription

구독의 모든 리소스를 나열하는 요청을 처리합니다.

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

URI 매개 변수

Name In Required Type Description
subscriptionId
path True
  • string

Microsoft Azure 구독을 고유하게 식별하는 구독 ID를 가져옵니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.

api-version
query True
  • string

클라이언트 API 버전입니다.

응답

Name Type Description
200 OK

성공. 응답은 구독의 리소스 목록을 설명합니다.

Other Status Codes

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

OAuth2 Flow Azure Active Directory

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

Scopes

Name Description
user_impersonation 사용자 계정 가장

예제

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

정의

ACLAction

Azure 네트워킹 ACL 작업.

createdByType

리소스를 만든 ID의 형식입니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

ErrorDetail

오류 세부 정보입니다.

ErrorResponse

오류 응답

LiveTraceCategory

Microsoft.SignalRService 리소스의 라이브 추적 범주 구성입니다.

LiveTraceConfiguration

Microsoft.SignalRService 리소스의 라이브 추적 구성입니다.

ManagedIdentity

클래스는 요청 및 응답에 사용되는 관리 ID를 나타냅니다.

ManagedIdentityType

id 형식을 나타냅니다. systemAssigned, userAssigned, None

NetworkACL

네트워크 ACL

PrivateEndpoint

프라이빗 엔드포인트

PrivateEndpointACL

프라이빗 엔드포인트에 대한 ACL

PrivateEndpointConnection

Azure 리소스에 대한 프라이빗 엔드포인트 연결

PrivateLinkServiceConnectionState

프라이빗 엔드포인트 연결의 연결 상태

PrivateLinkServiceConnectionStatus

서비스 소유자가 연결을 승인/거부/제거했는지 여부를 나타냅니다.

ProvisioningState

리소스의 프로비전 상태입니다.

ResourceLogCategory

Microsoft.SignalRService 리소스의 리소스 로그 범주 구성입니다.

ResourceLogConfiguration

Microsoft.SignalRService 리소스의 리소스 로그 구성입니다.

ResourceSku

리소스의 청구 정보입니다.

SharedPrivateLinkResource

공유 Private Link 리소스에 대해 설명합니다.

SharedPrivateLinkResourceStatus

공유 프라이빗 링크 리소스의 상태

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

UserAssignedIdentityProperty

사용자 할당 ID의 속성입니다.

WebPubSubNetworkACLs

리소스에 대한 네트워크 ACL

WebPubSubResource

클래스는 리소스를 나타냅니다.

WebPubSubResourceList

리소스 배열과 다음 집합에 대한 가능한 링크를 포함하는 개체입니다.

WebPubSubSkuTier

이 특정 SKU의 선택적 계층입니다. 'Standard' 또는 'Free'.

Basic는 사용되지 않으며, 대신 Standard를 사용합니다.

WebPubSubTlsSettings

리소스에 대한 TLS 설정

ACLAction

Azure 네트워킹 ACL 작업.

Name Type Description
Allow
  • string
Deny
  • string

createdByType

리소스를 만든 ID의 형식입니다.

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

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name Type Description
info
  • object

추가 정보입니다.

type
  • string

추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name Type Description
additionalInfo

오류 추가 정보입니다.

code
  • string

오류 코드입니다.

details

오류 세부 정보입니다.

message
  • string

오류 메시지입니다.

target
  • string

오류 대상입니다.

ErrorResponse

오류 응답

Name Type Description
error

오류 개체입니다.

LiveTraceCategory

Microsoft.SignalRService 리소스의 라이브 추적 범주 구성입니다.

Name Type Description
enabled
  • string

라이브 추적 범주를 사용할지 여부를 나타냅니다. 사용 가능한 값: true, false. 대/소문자를 구분하지 않습니다.

name
  • string

라이브 추적 범주의 이름을 가져오거나 설정합니다. 사용 가능한 값: ConnectivityLogs, MessagingLogs. 대/소문자를 구분하지 않습니다.

LiveTraceConfiguration

Microsoft.SignalRService 리소스의 라이브 추적 구성입니다.

Name Type Default Value Description
categories

범주 구성 목록을 가져오거나 설정합니다.

enabled
  • string
false

라이브 추적을 사용할지 여부를 나타냅니다. true로 설정하면 라이브 추적 클라이언트가 서비스에 연결할 수 있습니다. 그렇지 않으면 라이브 추적 클라이언트가 서비스에 연결할 수 없으므로 "범주"에서 구성한 내용에 관계없이 로그를 받을 수 없습니다. 사용 가능한 값: true, false. 대/소문자를 구분하지 않습니다.

ManagedIdentity

클래스는 요청 및 응답에 사용되는 관리 ID를 나타냅니다.

Name Type Description
principalId
  • string

시스템 할당 ID의 보안 주체 ID를 가져옵니다. 응답에만 사용됩니다.

tenantId
  • string

시스템 할당 ID의 테넌트 ID를 가져옵니다. 응답에만 사용

type

id 형식을 나타냅니다. systemAssigned, userAssigned, None

userAssignedIdentities

사용자 할당 ID 가져오기 또는 설정

ManagedIdentityType

id 형식을 나타냅니다. systemAssigned, userAssigned, None

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

NetworkACL

네트워크 ACL

Name Type Description
allow
  • string[]

허용되는 요청 형식입니다. 값은 ClientConnection, ServerConnection, RESTAPI 중 하나 이상일 수 있습니다.

deny
  • string[]

요청 유형이 거부되었습니다. 값은 ClientConnection, ServerConnection, RESTAPI 중 하나 이상일 수 있습니다.

PrivateEndpoint

프라이빗 엔드포인트

Name Type Description
id
  • string

프라이빗 엔드포인트의 정규화된 ID

PrivateEndpointACL

프라이빗 엔드포인트에 대한 ACL

Name Type Description
allow
  • string[]

허용되는 요청 형식입니다. 값은 ClientConnection, ServerConnection, RESTAPI 중 하나 이상일 수 있습니다.

deny
  • string[]

요청 유형이 거부되었습니다. 값은 ClientConnection, ServerConnection, RESTAPI 중 하나 이상일 수 있습니다.

name
  • string

프라이빗 엔드포인트 연결의 이름

PrivateEndpointConnection

Azure 리소스에 대한 프라이빗 엔드포인트 연결

Name Type Description
id
  • string

리소스에 대한 정규화된 리소스 ID입니다.

name
  • string

리소스의 이름입니다.

properties.groupIds
  • string[]

그룹 ID

properties.privateEndpoint

프라이빗 엔드포인트

properties.privateLinkServiceConnectionState

프라이빗 엔드포인트 연결의 연결 상태

properties.provisioningState

리소스의 프로비전 상태입니다.

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

type
  • string

리소스 유형(예: "Microsoft.SignalRService/SignalR")

PrivateLinkServiceConnectionState

프라이빗 엔드포인트 연결의 연결 상태

Name Type Description
actionsRequired
  • string

서비스 공급자의 변경 내용에 소비자에 대한 업데이트가 필요한지 여부를 나타내는 메시지입니다.

description
  • string

연결 승인/거부 이유입니다.

status

서비스 소유자가 연결을 승인/거부/제거했는지 여부를 나타냅니다.

PrivateLinkServiceConnectionStatus

서비스 소유자가 연결을 승인/거부/제거했는지 여부를 나타냅니다.

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

ProvisioningState

리소스의 프로비전 상태입니다.

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

ResourceLogCategory

Microsoft.SignalRService 리소스의 리소스 로그 범주 구성입니다.

Name Type Description
enabled
  • string

리소스 로그 범주를 사용할지 여부를 나타냅니다. 사용 가능한 값: true, false. 대/소문자를 구분하지 않습니다.

name
  • string

리소스 로그 범주의 이름을 가져오거나 설정합니다. 사용 가능한 값: ConnectivityLogs, MessagingLogs. 대/소문자를 구분하지 않습니다.

ResourceLogConfiguration

Microsoft.SignalRService 리소스의 리소스 로그 구성입니다.

Name Type Description
categories

범주 구성 목록을 가져오거나 설정합니다.

ResourceSku

리소스의 청구 정보입니다.

Name Type Description
capacity
  • integer

선택적 정수입니다. 리소스의 단위 수입니다. 기본적으로 1.

있는 경우 다음 값이 허용됩니다. 무료: 1 표준: 1,2,5,10,20,50,100

family
  • string

사용되지 않습니다. 나중에 사용할 수 있습니다.

name
  • string

SKU의 이름입니다. 필수 요소.

허용되는 값: Standard_S1, Free_F1

size
  • string

사용되지 않습니다. 나중에 사용할 수 있습니다.

tier

이 특정 SKU의 선택적 계층입니다. 'Standard' 또는 'Free'.

Basic는 사용되지 않으며, 대신 Standard를 사용합니다.

SharedPrivateLinkResource

공유 Private Link 리소스에 대해 설명합니다.

Name Type Description
id
  • string

리소스에 대한 정규화된 리소스 ID입니다.

name
  • string

리소스의 이름입니다.

properties.groupId
  • string

공유 프라이빗 링크 리소스가 인 리소스 공급자의 그룹 ID

properties.privateLinkResourceId
  • string

공유 프라이빗 링크 리소스가 사용할 리소스의 리소스 ID

properties.provisioningState

리소스의 프로비전 상태입니다.

properties.requestMessage
  • string

공유 프라이빗 링크 리소스의 승인을 요청하기 위한 요청 메시지

properties.status

공유 프라이빗 링크 리소스의 상태

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

type
  • string

리소스 유형(예: "Microsoft.SignalRService/SignalR")

SharedPrivateLinkResourceStatus

공유 프라이빗 링크 리소스의 상태

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

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name Type Description
createdAt
  • string

리소스 만들기의 타임스탬프(UTC)입니다.

createdBy
  • string

리소스를 만든 ID입니다.

createdByType

리소스를 만든 ID의 형식입니다.

lastModifiedAt
  • string

리소스 마지막 수정의 타임스탬프(UTC)

lastModifiedBy
  • string

리소스를 마지막으로 수정한 ID입니다.

lastModifiedByType

리소스를 마지막으로 수정한 ID의 형식입니다.

UserAssignedIdentityProperty

사용자 할당 ID의 속성입니다.

Name Type Description
clientId
  • string

사용자 할당 ID에 대한 클라이언트 ID 가져오기

principalId
  • string

사용자 할당 ID의 보안 주체 ID 가져오기

WebPubSubNetworkACLs

리소스에 대한 네트워크 ACL

Name Type Description
defaultAction

Azure 네트워킹 ACL 작업.

privateEndpoints

프라이빗 엔드포인트의 요청에 대한 ACL

publicNetwork

네트워크 ACL

WebPubSubResource

클래스는 리소스를 나타냅니다.

Name Type Default Value Description
id
  • string

리소스에 대한 정규화된 리소스 ID입니다.

identity

클래스는 요청 및 응답에 사용되는 관리 ID를 나타냅니다.

location
  • string

리소스의 GEO 위치입니다. 예: 미국 서부 | 미국 동부 | 미국 중북부 | 미국 중남부.

name
  • string

리소스의 이름입니다.

properties.disableAadAuth
  • boolean
False

DisableLocalAuth aad auth를 사용하거나 사용하지 않도록 설정하면 true로 설정하면 AuthType=aad와의 연결이 작동하지 않습니다.

properties.disableLocalAuth
  • boolean
False

DisableLocalAuth AccessKey를 사용하여 로컬 인증을 사용하거나 사용하지 않도록 설정하면 true로 설정하면 AccessKey=xxx와의 연결이 작동하지 않습니다.

properties.externalIP
  • string

리소스의 공개적으로 액세스할 수 있는 IP입니다.

properties.hostName
  • string

서비스 인스턴스의 FQDN입니다.

properties.hostNamePrefix
  • string

더 이상 사용되지 않습니다.

properties.liveTraceConfiguration

Microsoft.SignalRService 리소스의 라이브 추적 구성입니다.

properties.networkACLs

리소스에 대한 네트워크 ACL

properties.privateEndpointConnections

리소스에 대한 프라이빗 엔드포인트 연결입니다.

properties.provisioningState

리소스의 프로비전 상태입니다.

properties.publicNetworkAccess
  • string
Enabled

공용 네트워크 액세스를 사용하거나 사용하지 않도록 설정합니다. 기본값은 "Enabled"입니다. 사용하도록 설정되면 네트워크 ACL이 계속 적용됩니다. 사용 안 함인 경우 네트워크 ACL에서 설정한 내용에 관계없이 공용 네트워크 액세스는 항상 사용하지 않도록 설정됩니다.

properties.publicPort
  • integer

브라우저/클라이언트 쪽 사용을 위해 설계된 리소스의 공개적으로 액세스할 수 있는 포트입니다.

properties.resourceLogConfiguration

Microsoft.SignalRService 리소스의 리소스 로그 구성입니다.

properties.serverPort
  • integer

고객 서버 쪽 사용을 위해 설계된 리소스의 공개적으로 액세스할 수 있는 포트입니다.

properties.sharedPrivateLinkResources

공유 프라이빗 링크 리소스 목록입니다.

properties.tls

리소스에 대한 TLS 설정

properties.version
  • string

리소스의 버전입니다. 아마 클라이언트 SDK의 동일하거나 더 높은 버전이 필요합니다.

sku

리소스의 청구 정보입니다.

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

tags
  • object

리소스를 설명하는 키 값 쌍 목록인 서비스의 태그입니다.

type
  • string

리소스 유형(예: "Microsoft.SignalRService/SignalR")

WebPubSubResourceList

리소스 배열과 다음 집합에 대한 가능한 링크를 포함하는 개체입니다.

Name Type Description
nextLink
  • string

클라이언트가 다음 페이지(서버 쪽 페이징당)를 가져오는 데 사용해야 하는 URL입니다. 지금은 null이며 나중에 사용할 수 있게 추가되었습니다.

value

리소스 목록

WebPubSubSkuTier

이 특정 SKU의 선택적 계층입니다. 'Standard' 또는 'Free'.

Basic는 사용되지 않으며, 대신 Standard를 사용합니다.

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

WebPubSubTlsSettings

리소스에 대한 TLS 설정

Name Type Default Value Description
clientCertEnabled
  • boolean
True

사용하도록 설정된 경우 TLS 핸드셰이크 중에 클라이언트 인증서 요청