@pulumi/azuread
Version:
A Pulumi package for creating and managing Azure Active Directory (Azure AD) cloud resources.
118 lines (117 loc) • 4.36 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuread from "@pulumi/azuread";
*
* const example_ip = new azuread.NamedLocation("example-ip", {
* displayName: "IP Named Location",
* ip: {
* ipRanges: [
* "1.1.1.1/32",
* "2.2.2.2/32",
* ],
* trusted: true,
* },
* });
* const example_country = new azuread.NamedLocation("example-country", {
* displayName: "Country Named Location",
* country: {
* countriesAndRegions: [
* "GB",
* "US",
* ],
* includeUnknownCountriesAndRegions: false,
* },
* });
* ```
*
* ## Import
*
* Named Locations can be imported using the `id`, e.g.
*
* ```sh
* $ pulumi import azuread:index/namedLocation:NamedLocation my_location /identity/conditionalAccess/namedLocations/00000000-0000-0000-0000-000000000000
* ```
*/
export declare class NamedLocation extends pulumi.CustomResource {
/**
* Get an existing NamedLocation 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?: NamedLocationState, opts?: pulumi.CustomResourceOptions): NamedLocation;
/**
* Returns true if the given object is an instance of NamedLocation. 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 NamedLocation;
/**
* A `country` block as documented below, which configures a country-based named location.
*/
readonly country: pulumi.Output<outputs.NamedLocationCountry | undefined>;
/**
* The friendly name for this named location.
*/
readonly displayName: pulumi.Output<string>;
/**
* An `ip` block as documented below, which configures an IP-based named location.
*
* > Exactly one of `ip` or `country` must be specified. Changing between these forces a new resource to be created.
*/
readonly ip: pulumi.Output<outputs.NamedLocationIp | undefined>;
/**
* Create a NamedLocation 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: NamedLocationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering NamedLocation resources.
*/
export interface NamedLocationState {
/**
* A `country` block as documented below, which configures a country-based named location.
*/
country?: pulumi.Input<inputs.NamedLocationCountry>;
/**
* The friendly name for this named location.
*/
displayName?: pulumi.Input<string>;
/**
* An `ip` block as documented below, which configures an IP-based named location.
*
* > Exactly one of `ip` or `country` must be specified. Changing between these forces a new resource to be created.
*/
ip?: pulumi.Input<inputs.NamedLocationIp>;
}
/**
* The set of arguments for constructing a NamedLocation resource.
*/
export interface NamedLocationArgs {
/**
* A `country` block as documented below, which configures a country-based named location.
*/
country?: pulumi.Input<inputs.NamedLocationCountry>;
/**
* The friendly name for this named location.
*/
displayName: pulumi.Input<string>;
/**
* An `ip` block as documented below, which configures an IP-based named location.
*
* > Exactly one of `ip` or `country` must be specified. Changing between these forces a new resource to be created.
*/
ip?: pulumi.Input<inputs.NamedLocationIp>;
}