@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 3.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as enums from "../types/enums";
/**
* 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.
*
* Uses Azure REST API version 2020-05-15. In version 2.x of the Azure Native provider, it used API version 2020-05-15.
*
* Other available API versions: 2021-03-31-preview, 2021-06-30-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native timeseriesinsights [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class AccessPolicy extends pulumi.CustomResource {
/**
* Get an existing AccessPolicy resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): AccessPolicy;
/**
* Returns true if the given object is an instance of AccessPolicy. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is AccessPolicy;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* An description of the access policy.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Resource name
*/
readonly name: pulumi.Output<string>;
/**
* The objectId of the principal in Azure Active Directory.
*/
readonly principalObjectId: pulumi.Output<string | undefined>;
/**
* The list of roles the principal is assigned on the environment.
*/
readonly roles: pulumi.Output<string[] | undefined>;
/**
* Resource type
*/
readonly type: pulumi.Output<string>;
/**
* Create a AccessPolicy resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: AccessPolicyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a AccessPolicy resource.
*/
export interface AccessPolicyArgs {
/**
* Name of the access policy.
*/
accessPolicyName?: pulumi.Input<string>;
/**
* An description of the access policy.
*/
description?: pulumi.Input<string>;
/**
* The name of the Time Series Insights environment associated with the specified resource group.
*/
environmentName: pulumi.Input<string>;
/**
* The objectId of the principal in Azure Active Directory.
*/
principalObjectId?: pulumi.Input<string>;
/**
* Name of an Azure Resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The list of roles the principal is assigned on the environment.
*/
roles?: pulumi.Input<pulumi.Input<string | enums.timeseriesinsights.AccessPolicyRole>[]>;
}