Web Pub Sub - Get

Referenz

Dienst:: Azure Web PubSub Service

API-Version:: 2024-03-01

Rufen Sie die Ressource und die zugehörigen Eigenschaften ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
resourceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$	Der Name der Ressource.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	WebPubSubResource	Erfolg. Die Antwort beschreibt die entsprechende Ressource.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

WebPubSub_Get

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
ACLAction	Azure Networking ACL-Aktion.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
IPRule	Eine IP-Regel
LiveTraceCategory	Konfiguration der Live-Ablaufverfolgungskategorie einer Microsoft.SignalRService-Ressource.
LiveTraceConfiguration	Live-Ablaufverfolgungskonfiguration einer Microsoft.SignalRService-Ressource.
ManagedIdentity	Eine Klasse stellt verwaltete Identitäten dar, die für Anforderung und Antwort verwendet werden.
ManagedIdentityType	Stellt den Identitätstyp dar: systemAssigned, userAssigned, None
NetworkACL	Netzwerk-ACL
PrivateEndpoint	Privater Endpunkt
PrivateEndpointACL	ACL für einen privaten Endpunkt
PrivateEndpointConnection	Eine private Endpunktverbindung mit einer Azure-Ressource
PrivateLinkServiceConnectionState	Verbindungsstatus der privaten Endpunktverbindung
PrivateLinkServiceConnectionStatus	Gibt an, ob die Verbindung vom Besitzer des Diensts genehmigt/abgelehnt/entfernt wurde.
ProvisioningState	Bereitstellungsstatus der Ressource.
ResourceLogCategory	Ressourcenprotokollkategoriekonfiguration einer Microsoft.SignalRService-Ressource.
ResourceLogConfiguration	Ressourcenprotokollkonfiguration einer Microsoft.SignalRService-Ressource.
ResourceSku	Die Abrechnungsinformationen der Ressource.
ServiceKind	Die Art des Diensts
SharedPrivateLinkResource	Beschreibt eine Ressource für freigegebene private Verknüpfungen
SharedPrivateLinkResourceStatus	Status der freigegebenen ressource für private Links
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UserAssignedIdentityProperty	Eigenschaften der vom Benutzer zugewiesenen Identität.
WebPubSubNetworkACLs	Netzwerk-ACLs für die Ressource
WebPubSubRequestType	Der Typ der eingehenden Anforderung an den Dienst
WebPubSubResource	Eine Klasse stellt eine Ressource dar.
WebPubSubSkuTier	Optionale Ebene dieser bestimmten SKU. "Standard" oder "Kostenlos". `Basic` veraltet ist, verwenden Sie stattdessen `Standard`.
WebPubSubSocketIOSettings	SocketIO-Einstellungen für die Ressource
WebPubSubTlsSettings	TLS-Einstellungen für die Ressource

ACLAction

Enumeration

Azure Networking ACL-Aktion.

Wert	Beschreibung
Allow
Deny

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

IPRule

Objekt

Eine IP-Regel

Name	Typ	Beschreibung
action	ACLAction	Azure Networking ACL-Aktion.
value	string	EINE IP- oder CIDR- oder ServiceTag-Eigenschaft

LiveTraceCategory

Objekt

Konfiguration der Live-Ablaufverfolgungskategorie einer Microsoft.SignalRService-Ressource.

Name	Typ	Beschreibung
enabled	string	Gibt an, ob die Live-Ablaufverfolgungskategorie aktiviert ist. Verfügbare Werte: true, false. Schreibungsunabhängig.
name	string	Ruft den Namen der Live-Ablaufverfolgungskategorie ab oder legt sie fest. Verfügbare Werte: ConnectivityLogs, MessagingLogs. Schreibungsunabhängig.

LiveTraceConfiguration

Objekt

Live-Ablaufverfolgungskonfiguration einer Microsoft.SignalRService-Ressource.

Name	Typ	Standardwert	Beschreibung
categories	LiveTraceCategory[]		Dient zum Abrufen oder Festlegen der Liste der Kategoriekonfigurationen.
enabled	string	false	Gibt an, ob die Live-Ablaufverfolgung aktiviert ist. Wenn sie auf "true" festgelegt ist, kann der Live-Ablaufverfolgungsclient eine Verbindung mit dem Dienst herstellen. Andernfalls kann der Live-Ablaufverfolgungsclient keine Verbindung mit dem Dienst herstellen, sodass Sie kein Protokoll empfangen können, unabhängig davon, was Sie in "Kategorien" konfigurieren. Verfügbare Werte: true, false. Schreibungsunabhängig.

ManagedIdentity

Objekt

Eine Klasse stellt verwaltete Identitäten dar, die für Anforderung und Antwort verwendet werden.

Name	Typ	Beschreibung
principalId	string	Rufen Sie die Prinzipal-ID für die vom System zugewiesene Identität ab. Nur als Antwort verwendet werden.
tenantId	string	Rufen Sie die Mandanten-ID für die vom System zugewiesene Identität ab. Nur als Antwort verwendet werden
type	ManagedIdentityType	Stellt den Identitätstyp dar: systemAssigned, userAssigned, None
userAssignedIdentities	<string, UserAssignedIdentityProperty>	Abrufen oder Festlegen der vom Benutzer zugewiesenen Identitäten

ManagedIdentityType

Enumeration

Stellt den Identitätstyp dar: systemAssigned, userAssigned, None

Wert	Beschreibung
None
SystemAssigned
UserAssigned

NetworkACL

Objekt

Netzwerk-ACL

Name	Typ	Beschreibung
allow	WebPubSubRequestType[]	Zulässige Anforderungstypen. Der Wert kann eine oder mehrere von: ClientConnection, ServerConnection, RESTAPI sein.
deny	WebPubSubRequestType[]	Anforderungstypen verweigert. Der Wert kann eine oder mehrere von: ClientConnection, ServerConnection, RESTAPI sein.

PrivateEndpoint

Objekt

Privater Endpunkt

Name	Typ	Beschreibung
id	string	Vollständige qualifizierte ID des privaten Endpunkts

PrivateEndpointACL

Objekt

ACL für einen privaten Endpunkt

Name	Typ	Beschreibung
allow	WebPubSubRequestType[]	Zulässige Anforderungstypen. Der Wert kann eine oder mehrere von: ClientConnection, ServerConnection, RESTAPI sein.
deny	WebPubSubRequestType[]	Anforderungstypen verweigert. Der Wert kann eine oder mehrere von: ClientConnection, ServerConnection, RESTAPI sein.
name	string	Name der privaten Endpunktverbindung

PrivateEndpointConnection

Objekt

Eine private Endpunktverbindung mit einer Azure-Ressource

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.groupIds	string[]	Gruppen-IDs
properties.privateEndpoint	PrivateEndpoint	Privater Endpunkt
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Verbindungsstatus der privaten Endpunktverbindung
properties.provisioningState	ProvisioningState	Bereitstellungsstatus der Ressource.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateLinkServiceConnectionState

Objekt

Verbindungsstatus der privaten Endpunktverbindung

Name	Typ	Beschreibung
actionsRequired	string	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher erfordern.
description	string	Der Grund für die Genehmigung/Ablehnung der Verbindung.
status	PrivateLinkServiceConnectionStatus	Gibt an, ob die Verbindung vom Besitzer des Diensts genehmigt/abgelehnt/entfernt wurde.

PrivateLinkServiceConnectionStatus

Enumeration

Gibt an, ob die Verbindung vom Besitzer des Diensts genehmigt/abgelehnt/entfernt wurde.

Wert	Beschreibung
Approved
Disconnected
Pending
Rejected

ProvisioningState

Enumeration

Bereitstellungsstatus der Ressource.

Wert	Beschreibung
Canceled
Creating
Deleting
Failed
Moving
Running
Succeeded
Unknown
Updating

ResourceLogCategory

Objekt

Ressourcenprotokollkategoriekonfiguration einer Microsoft.SignalRService-Ressource.

Name	Typ	Beschreibung
enabled	string	Gibt an, ob die Ressourcenprotokollkategorie aktiviert ist. Verfügbare Werte: true, false. Schreibungsunabhängig.
name	string	Dient zum Abrufen oder Festlegen des Namens der Ressourcenprotokollkategorie. Verfügbare Werte: ConnectivityLogs, MessagingLogs. Schreibungsunabhängig.

ResourceLogConfiguration

Objekt

Ressourcenprotokollkonfiguration einer Microsoft.SignalRService-Ressource.

Name	Typ	Beschreibung
categories	ResourceLogCategory[]	Dient zum Abrufen oder Festlegen der Liste der Kategoriekonfigurationen.

ResourceSku

Objekt

Die Abrechnungsinformationen der Ressource.

Name	Typ	Beschreibung
capacity	integer (int32)	Optional, ganze Zahl. Die Anzahl der Einheiten der Ressource. 1 für Free_F1/Standard_S1/Premium_P1, 100 für Premium_P2 standardmäßig. Wenn vorhanden, sind folgende Werte zulässig: 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	Wird nicht verwendet. Für die zukünftige Verwendung beibehalten.
name	string	Der Name der SKU. Erforderlich. Zulässige Werte: Standard_S1, Free_F1, Premium_P1, Premium_P2
size	string	Wird nicht verwendet. Für die zukünftige Verwendung beibehalten.
tier	WebPubSubSkuTier	Optionale Ebene dieser bestimmten SKU. "Standard" oder "Kostenlos". `Basic` veraltet ist, verwenden Sie stattdessen `Standard`.

ServiceKind

Enumeration

Die Art des Diensts

Wert	Beschreibung
SocketIO
WebPubSub

SharedPrivateLinkResource

Objekt

Beschreibt eine Ressource für freigegebene private Verknüpfungen

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.groupId	string	Die Gruppen-ID vom Anbieter der Ressource, für die die freigegebene private Linkressource gilt
properties.privateLinkResourceId	string	Die Ressourcen-ID der Ressource, für die die freigegebene private Verknüpfungsressource gilt
properties.provisioningState	ProvisioningState	Bereitstellungsstatus der Ressource.
properties.requestMessage	string	Die Anforderungsnachricht zum Anfordern der Genehmigung der Ressource für freigegebene private Links
properties.status	SharedPrivateLinkResourceStatus	Status der freigegebenen ressource für private Links
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceStatus

Enumeration

Status der freigegebenen ressource für private Links

Wert	Beschreibung
Approved
Disconnected
Pending
Rejected
Timeout

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

UserAssignedIdentityProperty

Objekt

Eigenschaften der vom Benutzer zugewiesenen Identität.

Name	Typ	Beschreibung
clientId	string	Abrufen der Client-ID für die vom Benutzer zugewiesene Identität
principalId	string	Abrufen der Prinzipal-ID für die vom Benutzer zugewiesene Identität

WebPubSubNetworkACLs

Objekt

Netzwerk-ACLs für die Ressource

Name	Typ	Beschreibung
defaultAction	ACLAction	Azure Networking ACL-Aktion.
ipRules	IPRule[]	IP-Regeln zum Filtern von öffentlichem Datenverkehr
privateEndpoints	PrivateEndpointACL[]	ACLs für Anforderungen von privaten Endpunkten
publicNetwork	NetworkACL	Netzwerk-ACL

WebPubSubRequestType

Enumeration

Der Typ der eingehenden Anforderung an den Dienst

Wert	Beschreibung
ClientConnection
RESTAPI
ServerConnection
Trace

WebPubSubResource

Objekt

Eine Klasse stellt eine Ressource dar.

Name	Typ	Standardwert	Beschreibung
id	string (arm-id)		Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedIdentity		Eine Klasse stellt verwaltete Identitäten dar, die für Anforderung und Antwort verwendet werden.
kind	ServiceKind		Die Art des Diensts
location	string		Der geografische Standort, an dem sich die Ressource befindet
name	string		Der Name der Ressource
properties.disableAadAuth	boolean	False	DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad will't work.
properties.disableLocalAuth	boolean	False	DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx will't work.
properties.externalIP	string		Die öffentlich zugängliche IP der Ressource.
properties.hostName	string		FQDN der Dienstinstanz.
properties.hostNamePrefix	string		Veraltet
properties.liveTraceConfiguration	LiveTraceConfiguration		Live-Ablaufverfolgungskonfiguration einer Microsoft.SignalRService-Ressource.
properties.networkACLs	WebPubSubNetworkACLs		Netzwerk-ACLs für die Ressource
properties.privateEndpointConnections	PrivateEndpointConnection[]		Private Endpunktverbindungen mit der Ressource.
properties.provisioningState	ProvisioningState		Bereitstellungsstatus der Ressource.
properties.publicNetworkAccess	string	Enabled	Aktivieren oder Deaktivieren des öffentlichen Netzwerkzugriffs. Der Standardwert ist "Aktiviert". Wenn sie aktiviert ist, gelten weiterhin Netzwerk-ACLs. Wenn sie deaktiviert ist, ist der Zugriff auf öffentliche Netzwerke immer deaktiviert, unabhängig davon, was Sie in Netzwerk-ACLs festgelegt haben.
properties.publicPort	integer (int32)		Der öffentlich zugängliche Port der Ressource, die für die browser-/clientseitige Nutzung entwickelt wurde.
properties.regionEndpointEnabled	string	Enabled	Aktivieren oder deaktivieren Sie den regionalen Endpunkt. Der Standardwert ist "Aktiviert". Wenn sie deaktiviert ist, werden neue Verbindungen nicht an diesen Endpunkt weitergeleitet, vorhandene Verbindungen sind jedoch nicht betroffen. Diese Eigenschaft ist replizspezifisch. Der regionale Endpunkt ohne Replikat deaktivieren ist nicht zulässig.
properties.resourceLogConfiguration	ResourceLogConfiguration		Ressourcenprotokollkonfiguration einer Microsoft.SignalRService-Ressource.
properties.resourceStopped	string	false	Beenden oder starten Sie die Ressource. Der Standardwert ist "False". Wenn dies der Fall ist, wird die Datenebene der Ressource heruntergefahren. Wenn der Wert falsch ist, wird die Datenebene der Ressource gestartet.
properties.serverPort	integer (int32)		Der öffentlich zugängliche Port der Ressource, die für die serverseitige Nutzung des Kunden entwickelt wurde.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Die Liste der freigegebenen ressourcen für private Links.
properties.socketIO	WebPubSubSocketIOSettings		SocketIO-Einstellungen für die Ressource
properties.tls	WebPubSubTlsSettings		TLS-Einstellungen für die Ressource
properties.version	string		Version der Ressource. Wahrscheinlich benötigen Sie dieselbe oder höhere Version von Client-SDKs.
sku	ResourceSku		Die Abrechnungsinformationen der Ressource.
systemData	systemData		Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object		Ressourcentags.
type	string		Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

WebPubSubSkuTier

Enumeration

Optionale Ebene dieser bestimmten SKU. "Standard" oder "Kostenlos".

Basic veraltet ist, verwenden Sie stattdessen Standard.

Wert	Beschreibung
Basic
Free
Premium
Standard

WebPubSubSocketIOSettings

Objekt

SocketIO-Einstellungen für die Ressource

Name	Typ	Beschreibung
serviceMode	string	Der Dienstmodus von Web PubSub für Socket.IO. Zulässige Werte: "Standard": Haben Sie ein eigenes Back-End-Socket.IO Server "Serverless": Ihre Anwendung verfügt nicht über einen Back-End-Server.

WebPubSubTlsSettings

Objekt

TLS-Einstellungen für die Ressource

Name	Typ	Standardwert	Beschreibung
clientCertEnabled	boolean	False	Anfordern des Clientzertifikats während des TLS-Handshakes, falls aktiviert. Wird für die kostenlose Stufe nicht unterstützt. Alle Eingaben werden für die freie Leiste ignoriert.

Freigeben über

Web Pub Sub - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

WebPubSub_Get

Beispielanforderung

Beispiel für eine Antwort

Definitionen

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

Zusätzliche Ressourcen