Fork me on GitHub

Module ad

@pulumi/azure > ad

Index

ad/application.ts ad/getApplication.ts ad/getServicePrincipal.ts ad/servicePrincipal.ts ad/servicePrincipalPassword.ts

class Application

Manages an Application within Azure Active Directory.

-> NOTE: If you’re authenticating using a Service Principal then it must have permissions to both Read and write all applications and Sign in and read user profile within the Windows Azure Active Directory API.

constructor

new Application(name: string, args?: ApplicationArgs, opts?: pulumi.CustomResourceOptions)

Create a Application resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApplicationState): Application

Get an existing Application resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applicationId

public applicationId: pulumi.Output<string>;

The Application ID.

property availableToOtherTenants

public availableToOtherTenants: pulumi.Output<boolean | undefined>;

Is this Azure AD Application available to other tenants? Defaults to false.

property homepage

public homepage: pulumi.Output<string>;

The URL to the application’s home page. If no homepage is specified this defaults to https://{name}.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identifierUris

public identifierUris: pulumi.Output<string[]>;

A list of user-defined URI(s) that uniquely identify a Web application within it’s Azure AD tenant, or within a verified custom domain if the application is multi-tenant.

property name

public name: pulumi.Output<string>;

The display name for the application.

property oauth2AllowImplicitFlow

public oauth2AllowImplicitFlow: pulumi.Output<boolean | undefined>;

Does this Azure AD Application allow OAuth2.0 implicit flow tokens? Defaults to false.

property replyUrls

public replyUrls: pulumi.Output<string[]>;

A list of URLs that user tokens are sent to for sign in, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class ServicePrincipal

Manages a Service Principal associated with an Application within Azure Active Directory.

-> NOTE: If you’re authenticating using a Service Principal then it must have permissions to both Read and write all applications and Sign in and read user profile within the Windows Azure Active Directory API.

constructor

new ServicePrincipal(name: string, args: ServicePrincipalArgs, opts?: pulumi.CustomResourceOptions)

Create a ServicePrincipal resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServicePrincipalState): ServicePrincipal

Get an existing ServicePrincipal resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applicationId

public applicationId: pulumi.Output<string>;

The ID of the Azure AD Application for which to create a Service Principal.

property displayName

public displayName: pulumi.Output<string>;

The Display Name of the Azure Active Directory Application associated with this Service Principal.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class ServicePrincipalPassword

Manages a Password associated with a Service Principal within Azure Active Directory.

-> NOTE: If you’re authenticating using a Service Principal then it must have permissions to both Read and write all applications and Sign in and read user profile within the Windows Azure Active Directory API.

constructor

new ServicePrincipalPassword(name: string, args: ServicePrincipalPasswordArgs, opts?: pulumi.CustomResourceOptions)

Create a ServicePrincipalPassword resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServicePrincipalPasswordState): ServicePrincipalPassword

Get an existing ServicePrincipalPassword resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property endDate

public endDate: pulumi.Output<string>;

The End Date which the Password is valid until, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property keyId

public keyId: pulumi.Output<string>;

A GUID used to uniquely identify this Key. If not specified a GUID will be created. Changing this field forces a new resource to be created.

property servicePrincipalId

public servicePrincipalId: pulumi.Output<string>;

The ID of the Service Principal for which this password should be created. Changing this field forces a new resource to be created.

property startDate

public startDate: pulumi.Output<string>;

The Start Date which the Password is valid from, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). If this isn’t specified, the current date is used. Changing this field forces a new resource to be created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property value

public value: pulumi.Output<string>;

The Password for this Service Principal.

function getApplication

getApplication(args?: GetApplicationArgs, opts?: pulumi.InvokeOptions): Promise<GetApplicationResult>

Use this data source to access information about an existing Application within Azure Active Directory.

-> NOTE: If you’re authenticating using a Service Principal then it must have permissions to both Read and write all applications and Sign in and read user profile within the Windows Azure Active Directory API.

function getServicePrincipal

getServicePrincipal(args?: GetServicePrincipalArgs, opts?: pulumi.InvokeOptions): Promise<GetServicePrincipalResult>

Gets information about an existing Service Principal associated with an Application within Azure Active Directory.

-> NOTE: If you’re authenticating using a Service Principal then it must have permissions to both Read and write all applications and Sign in and read user profile within the Windows Azure Active Directory API.

interface ApplicationArgs

The set of arguments for constructing a Application resource.

property availableToOtherTenants

availableToOtherTenants?: pulumi.Input<boolean>;

Is this Azure AD Application available to other tenants? Defaults to false.

property homepage

homepage?: pulumi.Input<string>;

The URL to the application’s home page. If no homepage is specified this defaults to https://{name}.

property identifierUris

identifierUris?: pulumi.Input<pulumi.Input<string>[]>;

A list of user-defined URI(s) that uniquely identify a Web application within it’s Azure AD tenant, or within a verified custom domain if the application is multi-tenant.

property name

name?: pulumi.Input<string>;

The display name for the application.

property oauth2AllowImplicitFlow

oauth2AllowImplicitFlow?: pulumi.Input<boolean>;

Does this Azure AD Application allow OAuth2.0 implicit flow tokens? Defaults to false.

property replyUrls

replyUrls?: pulumi.Input<pulumi.Input<string>[]>;

A list of URLs that user tokens are sent to for sign in, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to.

interface ApplicationState

Input properties used for looking up and filtering Application resources.

property applicationId

applicationId?: pulumi.Input<string>;

The Application ID.

property availableToOtherTenants

availableToOtherTenants?: pulumi.Input<boolean>;

Is this Azure AD Application available to other tenants? Defaults to false.

property homepage

homepage?: pulumi.Input<string>;

The URL to the application’s home page. If no homepage is specified this defaults to https://{name}.

property identifierUris

identifierUris?: pulumi.Input<pulumi.Input<string>[]>;

A list of user-defined URI(s) that uniquely identify a Web application within it’s Azure AD tenant, or within a verified custom domain if the application is multi-tenant.

property name

name?: pulumi.Input<string>;

The display name for the application.

property oauth2AllowImplicitFlow

oauth2AllowImplicitFlow?: pulumi.Input<boolean>;

Does this Azure AD Application allow OAuth2.0 implicit flow tokens? Defaults to false.

property replyUrls

replyUrls?: pulumi.Input<pulumi.Input<string>[]>;

A list of URLs that user tokens are sent to for sign in, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to.

interface GetApplicationArgs

A collection of arguments for invoking getApplication.

property name

name?: string;

Specifies the name of the Application within Azure Active Directory.

property objectId

objectId?: string;

Specifies the Object ID of the Application within Azure Active Directory.

interface GetApplicationResult

A collection of values returned by getApplication.

property applicationId

applicationId: string;

the Application ID of the Azure Active Directory Application.

property availableToOtherTenants

availableToOtherTenants: boolean;

Is this Azure AD Application available to other tenants?

property homepage

homepage: string;

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property identifierUris

identifierUris: string[];

A list of user-defined URI(s) that uniquely identify a Web application within it’s Azure AD tenant, or within a verified custom domain if the application is multi-tenant.

property name

name: string;

property oauth2AllowImplicitFlow

oauth2AllowImplicitFlow: boolean;

Does this Azure AD Application allow OAuth2.0 implicit flow tokens?

property objectId

objectId: string;

the Object ID of the Azure Active Directory Application.

property replyUrls

replyUrls: string[];

A list of URLs that user tokens are sent to for sign in, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to.

interface GetServicePrincipalArgs

A collection of arguments for invoking getServicePrincipal.

property applicationId

applicationId?: string;

The ID of the Azure AD Application for which to create a Service Principal.

property displayName

displayName?: string;

The Display Name of the Azure AD Application associated with this Service Principal.

property objectId

objectId?: string;

The ID of the Azure AD Service Principal.

interface GetServicePrincipalResult

A collection of values returned by getServicePrincipal.

property applicationId

applicationId: string;

property displayName

displayName: string;

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property objectId

objectId: string;

interface ServicePrincipalArgs

The set of arguments for constructing a ServicePrincipal resource.

property applicationId

applicationId: pulumi.Input<string>;

The ID of the Azure AD Application for which to create a Service Principal.

interface ServicePrincipalPasswordArgs

The set of arguments for constructing a ServicePrincipalPassword resource.

property endDate

endDate: pulumi.Input<string>;

The End Date which the Password is valid until, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.

property keyId

keyId?: pulumi.Input<string>;

A GUID used to uniquely identify this Key. If not specified a GUID will be created. Changing this field forces a new resource to be created.

property servicePrincipalId

servicePrincipalId: pulumi.Input<string>;

The ID of the Service Principal for which this password should be created. Changing this field forces a new resource to be created.

property startDate

startDate?: pulumi.Input<string>;

The Start Date which the Password is valid from, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). If this isn’t specified, the current date is used. Changing this field forces a new resource to be created.

property value

value: pulumi.Input<string>;

The Password for this Service Principal.

interface ServicePrincipalPasswordState

Input properties used for looking up and filtering ServicePrincipalPassword resources.

property endDate

endDate?: pulumi.Input<string>;

The End Date which the Password is valid until, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.

property keyId

keyId?: pulumi.Input<string>;

A GUID used to uniquely identify this Key. If not specified a GUID will be created. Changing this field forces a new resource to be created.

property servicePrincipalId

servicePrincipalId?: pulumi.Input<string>;

The ID of the Service Principal for which this password should be created. Changing this field forces a new resource to be created.

property startDate

startDate?: pulumi.Input<string>;

The Start Date which the Password is valid from, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). If this isn’t specified, the current date is used. Changing this field forces a new resource to be created.

property value

value?: pulumi.Input<string>;

The Password for this Service Principal.

interface ServicePrincipalState

Input properties used for looking up and filtering ServicePrincipal resources.

property applicationId

applicationId?: pulumi.Input<string>;

The ID of the Azure AD Application for which to create a Service Principal.

property displayName

displayName?: pulumi.Input<string>;

The Display Name of the Azure Active Directory Application associated with this Service Principal.