@pulumi/azuread
Version:
A Pulumi package for creating and managing Azure Active Directory (Azure AD) cloud resources.
104 lines (103 loc) • 4.61 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a single owner of an application registration.
*
* > This resource is incompatible with the `azuread.Application` resource, instead use this with the `azuread.ApplicationRegistration` resource.
*
* ## API Permissions
*
* The following API permissions are required in order to use this resource.
*
* When authenticated with a service principal, this resource requires one of the following application roles: `Application.ReadWrite.OwnedBy` or `Application.ReadWrite.All`
*
* > When using the `Application.ReadWrite.OwnedBy` application role, the principal being used to run Pulumi must be an owner of the application.
*
* When authenticated with a user principal, this resource may require one of the following directory roles: `Application Administrator` or `Global Administrator`
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as azuread from "@pulumi/azuread";
*
* const example = new azuread.ApplicationRegistration("example", {displayName: "example"});
* const jane = new azuread.User("jane", {
* userPrincipalName: "jane.fischer@example.com",
* displayName: "Jane Fischer",
* password: "Ch@ngeMe",
* });
* const exampleJane = new azuread.ApplicationOwner("example_jane", {
* applicationId: example.id,
* ownerObjectId: jane.objectId,
* });
* ```
*
* > **Tip** For managing more application owners, create additional instances of this resource
*
* ## Import
*
* Application Owners can be imported using the object ID of the application and the object ID of the owner, in the following format.
*
* ```sh
* $ pulumi import azuread:index/applicationOwner:ApplicationOwner example /applications/00000000-0000-0000-0000-000000000000/owners/11111111-1111-1111-1111-111111111111
* ```
*/
export declare class ApplicationOwner extends pulumi.CustomResource {
/**
* Get an existing ApplicationOwner 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?: ApplicationOwnerState, opts?: pulumi.CustomResourceOptions): ApplicationOwner;
/**
* Returns true if the given object is an instance of ApplicationOwner. 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 ApplicationOwner;
/**
* The resource ID of the application registration. Changing this forces a new resource to be created.
*/
readonly applicationId: pulumi.Output<string>;
/**
* The object ID of the owner to assign to the application, typically a user or service principal. Changing this forces a new resource to be created.
*/
readonly ownerObjectId: pulumi.Output<string>;
/**
* Create a ApplicationOwner 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: ApplicationOwnerArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ApplicationOwner resources.
*/
export interface ApplicationOwnerState {
/**
* The resource ID of the application registration. Changing this forces a new resource to be created.
*/
applicationId?: pulumi.Input<string>;
/**
* The object ID of the owner to assign to the application, typically a user or service principal. Changing this forces a new resource to be created.
*/
ownerObjectId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ApplicationOwner resource.
*/
export interface ApplicationOwnerArgs {
/**
* The resource ID of the application registration. Changing this forces a new resource to be created.
*/
applicationId: pulumi.Input<string>;
/**
* The object ID of the owner to assign to the application, typically a user or service principal. Changing this forces a new resource to be created.
*/
ownerObjectId: pulumi.Input<string>;
}