Web Pub Sub - Get

참조

서비스:: Azure Web PubSub Service

API 버전:: 2024-03-01

리소스 및 해당 속성을 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string	리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
resourceName	path	True	string	리소스의 이름입니다. regex 패턴: `^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$`
subscriptionId	path	True	string uuid	대상 구독의 ID입니다. 값은 UUID여야 합니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	WebPubSubResource	성공. 응답은 해당 리소스를 설명합니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

WebPubSub_Get

샘플 요청

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


/**
 * Samples for WebPubSub GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSub_Get.json
     */
    /**
     * Sample code: WebPubSub_Get.
     * 
     * @param manager Entry point to WebPubSubManager.
     */
    public static void webPubSubGet(com.azure.resourcemanager.webpubsub.WebPubSubManager manager) {
        manager.webPubSubs().getByResourceGroupWithResponse("myResourceGroup", "myWebPubSubService",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.webpubsub import WebPubSubManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-webpubsub
# USAGE
    python web_pub_sub_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebPubSubManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.web_pub_sub.get(
        resource_group_name="myResourceGroup",
        resource_name="myWebPubSubService",
    )
    print(response)


# x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSub_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armwebpubsub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/webpubsub/armwebpubsub"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7189fb57f69468c56df76f9a4d68dd9ff04ab100/specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSub_Get.json
func ExampleClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armwebpubsub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewClient().Get(ctx, "myResourceGroup", "myWebPubSubService", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ResourceInfo = armwebpubsub.ResourceInfo{
	// 	Name: to.Ptr("myWebPubSubService"),
	// 	Type: to.Ptr("Microsoft.SignalRService/WebPubSub"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService"),
	// 	SystemData: &armwebpubsub.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-02-03T04:05:06.000Z"); return t}()),
	// 		CreatedBy: to.Ptr("string"),
	// 		CreatedByType: to.Ptr(armwebpubsub.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-02-03T04:05:06.000Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("string"),
	// 		LastModifiedByType: to.Ptr(armwebpubsub.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("eastus"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 	},
	// 	Identity: &armwebpubsub.ManagedIdentity{
	// 		Type: to.Ptr(armwebpubsub.ManagedIdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 	},
	// 	Kind: to.Ptr(armwebpubsub.ServiceKindWebPubSub),
	// 	Properties: &armwebpubsub.Properties{
	// 		DisableAADAuth: to.Ptr(false),
	// 		DisableLocalAuth: to.Ptr(false),
	// 		ExternalIP: to.Ptr("10.0.0.1"),
	// 		HostName: to.Ptr("mywebpubsubservice.webpubsub.azure.com"),
	// 		LiveTraceConfiguration: &armwebpubsub.LiveTraceConfiguration{
	// 			Categories: []*armwebpubsub.LiveTraceCategory{
	// 				{
	// 					Name: to.Ptr("ConnectivityLogs"),
	// 					Enabled: to.Ptr("true"),
	// 			}},
	// 			Enabled: to.Ptr("false"),
	// 		},
	// 		NetworkACLs: &armwebpubsub.NetworkACLs{
	// 			DefaultAction: to.Ptr(armwebpubsub.ACLActionDeny),
	// 			IPRules: []*armwebpubsub.IPRule{
	// 				{
	// 					Action: to.Ptr(armwebpubsub.ACLActionAllow),
	// 					Value: to.Ptr("123.456.789.123/24"),
	// 				},
	// 				{
	// 					Action: to.Ptr(armwebpubsub.ACLActionAllow),
	// 					Value: to.Ptr("123.456.789.123"),
	// 				},
	// 				{
	// 					Action: to.Ptr(armwebpubsub.ACLActionAllow),
	// 					Value: to.Ptr("AppService"),
	// 			}},
	// 			PrivateEndpoints: []*armwebpubsub.PrivateEndpointACL{
	// 				{
	// 					Allow: []*armwebpubsub.WebPubSubRequestType{
	// 						to.Ptr(armwebpubsub.WebPubSubRequestTypeServerConnection)},
	// 						Name: to.Ptr("mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e"),
	// 				}},
	// 				PublicNetwork: &armwebpubsub.NetworkACL{
	// 					Allow: []*armwebpubsub.WebPubSubRequestType{
	// 						to.Ptr(armwebpubsub.WebPubSubRequestTypeClientConnection)},
	// 					},
	// 				},
	// 				PrivateEndpointConnections: []*armwebpubsub.PrivateEndpointConnection{
	// 					{
	// 						Name: to.Ptr("mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e"),
	// 						Type: to.Ptr("Microsoft.SignalRService/WebPubSub/privateEndpointConnections"),
	// 						ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/WebPubSub/myWebPubSubService/privateEndpointConnections/mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e"),
	// 						SystemData: &armwebpubsub.SystemData{
	// 							CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-02-03T04:05:06.000Z"); return t}()),
	// 							CreatedBy: to.Ptr("string"),
	// 							CreatedByType: to.Ptr(armwebpubsub.CreatedByTypeUser),
	// 							LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-02-03T04:05:06.000Z"); return t}()),
	// 							LastModifiedBy: to.Ptr("string"),
	// 							LastModifiedByType: to.Ptr(armwebpubsub.CreatedByTypeUser),
	// 						},
	// 						Properties: &armwebpubsub.PrivateEndpointConnectionProperties{
	// 							PrivateEndpoint: &armwebpubsub.PrivateEndpoint{
	// 								ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"),
	// 							},
	// 							PrivateLinkServiceConnectionState: &armwebpubsub.PrivateLinkServiceConnectionState{
	// 								ActionsRequired: to.Ptr("None"),
	// 								Status: to.Ptr(armwebpubsub.PrivateLinkServiceConnectionStatusApproved),
	// 							},
	// 							ProvisioningState: to.Ptr(armwebpubsub.ProvisioningStateSucceeded),
	// 						},
	// 				}},
	// 				ProvisioningState: to.Ptr(armwebpubsub.ProvisioningStateSucceeded),
	// 				PublicNetworkAccess: to.Ptr("Enabled"),
	// 				PublicPort: to.Ptr[int32](443),
	// 				RegionEndpointEnabled: to.Ptr("Enabled"),
	// 				ResourceLogConfiguration: &armwebpubsub.ResourceLogConfiguration{
	// 					Categories: []*armwebpubsub.ResourceLogCategory{
	// 						{
	// 							Name: to.Ptr("ConnectivityLogs"),
	// 							Enabled: to.Ptr("true"),
	// 					}},
	// 				},
	// 				ResourceStopped: to.Ptr("false"),
	// 				ServerPort: to.Ptr[int32](443),
	// 				SocketIO: &armwebpubsub.SocketIOSettings{
	// 					ServiceMode: to.Ptr("Serverless"),
	// 				},
	// 				TLS: &armwebpubsub.TLSSettings{
	// 					ClientCertEnabled: to.Ptr(true),
	// 				},
	// 				Version: to.Ptr("1.0"),
	// 			},
	// 			SKU: &armwebpubsub.ResourceSKU{
	// 				Name: to.Ptr("Premium_P1"),
	// 				Capacity: to.Ptr[int32](1),
	// 				Size: to.Ptr("P1"),
	// 				Tier: to.Ptr(armwebpubsub.WebPubSubSKUTierPremium),
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { WebPubSubManagementClient } = require("@azure/arm-webpubsub");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get the resource and its properties.
 *
 * @summary Get the resource and its properties.
 * x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSub_Get.json
 */
async function webPubSubGet() {
  const subscriptionId =
    process.env["WEB-PUBSUB_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["WEB-PUBSUB_RESOURCE_GROUP"] || "myResourceGroup";
  const resourceName = "myWebPubSubService";
  const credential = new DefaultAzureCredential();
  const client = new WebPubSubManagementClient(credential, subscriptionId);
  const result = await client.webPubSub.get(resourceGroupName, resourceName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

샘플 응답

상태 코드:: 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"
  }
}

정의

Name	Description
ACLAction	Azure 네트워킹 ACL 작업.
createdByType	리소스를 만든 ID의 형식입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
IPRule	IP 규칙
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	리소스의 청구 정보입니다.
ServiceKind	서비스의 종류
SharedPrivateLinkResource	공유 Private Link 리소스에 대해 설명합니다.
SharedPrivateLinkResourceStatus	공유 프라이빗 링크 리소스의 상태
systemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.
UserAssignedIdentityProperty	사용자 할당 ID의 속성입니다.
WebPubSubNetworkACLs	리소스에 대한 네트워크 ACL
WebPubSubRequestType	서비스에 들어오는 요청 유형
WebPubSubResource	클래스는 리소스를 나타냅니다.
WebPubSubSkuTier	이 특정 SKU의 선택적 계층입니다. '표준' 또는 '무료'. `Basic`는 사용되지 않으며, 대신 `Standard`를 사용합니다.
WebPubSubSocketIOSettings	리소스에 대한 SocketIO 설정
WebPubSubTlsSettings	리소스에 대한 TLS 설정

ACLAction

Azure 네트워킹 ACL 작업.

Name	형식	Description
Allow	string
Deny	string

createdByType

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

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

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

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

오류 응답

Name	형식	Description
error	ErrorDetail	Error 개체.

IPRule

IP 규칙

Name	형식	Description
action	ACLAction	Azure 네트워킹 ACL 작업.
value	string	IP 또는 CIDR 또는 ServiceTag

LiveTraceCategory

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

Name	형식	Description
enabled	string	라이브 추적 범주를 사용할지 여부를 나타냅니다. 사용 가능한 값: true, false. 대/소문자를 구분하지 않습니다.
name	string	라이브 추적 범주의 이름을 가져오거나 설정합니다. 사용 가능한 값: ConnectivityLogs, MessagingLogs. 대/소문자를 구분하지 않습니다.

LiveTraceConfiguration

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

Name	형식	Default value	Description
categories	LiveTraceCategory[]		범주 구성 목록을 가져오거나 설정합니다.
enabled	string	false	라이브 추적을 사용하도록 설정할지 여부를 나타냅니다. true로 설정하면 라이브 추적 클라이언트가 서비스에 연결할 수 있습니다. 그렇지 않으면 라이브 추적 클라이언트가 서비스에 연결할 수 없으므로 "범주"에서 구성한 내용에 관계없이 로그를 받을 수 없습니다. 사용 가능한 값: true, false. 대/소문자를 구분하지 않습니다.

ManagedIdentity

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

Name	형식	Description
principalId	string	시스템 할당 ID의 보안 주체 ID를 가져옵니다. 응답에만 사용됩니다.
tenantId	string	시스템 할당 ID에 대한 테넌트 ID를 가져옵니다. 응답에만 사용
type	ManagedIdentityType	id 형식을 나타냅니다. systemAssigned, userAssigned, None
userAssignedIdentities	<string, UserAssignedIdentityProperty>	사용자 할당 ID 가져오기 또는 설정

ManagedIdentityType

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

Name	형식	Description
None	string
SystemAssigned	string
UserAssigned	string

NetworkACL

네트워크 ACL

Name	형식	Description
allow	WebPubSubRequestType[]	허용된 요청 유형입니다. 값은 ClientConnection, ServerConnection, RESTAPI 중 하나 이상일 수 있습니다.
deny	WebPubSubRequestType[]	요청 유형이 거부되었습니다. 값은 ClientConnection, ServerConnection, RESTAPI 중 하나 이상일 수 있습니다.

PrivateEndpoint

프라이빗 엔드포인트

Name	형식	Description
id	string	프라이빗 엔드포인트의 정규화된 ID

PrivateEndpointACL

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

Name	형식	Description
allow	WebPubSubRequestType[]	허용된 요청 유형입니다. 값은 ClientConnection, ServerConnection, RESTAPI 중 하나 이상일 수 있습니다.
deny	WebPubSubRequestType[]	요청 유형이 거부되었습니다. 값은 ClientConnection, ServerConnection, RESTAPI 중 하나 이상일 수 있습니다.
name	string	프라이빗 엔드포인트 연결의 이름

PrivateEndpointConnection

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

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	리소스의 이름입니다.
properties.groupIds	string[]	그룹 ID
properties.privateEndpoint	PrivateEndpoint	프라이빗 엔드포인트
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	프라이빗 엔드포인트 연결의 연결 상태
properties.provisioningState	ProvisioningState	리소스의 프로비전 상태입니다.
systemData	systemData	createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다.
type	string	리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

PrivateLinkServiceConnectionState

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

Name	형식	Description
actionsRequired	string	서비스 공급자의 변경 내용에 소비자에 대한 업데이트가 필요한지 여부를 나타내는 메시지입니다.
description	string	연결의 승인/거부 이유입니다.
status	PrivateLinkServiceConnectionStatus	서비스 소유자가 연결을 승인/거부/제거했는지 여부를 나타냅니다.

PrivateLinkServiceConnectionStatus

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

Name	형식	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

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

Name	형식	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Moving	string
Running	string
Succeeded	string
Unknown	string
Updating	string

ResourceLogCategory

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

Name	형식	Description
enabled	string	리소스 로그 범주를 사용할지 여부를 나타냅니다. 사용 가능한 값: true, false. 대/소문자를 구분하지 않습니다.
name	string	리소스 로그 범주의 이름을 가져오거나 설정합니다. 사용 가능한 값: ConnectivityLogs, MessagingLogs. 대/소문자를 구분하지 않습니다.

ResourceLogConfiguration

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

Name	형식	Description
categories	ResourceLogCategory[]	범주 구성 목록을 가져오거나 설정합니다.

ResourceSku

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

Name	형식	Description
capacity	integer	선택적 정수입니다. 리소스의 단위 수입니다. Free_F1/Standard_S1/Premium_P1 1, 기본적으로 Premium_P2 경우 100입니다. 있는 경우 다음 값이 허용됩니다. 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	사용되지 않습니다. 나중에 사용할 수 있습니다.
name	string	SKU의 이름입니다. 필수 사항입니다. 허용되는 값: Standard_S1, Free_F1, Premium_P1, Premium_P2
size	string	사용되지 않습니다. 나중에 사용할 수 있습니다.
tier	WebPubSubSkuTier	이 특정 SKU의 선택적 계층입니다. '표준' 또는 '무료'. `Basic`는 사용되지 않으며, 대신 `Standard`를 사용합니다.

ServiceKind

서비스의 종류

Name	형식	Description
SocketIO	string
WebPubSub	string

SharedPrivateLinkResource

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

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	리소스의 이름입니다.
properties.groupId	string	공유 프라이빗 링크 리소스가 대상인 리소스 공급자의 그룹 ID
properties.privateLinkResourceId	string	공유 프라이빗 링크 리소스가 사용하는 리소스의 리소스 ID
properties.provisioningState	ProvisioningState	리소스의 프로비전 상태입니다.
properties.requestMessage	string	공유 프라이빗 링크 리소스의 승인을 요청하기 위한 요청 메시지
properties.status	SharedPrivateLinkResourceStatus	공유 프라이빗 링크 리소스의 상태
systemData	systemData	createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다.
type	string	리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceStatus

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

Name	형식	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string
Timeout	string

systemData

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

Name	형식	Description
createdAt	string	UTC(리소스 만들기)의 타임스탬프입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID 유형입니다.

UserAssignedIdentityProperty

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

Name	형식	Description
clientId	string	사용자 할당 ID에 대한 클라이언트 ID 가져오기
principalId	string	사용자 할당 ID의 보안 주체 ID 가져오기

WebPubSubNetworkACLs

리소스에 대한 네트워크 ACL

Name	형식	Description
defaultAction	ACLAction	Azure 네트워킹 ACL 작업.
ipRules	IPRule[]	공용 트래픽을 필터링하기 위한 IP 규칙
privateEndpoints	PrivateEndpointACL[]	프라이빗 엔드포인트의 요청에 대한 ACL
publicNetwork	NetworkACL	네트워크 ACL

WebPubSubRequestType

서비스에 들어오는 요청 유형

Name	형식	Description
ClientConnection	string
RESTAPI	string
ServerConnection	string
Trace	string

WebPubSubResource

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

Name	형식	Default value	Description
id	string		리소스에 대한 정규화된 리소스 ID입니다. 예: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedIdentity		클래스는 요청 및 응답에 사용되는 관리 ID를 나타냅니다.
kind	ServiceKind		서비스의 종류
location	string		리소스가 있는 지리적 위치
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 instance.
properties.hostNamePrefix	string		더 이상 사용되지 않습니다.
properties.liveTraceConfiguration	LiveTraceConfiguration		Microsoft.SignalRService 리소스의 라이브 추적 구성입니다.
properties.networkACLs	WebPubSubNetworkACLs		리소스에 대한 네트워크 ACL
properties.privateEndpointConnections	PrivateEndpointConnection[]		리소스에 대한 프라이빗 엔드포인트 연결입니다.
properties.provisioningState	ProvisioningState		리소스의 프로비전 상태입니다.
properties.publicNetworkAccess	string	Enabled	공용 네트워크 액세스를 사용하거나 사용하지 않도록 설정합니다. 기본값은 "사용"입니다. 사용하도록 설정되면 네트워크 ACL이 계속 적용됩니다. 사용 안 함인 경우 네트워크 ACL에서 설정한 내용에 관계없이 공용 네트워크 액세스는 항상 사용하지 않도록 설정됩니다.
properties.publicPort	integer		브라우저/클라이언트 쪽 사용을 위해 설계된 리소스의 공개적으로 액세스할 수 있는 포트입니다.
properties.regionEndpointEnabled	string	Enabled	지역별 엔드포인트를 사용하거나 사용하지 않도록 설정합니다. 기본값은 "사용"입니다. 사용 안 함으로 설정되면 새 연결이 이 엔드포인트로 라우팅되지 않지만 기존 연결은 영향을 받지 않습니다. 이 속성은 복제본(replica) 고유합니다. 복제본(replica) 없이 지역 엔드포인트를 사용하지 않도록 설정할 수 없습니다.
properties.resourceLogConfiguration	ResourceLogConfiguration		Microsoft.SignalRService 리소스의 리소스 로그 구성입니다.
properties.resourceStopped	string	false	리소스를 중지하거나 시작합니다. 기본값은 "False"입니다. True이면 리소스의 데이터 평면이 종료됩니다. false이면 리소스의 데이터 평면이 시작됩니다.
properties.serverPort	integer		고객 서버 쪽 사용을 위해 설계된 리소스의 공개적으로 액세스할 수 있는 포트입니다.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		공유 프라이빗 링크 리소스 목록입니다.
properties.socketIO	WebPubSubSocketIOSettings		리소스에 대한 SocketIO 설정
properties.tls	WebPubSubTlsSettings		리소스에 대한 TLS 설정
properties.version	string		리소스의 버전입니다. 클라이언트 SDK의 버전이 동일하거나 그 이상 필요할 수 있습니다.
sku	ResourceSku		리소스의 청구 정보입니다.
systemData	systemData		createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다.
tags	object		리소스 태그.
type	string		리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

WebPubSubSkuTier

이 특정 SKU의 선택적 계층입니다. '표준' 또는 '무료'.

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

Name	형식	Description
Basic	string
Free	string
Premium	string
Standard	string

WebPubSubSocketIOSettings

리소스에 대한 SocketIO 설정

Name	형식	Description
serviceMode	string	Socket.IO 대한 Web PubSub의 서비스 모드입니다. 허용되는 값: "기본값": 사용자 고유의 백 엔드 Socket.IO 서버 "서버리스"가 있음: 애플리케이션에 백 엔드 서버가 없습니다.

WebPubSubTlsSettings

리소스에 대한 TLS 설정

Name	형식	Default value	Description
clientCertEnabled	boolean	False	사용하도록 설정된 경우 TLS 핸드셰이크 중에 클라이언트 인증서를 요청합니다. 무료 계층에 대해 지원되지 않습니다. 모든 입력은 무료 계층에 대해 무시됩니다.

다음을 통해 공유

Web Pub Sub - Get

URI 매개 변수

응답

보안

azure_auth

범위

예제

WebPubSub_Get

샘플 요청

샘플 응답

정의

ACLAction

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IPRule

LiveTraceCategory

LiveTraceConfiguration

ManagedIdentity

ManagedIdentityType

NetworkACL

PrivateEndpoint

PrivateEndpointACL

PrivateEndpointConnection

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningState

ResourceLogCategory

ResourceLogConfiguration

ResourceSku

ServiceKind

SharedPrivateLinkResource

SharedPrivateLinkResourceStatus

systemData

UserAssignedIdentityProperty

WebPubSubNetworkACLs

WebPubSubRequestType

WebPubSubResource

WebPubSubSkuTier

WebPubSubSocketIOSettings

WebPubSubTlsSettings

추가 리소스