Access Policies - List By Environment

Lists all the available access policies associated with the environment.

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

URI Parameters

Name In Required Type Description
environmentName
path True

string

The name of the Time Series Insights environment associated with the specified resource group.

resourceGroupName
path True

string

Name of an Azure Resource group.

subscriptionId
path True

string

Azure Subscription ID.

api-version
query True

string

Version of the API to be used with the client request.

Responses

Name Type Description
200 OK

AccessPolicyListResponse

access policies returned successfully.

Other Status Codes

CloudError

HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.

Security

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 impersonate your user account

Examples

AccessPoliciesByEnvironment

Sample request

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

Sample response

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

Definitions

Name Description
AccessPolicyListResponse

The response of the List access policies operation.

AccessPolicyResource

An access policy is used to grant users and applications access to the environment. Roles are assigned to service principals in Azure Active Directory. These roles define the actions the principal can perform through the Time Series Insights data plane APIs.

AccessPolicyRole

The list of roles the principal is assigned on the environment.

CloudError

Contains information about an API error.

CloudErrorBody

Describes a particular API error with an error code and a message.

AccessPolicyListResponse

The response of the List access policies operation.

Name Type Description
value

AccessPolicyResource[]

Result of the List access policies operation.

AccessPolicyResource

An access policy is used to grant users and applications access to the environment. Roles are assigned to service principals in Azure Active Directory. These roles define the actions the principal can perform through the Time Series Insights data plane APIs.

Name Type Description
id

string

Resource Id

name

string

Resource name

properties.description

string

An description of the access policy.

properties.principalObjectId

string

The objectId of the principal in Azure Active Directory.

properties.roles

AccessPolicyRole[]

The list of roles the principal is assigned on the environment.

type

string

Resource type

AccessPolicyRole

The list of roles the principal is assigned on the environment.

Name Type Description
Contributor

string

Reader

string

CloudError

Contains information about an API error.

Name Type Description
error

CloudErrorBody

Describes a particular API error with an error code and a message.

CloudErrorBody

Describes a particular API error with an error code and a message.

Name Type Description
code

string

An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases.

details

CloudErrorBody[]

Contains nested errors that are related to this error.

message

string

A message that describes the error in detail and provides debugging information.

target

string

The target of the particular error (for example, the name of the property in error).