@pulumi/azuread/getDirectoryObject.d.ts

A Pulumi package for creating and managing Azure Active Directory (Azure AD) cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Retrieves the OData type for a generic directory object having the provided object ID.
 *
 * ## API Permissions
 *
 * The following API permissions are required in order to use this data source.
 *
 * When authenticated with a service principal, this data source requires either `User.Read.All`, `Group.Read.All` or `Directory.Read.All`, depending on the type of object being queried.
 *
 * When authenticated with a user principal, this data source does not require any additional roles.
 *
 * ## Example Usage
 *
 * *Look up and output type of object by ID*
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuread from "@pulumi/azuread";
 *
 * const example = azuread.getDirectoryObject({
 *     objectId: "00000000-0000-0000-0000-000000000000",
 * });
 * export const objectType = example.then(example => example.type);
 * ```
 *
 * ## Attributes Reference
 *
 * The following attributes are exported:
 *
 * * `objectId` - The object ID of the directory object.
 * * `type` - The shortened OData type of the directory object. Possible values include: `Group`, `User` or `ServicePrincipal`.
 */
export declare function getDirectoryObject(args: GetDirectoryObjectArgs, opts?: pulumi.InvokeOptions): Promise<GetDirectoryObjectResult>;
/**
 * A collection of arguments for invoking getDirectoryObject.
 */
export interface GetDirectoryObjectArgs {
    /**
     * Specifies the Object ID of the directory object to look up.
     */
    objectId: string;
}
/**
 * A collection of values returned by getDirectoryObject.
 */
export interface GetDirectoryObjectResult {
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly objectId: string;
    readonly type: string;
}
/**
 * Retrieves the OData type for a generic directory object having the provided object ID.
 *
 * ## API Permissions
 *
 * The following API permissions are required in order to use this data source.
 *
 * When authenticated with a service principal, this data source requires either `User.Read.All`, `Group.Read.All` or `Directory.Read.All`, depending on the type of object being queried.
 *
 * When authenticated with a user principal, this data source does not require any additional roles.
 *
 * ## Example Usage
 *
 * *Look up and output type of object by ID*
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azuread from "@pulumi/azuread";
 *
 * const example = azuread.getDirectoryObject({
 *     objectId: "00000000-0000-0000-0000-000000000000",
 * });
 * export const objectType = example.then(example => example.type);
 * ```
 *
 * ## Attributes Reference
 *
 * The following attributes are exported:
 *
 * * `objectId` - The object ID of the directory object.
 * * `type` - The shortened OData type of the directory object. Possible values include: `Group`, `User` or `ServicePrincipal`.
 */
export declare function getDirectoryObjectOutput(args: GetDirectoryObjectOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDirectoryObjectResult>;
/**
 * A collection of arguments for invoking getDirectoryObject.
 */
export interface GetDirectoryObjectOutputArgs {
    /**
     * Specifies the Object ID of the directory object to look up.
     */
    objectId: pulumi.Input<string>;
}