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

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
resourceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$	Имя ресурса.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть UUID.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	WebPubSubResource	Успех. Ответ описывает соответствующий ресурс.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
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"
  }
}

Определения

Имя	Описание
ACLAction	Действие ACL сети Azure.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
IPRule	Правило IP-адресов
LiveTraceCategory	Конфигурация категории динамической трассировки ресурса Microsoft.SignalRService.
LiveTraceConfiguration	Конфигурация динамической трассировки ресурса Microsoft.SignalRService.
ManagedIdentity	Класс представляет управляемые удостоверения, используемые для запроса и ответа
ManagedIdentityType	Представляет тип удостоверения: systemAssigned, userAssigned, None
NetworkACL	ACL сети
PrivateEndpoint	Частная конечная точка
PrivateEndpointACL	ACL для частной конечной точки
PrivateEndpointConnection	Подключение частной конечной точки к ресурсу Azure
PrivateLinkServiceConnectionState	Состояние подключения частной конечной точки
PrivateLinkServiceConnectionStatus	Указывает, утверждено ли подключение, отклонено или удалено владельцем службы.
ProvisioningState	Состояние подготовки ресурса.
ResourceLogCategory	Конфигурация категории журналов ресурсов ресурса Microsoft.SignalRService.
ResourceLogConfiguration	Конфигурация журнала ресурсов ресурса Microsoft.SignalRService.
ResourceSku	Сведения о выставлении счетов ресурса.
ServiceKind	Тип службы
SharedPrivateLinkResource	Описание ресурса общего приватного канала
SharedPrivateLinkResourceStatus	Состояние ресурса общего приватного канала
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
UserAssignedIdentityProperty	Свойства назначаемого пользователем удостоверения.
WebPubSubNetworkACLs	Сетевые списки управления доступом для ресурса
WebPubSubRequestType	Тип входящего запроса в службу
WebPubSubResource	Класс представляет ресурс.
WebPubSubSkuTier	Необязательный уровень этого конкретного номера SKU. "Стандартный" или "Бесплатный". `Basic` устарели, вместо этого используйте `Standard`.
WebPubSubSocketIOSettings	Параметры SocketIO для ресурса
WebPubSubTlsSettings	Параметры TLS для ресурса

ACLAction

Перечисление

Действие ACL сети Azure.

Значение	Описание
Allow
Deny

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

IPRule

Object

Правило IP-адресов

Имя	Тип	Описание
action	ACLAction	Действие ACL сети Azure.
value	string	IP-адрес или CIDR или ServiceTag

LiveTraceCategory

Object

Конфигурация категории динамической трассировки ресурса Microsoft.SignalRService.

Имя	Тип	Описание
enabled	string	Указывает, включена ли категория динамической трассировки. Доступные значения: true, false. Без учета регистра.
name	string	Возвращает или задает имя категории динамической трассировки. Доступные значения: ConnectivityLogs, MessagingLogs. Без учета регистра.

LiveTraceConfiguration

Object

Конфигурация динамической трассировки ресурса Microsoft.SignalRService.

Имя	Тип	Default value	Описание
categories	LiveTraceCategory[]		Возвращает или задает список конфигураций категорий.
enabled	string	false	Указывает, включена ли динамическая трассировка. Если задано значение true, клиент динамической трассировки может подключиться к службе. В противном случае клиент динамической трассировки не может подключиться к службе, чтобы получить любой журнал независимо от того, что вы настраиваете в категориях. Доступные значения: true, false. Без учета регистра.

ManagedIdentity

Object

Класс представляет управляемые удостоверения, используемые для запроса и ответа

Имя	Тип	Описание
principalId	string	Получите идентификатор субъекта для назначенного системой удостоверения. Используется только в ответе.
tenantId	string	Получите идентификатор клиента для назначенного системой удостоверения. Использовать только в ответе
type	ManagedIdentityType	Представляет тип удостоверения: systemAssigned, userAssigned, None
userAssignedIdentities	<string, UserAssignedIdentityProperty>	Получение или установка назначенных пользователем удостоверений

ManagedIdentityType

Перечисление

Представляет тип удостоверения: systemAssigned, userAssigned, None

Значение	Описание
None
SystemAssigned
UserAssigned

NetworkACL

Object

ACL сети

Имя	Тип	Описание
allow	WebPubSubRequestType[]	Разрешенные типы запросов. Значение может быть одним или несколькими: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Типы отклоненных запросов. Значение может быть одним или несколькими: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpoint

Object

Частная конечная точка

Имя	Тип	Описание
id	string	Полный идентификатор частной конечной точки

PrivateEndpointACL

Object

ACL для частной конечной точки

Имя	Тип	Описание
allow	WebPubSubRequestType[]	Разрешенные типы запросов. Значение может быть одним или несколькими: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Типы отклоненных запросов. Значение может быть одним или несколькими: ClientConnection, ServerConnection, RESTAPI.
name	string	Имя подключения частной конечной точки

PrivateEndpointConnection

Object

Подключение частной конечной точки к ресурсу Azure

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса
properties.groupIds	string[]	Идентификаторы групп
properties.privateEndpoint	PrivateEndpoint	Частная конечная точка
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Состояние подключения частной конечной точки
properties.provisioningState	ProvisioningState	Состояние подготовки ресурса.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

PrivateLinkServiceConnectionState

Object

Состояние подключения частной конечной точки

Имя	Тип	Описание
actionsRequired	string	Сообщение, указывающее, требуются ли изменения в поставщике услуг, требуются какие-либо обновления для потребителя.
description	string	Причина утверждения или отклонения подключения.
status	PrivateLinkServiceConnectionStatus	Указывает, утверждено ли подключение, отклонено или удалено владельцем службы.

PrivateLinkServiceConnectionStatus

Перечисление

Указывает, утверждено ли подключение, отклонено или удалено владельцем службы.

Значение	Описание
Approved
Disconnected
Pending
Rejected

ProvisioningState

Перечисление

Состояние подготовки ресурса.

Значение	Описание
Canceled
Creating
Deleting
Failed
Moving
Running
Succeeded
Unknown
Updating

ResourceLogCategory

Object

Конфигурация категории журналов ресурсов ресурса Microsoft.SignalRService.

Имя	Тип	Описание
enabled	string	Указывает, включена ли категория журнала ресурсов. Доступные значения: true, false. Без учета регистра.
name	string	Возвращает или задает имя категории журнала ресурсов. Доступные значения: ConnectivityLogs, MessagingLogs. Без учета регистра.

ResourceLogConfiguration

Object

Конфигурация журнала ресурсов ресурса Microsoft.SignalRService.

Имя	Тип	Описание
categories	ResourceLogCategory[]	Возвращает или задает список конфигураций категорий.

ResourceSku

Object

Сведения о выставлении счетов ресурса.

Имя	Тип	Описание
capacity	integer (int32)	Необязательное целое число. Количество единиц ресурса. 1 для Free_F1/Standard_S1/Premium_P1, 100 для Premium_P2 по умолчанию. При наличии допустимы следующие значения: 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

Перечисление

Тип службы

Значение	Описание
SocketIO
WebPubSub

SharedPrivateLinkResource

Object

Описание ресурса общего приватного канала

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса
properties.groupId	string	Идентификатор группы поставщика ресурса, для которой используется общий ресурс приватного канала.
properties.privateLinkResourceId	string	Идентификатор ресурса, для которой используется общий ресурс приватного канала.
properties.provisioningState	ProvisioningState	Состояние подготовки ресурса.
properties.requestMessage	string	Сообщение запроса для запроса утверждения общего ресурса приватного канала
properties.status	SharedPrivateLinkResourceStatus	Состояние ресурса общего приватного канала
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceStatus

Перечисление

Состояние ресурса общего приватного канала

Значение	Описание
Approved
Disconnected
Pending
Rejected
Timeout

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

UserAssignedIdentityProperty

Object

Свойства назначаемого пользователем удостоверения.

Имя	Тип	Описание
clientId	string	Получение идентификатора клиента для назначаемого пользователем удостоверения
principalId	string	Получение идентификатора субъекта для назначенного пользователем удостоверения

WebPubSubNetworkACLs

Object

Сетевые списки управления доступом для ресурса

Имя	Тип	Описание
defaultAction	ACLAction	Действие ACL сети Azure.
ipRules	IPRule[]	Правила IP-адресов для фильтрации общедоступного трафика
privateEndpoints	PrivateEndpointACL[]	Списки управления доступом для запросов из частных конечных точек
publicNetwork	NetworkACL	ACL сети

WebPubSubRequestType

Перечисление

Тип входящего запроса в службу

Значение	Описание
ClientConnection
RESTAPI
ServerConnection
Trace

WebPubSubResource

Object

Класс представляет ресурс.

Имя	Тип	Default value	Описание
id	string (arm-id)		Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedIdentity		Класс представляет управляемые удостоверения, используемые для запроса и ответа
kind	ServiceKind		Тип службы
location	string		Географическое расположение, в котором находится ресурс
name	string		Имя ресурса
properties.disableAadAuth	boolean	False	DisableLocalAuth Enable или disable aad auth When set as true, connection with AuthType=aad не будет работать.
properties.disableLocalAuth	boolean	False	DisableLocalAuth Enable или disable local auth with AccessKey When set as true, connection with AccessKey=xxx не будет работать.
properties.externalIP	string		Общедоступный IP-адрес ресурса.
properties.hostName	string		Полное доменное имя экземпляра службы.
properties.hostNamePrefix	string		Устарело.
properties.liveTraceConfiguration	LiveTraceConfiguration		Конфигурация динамической трассировки ресурса Microsoft.SignalRService.
properties.networkACLs	WebPubSubNetworkACLs		Сетевые списки управления доступом для ресурса
properties.privateEndpointConnections	PrivateEndpointConnection[]		Подключения частной конечной точки к ресурсу.
properties.provisioningState	ProvisioningState		Состояние подготовки ресурса.
properties.publicNetworkAccess	string	Enabled	Включение или отключение доступа к общедоступной сети. Значение по умолчанию — "Включено". Если он включен, сетевые списки управления доступом по-прежнему применяются. Если он отключен, доступ к общедоступной сети всегда отключен независимо от того, что вы устанавливаете в сетевых списках управления доступом.
properties.publicPort	integer (int32)		Общедоступный порт ресурса, предназначенный для использования на стороне браузера или клиента.
properties.regionEndpointEnabled	string	Enabled	Включите или отключите региональную конечную точку. Значение по умолчанию — "Включено". При отключении новые подключения не будут перенаправлены в эту конечную точку, однако существующие подключения не будут затронуты. Это свойство зависит от реплики. Отключить региональную конечную точку без реплики запрещено.
properties.resourceLogConfiguration	ResourceLogConfiguration		Конфигурация журнала ресурсов ресурса Microsoft.SignalRService.
properties.resourceStopped	string	false	Остановите или запустите ресурс. По умолчанию — False. Если это верно, плоскость данных ресурса завершается. Когда это значение равно false, запускается плоскость данных ресурса.
properties.serverPort	integer (int32)		Общедоступный порт ресурса, предназначенный для использования на стороне клиента.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Список общих ресурсов приватного канала.
properties.socketIO	WebPubSubSocketIOSettings		Параметры SocketIO для ресурса
properties.tls	WebPubSubTlsSettings		Параметры TLS для ресурса
properties.version	string		Версия ресурса. Возможно, вам нужна та же или более поздняя версия клиентских пакетов SDK.
sku	ResourceSku		Сведения о выставлении счетов ресурса.
systemData	systemData		Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object		Теги ресурсов.
type	string		Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

WebPubSubSkuTier

Перечисление

Необязательный уровень этого конкретного номера SKU. "Стандартный" или "Бесплатный".

Basic устарели, вместо этого используйте Standard.

Значение	Описание
Basic
Free
Premium
Standard

WebPubSubSocketIOSettings

Object

Параметры SocketIO для ресурса

Имя	Тип	Описание
serviceMode	string	Режим службы Web PubSub для Socket.IO. Допустимые значения: "Default": у вас есть собственный сервер серверной Socket.IO "Бессерверный": у вашего приложения нет серверного сервера.

WebPubSubTlsSettings

Object

Параметры TLS для ресурса

Имя	Тип	Default value	Описание
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

Дополнительные ресурсы