Web Pub Sub - Get

Referens

Tjänst:: Azure Web PubSub Service

API-version:: 2024-03-01

Hämta resursen och dess egenskaper.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
resourceName	path	True	string	Namnet på resursen. Reguljärt uttrycksmönster: `^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$`
subscriptionId	path	True	string uuid	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	WebPubSubResource	Åtgärden lyckades. Svaret beskriver motsvarande resurs.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

WebPubSub_Get

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
  }
}

Definitioner

Name	Description
ACLAction	ACL-åtgärd för Azure-nätverk.
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
IPRule	En IP-regel
LiveTraceCategory	Konfiguration av livespårningskategori för en Microsoft.SignalRService-resurs.
LiveTraceConfiguration	Livespårningskonfiguration av en Microsoft.SignalRService-resurs.
ManagedIdentity	En klass representerar hanterade identiteter som används för begäran och svar
ManagedIdentityType	Representerar identitetstypen: systemTilldelad, userAssigned, None
NetworkACL	Nätverks-ACL
PrivateEndpoint	Privat slutpunkt
PrivateEndpointACL	ACL för en privat slutpunkt
PrivateEndpointConnection	En privat slutpunktsanslutning till en Azure-resurs
PrivateLinkServiceConnectionState	Anslutningstillstånd för den privata slutpunktsanslutningen
PrivateLinkServiceConnectionStatus	Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare.
ProvisioningState	Etableringstillstånd för resursen.
ResourceLogCategory	Konfiguration av resursloggkategori för en Microsoft.SignalRService-resurs.
ResourceLogConfiguration	Resursloggkonfiguration för en Microsoft.SignalRService-resurs.
ResourceSku	Faktureringsinformationen för resursen.
ServiceKind	Typen av tjänst
SharedPrivateLinkResource	Beskriver en resurs för delad Private Link
SharedPrivateLinkResourceStatus	Status för resursen för den delade privata länken
systemData	Metadata som rör skapande och senaste ändring av resursen.
UserAssignedIdentityProperty	Egenskaper för användartilldelad identitet.
WebPubSubNetworkACLs	Nätverks-ACL:er för resursen
WebPubSubRequestType	Typen av inkommande begäran till tjänsten
WebPubSubResource	En klass representerar en resurs.
WebPubSubSkuTier	Valfri nivå för den här specifika SKU:n. "Standard" eller "Free". `Basic` är inaktuell, använd `Standard` i stället.
WebPubSubSocketIOSettings	SocketIO-inställningar för resursen
WebPubSubTlsSettings	TLS-inställningar för resursen

ACLAction

ACL-åtgärd för Azure-nätverk.

Name	Typ	Description
Allow	string
Deny	string

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

IPRule

En IP-regel

Name	Typ	Description
action	ACLAction	ACL-åtgärd för Azure-nätverk.
value	string	En IP- eller CIDR eller ServiceTag

LiveTraceCategory

Konfiguration av livespårningskategori för en Microsoft.SignalRService-resurs.

Name	Typ	Description
enabled	string	Anger om eller livespårningskategorin är aktiverad. Tillgängliga värden: true, false. Skiftlägesokänsligt.
name	string	Hämtar eller anger livespårningskategorins namn. Tillgängliga värden: ConnectivityLogs, MessagingLogs. Skiftlägesokänsligt.

LiveTraceConfiguration

Livespårningskonfiguration av en Microsoft.SignalRService-resurs.

Name	Typ	Standardvärde	Description
categories	LiveTraceCategory[]		Hämtar eller anger listan över kategorikonfigurationer.
enabled	string	false	Anger om livespårning ska aktiveras eller inte. När den är inställd på true kan livespårningsklienten ansluta till tjänsten. Annars kan livespårningsklienten inte ansluta till tjänsten, så att du inte kan ta emot någon logg, oavsett vad du konfigurerar i "kategorier". Tillgängliga värden: true, false. Skiftlägesokänsligt.

ManagedIdentity

En klass representerar hanterade identiteter som används för begäran och svar

Name	Typ	Description
principalId	string	Hämta huvud-ID:t för den systemtilldelade identiteten. Används endast som svar.
tenantId	string	Hämta klient-ID:t för den systemtilldelade identiteten. Endast användas som svar
type	ManagedIdentityType	Representerar identitetstypen: systemTilldelad, userAssigned, None
userAssignedIdentities	<string, UserAssignedIdentityProperty>	Hämta eller ange användartilldelade identiteter

ManagedIdentityType

Representerar identitetstypen: systemTilldelad, userAssigned, None

Name	Typ	Description
None	string
SystemAssigned	string
UserAssigned	string

NetworkACL

Nätverks-ACL

Name	Typ	Description
allow	WebPubSubRequestType[]	Tillåtna typer av begäranden. Värdet kan vara ett eller flera av: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Nekade begärandetyper. Värdet kan vara ett eller flera av: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpoint

Privat slutpunkt

Name	Typ	Description
id	string	Fullständigt kvalificerat ID för den privata slutpunkten

PrivateEndpointACL

ACL för en privat slutpunkt

Name	Typ	Description
allow	WebPubSubRequestType[]	Tillåtna typer av begäranden. Värdet kan vara ett eller flera av: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Nekade begärandetyper. Värdet kan vara ett eller flera av: ClientConnection, ServerConnection, RESTAPI.
name	string	Namnet på den privata slutpunktsanslutningen

PrivateEndpointConnection

En privat slutpunktsanslutning till en Azure-resurs

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties.groupIds	string[]	Grupp-ID:t
properties.privateEndpoint	PrivateEndpoint	Privat slutpunkt
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Anslutningstillstånd för den privata slutpunktsanslutningen
properties.provisioningState	ProvisioningState	Etableringstillstånd för resursen.
systemData	systemData	Azure Resource Manager metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

PrivateLinkServiceConnectionState

Anslutningstillstånd för den privata slutpunktsanslutningen

Name	Typ	Description
actionsRequired	string	Ett meddelande som anger om ändringar på tjänstleverantören kräver uppdateringar på konsumenten.
description	string	Anledningen till godkännande/avvisande av anslutningen.
status	PrivateLinkServiceConnectionStatus	Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare.

PrivateLinkServiceConnectionStatus

Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare.

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Etableringstillstånd för resursen.

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

ResourceLogCategory

Konfiguration av resursloggkategori för en Microsoft.SignalRService-resurs.

Name	Typ	Description
enabled	string	Anger om eller resursloggkategorin är aktiverad. Tillgängliga värden: true, false. Skiftlägesokänsligt.
name	string	Hämtar eller anger resursloggkategorins namn. Tillgängliga värden: ConnectivityLogs, MessagingLogs. Skiftlägesokänsligt.

ResourceLogConfiguration

Resursloggkonfiguration för en Microsoft.SignalRService-resurs.

Name	Typ	Description
categories	ResourceLogCategory[]	Hämtar eller anger listan över kategorikonfigurationer.

ResourceSku

Faktureringsinformationen för resursen.

Name	Typ	Description
capacity	integer	Valfritt, heltal. Antalet enheter för resursen. 1 för Free_F1/Standard_S1/Premium_P1, 100 för Premium_P2 som standard. Om det finns tillåts följande värden: 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	Används inte. Behålls för framtida användning.
name	string	Namnet på SKU:n. Krävs. Tillåtna värden: Standard_S1, Free_F1, Premium_P1, Premium_P2
size	string	Används inte. Behålls för framtida användning.
tier	WebPubSubSkuTier	Valfri nivå för den här specifika SKU:n. "Standard" eller "Free". `Basic` är inaktuell, använd `Standard` i stället.

ServiceKind

Typen av tjänst

Name	Typ	Description
SocketIO	string
WebPubSub	string

SharedPrivateLinkResource

Beskriver en resurs för delad Private Link

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties.groupId	string	Grupp-ID:t från resursprovidern som den delade privata länkresursen är till för
properties.privateLinkResourceId	string	Resurs-ID:t för resursen som den delade privata länkresursen är till för
properties.provisioningState	ProvisioningState	Etableringstillstånd för resursen.
properties.requestMessage	string	Begärandemeddelandet för att begära godkännande av resursen för delad privat länk
properties.status	SharedPrivateLinkResourceStatus	Status för resursen för den delade privata länken
systemData	systemData	Azure Resource Manager metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceStatus

Status för resursen för den delade privata länken

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

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

UserAssignedIdentityProperty

Egenskaper för användartilldelad identitet.

Name	Typ	Description
clientId	string	Hämta klient-ID:t för den användartilldelade identiteten
principalId	string	Hämta huvud-ID:t för den användartilldelade identiteten

WebPubSubNetworkACLs

Nätverks-ACL:er för resursen

Name	Typ	Description
defaultAction	ACLAction	ACL-åtgärd för Azure-nätverk.
ipRules	IPRule[]	IP-regler för filtrering av offentlig trafik
privateEndpoints	PrivateEndpointACL[]	ACL:er för begäranden från privata slutpunkter
publicNetwork	NetworkACL	Nätverks-ACL

WebPubSubRequestType

Typen av inkommande begäran till tjänsten

Name	Typ	Description
ClientConnection	string
RESTAPI	string
ServerConnection	string
Trace	string

WebPubSubResource

En klass representerar en resurs.

Name	Typ	Standardvärde	Description
id	string		Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedIdentity		En klass representerar hanterade identiteter som används för begäran och svar
kind	ServiceKind		Typen av tjänst
location	string		Den geo-plats där resursen finns
name	string		Namnet på resursen
properties.disableAadAuth	boolean	False	DisableLocalAuth Aktivera eller inaktivera aad-autentisering När inställningen är true fungerar inte anslutningen med AuthType=aad.
properties.disableLocalAuth	boolean	False	DisableLocalAuth Aktivera eller inaktivera lokal autentisering med AccessKey När inställningen är true fungerar inte anslutningen med AccessKey=xxx.
properties.externalIP	string		Resursens offentligt tillgängliga IP-adress.
properties.hostName	string		FQDN för tjänstinstansen.
properties.hostNamePrefix	string		Inaktuellt.
properties.liveTraceConfiguration	LiveTraceConfiguration		Livespårningskonfiguration av en Microsoft.SignalRService-resurs.
properties.networkACLs	WebPubSubNetworkACLs		Nätverks-ACL:er för resursen
properties.privateEndpointConnections	PrivateEndpointConnection[]		Privata slutpunktsanslutningar till resursen.
properties.provisioningState	ProvisioningState		Etableringstillstånd för resursen.
properties.publicNetworkAccess	string	Enabled	Aktivera eller inaktivera åtkomst till offentligt nätverk. Standardvärdet är "Aktiverad". När den är aktiverad gäller fortfarande nätverks-ACL:er. När den är inaktiverad inaktiveras alltid åtkomsten till det offentliga nätverket oavsett vad du anger i nätverks-ACL:er.
properties.publicPort	integer		Den offentligt tillgängliga porten för resursen som är utformad för användning på webbläsar-/klientsidan.
properties.regionEndpointEnabled	string	Enabled	Aktivera eller inaktivera den regionala slutpunkten. Standardvärdet är "Aktiverad". När den är inaktiverad dirigeras inte nya anslutningar till den här slutpunkten, men befintliga anslutningar påverkas inte. Den här egenskapen är replikspecifik. Inaktivera den regionala slutpunkten utan replik tillåts inte.
properties.resourceLogConfiguration	ResourceLogConfiguration		Resursloggkonfiguration för en Microsoft.SignalRService-resurs.
properties.resourceStopped	string	false	Stoppa eller starta resursen. Standardvärdet är "False". När det är sant stängs resursens dataplan av. När det är falskt startas resursens dataplan.
properties.serverPort	integer		Den offentligt tillgängliga porten för resursen som är utformad för användning på kundserversidan.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Listan över delade privata länkresurser.
properties.socketIO	WebPubSubSocketIOSettings		SocketIO-inställningar för resursen
properties.tls	WebPubSubTlsSettings		TLS-inställningar för resursen
properties.version	string		Resursens version. Förmodligen behöver du samma eller högre version av klient-SDK:er.
sku	ResourceSku		Faktureringsinformationen för resursen.
systemData	systemData		Azure Resource Manager metadata som innehåller createdBy och modifiedBy information.
tags	object		Resurstaggar.
type	string		Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

WebPubSubSkuTier

Valfri nivå för den här specifika SKU:n. "Standard" eller "Free".

Basic är inaktuell, använd Standard i stället.

Name	Typ	Description
Basic	string
Free	string
Premium	string
Standard	string

WebPubSubSocketIOSettings

SocketIO-inställningar för resursen

Name	Typ	Description
serviceMode	string	Tjänstläget för Web PubSub för Socket.IO. Tillåtna värden: "Standard": har en egen serverdel Socket.IO servern "Serverlös": ditt program har ingen serverdelsserver

WebPubSubTlsSettings

TLS-inställningar för resursen

Name	Typ	Standardvärde	Description
clientCertEnabled	boolean	False	Begär klientcertifikat under TLS-handskakning om det är aktiverat. Stöds inte för den kostnadsfria nivån. Alla indata ignoreras för den kostnadsfria nivån.

Dela via

Web Pub Sub - Get

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

WebPubSub_Get

Exempelbegäran

Exempelsvar

Definitioner

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

Ytterligare resurser