Web Pub Sub - Get

Dienst:

Azure Web PubSub Service

API-Version:

2024-03-01

Rufen Sie die Ressource und ihre 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	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
resourceName	path	True	string	Der Name der Ressource. RegEx-Muster: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$
subscriptionId	path	True	string uuid	Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	WebPubSubResource	Erfolg. Die Antwort beschreibt die entsprechende Ressource.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SignalRService/webPubSub/myWebPubSubService?api-version=2024-03-01

Java

/**
 * 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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.webpubsub import WebPubSubManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-webpubsub
# USAGE
    python web_pub_sub_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

Go

package armwebpubsub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/webpubsub/armwebpubsub"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/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

JavaScript

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-Netzwerk-ACL-Aktion.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
IPRule	Eine IP-Regel
LiveTraceCategory	Live-Ablaufverfolgungskategoriekonfiguration einer Microsoft.SignalRService-Ressource.
LiveTraceConfiguration	Liveablaufverfolgungskonfiguration 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 Verbindung mit einem privaten Endpunkt 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 freigegebene Private Link-Ressource
SharedPrivateLinkResourceStatus	Status der freigegebenen Private Link-Ressource
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
UserAssignedIdentityProperty	Eigenschaften der benutzerseitig zugewiesenen Identität.
WebPubSubNetworkACLs	Netzwerk-ACLs für die Ressource
WebPubSubRequestType	Der eingehende Anforderungstyp für den Dienst
WebPubSubResource	Eine Klasse stellt eine Ressource dar.
WebPubSubSkuTier	Optionaler Tarif dieser bestimmten SKU. "Standard" oder "Free". Basic ist veraltet. Verwenden Sie stattdessen Standard.
WebPubSubSocketIOSettings	SocketIO-Einstellungen für die Ressource
WebPubSubTlsSettings	TLS-Einstellungen für die Ressource

ACLAction

Azure-Netzwerk-ACL-Aktion.

Name	Typ	Beschreibung
Allow	string
Deny	string

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

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

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

IPRule

Eine IP-Regel

Name	Typ	Beschreibung
action	ACLAction	Azure-Netzwerk-ACL-Aktion.
value	string	Eine IP- oder CIDR- oder ServiceTag-Instanz

LiveTraceCategory

Live-Ablaufverfolgungskategoriekonfiguration einer Microsoft.SignalRService-Ressource.

Name	Typ	Beschreibung
enabled	string	Gibt an, ob oder die Live-Ablaufverfolgungskategorie aktiviert ist. Verfügbare Werte: true, false. Diese Klasse berücksichtigt keine Groß-/Kleinschreibung.
name	string	Ruft den Namen der Live-Ablaufverfolgungskategorie ab oder legt diese fest. Verfügbare Werte: ConnectivityLogs, MessagingLogs. Diese Klasse berücksichtigt keine Groß-/Kleinschreibung.

LiveTraceConfiguration

Liveablaufverfolgungskonfiguration einer Microsoft.SignalRService-Ressource.

Name	Typ	Standardwert	Beschreibung
categories	LiveTraceCategory[]		Ruft die Liste der Kategoriekonfigurationen ab oder legt sie fest.
enabled	string	false	Gibt an, ob die Liveablaufverfolgung aktiviert wird. Wenn er 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. Diese Klasse berücksichtigt keine Groß-/Kleinschreibung.

ManagedIdentity

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 systemseitig zugewiesene Identität ab. Nur als Antwort verwendet werden.
tenantId	string	Rufen Sie die Mandanten-ID für die systemseitig 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 benutzerseitig zugewiesenen Identitäten

ManagedIdentityType

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

Name	Typ	Beschreibung
None	string
SystemAssigned	string
UserAssigned	string

NetworkACL

Netzwerk-ACL

Name	Typ	Beschreibung
allow	WebPubSubRequestType[]	Zulässige Anforderungstypen. Der Wert kann mindestens eine der folgenden Werte sein: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Abgelehnte Anforderungstypen. Der Wert kann mindestens eine der folgenden Werte sein: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpoint

Privater Endpunkt

Name	Typ	Beschreibung
id	string	Vollqualifizierte ID des privaten Endpunkts

PrivateEndpointACL

ACL für einen privaten Endpunkt

Name	Typ	Beschreibung
allow	WebPubSubRequestType[]	Zulässige Anforderungstypen. Der Wert kann mindestens eine der folgenden Werte sein: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Abgelehnte Anforderungstypen. Der Wert kann mindestens eine der folgenden Werte sein: ClientConnection, ServerConnection, RESTAPI.
name	string	Name der verbindung mit dem privaten Endpunkt

PrivateEndpointConnection

Eine Verbindung mit einem privaten Endpunkt mit einer Azure-Ressource

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{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 mit createdBy- und modifiedBy-Informationen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateLinkServiceConnectionState

Verbindungsstatus der privaten Endpunktverbindung

Name	Typ	Beschreibung
actionsRequired	string	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer 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

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

Name	Typ	Beschreibung
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Bereitstellungsstatus der Ressource.

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

ResourceLogCategory

Ressourcenprotokollkategoriekonfiguration einer Microsoft.SignalRService-Ressource.

Name	Typ	Beschreibung
enabled	string	Gibt an, ob oder die Ressourcenprotokollkategorie aktiviert ist. Verfügbare Werte: true, false. Diese Klasse berücksichtigt keine Groß-/Kleinschreibung.
name	string	Ruft den Namen der Ressourcenprotokollkategorie ab oder legt diese fest. Verfügbare Werte: ConnectivityLogs, MessagingLogs. Diese Klasse berücksichtigt keine Groß-/Kleinschreibung.

ResourceLogConfiguration

Ressourcenprotokollkonfiguration einer Microsoft.SignalRService-Ressource.

Name	Typ	Beschreibung
categories	ResourceLogCategory[]	Ruft die Liste der Kategoriekonfigurationen ab oder legt sie fest.

ResourceSku

Die Abrechnungsinformationen der Ressource.

Name	Typ	Beschreibung
capacity	integer	Optional, ganze Zahl. Die Einheitenanzahl der Ressource. 1 für Free_F1/Standard_S1/Premium_P1, 100 für Premium_P2 standardmäßig. Falls vorhanden, sind die folgenden 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	Optionaler Tarif dieser bestimmten SKU. "Standard" oder "Free". Basic ist veraltet. Verwenden Sie stattdessen Standard.

ServiceKind

Die Art des Diensts

Name	Typ	Beschreibung
SocketIO	string
WebPubSub	string

SharedPrivateLinkResource

Beschreibt eine freigegebene Private Link-Ressource

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.groupId	string	Die Gruppen-ID des Ressourcenanbieters, für den die freigegebene Private Link-Ressource verwendet wird
properties.privateLinkResourceId	string	Die Ressourcen-ID der Ressource, für die die freigegebene Private Link-Ressource verwendet wird
properties.provisioningState	ProvisioningState	Bereitstellungsstatus der Ressource.
properties.requestMessage	string	Die Anforderungsnachricht zum Anfordern der Genehmigung der freigegebenen Privaten Link-Ressource
properties.status	SharedPrivateLinkResourceStatus	Status der freigegebenen Private Link-Ressource
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceStatus

Status der freigegebenen Private Link-Ressource

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

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	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	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

Eigenschaften der benutzerseitig zugewiesenen Identität.

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

WebPubSubNetworkACLs

Netzwerk-ACLs für die Ressource

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

WebPubSubRequestType

Der eingehende Anforderungstyp für den Dienst

Name	Typ	Beschreibung
ClientConnection	string
RESTAPI	string
ServerConnection	string
Trace	string

WebPubSubResource

Eine Klasse stellt eine Ressource dar.

Name	Typ	Standardwert	Beschreibung
id	string		Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{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 Aktivieren oder Deaktivieren der aad-Authentifizierung Wenn sie auf true festgelegt ist, funktioniert die Verbindung mit AuthType=aad nicht.
properties.disableLocalAuth	boolean	False	DisableLocalAuth Aktivieren oder Deaktivieren der lokalen Authentifizierung mit AccessKey Wenn sie auf true festgelegt ist, funktioniert die Verbindung mit AccessKey=xxx nicht.
properties.externalIP	string		Die öffentlich zugängliche IP-Adresse der Ressource.
properties.hostName	string		FQDN des Diensts instance.
properties.hostNamePrefix	string		Veraltet.
properties.liveTraceConfiguration	LiveTraceConfiguration		Liveablaufverfolgungskonfiguration 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 Sie den Zugriff auf öffentliche Netzwerke. Standardmäßig ist "Aktiviert". Wenn 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 festlegen.
properties.publicPort	integer		Der öffentlich zugängliche Port der Ressource, der für die browser-/clientseitige Nutzung konzipiert ist.
properties.regionEndpointEnabled	string	Enabled	Aktivieren oder deaktivieren Sie den regionalen Endpunkt. Standardmäßig ist "Aktiviert". Wenn es deaktiviert ist, werden neue Verbindungen nicht an diesen Endpunkt weitergeleitet, aber vorhandene Verbindungen sind nicht betroffen. Diese Eigenschaft ist replikatspezifisch. Das Deaktivieren des regionalen Endpunkts ohne Replikat 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 es false ist, wird die Datenebene der Ressource gestartet.
properties.serverPort	integer		Der öffentlich zugängliche Port der Ressource, der für die serverseitige Nutzung des Kunden konzipiert ist.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Die Liste der freigegebenen privaten Linkressourcen.
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 eine höhere Version von Client-SDKs.
sku	ResourceSku		Die Abrechnungsinformationen der Ressource.
systemData	systemData		Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
tags	object		Ressourcentags.
type	string		Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

WebPubSubSkuTier

Optionaler Tarif dieser bestimmten SKU. "Standard" oder "Free".

Basic ist veraltet. Verwenden Sie stattdessen Standard.

Name	Typ	Beschreibung
Basic	string
Free	string
Premium	string
Standard	string

WebPubSubSocketIOSettings

SocketIO-Einstellungen für die Ressource

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

WebPubSubTlsSettings

TLS-Einstellungen für die Ressource

Name	Typ	Standardwert	Beschreibung
clientCertEnabled	boolean	False	Anfordern eines Clientzertifikats während des TLS-Handshakes, falls aktiviert. Wird für den kostenlosen Tarif nicht unterstützt. Alle Eingaben werden für den kostenlosen Tarif ignoriert.