Web Pub Sub - Get

Reference

Služba:: Azure Web PubSub Service

Verze rozhraní API:: 2024-03-01

Získejte prostředek a jeho vlastnosti.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
resourceName	path	True	string	Název prostředku. Vzor regulárního výrazu: `^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$`
subscriptionId	path	True	string uuid	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	WebPubSubResource	Úspěch. Odpověď popisuje odpovídající prostředek.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

WebPubSub_Get

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Definice

Name	Description
ACLAction	Akce seznamu ACL pro sítě Azure
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě
ErrorResponse	Chybová odpověď
IPRule	Pravidlo PROTOKOLU IP
LiveTraceCategory	Konfigurace kategorie živého trasování prostředku Microsoft.SignalRService
LiveTraceConfiguration	Konfigurace živého trasování prostředku Microsoft.SignalRService
ManagedIdentity	Třída představující spravované identity používané pro požadavky a odpovědi
ManagedIdentityType	Představuje typ identity: systemAssigned, userAssigned, None
NetworkACL	Seznam ACL sítě
PrivateEndpoint	Privátní koncový bod
PrivateEndpointACL	Seznam ACL pro privátní koncový bod
PrivateEndpointConnection	Připojení privátního koncového bodu k prostředku Azure
PrivateLinkServiceConnectionState	Stav připojení privátního koncového bodu
PrivateLinkServiceConnectionStatus	Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby.
ProvisioningState	Stav zřizování prostředku.
ResourceLogCategory	Konfigurace kategorie protokolu prostředků pro prostředek Microsoft.SignalRService
ResourceLogConfiguration	Konfigurace protokolu prostředků prostředku Microsoft.SignalRService.
ResourceSku	Fakturační údaje prostředku.
ServiceKind	Druh služby
SharedPrivateLinkResource	Popisuje sdílený prostředek Private Link.
SharedPrivateLinkResourceStatus	Stav prostředku sdíleného privátního propojení
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
UserAssignedIdentityProperty	Vlastnosti identity přiřazené uživatelem.
WebPubSubNetworkACLs	Síťové seznamy ACL pro prostředek
WebPubSubRequestType	Typ příchozího požadavku na službu
WebPubSubResource	Třída představuje prostředek.
WebPubSubSkuTier	Volitelná úroveň této konkrétní skladové položky 'Standard' nebo 'Free'. `Basic` je zastaralá, místo toho použijte `Standard` .
WebPubSubSocketIOSettings	Nastavení SocketIO pro prostředek
WebPubSubTlsSettings	Nastavení protokolu TLS pro prostředek

ACLAction

Akce seznamu ACL pro sítě Azure

Name	Typ	Description
Allow	string
Deny	string

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

IPRule

Pravidlo PROTOKOLU IP

Name	Typ	Description
action	ACLAction	Akce seznamu ACL pro sítě Azure
value	string	IP adresa, CIDR nebo značka služby

LiveTraceCategory

Konfigurace kategorie živého trasování prostředku Microsoft.SignalRService

Name	Typ	Description
enabled	string	Určuje, jestli je povolená kategorie živého trasování nebo . Dostupné hodnoty: true, false Nerozlišují se malá a velká písmena.
name	string	Získá nebo nastaví název kategorie živého trasování. Dostupné hodnoty: ConnectivityLogs, MessagingLogs. Nerozlišují se malá a velká písmena.

LiveTraceConfiguration

Konfigurace živého trasování prostředku Microsoft.SignalRService

Name	Typ	Default value	Description
categories	LiveTraceCategory[]		Získá nebo nastaví seznam konfigurací kategorií.
enabled	string	false	Určuje, jestli je povolené živé trasování. Když je nastavená hodnota true, klient živého trasování se může připojit ke službě. Jinak se klient živého trasování nemůže ke službě připojit, takže nemůžete přijímat žádný protokol bez ohledu na to, co nakonfigurujete v kategoriích. Dostupné hodnoty: true, false Nerozlišují se malá a velká písmena.

ManagedIdentity

Třída představující spravované identity používané pro požadavky a odpovědi

Name	Typ	Description
principalId	string	Získejte ID objektu zabezpečení pro identitu přiřazenou systémem. Použít pouze jako odpověď.
tenantId	string	Získejte ID tenanta pro identitu přiřazenou systémem. Použít pouze v reakci
type	ManagedIdentityType	Představuje typ identity: systemAssigned, userAssigned, None
userAssignedIdentities	<string, UserAssignedIdentityProperty>	Získání nebo nastavení identit přiřazených uživatelem

ManagedIdentityType

Představuje typ identity: systemAssigned, userAssigned, None

Name	Typ	Description
None	string
SystemAssigned	string
UserAssigned	string

NetworkACL

Seznam ACL sítě

Name	Typ	Description
allow	WebPubSubRequestType[]	Povolené typy požadavků. Hodnota může být jedna nebo více z těchto: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Typy zamítnutých požadavků Hodnota může být jedna nebo více z těchto: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpoint

Privátní koncový bod

Name	Typ	Description
id	string	Úplné kvalifikované ID privátního koncového bodu

PrivateEndpointACL

Seznam ACL pro privátní koncový bod

Name	Typ	Description
allow	WebPubSubRequestType[]	Povolené typy požadavků. Hodnota může být jedna nebo více z těchto: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Typy zamítnutých požadavků Hodnota může být jedna nebo více z těchto: ClientConnection, ServerConnection, RESTAPI.
name	string	Název připojení privátního koncového bodu

PrivateEndpointConnection

Připojení privátního koncového bodu k prostředku Azure

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku Například /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{název_poskytovatele_prostředku}/{typ_prostředku}/{název_prostředku}.
name	string	Název prostředku
properties.groupIds	string[]	ID skupin
properties.privateEndpoint	PrivateEndpoint	Privátní koncový bod
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stav připojení privátního koncového bodu
properties.provisioningState	ProvisioningState	Stav zřizování prostředku.
systemData	systemData	Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

PrivateLinkServiceConnectionState

Stav připojení privátního koncového bodu

Name	Typ	Description
actionsRequired	string	Zpráva s informacemi o tom, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.
description	string	Důvod schválení nebo zamítnutí připojení.
status	PrivateLinkServiceConnectionStatus	Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby.

PrivateLinkServiceConnectionStatus

Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby.

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Stav zřizování prostředku.

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

ResourceLogCategory

Konfigurace kategorie protokolu prostředků pro prostředek Microsoft.SignalRService

Name	Typ	Description
enabled	string	Určuje, jestli je povolená kategorie protokolu prostředků nebo . Dostupné hodnoty: true, false Nerozlišují se malá a velká písmena.
name	string	Získá nebo nastaví název kategorie protokolu prostředků. Dostupné hodnoty: ConnectivityLogs, MessagingLogs. Nerozlišují se malá a velká písmena.

ResourceLogConfiguration

Konfigurace protokolu prostředků prostředku Microsoft.SignalRService.

Name	Typ	Description
categories	ResourceLogCategory[]	Získá nebo nastaví seznam konfigurací kategorií.

ResourceSku

Fakturační údaje prostředku.

Name	Typ	Description
capacity	integer	Volitelné, celé číslo. Počet jednotek prostředku. 1 pro Free_F1/Standard_S1/Premium_P1, 100 pro Premium_P2 ve výchozím nastavení. Pokud existují, jsou povoleny následující hodnoty: 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	Nepoužívá se. Uchová se pro budoucí použití.
name	string	Název skladové položky. Povinná hodnota. Povolené hodnoty: Standard_S1, Free_F1, Premium_P1, Premium_P2
size	string	Nepoužívá se. Uchová se pro budoucí použití.
tier	WebPubSubSkuTier	Volitelná úroveň této konkrétní skladové položky 'Standard' nebo 'Free'. `Basic` je zastaralá, místo toho použijte `Standard` .

ServiceKind

Druh služby

Name	Typ	Description
SocketIO	string
WebPubSub	string

SharedPrivateLinkResource

Popisuje sdílený prostředek Private Link.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku Například /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{název_poskytovatele_prostředku}/{typ_prostředku}/{název_prostředku}.
name	string	Název prostředku
properties.groupId	string	ID skupiny od poskytovatele prostředku, pro který je prostředek sdíleného privátního propojení určen
properties.privateLinkResourceId	string	ID prostředku, pro který je prostředek sdíleného privátního propojení určen
properties.provisioningState	ProvisioningState	Stav zřizování prostředku.
properties.requestMessage	string	Zpráva žádosti o schválení prostředku sdíleného privátního propojení
properties.status	SharedPrivateLinkResourceStatus	Stav prostředku sdíleného privátního propojení
systemData	systemData	Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

SharedPrivateLinkResourceStatus

Stav prostředku sdíleného privátního propojení

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string
Timeout	string

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která vytvořila prostředek.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

UserAssignedIdentityProperty

Vlastnosti identity přiřazené uživatelem.

Name	Typ	Description
clientId	string	Získání ID klienta pro identitu přiřazenou uživatelem
principalId	string	Získání ID objektu zabezpečení pro identitu přiřazenou uživatelem

WebPubSubNetworkACLs

Síťové seznamy ACL pro prostředek

Name	Typ	Description
defaultAction	ACLAction	Akce seznamu ACL pro sítě Azure
ipRules	IPRule[]	Pravidla IP adres pro filtrování veřejného provozu
privateEndpoints	PrivateEndpointACL[]	Seznamy ACL pro požadavky z privátních koncových bodů
publicNetwork	NetworkACL	Seznam ACL sítě

WebPubSubRequestType

Typ příchozího požadavku na službu

Name	Typ	Description
ClientConnection	string
RESTAPI	string
ServerConnection	string
Trace	string

WebPubSubResource

Třída představuje prostředek.

Name	Typ	Default value	Description
id	string		Plně kvalifikované ID prostředku Například /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{název_poskytovatele_prostředku}/{typ_prostředku}/{název_prostředku}.
identity	ManagedIdentity		Třída představující spravované identity používané pro požadavky a odpovědi
kind	ServiceKind		Druh služby
location	string		Geografické umístění, kde se prostředek nachází
name	string		Název prostředku
properties.disableAadAuth	boolean	False	DisableLocalAuth Povolení nebo zakázání ověřování aad Pokud je nastaveno na hodnotu true, připojení pomocí AuthType=aad nebude fungovat.
properties.disableLocalAuth	boolean	False	DisableLocalAuth Povolení nebo zakázání místního ověřování pomocí AccessKey Pokud je nastavená hodnota true, připojení pomocí AccessKey=xxx nebude fungovat.
properties.externalIP	string		Veřejně přístupná IP adresa prostředku.
properties.hostName	string		Plně kvalifikovaný název domény instance služby.
properties.hostNamePrefix	string		Zastaralé
properties.liveTraceConfiguration	LiveTraceConfiguration		Konfigurace živého trasování prostředku Microsoft.SignalRService
properties.networkACLs	WebPubSubNetworkACLs		Síťové seznamy ACL pro prostředek
properties.privateEndpointConnections	PrivateEndpointConnection[]		Připojení privátních koncových bodů k prostředku
properties.provisioningState	ProvisioningState		Stav zřizování prostředku.
properties.publicNetworkAccess	string	Enabled	Povolte nebo zakažte veřejný síťový přístup. Výchozí hodnota je "Povoleno". Síťové seznamy ACL platí i v případě, že je povoleno. Pokud je zakázaný, veřejný síťový přístup je vždy zakázán bez ohledu na to, co jste nastavili v seznamech ACL sítě.
properties.publicPort	integer		Veřejně přístupný port prostředku, který je určený pro použití na straně prohlížeče nebo klienta.
properties.regionEndpointEnabled	string	Enabled	Povolte nebo zakažte místní koncový bod. Výchozí hodnota je "Povoleno". Pokud je tato možnost zakázaná, nová připojení se do tohoto koncového bodu nesměrují, ale na stávající připojení to nebude mít vliv. Tato vlastnost je specifická pro repliku. Zakázání místního koncového bodu bez repliky není povolené.
properties.resourceLogConfiguration	ResourceLogConfiguration		Konfigurace protokolu prostředků prostředku Microsoft.SignalRService.
properties.resourceStopped	string	false	Zastavte nebo spusťte prostředek. Výchozí hodnota je False. Pokud je to pravda, rovina dat prostředku se vypne. Když je hodnota false, spustí se rovina dat prostředku.
properties.serverPort	integer		Veřejně přístupný port prostředku, který je určený pro použití na straně serveru zákazníka.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Seznam prostředků sdíleného privátního propojení.
properties.socketIO	WebPubSubSocketIOSettings		Nastavení SocketIO pro prostředek
properties.tls	WebPubSubTlsSettings		Nastavení protokolu TLS pro prostředek
properties.version	string		Verze prostředku. Pravděpodobně potřebujete stejnou nebo vyšší verzi klientských sad SDK.
sku	ResourceSku		Fakturační údaje prostředku.
systemData	systemData		Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
tags	object		Značky prostředků.
type	string		Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

WebPubSubSkuTier

Volitelná úroveň této konkrétní skladové položky 'Standard' nebo 'Free'.

Basic je zastaralá, místo toho použijte Standard .

Name	Typ	Description
Basic	string
Free	string
Premium	string
Standard	string

WebPubSubSocketIOSettings

Nastavení SocketIO pro prostředek

Name	Typ	Description
serviceMode	string	Režim služby Web PubSub pro Socket.IO. Povolené hodnoty: Výchozí: máte vlastní back-end Socket.IO server bez serveru: vaše aplikace nemá back-endový server.

WebPubSubTlsSettings

Nastavení protokolu TLS pro prostředek

Name	Typ	Default value	Description
clientCertEnabled	boolean	False	Vyžádejte si klientský certifikát během metody handshake protokolu TLS, pokud je povoleno. Nepodporuje se pro úroveň Free. Všechny vstupy budou ignorovány pro úroveň Free.

Sdílet prostřednictvím

Web Pub Sub - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

WebPubSub_Get

Ukázkový požadavek

Ukázková odpověď

Definice

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

Další materiály