Web Pub Sub - Get

Referentie

Service:: Azure Web PubSub Service

API-versie:: 2024-03-01

Haal de resource en de bijbehorende eigenschappen op.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
resourceName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$	De naam van de resource.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	WebPubSubResource	Succes. In het antwoord wordt de bijbehorende resource beschreven.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

WebPubSub_Get

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
ACLAction	Azure Networking ACL Action.
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
IPRule	Een IP-regel
LiveTraceCategory	Configuratie van livetraceringscategorie van een Microsoft.SignalRService-resource.
LiveTraceConfiguration	Live trace-configuratie van een Microsoft.SignalRService-resource.
ManagedIdentity	Een klasse vertegenwoordigt beheerde identiteiten die worden gebruikt voor aanvragen en antwoorden
ManagedIdentityType	Vertegenwoordigt het identiteitstype: systemAssigned, userAssigned, None
NetworkACL	Netwerk-ACL
PrivateEndpoint	Privé-eindpunt
PrivateEndpointACL	ACL voor een privé-eindpunt
PrivateEndpointConnection	Een privé-eindpuntverbinding met een Azure-resource
PrivateLinkServiceConnectionState	Verbindingsstatus van de privé-eindpuntverbinding
PrivateLinkServiceConnectionStatus	Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service.
ProvisioningState	Inrichtingsstatus van de resource.
ResourceLogCategory	Resourcelogboekcategorieconfiguratie van een Microsoft.SignalRService-resource.
ResourceLogConfiguration	Configuratie van resourcelogboek van een Microsoft.SignalRService-resource.
ResourceSku	De factureringsgegevens van de resource.
ServiceKind	Het soort service
SharedPrivateLinkResource	Beschrijft een Gedeelde Private Link-resource
SharedPrivateLinkResourceStatus	Status van de gedeelde private link-resource
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
UserAssignedIdentityProperty	Eigenschappen van door de gebruiker toegewezen identiteit.
WebPubSubNetworkACLs	Netwerk-ACL's voor de resource
WebPubSubRequestType	Het binnenkomende aanvraagtype voor de service
WebPubSubResource	Een klasse vertegenwoordigt een resource.
WebPubSubSkuTier	Optionele laag van deze specifieke SKU. 'Standaard' of 'Gratis'. `Basic` is afgeschaft, gebruikt u in plaats daarvan `Standard`.
WebPubSubSocketIOSettings	SocketIO-instellingen voor de resource
WebPubSubTlsSettings	TLS-instellingen voor de resource

ACLAction

Inventarisatie

Azure Networking ACL Action.

Waarde	Description
Allow
Deny

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

IPRule

Object

Een IP-regel

Name	Type	Description
action	ACLAction	Azure Networking ACL Action.
value	string	Een IP- of CIDR- of ServiceTag

LiveTraceCategory

Object

Configuratie van livetraceringscategorie van een Microsoft.SignalRService-resource.

Name	Type	Description
enabled	string	Geeft aan of de livetraceringscategorie is ingeschakeld. Beschikbare waarden: waar, onwaar. Hoofdlettergevoelig.
name	string	Hiermee haalt u de naam van de live traceringscategorie op of stelt u deze in. Beschikbare waarden: ConnectivityLogs, MessagingLogs. Hoofdlettergevoelig.

LiveTraceConfiguration

Object

Live trace-configuratie van een Microsoft.SignalRService-resource.

Name	Type	Default value	Description
categories	LiveTraceCategory[]		Hiermee haalt u de lijst met categorieconfiguraties op of stelt u deze in.
enabled	string	false	Hiermee wordt aangegeven of livetracering al dan niet is ingeschakeld. Als deze is ingesteld op true, kan de live trace-client verbinding maken met de service. Anders kan de livetraceringsclient geen verbinding maken met de service, zodat u geen logboeken kunt ontvangen, ongeacht wat u configureert in 'categorieën'. Beschikbare waarden: waar, onwaar. Hoofdlettergevoelig.

ManagedIdentity

Object

Een klasse vertegenwoordigt beheerde identiteiten die worden gebruikt voor aanvragen en antwoorden

Name	Type	Description
principalId	string	Haal de principal-id op voor de door het systeem toegewezen identiteit. Alleen worden gebruikt in reactie.
tenantId	string	Haal de tenant-id op voor de door het systeem toegewezen identiteit. Alleen worden gebruikt in reactie
type	ManagedIdentityType	Vertegenwoordigt het identiteitstype: systemAssigned, userAssigned, None
userAssignedIdentities	<string, UserAssignedIdentityProperty>	De door de gebruiker toegewezen identiteiten ophalen of instellen

ManagedIdentityType

Inventarisatie

Vertegenwoordigt het identiteitstype: systemAssigned, userAssigned, None

Waarde	Description
None
SystemAssigned
UserAssigned

NetworkACL

Object

Netwerk-ACL

Name	Type	Description
allow	WebPubSubRequestType[]	Toegestane aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Geweigerde aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpoint

Object

Privé-eindpunt

Name	Type	Description
id	string	Volledig gekwalificeerde id van het privé-eindpunt

PrivateEndpointACL

Object

ACL voor een privé-eindpunt

Name	Type	Description
allow	WebPubSubRequestType[]	Toegestane aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI.
deny	WebPubSubRequestType[]	Geweigerde aanvraagtypen. De waarde kan een of meer zijn: ClientConnection, ServerConnection, RESTAPI.
name	string	Naam van de privé-eindpuntverbinding

PrivateEndpointConnection

Object

Een privé-eindpuntverbinding met een Azure-resource

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties.groupIds	string[]	Groeps-id's
properties.privateEndpoint	PrivateEndpoint	Privé-eindpunt
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Verbindingsstatus van de privé-eindpuntverbinding
properties.provisioningState	ProvisioningState	Inrichtingsstatus van de resource.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PrivateLinkServiceConnectionState

Object

Verbindingsstatus van de privé-eindpuntverbinding

Name	Type	Description
actionsRequired	string	Een bericht dat aangeeft of wijzigingen in de serviceprovider updates voor de consument vereisen.
description	string	De reden voor goedkeuring/afwijzing van de verbinding.
status	PrivateLinkServiceConnectionStatus	Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service.

PrivateLinkServiceConnectionStatus

Inventarisatie

Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service.

Waarde	Description
Approved
Disconnected
Pending
Rejected

ProvisioningState

Inventarisatie

Inrichtingsstatus van de resource.

Waarde	Description
Canceled
Creating
Deleting
Failed
Moving
Running
Succeeded
Unknown
Updating

ResourceLogCategory

Object

Resourcelogboekcategorieconfiguratie van een Microsoft.SignalRService-resource.

Name	Type	Description
enabled	string	Hiermee wordt aangegeven of de categorie resourcelogboek is ingeschakeld. Beschikbare waarden: waar, onwaar. Hoofdlettergevoelig.
name	string	Hiermee haalt u de naam van de resourcelogboekcategorie op of stelt u deze in. Beschikbare waarden: ConnectivityLogs, MessagingLogs. Hoofdlettergevoelig.

ResourceLogConfiguration

Object

Configuratie van resourcelogboek van een Microsoft.SignalRService-resource.

Name	Type	Description
categories	ResourceLogCategory[]	Hiermee haalt u de lijst met categorieconfiguraties op of stelt u deze in.

ResourceSku

Object

De factureringsgegevens van de resource.

Name	Type	Description
capacity	integer (int32)	Optioneel, geheel getal. Het aantal eenheden van de resource. 1 voor Free_F1/Standard_S1/Premium_P1, standaard 100 voor Premium_P2. Indien aanwezig zijn de volgende waarden toegestaan: 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	Niet gebruikt. Behouden voor toekomstig gebruik.
name	string	De naam van de SKU. Verplicht. Toegestane waarden: Standard_S1, Free_F1, Premium_P1, Premium_P2
size	string	Niet gebruikt. Behouden voor toekomstig gebruik.
tier	WebPubSubSkuTier	Optionele laag van deze specifieke SKU. 'Standaard' of 'Gratis'. `Basic` is afgeschaft, gebruikt u in plaats daarvan `Standard`.

ServiceKind

Inventarisatie

Het soort service

Waarde	Description
SocketIO
WebPubSub

SharedPrivateLinkResource

Object

Beschrijft een Gedeelde Private Link-resource

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties.groupId	string	De groeps-id van de provider van de resource waarvoor de gedeelde private link-resource is bedoeld
properties.privateLinkResourceId	string	De resource-id van de resource waarvoor de gedeelde private link-resource is bedoeld
properties.provisioningState	ProvisioningState	Inrichtingsstatus van de resource.
properties.requestMessage	string	Het aanvraagbericht voor het aanvragen van goedkeuring van de gedeelde private link-resource
properties.status	SharedPrivateLinkResourceStatus	Status van de gedeelde private link-resource
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

SharedPrivateLinkResourceStatus

Inventarisatie

Status van de gedeelde private link-resource

Waarde	Description
Approved
Disconnected
Pending
Rejected
Timeout

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

UserAssignedIdentityProperty

Object

Eigenschappen van door de gebruiker toegewezen identiteit.

Name	Type	Description
clientId	string	De client-id ophalen voor de door de gebruiker toegewezen identiteit
principalId	string	De principal-id ophalen voor de door de gebruiker toegewezen identiteit

WebPubSubNetworkACLs

Object

Netwerk-ACL's voor de resource

Name	Type	Description
defaultAction	ACLAction	Azure Networking ACL Action.
ipRules	IPRule[]	IP-regels voor het filteren van openbaar verkeer
privateEndpoints	PrivateEndpointACL[]	ACL's voor aanvragen van privé-eindpunten
publicNetwork	NetworkACL	Netwerk-ACL

WebPubSubRequestType

Inventarisatie

Het binnenkomende aanvraagtype voor de service

Waarde	Description
ClientConnection
RESTAPI
ServerConnection
Trace

WebPubSubResource

Object

Een klasse vertegenwoordigt een resource.

Name	Type	Default value	Description
id	string (arm-id)		Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
identity	ManagedIdentity		Een klasse vertegenwoordigt beheerde identiteiten die worden gebruikt voor aanvragen en antwoorden
kind	ServiceKind		Het soort service
location	string		De geografische locatie waar de resource zich bevindt
name	string		De naam van de resource
properties.disableAadAuth	boolean	False	DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad werkt niet.
properties.disableLocalAuth	boolean	False	DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx werkt niet.
properties.externalIP	string		Het openbaar toegankelijke IP-adres van de resource.
properties.hostName	string		FQDN van het service-exemplaar.
properties.hostNamePrefix	string		Afgeschreven
properties.liveTraceConfiguration	LiveTraceConfiguration		Live trace-configuratie van een Microsoft.SignalRService-resource.
properties.networkACLs	WebPubSubNetworkACLs		Netwerk-ACL's voor de resource
properties.privateEndpointConnections	PrivateEndpointConnection[]		Privé-eindpuntverbindingen met de resource.
properties.provisioningState	ProvisioningState		Inrichtingsstatus van de resource.
properties.publicNetworkAccess	string	Enabled	Openbare netwerktoegang in- of uitschakelen. De standaardwaarde is Ingeschakeld. Wanneer deze functie is ingeschakeld, zijn netwerk-ACL's nog steeds van toepassing. Wanneer deze optie is uitgeschakeld, wordt openbare netwerktoegang altijd uitgeschakeld, ongeacht wat u instelt in netwerk-ACL's.
properties.publicPort	integer (int32)		De openbaar toegankelijke poort van de resource die is ontworpen voor gebruik aan de browser-/clientzijde.
properties.regionEndpointEnabled	string	Enabled	Schakel het regionale eindpunt in of uit. De standaardwaarde is Ingeschakeld. Wanneer deze optie is uitgeschakeld, worden nieuwe verbindingen niet doorgestuurd naar dit eindpunt, maar worden bestaande verbindingen niet beïnvloed. Deze eigenschap is specifiek voor replica's. Het regionale eindpunt zonder replica uitschakelen is niet toegestaan.
properties.resourceLogConfiguration	ResourceLogConfiguration		Configuratie van resourcelogboek van een Microsoft.SignalRService-resource.
properties.resourceStopped	string	false	Stop of start de resource. Standaard ingesteld op 'Onwaar'. Wanneer dit het geval is, wordt het gegevensvlak van de resource afgesloten. Wanneer deze onwaar is, wordt het gegevensvlak van de resource gestart.
properties.serverPort	integer (int32)		De openbaar toegankelijke poort van de resource die is ontworpen voor gebruik aan de serverzijde van de klant.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		De lijst met gedeelde private link-resources.
properties.socketIO	WebPubSubSocketIOSettings		SocketIO-instellingen voor de resource
properties.tls	WebPubSubTlsSettings		TLS-instellingen voor de resource
properties.version	string		Versie van de resource. Waarschijnlijk hebt u dezelfde of hogere versie van client-SDK's nodig.
sku	ResourceSku		De factureringsgegevens van de resource.
systemData	systemData		Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
tags	object		Resourcetags.
type	string		Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

WebPubSubSkuTier

Inventarisatie

Optionele laag van deze specifieke SKU. 'Standaard' of 'Gratis'.

Basic is afgeschaft, gebruikt u in plaats daarvan Standard.

Waarde	Description
Basic
Free
Premium
Standard

WebPubSubSocketIOSettings

Object

SocketIO-instellingen voor de resource

Name	Type	Description
serviceMode	string	De servicemodus van Web PubSub voor Socket.IO. Toegestane waarden: 'Standaard': uw eigen back-end hebben Socket.IO server 'Serverloos': uw toepassing heeft geen back-endserver

WebPubSubTlsSettings

Object

TLS-instellingen voor de resource

Name	Type	Default value	Description
clientCertEnabled	boolean	False	Vraag clientcertificaat aan tijdens TLS-handshake indien ingeschakeld. Niet ondersteund voor de gratis laag. Alle invoer wordt genegeerd voor de gratis laag.

Delen via

Web Pub Sub - Get

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

WebPubSub_Get

Voorbeeldaanvraag

Voorbeeldrespons

Definities

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

Aanvullende resources