Access Policies - List By Environment

Service:

Time Series Insights

API Version:

2020-05-15

Listen alle verfügbaren Zugriffsrichtlinien, die der Umgebung zugeordnet sind.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
environmentName	path	True	string	Der Name der Time Series Insights-Umgebung, die der angegebenen Ressourcengruppe zugeordnet ist.
resourceGroupName	path	True	string	Name einer Azure-Ressourcengruppe.
subscriptionId	path	True	string	Die Azure-Abonnement-ID.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	AccessPolicyListResponse	Zugriffsrichtlinien wurden erfolgreich zurückgegeben.
Other Status Codes	CloudError	HTTP 404 (Nicht gefunden): Das Abonnement, die Ressourcengruppe oder die Umgebung konnte nicht gefunden werden.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name	Beschreibung
AccessPolicyListResponse	Die Antwort des Vorgangs Listenzugriffsrichtlinien.
AccessPolicyResource	Eine Zugriffsrichtlinie wird verwendet, um Benutzern und Anwendungen Zugriff auf die Umgebung zu gewähren. Rollen werden Dienstprinzipalen in Azure Active Directory zugewiesen. Diese Rollen definieren die Aktionen, die der Prinzipal über die Time Series Insights-Datenebenen-APIs ausführen kann.
AccessPolicyRole	Die Liste der Rollen, die dem Prinzipal in der Umgebung zugewiesen sind.
CloudError	Enthält Informationen zu einem API-Fehler.
CloudErrorBody	Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

AccessPolicyListResponse

Die Antwort des Vorgangs Listenzugriffsrichtlinien.

Name	Typ	Beschreibung
value	AccessPolicyResource[]	Ergebnis des Vorgangs Listenzugriffsrichtlinien.

AccessPolicyResource

Eine Zugriffsrichtlinie wird verwendet, um Benutzern und Anwendungen Zugriff auf die Umgebung zu gewähren. Rollen werden Dienstprinzipalen in Azure Active Directory zugewiesen. Diese Rollen definieren die Aktionen, die der Prinzipal über die Time Series Insights-Datenebenen-APIs ausführen kann.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Ressourcenname
properties.description	string	Eine Beschreibung der Zugriffsrichtlinie.
properties.principalObjectId	string	Die objectId des Prinzipals in Azure Active Directory.
properties.roles	AccessPolicyRole[]	Die Liste der Rollen, die dem Prinzipal in der Umgebung zugewiesen sind.
type	string	Ressourcentyp

AccessPolicyRole

Die Liste der Rollen, die dem Prinzipal in der Umgebung zugewiesen sind.

Name	Typ	Beschreibung
Contributor	string
Reader	string

CloudError

Enthält Informationen zu einem API-Fehler.

Name	Typ	Beschreibung
error	CloudErrorBody	Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

Name	Typ	Beschreibung
code	string	Ein Fehlercode, der die Fehlerbedingung genauer beschreibt als ein HTTP-status Code. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
details	CloudErrorBody[]	Enthält geschachtelte Fehler, die sich auf diesen Fehler beziehen.
message	string	Eine Meldung, die den Fehler detailliert beschreibt und Debuginformationen bereitstellt.
target	string	Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler).