Skip to content

Latest commit

 

History

History
2385 lines (1517 loc) · 111 KB

applicationRegistration.python.md

File metadata and controls

2385 lines (1517 loc) · 111 KB
Raw

applicationRegistration Submodule

Constructs

ApplicationRegistration

Represents a {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration azuread_application_registration}.

Initializers 

from cdktf_cdktf_provider_azuread import application_registration

applicationRegistration.ApplicationRegistration(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  display_name: str,
  description: str = None,
  group_membership_claims: typing.List[str] = None,
  homepage_url: str = None,
  id: str = None,
  implicit_access_token_issuance_enabled: typing.Union[bool, IResolvable] = None,
  implicit_id_token_issuance_enabled: typing.Union[bool, IResolvable] = None,
  logout_url: str = None,
  marketing_url: str = None,
  notes: str = None,
  privacy_statement_url: str = None,
  requested_access_token_version: typing.Union[int, float] = None,
  service_management_reference: str = None,
  sign_in_audience: str = None,
  support_url: str = None,
  terms_of_service_url: str = None,
  timeouts: ApplicationRegistrationTimeouts = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
display_name str The display name for the application.
description str Description of the application as shown to end users.
group_membership_claims typing.List[str] Configures the groups claim that the app expects issued in a user or OAuth access token.
homepage_url str URL of the home page for the application.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#id ApplicationRegistration#id}.
implicit_access_token_issuance_enabled typing.Union[bool, cdktf.IResolvable] Whether this application can request an access token using OAuth implicit flow.
implicit_id_token_issuance_enabled typing.Union[bool, cdktf.IResolvable] Whether this application can request an ID token using OAuth implicit flow.
logout_url str URL of the logout page for the application, where the session is cleared for single sign-out.
marketing_url str URL of the marketing page for the application.
notes str User-specified notes relevant for the management of the application.
privacy_statement_url str URL of the privacy statement for the application.
requested_access_token_version typing.Union[int, float] The access token version expected by this resource.
service_management_reference str References application or contact information from a service or asset management database.
sign_in_audience str The Microsoft account types that are supported for the current application.
support_url str URL of the support page for the application.
terms_of_service_url str URL of the terms of service statement for the application.
timeouts ApplicationRegistrationTimeouts timeouts block.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
display_nameRequired
  • Type: str

The display name for the application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#display_name ApplicationRegistration#display_name}

descriptionOptional
  • Type: str

Description of the application as shown to end users.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#description ApplicationRegistration#description}

group_membership_claimsOptional
  • Type: typing.List[str]

Configures the groups claim that the app expects issued in a user or OAuth access token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#group_membership_claims ApplicationRegistration#group_membership_claims}

homepage_urlOptional
  • Type: str

URL of the home page for the application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#homepage_url ApplicationRegistration#homepage_url}

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#id ApplicationRegistration#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

implicit_access_token_issuance_enabledOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether this application can request an access token using OAuth implicit flow.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#implicit_access_token_issuance_enabled ApplicationRegistration#implicit_access_token_issuance_enabled}

implicit_id_token_issuance_enabledOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether this application can request an ID token using OAuth implicit flow.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#implicit_id_token_issuance_enabled ApplicationRegistration#implicit_id_token_issuance_enabled}

logout_urlOptional
  • Type: str

URL of the logout page for the application, where the session is cleared for single sign-out.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#logout_url ApplicationRegistration#logout_url}

marketing_urlOptional
  • Type: str

URL of the marketing page for the application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#marketing_url ApplicationRegistration#marketing_url}

notesOptional
  • Type: str

User-specified notes relevant for the management of the application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#notes ApplicationRegistration#notes}

privacy_statement_urlOptional
  • Type: str

URL of the privacy statement for the application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#privacy_statement_url ApplicationRegistration#privacy_statement_url}

requested_access_token_versionOptional
  • Type: typing.Union[int, float]

The access token version expected by this resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#requested_access_token_version ApplicationRegistration#requested_access_token_version}

service_management_referenceOptional
  • Type: str

References application or contact information from a service or asset management database.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#service_management_reference ApplicationRegistration#service_management_reference}

sign_in_audienceOptional
  • Type: str

The Microsoft account types that are supported for the current application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#sign_in_audience ApplicationRegistration#sign_in_audience}

support_urlOptional
  • Type: str

URL of the support page for the application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#support_url ApplicationRegistration#support_url}

terms_of_service_urlOptional
  • Type: str

URL of the terms of service statement for the application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#terms_of_service_url ApplicationRegistration#terms_of_service_url}

timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#timeouts ApplicationRegistration#timeouts}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_timeouts No description.
reset_description No description.
reset_group_membership_claims No description.
reset_homepage_url No description.
reset_id No description.
reset_implicit_access_token_issuance_enabled No description.
reset_implicit_id_token_issuance_enabled No description.
reset_logout_url No description.
reset_marketing_url No description.
reset_notes No description.
reset_privacy_statement_url No description.
reset_requested_access_token_version No description.
reset_service_management_reference No description.
reset_sign_in_audience No description.
reset_support_url No description.
reset_terms_of_service_url No description.
reset_timeouts No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

move_to_id 
def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

put_timeouts 
def put_timeouts(
  create: str = None,
  delete: str = None,
  read: str = None,
  update: str = None
) -> None
createOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#create ApplicationRegistration#create}.

deleteOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#delete ApplicationRegistration#delete}.

readOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#read ApplicationRegistration#read}.

updateOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#update ApplicationRegistration#update}.

reset_description 
def reset_description() -> None
reset_group_membership_claims 
def reset_group_membership_claims() -> None
reset_homepage_url 
def reset_homepage_url() -> None
reset_id 
def reset_id() -> None
reset_implicit_access_token_issuance_enabled 
def reset_implicit_access_token_issuance_enabled() -> None
reset_implicit_id_token_issuance_enabled 
def reset_implicit_id_token_issuance_enabled() -> None
reset_logout_url 
def reset_logout_url() -> None
reset_marketing_url 
def reset_marketing_url() -> None
reset_notes 
def reset_notes() -> None
reset_privacy_statement_url 
def reset_privacy_statement_url() -> None
reset_requested_access_token_version 
def reset_requested_access_token_version() -> None
reset_service_management_reference 
def reset_service_management_reference() -> None
reset_sign_in_audience 
def reset_sign_in_audience() -> None
reset_support_url 
def reset_support_url() -> None
reset_terms_of_service_url 
def reset_terms_of_service_url() -> None
reset_timeouts 
def reset_timeouts() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a ApplicationRegistration resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_azuread import application_registration

applicationRegistration.ApplicationRegistration.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_azuread import application_registration

applicationRegistration.ApplicationRegistration.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_azuread import application_registration

applicationRegistration.ApplicationRegistration.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_azuread import application_registration

applicationRegistration.ApplicationRegistration.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a ApplicationRegistration resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

The construct id used in the generated config for the ApplicationRegistration to import.

import_from_idRequired
  • Type: str

The id of the existing ApplicationRegistration that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the ApplicationRegistration to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
client_id str No description.
disabled_by_microsoft str No description.
object_id str No description.
publisher_domain str No description.
timeouts ApplicationRegistrationTimeoutsOutputReference No description.
description_input str No description.
display_name_input str No description.
group_membership_claims_input typing.List[str] No description.
homepage_url_input str No description.
id_input str No description.
implicit_access_token_issuance_enabled_input typing.Union[bool, cdktf.IResolvable] No description.
implicit_id_token_issuance_enabled_input typing.Union[bool, cdktf.IResolvable] No description.
logout_url_input str No description.
marketing_url_input str No description.
notes_input str No description.
privacy_statement_url_input str No description.
requested_access_token_version_input typing.Union[int, float] No description.
service_management_reference_input str No description.
sign_in_audience_input str No description.
support_url_input str No description.
terms_of_service_url_input str No description.
timeouts_input typing.Union[cdktf.IResolvable, ApplicationRegistrationTimeouts] No description.
description str No description.
display_name str No description.
group_membership_claims typing.List[str] No description.
homepage_url str No description.
id str No description.
implicit_access_token_issuance_enabled typing.Union[bool, cdktf.IResolvable] No description.
implicit_id_token_issuance_enabled typing.Union[bool, cdktf.IResolvable] No description.
logout_url str No description.
marketing_url str No description.
notes str No description.
privacy_statement_url str No description.
requested_access_token_version typing.Union[int, float] No description.
service_management_reference str No description.
sign_in_audience str No description.
support_url str No description.
terms_of_service_url str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
client_idRequired 
client_id: str
  • Type: str
disabled_by_microsoftRequired 
disabled_by_microsoft: str
  • Type: str
object_idRequired 
object_id: str
  • Type: str
publisher_domainRequired 
publisher_domain: str
  • Type: str
timeoutsRequired 
timeouts: ApplicationRegistrationTimeoutsOutputReference
description_inputOptional 
description_input: str
  • Type: str
display_name_inputOptional 
display_name_input: str
  • Type: str
group_membership_claims_inputOptional 
group_membership_claims_input: typing.List[str]
  • Type: typing.List[str]
homepage_url_inputOptional 
homepage_url_input: str
  • Type: str
id_inputOptional 
id_input: str
  • Type: str
implicit_access_token_issuance_enabled_inputOptional 
implicit_access_token_issuance_enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
implicit_id_token_issuance_enabled_inputOptional 
implicit_id_token_issuance_enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
logout_url_inputOptional 
logout_url_input: str
  • Type: str
marketing_url_inputOptional 
marketing_url_input: str
  • Type: str
notes_inputOptional 
notes_input: str
  • Type: str
privacy_statement_url_inputOptional 
privacy_statement_url_input: str
  • Type: str
requested_access_token_version_inputOptional 
requested_access_token_version_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
service_management_reference_inputOptional 
service_management_reference_input: str
  • Type: str
sign_in_audience_inputOptional 
sign_in_audience_input: str
  • Type: str
support_url_inputOptional 
support_url_input: str
  • Type: str
terms_of_service_url_inputOptional 
terms_of_service_url_input: str
  • Type: str
timeouts_inputOptional 
timeouts_input: typing.Union[IResolvable, ApplicationRegistrationTimeouts]
descriptionRequired 
description: str
  • Type: str
display_nameRequired 
display_name: str
  • Type: str
group_membership_claimsRequired 
group_membership_claims: typing.List[str]
  • Type: typing.List[str]
homepage_urlRequired 
homepage_url: str
  • Type: str
idRequired 
id: str
  • Type: str
implicit_access_token_issuance_enabledRequired 
implicit_access_token_issuance_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
implicit_id_token_issuance_enabledRequired 
implicit_id_token_issuance_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
logout_urlRequired 
logout_url: str
  • Type: str
marketing_urlRequired 
marketing_url: str
  • Type: str
notesRequired 
notes: str
  • Type: str
privacy_statement_urlRequired 
privacy_statement_url: str
  • Type: str
requested_access_token_versionRequired 
requested_access_token_version: typing.Union[int, float]
  • Type: typing.Union[int, float]
service_management_referenceRequired 
service_management_reference: str
  • Type: str
sign_in_audienceRequired 
sign_in_audience: str
  • Type: str
support_urlRequired 
support_url: str
  • Type: str
terms_of_service_urlRequired 
terms_of_service_url: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

ApplicationRegistrationConfig

Initializer 

from cdktf_cdktf_provider_azuread import application_registration

applicationRegistration.ApplicationRegistrationConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  display_name: str,
  description: str = None,
  group_membership_claims: typing.List[str] = None,
  homepage_url: str = None,
  id: str = None,
  implicit_access_token_issuance_enabled: typing.Union[bool, IResolvable] = None,
  implicit_id_token_issuance_enabled: typing.Union[bool, IResolvable] = None,
  logout_url: str = None,
  marketing_url: str = None,
  notes: str = None,
  privacy_statement_url: str = None,
  requested_access_token_version: typing.Union[int, float] = None,
  service_management_reference: str = None,
  sign_in_audience: str = None,
  support_url: str = None,
  terms_of_service_url: str = None,
  timeouts: ApplicationRegistrationTimeouts = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
display_name str The display name for the application.
description str Description of the application as shown to end users.
group_membership_claims typing.List[str] Configures the groups claim that the app expects issued in a user or OAuth access token.
homepage_url str URL of the home page for the application.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#id ApplicationRegistration#id}.
implicit_access_token_issuance_enabled typing.Union[bool, cdktf.IResolvable] Whether this application can request an access token using OAuth implicit flow.
implicit_id_token_issuance_enabled typing.Union[bool, cdktf.IResolvable] Whether this application can request an ID token using OAuth implicit flow.
logout_url str URL of the logout page for the application, where the session is cleared for single sign-out.
marketing_url str URL of the marketing page for the application.
notes str User-specified notes relevant for the management of the application.
privacy_statement_url str URL of the privacy statement for the application.
requested_access_token_version typing.Union[int, float] The access token version expected by this resource.
service_management_reference str References application or contact information from a service or asset management database.
sign_in_audience str The Microsoft account types that are supported for the current application.
support_url str URL of the support page for the application.
terms_of_service_url str URL of the terms of service statement for the application.
timeouts ApplicationRegistrationTimeouts timeouts block.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
display_nameRequired 
display_name: str
  • Type: str

The display name for the application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#display_name ApplicationRegistration#display_name}

descriptionOptional 
description: str
  • Type: str

Description of the application as shown to end users.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#description ApplicationRegistration#description}

group_membership_claimsOptional 
group_membership_claims: typing.List[str]
  • Type: typing.List[str]

Configures the groups claim that the app expects issued in a user or OAuth access token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#group_membership_claims ApplicationRegistration#group_membership_claims}

homepage_urlOptional 
homepage_url: str
  • Type: str

URL of the home page for the application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#homepage_url ApplicationRegistration#homepage_url}

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#id ApplicationRegistration#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

implicit_access_token_issuance_enabledOptional 
implicit_access_token_issuance_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether this application can request an access token using OAuth implicit flow.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#implicit_access_token_issuance_enabled ApplicationRegistration#implicit_access_token_issuance_enabled}

implicit_id_token_issuance_enabledOptional 
implicit_id_token_issuance_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether this application can request an ID token using OAuth implicit flow.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#implicit_id_token_issuance_enabled ApplicationRegistration#implicit_id_token_issuance_enabled}

logout_urlOptional 
logout_url: str
  • Type: str

URL of the logout page for the application, where the session is cleared for single sign-out.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#logout_url ApplicationRegistration#logout_url}

marketing_urlOptional 
marketing_url: str
  • Type: str

URL of the marketing page for the application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#marketing_url ApplicationRegistration#marketing_url}

notesOptional 
notes: str
  • Type: str

User-specified notes relevant for the management of the application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#notes ApplicationRegistration#notes}

privacy_statement_urlOptional 
privacy_statement_url: str
  • Type: str

URL of the privacy statement for the application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#privacy_statement_url ApplicationRegistration#privacy_statement_url}

requested_access_token_versionOptional 
requested_access_token_version: typing.Union[int, float]
  • Type: typing.Union[int, float]

The access token version expected by this resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#requested_access_token_version ApplicationRegistration#requested_access_token_version}

service_management_referenceOptional 
service_management_reference: str
  • Type: str

References application or contact information from a service or asset management database.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#service_management_reference ApplicationRegistration#service_management_reference}

sign_in_audienceOptional 
sign_in_audience: str
  • Type: str

The Microsoft account types that are supported for the current application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#sign_in_audience ApplicationRegistration#sign_in_audience}

support_urlOptional 
support_url: str
  • Type: str

URL of the support page for the application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#support_url ApplicationRegistration#support_url}

terms_of_service_urlOptional 
terms_of_service_url: str
  • Type: str

URL of the terms of service statement for the application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#terms_of_service_url ApplicationRegistration#terms_of_service_url}

timeoutsOptional 
timeouts: ApplicationRegistrationTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#timeouts ApplicationRegistration#timeouts}

ApplicationRegistrationTimeouts

Initializer 

from cdktf_cdktf_provider_azuread import application_registration

applicationRegistration.ApplicationRegistrationTimeouts(
  create: str = None,
  delete: str = None,
  read: str = None,
  update: str = None
)

Properties

Name Type Description
create str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#create ApplicationRegistration#create}.
delete str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#delete ApplicationRegistration#delete}.
read str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#read ApplicationRegistration#read}.
update str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#update ApplicationRegistration#update}.
createOptional 
create: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#create ApplicationRegistration#create}.

deleteOptional 
delete: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#delete ApplicationRegistration#delete}.

readOptional 
read: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#read ApplicationRegistration#read}.

updateOptional 
update: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/resources/application_registration#update ApplicationRegistration#update}.

Classes

ApplicationRegistrationTimeoutsOutputReference

Initializers 

from cdktf_cdktf_provider_azuread import application_registration

applicationRegistration.ApplicationRegistrationTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_create No description.
reset_delete No description.
reset_read No description.
reset_update No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_create 
def reset_create() -> None
reset_delete 
def reset_delete() -> None
reset_read 
def reset_read() -> None
reset_update 
def reset_update() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
create_input str No description.
delete_input str No description.
read_input str No description.
update_input str No description.
create str No description.
delete str No description.
read str No description.
update str No description.
internal_value typing.Union[cdktf.IResolvable, ApplicationRegistrationTimeouts] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
create_inputOptional 
create_input: str
  • Type: str
delete_inputOptional 
delete_input: str
  • Type: str
read_inputOptional 
read_input: str
  • Type: str
update_inputOptional 
update_input: str
  • Type: str
createRequired 
create: str
  • Type: str
deleteRequired 
delete: str
  • Type: str
readRequired 
read: str
  • Type: str
updateRequired 
update: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, ApplicationRegistrationTimeouts]