Private Endpoints - Get

Szolgáltatás:

Stream Analytics

API-verzió:

2020-03-01

Információt kap a megadott privát végpontról.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/clusters/{clusterName}/privateEndpoints/{privateEndpointName}?api-version=2020-03-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
clusterName	path	True	string	A klaszter neve.
privateEndpointName	path	True	string	A privát végpont neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	PrivateEndpoint	Sikeresen lekérte a megadott privát végpontot.
Other Status Codes	Error	Hiba.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Get a private endpoint

Mintakérelem

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/testcluster/privateEndpoints/testpe?api-version=2020-03-01

Java

/**
 * Samples for PrivateEndpoints Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/
     * PrivateEndpoint_Get.json
     */
    /**
     * Sample code: Get a private endpoint.
     * 
     * @param manager Entry point to StreamAnalyticsManager.
     */
    public static void getAPrivateEndpoint(com.azure.resourcemanager.streamanalytics.StreamAnalyticsManager manager) {
        manager.privateEndpoints().getWithResponse("sjrg", "testcluster", "testpe", 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

Go

package armstreamanalytics_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/streamanalytics/armstreamanalytics"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/PrivateEndpoint_Get.json
func ExamplePrivateEndpointsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstreamanalytics.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPrivateEndpointsClient().Get(ctx, "sjrg", "testcluster", "testpe", 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.PrivateEndpoint = armstreamanalytics.PrivateEndpoint{
	// 	Name: to.Ptr("An Example Private Endpoint"),
	// 	Type: to.Ptr("Microsoft.StreamAnalytics/clusters/privateEndpoints"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/testcluster/privateEndpoints/AnExamplePrivateEndpoint"),
	// 	Etag: to.Ptr("F86B9B70-D5B1-451D-AFC8-0B42D4729B8C"),
	// 	Properties: &armstreamanalytics.PrivateEndpointProperties{
	// 		CreatedDate: to.Ptr("2020-03-01T01:00Z"),
	// 		ManualPrivateLinkServiceConnections: []*armstreamanalytics.PrivateLinkServiceConnection{
	// 			{
	// 				Properties: &armstreamanalytics.PrivateLinkServiceConnectionProperties{
	// 					GroupIDs: []*string{
	// 						to.Ptr("groupIdFromResource")},
	// 						PrivateLinkServiceConnectionState: &armstreamanalytics.PrivateLinkConnectionState{
	// 							Description: to.Ptr("Awaiting approval"),
	// 							ActionsRequired: to.Ptr("None"),
	// 							Status: to.Ptr("Pending"),
	// 						},
	// 						PrivateLinkServiceID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls"),
	// 						RequestMessage: to.Ptr("This connection request originated from Azure Stream Analytics cluster named \"testcluster\". Please approve this request to allow any Stream Analytics job running on that cluster to access this resource."),
	// 					},
	// 			}},
	// 		},
	// 	}
}

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 { StreamAnalyticsManagementClient } = require("@azure/arm-streamanalytics");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets information about the specified Private Endpoint.
 *
 * @summary Gets information about the specified Private Endpoint.
 * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/PrivateEndpoint_Get.json
 */
async function getAPrivateEndpoint() {
  const subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = "sjrg";
  const clusterName = "testcluster";
  const privateEndpointName = "testpe";
  const credential = new DefaultAzureCredential();
  const client = new StreamAnalyticsManagementClient(credential, subscriptionId);
  const result = await client.privateEndpoints.get(
    resourceGroupName,
    clusterName,
    privateEndpointName
  );
  console.log(result);
}

getAPrivateEndpoint().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Mintaválasz

Állapotkód:

200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/testcluster/privateEndpoints/AnExamplePrivateEndpoint",
  "name": "An Example Private Endpoint",
  "type": "Microsoft.StreamAnalytics/clusters/privateEndpoints",
  "properties": {
    "createdDate": "2020-03-01T01:00Z",
    "manualPrivateLinkServiceConnections": [
      {
        "properties": {
          "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls",
          "groupIds": [
            "groupIdFromResource"
          ],
          "requestMessage": "This connection request originated from Azure Stream Analytics cluster named \"testcluster\". Please approve this request to allow any Stream Analytics job running on that cluster to access this resource.",
          "privateLinkServiceConnectionState": {
            "status": "Pending",
            "description": "Awaiting approval",
            "actionsRequired": "None"
          }
        }
      }
    ]
  },
  "etag": "F86B9B70-D5B1-451D-AFC8-0B42D4729B8C"
}

Definíciók

Name	Description
Error	Gyakori hibaábrázolás.
PrivateEndpoint	Teljes körű információ a privát végpontról.
PrivateLinkConnectionState	Írásvédett információk gyűjteménye a magánhálózati távoli erőforráshoz való csatlakozás állapotáról.
PrivateLinkServiceConnection	A távoli erőforráshoz való csatlakozással kapcsolatos információk csoportosítása.

Error

Objektum

Gyakori hibaábrázolás.

Name	Típus	Description
error	Error	Hibadefiníció tulajdonságai.

PrivateEndpoint

Objektum

Teljes körű információ a privát végpontról.

Name	Típus	Description
etag	string	Egyedi átlátszatlan sztring (általában GUID), amely az erőforrás (privát végpont) metaadat-állapotát jelöli, és az erőforrás frissítésekor megváltozik. PUT (CreateOrUpdate) kérelmekhez szükséges.
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.createdDate	string	A privát végpont létrehozásának dátuma.
properties.manualPrivateLinkServiceConnections	PrivateLinkServiceConnection[]	A távoli erőforráshoz való kapcsolatok listája. A beállítás után nem módosítható.
type	string	Az erőforrás típusa. Például: Microsoft.Compute/virtualMachines vagy Microsoft.Storage/storageAccounts.

PrivateLinkConnectionState

Objektum

Írásvédett információk gyűjteménye a magánhálózati távoli erőforráshoz való csatlakozás állapotáról.

Name	Típus	Description
actionsRequired	string	Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére.
description	string	A kapcsolat jóváhagyásának/elutasításának oka.
status	string	Azt jelzi, hogy a távoli erőforrás/szolgáltatás tulajdonosa jóváhagyta/elutasította/eltávolította-e a kapcsolatot.

PrivateLinkServiceConnection

Objektum

A távoli erőforráshoz való csatlakozással kapcsolatos információk csoportosítása.

Name	Típus	Description
properties.groupIds	string[]	A csoport(ok) azon távoli erőforrásból beszerzett azonosítója(i), amelyhez ennek a privát végpontnak csatlakoznia kell. PUT (CreateOrUpdate) kérelmekhez szükséges.
properties.privateLinkServiceConnectionState	PrivateLinkConnectionState	Írásvédett információk gyűjteménye a magánhálózati távoli erőforráshoz való csatlakozás állapotáról.
properties.privateLinkServiceId	string	A privát kapcsolat szolgáltatás erőforrás-azonosítója. PUT (CreateOrUpdate) kérelmekhez szükséges.
properties.requestMessage	string	A távoli erőforrás tulajdonosának küldött üzenet ezzel a kapcsolatkéréssel. 140 karakterre korlátozva.