Access Policies - List By Environment

Service:

Time Series Insights

Version d'API:

2020-05-15

Listes toutes les stratégies d’accès disponibles associées à l’environnement.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
environmentName	path	True	string	Nom de l’environnement Time Series Insights associé au groupe de ressources spécifié.
resourceGroupName	path	True	string	Nom d’un groupe de ressources Azure.
subscriptionId	path	True	string	ID d’abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente.

Réponses

Nom	Type	Description
200 OK	AccessPolicyListResponse	stratégies d’accès retournées avec succès.
Other Status Codes	CloudError	HTTP 404 (introuvable) : l’abonnement, le groupe de ressources ou l’environnement est introuvable.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

AccessPoliciesByEnvironment

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
AccessPolicyListResponse	Réponse de l’opération Répertorier les stratégies d’accès.
AccessPolicyResource	Une stratégie d’accès est utilisée pour accorder aux utilisateurs et aux applications l’accès à l’environnement. Les rôles sont attribués aux principaux de service dans Azure Active Directory. Ces rôles définissent les actions que le principal peut effectuer via les API de plan de données Time Series Insights.
AccessPolicyRole	Liste des rôles que le principal est affecté à l’environnement.
CloudError	Contient des informations sur une erreur d’API.
CloudErrorBody	Décrit une erreur d’API particulière avec un code d’erreur et un message.

AccessPolicyListResponse

Réponse de l’opération Répertorier les stratégies d’accès.

Nom	Type	Description
value	AccessPolicyResource[]	Résultat de l’opération Répertorier les stratégies d’accès.

AccessPolicyResource

Une stratégie d’accès est utilisée pour accorder aux utilisateurs et aux applications l’accès à l’environnement. Les rôles sont attribués aux principaux de service dans Azure Active Directory. Ces rôles définissent les actions que le principal peut effectuer via les API de plan de données Time Series Insights.

Nom	Type	Description
id	string	ID de ressource
name	string	Nom de la ressource
properties.description	string	Description de la stratégie d’accès.
properties.principalObjectId	string	ObjectId du principal dans Azure Active Directory.
properties.roles	AccessPolicyRole[]	Liste des rôles que le principal est affecté à l’environnement.
type	string	Type de ressource

AccessPolicyRole

Liste des rôles que le principal est affecté à l’environnement.

Nom	Type	Description
Contributor	string
Reader	string

CloudError

Contient des informations sur une erreur d’API.

Nom	Type	Description
error	CloudErrorBody	Décrit une erreur d’API particulière avec un code d’erreur et un message.

CloudErrorBody

Décrit une erreur d’API particulière avec un code d’erreur et un message.

Nom	Type	Description
code	string	Code d’erreur qui décrit la condition d’erreur plus précisément qu’un code http status. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.
details	CloudErrorBody[]	Contient les erreurs imbriquées liées à cette erreur.
message	string	Message qui décrit l’erreur en détail et fournit des informations de débogage.
target	string	Cible de l’erreur particulière (par exemple, le nom de la propriété en erreur).