@pulumi/azuread
Version:
A Pulumi package for creating and managing Azure Active Directory (Azure AD) cloud resources.
135 lines (134 loc) • 5.33 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a Authentication Strength Policy within Azure Active Directory.
*
* ## API Permissions
*
* The following API permissions are required in order to use this resource.
*
* When authenticated with a service principal, this resource requires the following application roles: `Policy.ReadWrite.ConditionalAccess` and `Policy.Read.All`
*
* When authenticated with a user principal, this resource requires one of the following directory roles: `Conditional Access Administrator` or `Global Administrator`
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuread from "@pulumi/azuread";
*
* const example = new azuread.AuthenticationStrengthPolicy("example", {
* displayName: "Example Authentication Strength Policy",
* description: "Policy for demo purposes",
* allowedCombinations: [
* "fido2",
* "password",
* ],
* });
* const example2 = new azuread.AuthenticationStrengthPolicy("example2", {
* displayName: "Example Authentication Strength Policy",
* description: "Policy for demo purposes with all possible combinations",
* allowedCombinations: [
* "fido2",
* "password",
* "deviceBasedPush",
* "temporaryAccessPassOneTime",
* "federatedMultiFactor",
* "federatedSingleFactor",
* "hardwareOath,federatedSingleFactor",
* "microsoftAuthenticatorPush,federatedSingleFactor",
* "password,hardwareOath",
* "password,microsoftAuthenticatorPush",
* "password,sms",
* "password,softwareOath",
* "password,voice",
* "sms",
* "sms,federatedSingleFactor",
* "softwareOath,federatedSingleFactor",
* "temporaryAccessPassMultiUse",
* "voice,federatedSingleFactor",
* "windowsHelloForBusiness",
* "x509CertificateMultiFactor",
* "x509CertificateSingleFactor",
* ],
* });
* ```
*
* ## Import
*
* Authentication Strength Policies can be imported using the `id`, e.g.
*
* ```sh
* $ pulumi import azuread:index/authenticationStrengthPolicy:AuthenticationStrengthPolicy my_policy /policies/authenticationStrengthPolicies/00000000-0000-0000-0000-000000000000
* ```
*/
export declare class AuthenticationStrengthPolicy extends pulumi.CustomResource {
/**
* Get an existing AuthenticationStrengthPolicy 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 state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AuthenticationStrengthPolicyState, opts?: pulumi.CustomResourceOptions): AuthenticationStrengthPolicy;
/**
* Returns true if the given object is an instance of AuthenticationStrengthPolicy. 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 AuthenticationStrengthPolicy;
/**
* List of allowed authentication methods for this authentication strength policy.
*/
readonly allowedCombinations: pulumi.Output<string[]>;
/**
* The description for this authentication strength policy.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The friendly name for this authentication strength policy.
*/
readonly displayName: pulumi.Output<string>;
/**
* Create a AuthenticationStrengthPolicy 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: AuthenticationStrengthPolicyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AuthenticationStrengthPolicy resources.
*/
export interface AuthenticationStrengthPolicyState {
/**
* List of allowed authentication methods for this authentication strength policy.
*/
allowedCombinations?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The description for this authentication strength policy.
*/
description?: pulumi.Input<string>;
/**
* The friendly name for this authentication strength policy.
*/
displayName?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a AuthenticationStrengthPolicy resource.
*/
export interface AuthenticationStrengthPolicyArgs {
/**
* List of allowed authentication methods for this authentication strength policy.
*/
allowedCombinations: pulumi.Input<pulumi.Input<string>[]>;
/**
* The description for this authentication strength policy.
*/
description?: pulumi.Input<string>;
/**
* The friendly name for this authentication strength policy.
*/
displayName: pulumi.Input<string>;
}