Access Policies - List By Environment

Service:

Time Series Insights

API Version:

2020-05-15

Listák a környezethez társított összes elérhető hozzáférési szabályzatot.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/accessPolicies?api-version=2020-05-15

URI-paraméterek

Name	In	Kötelező	Típus	Description
environmentName	path	True	string	A megadott erőforráscsoporthoz társított Time Series Insights-környezet neve.
resourceGroupName	path	True	string	Egy Azure-erőforráscsoport neve.
subscriptionId	path	True	string	Azure-előfizetés azonosítója.
api-version	query	True	string	Az ügyfélkéréshez használandó API verziója.

Válaszok

Name	Típus	Description
200 OK	AccessPolicyListResponse	a hozzáférési szabályzatok sikeresen visszaadva.
Other Status Codes	CloudError	HTTP 404 (Nem található): Az előfizetés, az erőforráscsoport vagy a környezet nem található.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Példák

AccessPoliciesByEnvironment

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/environments/env1/accessPolicies?api-version=2020-05-15

Java

/** Samples for AccessPolicies ListByEnvironment. */
public final class Main {
    /*
     * x-ms-original-file: specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesListByEnvironment.json
     */
    /**
     * Sample code: AccessPoliciesByEnvironment.
     *
     * @param manager Entry point to TimeSeriesInsightsManager.
     */
    public static void accessPoliciesByEnvironment(
        com.azure.resourcemanager.timeseriesinsights.TimeSeriesInsightsManager manager) {
        manager.accessPolicies().listByEnvironmentWithResponse("rg1", "env1", 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 armtimeseriesinsights_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/timeseriesinsights/armtimeseriesinsights"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/163e27c0ca7570bc39e00a46f255740d9b3ba3cb/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesListByEnvironment.json
func ExampleAccessPoliciesClient_ListByEnvironment() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armtimeseriesinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccessPoliciesClient().ListByEnvironment(ctx, "rg1", "env1", 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.AccessPolicyListResponse = armtimeseriesinsights.AccessPolicyListResponse{
	// 	Value: []*armtimeseriesinsights.AccessPolicyResource{
	// 		{
	// 			Name: to.Ptr("ap1"),
	// 			Type: to.Ptr("Microsoft.TimeSeriesInsights/Environments/AccessPolicies"),
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1"),
	// 			Properties: &armtimeseriesinsights.AccessPolicyResourceProperties{
	// 				Description: to.Ptr("some description"),
	// 				PrincipalObjectID: to.Ptr("aGuid"),
	// 				Roles: []*armtimeseriesinsights.AccessPolicyRole{
	// 					to.Ptr(armtimeseriesinsights.AccessPolicyRoleReader)},
	// 				},
	// 		}},
	// 	}
}

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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1",
      "name": "ap1",
      "type": "Microsoft.TimeSeriesInsights/Environments/AccessPolicies",
      "properties": {
        "principalObjectId": "aGuid",
        "roles": [
          "Reader"
        ],
        "description": "some description"
      }
    }
  ]
}

Definíciók

Name	Description
AccessPolicyListResponse	A Hozzáférési szabályzatok listázása művelet válasza.
AccessPolicyResource	A hozzáférési szabályzattal hozzáférést adhat a felhasználóknak és az alkalmazásoknak a környezethez. A szerepkörök az Azure Active Directory szolgáltatásneveihez vannak hozzárendelve. Ezek a szerepkörök határozzák meg, hogy a rendszerbiztonsági tag milyen műveleteket hajthat végre a Time Series Insights adatsík API-kkal.
AccessPolicyRole	A rendszerbiztonsági tag által a környezetben hozzárendelt szerepkörök listája.
CloudError	Egy API-hibával kapcsolatos információkat tartalmaz.
CloudErrorBody	Egy adott API-hibát ismertet hibakóddal és üzenettel.

AccessPolicyListResponse

A Hozzáférési szabályzatok listázása művelet válasza.

Name	Típus	Description
value	AccessPolicyResource[]	A Hozzáférési szabályzatok listázása művelet eredménye.

AccessPolicyResource

A hozzáférési szabályzattal hozzáférést adhat a felhasználóknak és az alkalmazásoknak a környezethez. A szerepkörök az Azure Active Directory szolgáltatásneveihez vannak hozzárendelve. Ezek a szerepkörök határozzák meg, hogy a rendszerbiztonsági tag milyen műveleteket hajthat végre a Time Series Insights adatsík API-kkal.

Name	Típus	Description
id	string	Erőforrás-azonosító
name	string	Erőforrás neve
properties.description	string	A hozzáférési szabályzat leírása.
properties.principalObjectId	string	A rendszerbiztonsági tag objectId azonosítója az Azure Active Directoryban.
properties.roles	AccessPolicyRole[]	A rendszerbiztonsági tag által a környezetben hozzárendelt szerepkörök listája.
type	string	Erőforrás típusa

AccessPolicyRole

A rendszerbiztonsági tag által a környezetben hozzárendelt szerepkörök listája.

Name	Típus	Description
Contributor	string
Reader	string

CloudError

Egy API-hibával kapcsolatos információkat tartalmaz.

Name	Típus	Description
error	CloudErrorBody	Egy adott API-hibát ismertet hibakóddal és üzenettel.

CloudErrorBody

Egy adott API-hibát ismertet hibakóddal és üzenettel.

Name	Típus	Description
code	string	Egy hibakód, amely pontosabban írja le a hibaállapotot, mint egy HTTP-állapotkód. Adott hibaeseteket programozott módon lehet kezelni.
details	CloudErrorBody[]	Beágyazott hibákat tartalmaz, amelyek ehhez a hibához kapcsolódnak.
message	string	Egy üzenet, amely részletesen leírja a hibát, és hibakeresési információkat tartalmaz.
target	string	Az adott hiba célja (például a hibás tulajdonság neve).