Web Pub Sub - List By Subscription

Service:

Azure Web PubSub Service

API Version:

2023-02-01

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=2023-02-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Pobiera identyfikator subskrypcji, który jednoznacznie identyfikuje subskrypcję platformy 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

Nazwa	Typ	Opis
200 OK	WebPubSubResourceList	Powodzenie. Odpowiedź opisuje listę zasobów w subskrypcji.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

WebPubSub_ListBySubscription

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/webPubSub?api-version=2023-02-01

Java

/** Samples for WebPubSub List. */
public final class Main {
    /*
     * x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/WebPubSub_ListBySubscription.json
     */
    /**
     * Sample code: WebPubSub_ListBySubscription.
     *
     * @param manager Entry point to WebPubSubManager.
     */
    public static void webPubSubListBySubscription(com.azure.resourcemanager.webpubsub.WebPubSubManager manager) {
        manager.webPubSubs().list(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

Python

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_list_by_subscription.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.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/WebPubSub_ListBySubscription.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

Go

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/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/WebPubSub_ListBySubscription.json
func ExampleClient_NewListBySubscriptionPager() {
	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)
	}
	pager := clientFactory.NewClient().NewListBySubscriptionPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ResourceInfoList = armwebpubsub.ResourceInfoList{
		// 	Value: []*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"),
		// 			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"),
		// 			},
		// 			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),
		// 					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"),
		// 								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),
		// 								},
		// 								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),
		// 								},
		// 						}},
		// 						ProvisioningState: to.Ptr(armwebpubsub.ProvisioningStateSucceeded),
		// 						PublicNetworkAccess: to.Ptr("Enabled"),
		// 						PublicPort: to.Ptr[int32](443),
		// 						ResourceLogConfiguration: &armwebpubsub.ResourceLogConfiguration{
		// 							Categories: []*armwebpubsub.ResourceLogCategory{
		// 								{
		// 									Name: to.Ptr("ConnectivityLogs"),
		// 									Enabled: to.Ptr("true"),
		// 							}},
		// 						},
		// 						ServerPort: to.Ptr[int32](443),
		// 						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),
		// 					},
		// 					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),
		// 					},
		// 			}},
		// 		}
	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Handles requests to list all resources in a subscription.
 *
 * @summary Handles requests to list all resources in a subscription.
 * x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2023-02-01/examples/WebPubSub_ListBySubscription.json
 */
async function webPubSubListBySubscription() {
  const subscriptionId =
    process.env["WEB-PUBSUB_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new WebPubSubManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.webPubSub.listBySubscription()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

Sample Response

Status code:

200

{
  "value": [
    {
      "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": [
          {
            "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

Nazwa	Opis
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 żądania 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
WebPubSubRequestType	Typ żądania przychodzącego do usługi
WebPubSubResource	Klasa reprezentuje zasób.
WebPubSubResourceList	Obiekt zawierający 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.

Nazwa	Typ	Opis
Allow	string
Deny	string

createdByType

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

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

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

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

LiveTraceCategory

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

Nazwa	Typ	Opis
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.

Nazwa	Typ	Wartość domyślna	Opis
categories	LiveTraceCategory[]		Pobiera lub ustawia listę konfiguracji kategorii.
enabled	string	false	Wskazuje, czy włączyć ś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, bez względu na to, co konfigurujesz 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 żądania i odpowiedzi

Nazwa	Typ	Opis
principalId	string	Pobierz identyfikator podmiotu zabezpieczeń dla 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. Tylko być używane w odpowiedzi
type	ManagedIdentityType	Reprezentuje typ tożsamości: systemAssigned, userAssigned, None
userAssignedIdentities	<string,  UserAssignedIdentityProperty>	Pobieranie lub ustawianie tożsamości przypisanych przez użytkownika

ManagedIdentityType

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

Nazwa	Typ	Opis
None	string
SystemAssigned	string
UserAssigned	string

NetworkACL

Lista ACL sieci

Nazwa	Typ	Opis
allow	WebPubSubRequestType[]	Dozwolone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Odrzucone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpoint

Prywatny punkt końcowy

Nazwa	Typ	Opis
id	string	Pełny kwalifikowany identyfikator prywatnego punktu końcowego

PrivateEndpointACL

Lista ACL dla prywatnego punktu końcowego

Nazwa	Typ	Opis
allow	WebPubSubRequestType[]	Dozwolone typy żądań. Wartość może być jedną lub więcej: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	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

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu.
name	string	Nazwa zasobu.
properties.groupIds	string[]	Identyfikatory grup
properties.privateEndpoint	PrivateEndpoint	Prywatny punkt końcowy
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stan połączenia prywatnego punktu końcowego
properties.provisioningState	ProvisioningState	Stan aprowizacji zasobu.
systemData	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

Nazwa	Typ	Opis
actionsRequired	string	Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji dla konsumenta.
description	string	Przyczyna zatwierdzenia/odrzucenia połączenia.
status	PrivateLinkServiceConnectionStatus	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.

Nazwa	Typ	Opis
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Stan aprowizacji zasobu.

Nazwa	Typ	Opis
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.

Nazwa	Typ	Opis
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.

Nazwa	Typ	Opis
categories	ResourceLogCategory[]	Pobiera lub ustawia listę konfiguracji kategorii.

ResourceSku

Informacje dotyczące rozliczeń zasobu.

Nazwa	Typ	Opis
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,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,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, Premium_P1
size	string	Nie używany. Zachowywane do użytku w przyszłości.
tier	WebPubSubSkuTier	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

Nazwa	Typ	Opis
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ę udostępniony zasób łącza prywatnego
properties.privateLinkResourceId	string	Identyfikator zasobu zasobu, dla których znajduje się udostępniony zasób łącza prywatnego
properties.provisioningState	ProvisioningState	Stan aprowizacji zasobu.
properties.requestMessage	string	Komunikat żądania żądania żądania zatwierdzenia udostępnionego zasobu łącza prywatnego
properties.status	SharedPrivateLinkResourceStatus	Stan zasobu udostępnionego łącza prywatnego
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
type	string	Typ zasobu — np. "Microsoft.SignalRService/SignalR"

SharedPrivateLinkResourceStatus

Stan zasobu udostępnionego łącza prywatnego

Nazwa	Typ	Opis
Approved	string
Disconnected	string
Pending	string
Rejected	string
Timeout	string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	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	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

UserAssignedIdentityProperty

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

Nazwa	Typ	Opis
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

Nazwa	Typ	Opis
defaultAction	ACLAction	Akcja listy ACL sieci platformy Azure.
privateEndpoints	PrivateEndpointACL[]	Listy ACL dla żądań z prywatnych punktów końcowych
publicNetwork	NetworkACL	Lista ACL sieci

WebPubSubRequestType

Typ żądania przychodzącego do usługi

Nazwa	Typ	Opis
ClientConnection	string
RESTAPI	string
ServerConnection	string
Trace	string

WebPubSubResource

Klasa reprezentuje zasób.

Nazwa	Typ	Wartość domyślna	Opis
id	string		W pełni kwalifikowany identyfikator zasobu dla zasobu.
identity	ManagedIdentity		Klasa reprezentuje tożsamości zarządzane używane do żądania i odpowiedzi
location	string		Lokalizacja GEO 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't work.DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx't work.
properties.externalIP	string		Publiczny adres IP zasobu.
properties.hostName	string		Nazwa FQDN wystąpienia usługi.
properties.hostNamePrefix	string		Przestarzałe.
properties.liveTraceConfiguration	LiveTraceConfiguration		Konfiguracja śledzenia na żywo zasobu Microsoft.SignalRService.
properties.networkACLs	WebPubSubNetworkACLs		Listy ACL sieci dla zasobu
properties.privateEndpointConnections	PrivateEndpointConnection[]		Połączenia prywatnego punktu końcowego z zasobem.
properties.provisioningState	ProvisioningState		Stan aprowizacji zasobu.
properties.publicNetworkAccess	string	Enabled	Włącz lub wyłącz dostęp 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	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	SharedPrivateLinkResource[]		Lista udostępnionych zasobów łącza prywatnego.
properties.tls	WebPubSubTlsSettings		Ustawienia protokołu TLS dla zasobu
properties.version	string		Wersja zasobu. Prawdopodobnie potrzebujesz tej samej lub nowszej wersji zestawów SDK klienta.
sku	ResourceSku		Informacje dotyczące rozliczeń zasobu.
systemData	systemData		Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
tags	object		Tagi usługi, która jest listą par klucz wartości opisujących zasób.
type	string		Typ zasobu — np. "Microsoft.SignalRService/SignalR"

WebPubSubResourceList

Obiekt zawierający tablicę zasobów i możliwy link do następnego zestawu.

Nazwa	Typ	Opis
nextLink	string	Adres URL klienta 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	WebPubSubResource[]	Lista zasobów

WebPubSubSkuTier

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

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

Nazwa	Typ	Opis
Basic	string
Free	string
Premium	string
Standard	string

WebPubSubTlsSettings

Ustawienia protokołu TLS dla zasobu

Nazwa	Typ	Wartość domyślna	Opis
clientCertEnabled	boolean	True	Żądanie certyfikatu klienta podczas uzgadniania protokołu TLS, jeśli jest włączone