`dataAzureadServicePrincipals` Submodule

Constructs

DataAzureadServicePrincipals

Represents a {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals azuread_service_principals}.

Initializers

from cdktf_cdktf_provider_azuread import data_azuread_service_principals

dataAzureadServicePrincipals.DataAzureadServicePrincipals(
  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,
  application_ids: typing.List[str] = None,
  client_ids: typing.List[str] = None,
  display_names: typing.List[str] = None,
  id: str = None,
  ignore_missing: typing.Union[bool, IResolvable] = None,
  object_ids: typing.List[str] = None,
  return_all: typing.Union[bool, IResolvable] = None,
  timeouts: DataAzureadServicePrincipalsTimeouts = 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.
`application_ids`	`typing.List[str]`	The application IDs (client IDs) of the applications associated with the service principals.
`client_ids`	`typing.List[str]`	The client IDs of the applications associated with the service principals.
`display_names`	`typing.List[str]`	The display names of the applications associated with the service principals.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#id DataAzureadServicePrincipals#id}.
`ignore_missing`	`typing.Union[bool, cdktf.IResolvable]`	Ignore missing service principals and return the service principals that were found.
`object_ids`	`typing.List[str]`	The object IDs of the service principals.
`return_all`	`typing.Union[bool, cdktf.IResolvable]`	Fetch all service principals with no filter and return all that were found.
`timeouts`	`DataAzureadServicePrincipalsTimeouts`	timeouts block.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

Type: cdktf.TerraformProvider

`provisioners`^Optional

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`application_ids`^Optional

Type: typing.List[str]

The application IDs (client IDs) of the applications associated with the service principals.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#application_ids DataAzureadServicePrincipals#application_ids}

`client_ids`^Optional

Type: typing.List[str]

The client IDs of the applications associated with the service principals.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#client_ids DataAzureadServicePrincipals#client_ids}

`display_names`^Optional

Type: typing.List[str]

The display names of the applications associated with the service principals.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#display_names DataAzureadServicePrincipals#display_names}

`id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#id DataAzureadServicePrincipals#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.

`ignore_missing`^Optional

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

Ignore missing service principals and return the service principals that were found.

The data source will still fail if no service principals are found

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#ignore_missing DataAzureadServicePrincipals#ignore_missing}

`object_ids`^Optional

Type: typing.List[str]

The object IDs of the service principals.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#object_ids DataAzureadServicePrincipals#object_ids}

`return_all`^Optional

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

Fetch all service principals with no filter and return all that were found.

The data source will still fail if no service principals are found.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#return_all DataAzureadServicePrincipals#return_all}

`timeouts`^Optional

Type: DataAzureadServicePrincipalsTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#timeouts DataAzureadServicePrincipals#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`	Adds this resource to the terraform JSON output.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`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.
`put_timeouts`	No description.
`reset_application_ids`	No description.
`reset_client_ids`	No description.
`reset_display_names`	No description.
`reset_id`	No description.
`reset_ignore_missing`	No description.
`reset_object_ids`	No description.
`reset_return_all`	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

`path`^Required

Type: str

`value`^Required

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_id`^Required

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

Adds this resource to the terraform JSON output.

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`put_timeouts`

def put_timeouts(
  read: str = None
) -> None

`read`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#read DataAzureadServicePrincipals#read}.

`reset_application_ids`

def reset_application_ids() -> None

`reset_client_ids`

def reset_client_ids() -> None

`reset_display_names`

def reset_display_names() -> None

`reset_id`

def reset_id() -> None

`reset_ignore_missing`

def reset_ignore_missing() -> None

`reset_object_ids`

def reset_object_ids() -> None

`reset_return_all`

def reset_return_all() -> 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_data_source`	No description.
`generate_config_for_import`	Generates CDKTF code for importing a DataAzureadServicePrincipals resource upon running "cdktf plan ".

`is_construct`

from cdktf_cdktf_provider_azuread import data_azuread_service_principals

dataAzureadServicePrincipals.DataAzureadServicePrincipals.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.

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

from cdktf_cdktf_provider_azuread import data_azuread_service_principals

dataAzureadServicePrincipals.DataAzureadServicePrincipals.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_data_source`

from cdktf_cdktf_provider_azuread import data_azuread_service_principals

dataAzureadServicePrincipals.DataAzureadServicePrincipals.is_terraform_data_source(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktf_cdktf_provider_azuread import data_azuread_service_principals

dataAzureadServicePrincipals.DataAzureadServicePrincipals.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`import_to_id`^Required

Type: str

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

`import_from_id`^Required

Type: str

The id of the existing DataAzureadServicePrincipals that should be imported.

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

`provider`^Optional

Type: cdktf.TerraformProvider

? Optional instance of the provider where the DataAzureadServicePrincipals 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.
`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.
`service_principals`	`DataAzureadServicePrincipalsServicePrincipalsList`	No description.
`timeouts`	`DataAzureadServicePrincipalsTimeoutsOutputReference`	No description.
`application_ids_input`	`typing.List[str]`	No description.
`client_ids_input`	`typing.List[str]`	No description.
`display_names_input`	`typing.List[str]`	No description.
`id_input`	`str`	No description.
`ignore_missing_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`object_ids_input`	`typing.List[str]`	No description.
`return_all_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`timeouts_input`	`typing.Union[cdktf.IResolvable, DataAzureadServicePrincipalsTimeouts]`	No description.
`application_ids`	`typing.List[str]`	No description.
`client_ids`	`typing.List[str]`	No description.
`display_names`	`typing.List[str]`	No description.
`id`	`str`	No description.
`ignore_missing`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`object_ids`	`typing.List[str]`	No description.
`return_all`	`typing.Union[bool, cdktf.IResolvable]`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktf.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktf.TerraformProviderGeneratorMetadata

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`service_principals`^Required

service_principals: DataAzureadServicePrincipalsServicePrincipalsList

Type: DataAzureadServicePrincipalsServicePrincipalsList

`timeouts`^Required

timeouts: DataAzureadServicePrincipalsTimeoutsOutputReference

Type: DataAzureadServicePrincipalsTimeoutsOutputReference

`application_ids_input`^Optional

application_ids_input: typing.List[str]

Type: typing.List[str]

`client_ids_input`^Optional

client_ids_input: typing.List[str]

Type: typing.List[str]

`display_names_input`^Optional

display_names_input: typing.List[str]

Type: typing.List[str]

`id_input`^Optional

id_input: str

Type: str

`ignore_missing_input`^Optional

ignore_missing_input: typing.Union[bool, IResolvable]

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

`object_ids_input`^Optional

object_ids_input: typing.List[str]

Type: typing.List[str]

`return_all_input`^Optional

return_all_input: typing.Union[bool, IResolvable]

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

`timeouts_input`^Optional

timeouts_input: typing.Union[IResolvable, DataAzureadServicePrincipalsTimeouts]

Type: typing.Union[cdktf.IResolvable, DataAzureadServicePrincipalsTimeouts]

`application_ids`^Required

application_ids: typing.List[str]

Type: typing.List[str]

`client_ids`^Required

client_ids: typing.List[str]

Type: typing.List[str]

`display_names`^Required

display_names: typing.List[str]

Type: typing.List[str]

`id`^Required

id: str

Type: str

`ignore_missing`^Required

ignore_missing: typing.Union[bool, IResolvable]

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

`object_ids`^Required

object_ids: typing.List[str]

Type: typing.List[str]

`return_all`^Required

return_all: typing.Union[bool, IResolvable]

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

Constants

Name	Type	Description
`tfResourceType`	`str`	No description.

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

DataAzureadServicePrincipalsConfig

Initializer

from cdktf_cdktf_provider_azuread import data_azuread_service_principals

dataAzureadServicePrincipals.DataAzureadServicePrincipalsConfig(
  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,
  application_ids: typing.List[str] = None,
  client_ids: typing.List[str] = None,
  display_names: typing.List[str] = None,
  id: str = None,
  ignore_missing: typing.Union[bool, IResolvable] = None,
  object_ids: typing.List[str] = None,
  return_all: typing.Union[bool, IResolvable] = None,
  timeouts: DataAzureadServicePrincipalsTimeouts = 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.
`application_ids`	`typing.List[str]`	The application IDs (client IDs) of the applications associated with the service principals.
`client_ids`	`typing.List[str]`	The client IDs of the applications associated with the service principals.
`display_names`	`typing.List[str]`	The display names of the applications associated with the service principals.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#id DataAzureadServicePrincipals#id}.
`ignore_missing`	`typing.Union[bool, cdktf.IResolvable]`	Ignore missing service principals and return the service principals that were found.
`object_ids`	`typing.List[str]`	The object IDs of the service principals.
`return_all`	`typing.Union[bool, cdktf.IResolvable]`	Fetch all service principals with no filter and return all that were found.
`timeouts`	`DataAzureadServicePrincipalsTimeouts`	timeouts block.

`connection`^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`application_ids`^Optional

application_ids: typing.List[str]

Type: typing.List[str]

The application IDs (client IDs) of the applications associated with the service principals.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#application_ids DataAzureadServicePrincipals#application_ids}

`client_ids`^Optional

client_ids: typing.List[str]

Type: typing.List[str]

The client IDs of the applications associated with the service principals.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#client_ids DataAzureadServicePrincipals#client_ids}

`display_names`^Optional

display_names: typing.List[str]

Type: typing.List[str]

The display names of the applications associated with the service principals.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#display_names DataAzureadServicePrincipals#display_names}

`id`^Optional

id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#id DataAzureadServicePrincipals#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.

`ignore_missing`^Optional

ignore_missing: typing.Union[bool, IResolvable]

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

Ignore missing service principals and return the service principals that were found.

The data source will still fail if no service principals are found

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#ignore_missing DataAzureadServicePrincipals#ignore_missing}

`object_ids`^Optional

object_ids: typing.List[str]

Type: typing.List[str]

The object IDs of the service principals.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#object_ids DataAzureadServicePrincipals#object_ids}

`return_all`^Optional

return_all: typing.Union[bool, IResolvable]

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

Fetch all service principals with no filter and return all that were found.

The data source will still fail if no service principals are found.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#return_all DataAzureadServicePrincipals#return_all}

`timeouts`^Optional

timeouts: DataAzureadServicePrincipalsTimeouts

Type: DataAzureadServicePrincipalsTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#timeouts DataAzureadServicePrincipals#timeouts}

DataAzureadServicePrincipalsServicePrincipals

Initializer

from cdktf_cdktf_provider_azuread import data_azuread_service_principals

dataAzureadServicePrincipals.DataAzureadServicePrincipalsServicePrincipals()

DataAzureadServicePrincipalsTimeouts

Initializer

from cdktf_cdktf_provider_azuread import data_azuread_service_principals

dataAzureadServicePrincipals.DataAzureadServicePrincipalsTimeouts(
  read: str = None
)

Properties

Name	Type	Description
`read`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#read DataAzureadServicePrincipals#read}.

`read`^Optional

read: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.51.0/docs/data-sources/service_principals#read DataAzureadServicePrincipals#read}.

Classes

DataAzureadServicePrincipalsServicePrincipalsList

Initializers

from cdktf_cdktf_provider_azuread import data_azuread_service_principals

dataAzureadServicePrincipals.DataAzureadServicePrincipalsServicePrincipalsList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)

Name	Type	Description
`terraform_resource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.
`wraps_set`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraform_resource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

`wraps_set`^Required

Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`all_with_map_key`	Creating an iterator for this complex list.
`compute_fqn`	No description.
`resolve`	Produce the Token's value at resolution time.
`to_string`	Return a string representation of this resolvable object.
`get`	No description.

`all_with_map_key`

def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`map_key_attribute_name`^Required

Type: str

`compute_fqn`

def compute_fqn() -> str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

`get`

def get(
  index: typing.Union[int, float]
) -> DataAzureadServicePrincipalsServicePrincipalsOutputReference

`index`^Required

Type: typing.Union[int, float]

the index of the item to return.

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.

`creation_stack`^Required

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.

`fqn`^Required

fqn: str

Type: str

DataAzureadServicePrincipalsServicePrincipalsOutputReference

Initializers

from cdktf_cdktf_provider_azuread import data_azuread_service_principals

dataAzureadServicePrincipals.DataAzureadServicePrincipalsServicePrincipalsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)

Name	Type	Description
`terraform_resource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.
`complex_object_index`	`typing.Union[int, float]`	the index of this item in the list.
`complex_object_is_from_set`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraform_resource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

`complex_object_index`^Required

Type: typing.Union[int, float]

the index of this item in the list.

`complex_object_is_from_set`^Required

Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

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.

`compute_fqn`

def compute_fqn() -> str

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

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.
`account_enabled`	`cdktf.IResolvable`	No description.
`application_id`	`str`	No description.
`application_tenant_id`	`str`	No description.
`app_role_assignment_required`	`cdktf.IResolvable`	No description.
`client_id`	`str`	No description.
`display_name`	`str`	No description.
`object_id`	`str`	No description.
`preferred_single_sign_on_mode`	`str`	No description.
`saml_metadata_url`	`str`	No description.
`service_principal_names`	`typing.List[str]`	No description.
`sign_in_audience`	`str`	No description.
`tags`	`typing.List[str]`	No description.
`type`	`str`	No description.
`internal_value`	`DataAzureadServicePrincipalsServicePrincipals`	No description.

`creation_stack`^Required

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.

`fqn`^Required

fqn: str

Type: str

`account_enabled`^Required

account_enabled: IResolvable

Type: cdktf.IResolvable

`application_id`^Required

application_id: str

Type: str

`application_tenant_id`^Required

application_tenant_id: str

Type: str

`app_role_assignment_required`^Required

app_role_assignment_required: IResolvable

Type: cdktf.IResolvable

`client_id`^Required

client_id: str

Type: str

`display_name`^Required

display_name: str

Type: str

`object_id`^Required

object_id: str

Type: str

`preferred_single_sign_on_mode`^Required

preferred_single_sign_on_mode: str

Type: str

`saml_metadata_url`^Required

saml_metadata_url: str

Type: str

`service_principal_names`^Required

service_principal_names: typing.List[str]

Type: typing.List[str]

`sign_in_audience`^Required

sign_in_audience: str

Type: str

`tags`^Required

tags: typing.List[str]

Type: typing.List[str]

`type`^Required

type: str

Type: str

`internal_value`^Optional

internal_value: DataAzureadServicePrincipalsServicePrincipals

Type: DataAzureadServicePrincipalsServicePrincipals

DataAzureadServicePrincipalsTimeoutsOutputReference

Initializers

from cdktf_cdktf_provider_azuread import data_azuread_service_principals

dataAzureadServicePrincipals.DataAzureadServicePrincipalsTimeoutsOutputReference(
  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_resource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

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_read`	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_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

`reset_read`

def reset_read() -> 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.
`read_input`	`str`	No description.
`read`	`str`	No description.
`internal_value`	`typing.Union[cdktf.IResolvable, DataAzureadServicePrincipalsTimeouts]`	No description.

`creation_stack`^Required

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.

`fqn`^Required

fqn: str

Type: str

`read_input`^Optional

read_input: str

Type: str

`read`^Required

read: str

Type: str

`internal_value`^Optional

internal_value: typing.Union[IResolvable, DataAzureadServicePrincipalsTimeouts]

Type: typing.Union[cdktf.IResolvable, DataAzureadServicePrincipalsTimeouts]

Files

dataAzureadServicePrincipals.python.md

Latest commit

History

dataAzureadServicePrincipals.python.md

File metadata and controls

dataAzureadServicePrincipals Submodule

Constructs