Access Policies - List By Environment

Service:

Time Series Insights

API Version:

2020-05-15

Elenchi tutti i criteri di accesso disponibili associati all'ambiente.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
environmentName	path	True	string	Nome dell'ambiente Time Series Insights associato al gruppo di risorse specificato.
resourceGroupName	path	True	string	Nome di un gruppo di risorse di Azure.
subscriptionId	path	True	string	ID sottoscrizione di Azure.
api-version	query	True	string	Versione dell'API da usare con la richiesta client.

Risposte

Nome	Tipo	Descrizione
200 OK	AccessPolicyListResponse	criteri di accesso restituiti correttamente.
Other Status Codes	CloudError	HTTP 404 (Non trovato): impossibile trovare la sottoscrizione, il gruppo di risorse o l'ambiente.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Definizioni

Nome	Descrizione
AccessPolicyListResponse	Risposta dell'operazione Criteri di accesso elenco.
AccessPolicyResource	Un criterio di accesso viene usato per concedere agli utenti e alle applicazioni l'accesso all'ambiente. I ruoli vengono assegnati alle entità servizio in Azure Active Directory. Questi ruoli definiscono le azioni che l'entità può eseguire tramite le API del piano dati Time Series Insights.
AccessPolicyRole	Nell'ambiente viene assegnato l'elenco dei ruoli dell'entità.
CloudError	Contiene informazioni su un errore dell'API.
CloudErrorBody	Descrive un errore dell'API specifico con un codice di errore e un messaggio.

AccessPolicyListResponse

Risposta dell'operazione Criteri di accesso elenco.

Nome	Tipo	Descrizione
value	AccessPolicyResource[]	Risultato dell'operazione Criteri di accesso elenco.

AccessPolicyResource

Un criterio di accesso viene usato per concedere agli utenti e alle applicazioni l'accesso all'ambiente. I ruoli vengono assegnati alle entità servizio in Azure Active Directory. Questi ruoli definiscono le azioni che l'entità può eseguire tramite le API del piano dati Time Series Insights.

Nome	Tipo	Descrizione
id	string	ID risorsa
name	string	Nome risorsa
properties.description	string	Descrizione dei criteri di accesso.
properties.principalObjectId	string	ObjectId dell'entità in Azure Active Directory.
properties.roles	AccessPolicyRole[]	Nell'ambiente viene assegnato l'elenco dei ruoli dell'entità.
type	string	Tipo di risorsa

AccessPolicyRole

Nell'ambiente viene assegnato l'elenco dei ruoli dell'entità.

Nome	Tipo	Descrizione
Contributor	string
Reader	string

CloudError

Contiene informazioni su un errore dell'API.

Nome	Tipo	Descrizione
error	CloudErrorBody	Descrive un errore dell'API specifico con un codice di errore e un messaggio.

CloudErrorBody

Descrive un errore dell'API specifico con un codice di errore e un messaggio.

Nome	Tipo	Descrizione
code	string	Codice di errore che descrive la condizione di errore più precisamente di un codice di stato HTTP. Può essere usato per gestire casi di errore specifici a livello di codice.
details	CloudErrorBody[]	Contiene errori annidati correlati a questo errore.
message	string	Messaggio che descrive l'errore in dettaglio e fornisce informazioni di debug.
target	string	Destinazione dell'errore specifico, ad esempio il nome della proprietà in errore.