permalink |
---|
/data/service_principal/ |
service_principal
represents the azuread_service_principal
Terraform data source.
This package contains functions and utilities for setting up the data source using Jsonnet code.
fn new()
fn newAttrs()
fn withApplicationId()
fn withClientId()
fn withDisplayName()
fn withObjectId()
fn withTimeouts()
fn withTimeoutsMixin()
obj timeouts
new()
azuread.data.service_principal.new
injects a new data_azuread_service_principal
Terraform data source
block into the root module document.
Additionally, this inserts a private function into the _ref
attribute that generates references to attributes of the
resource. For example, if you added a new instance to the root using:
# arguments omitted for brevity
azuread.data.service_principal.new('some_id')
You can get the reference to the id
field of the created azuread.data.service_principal
using the reference:
$._ref.data_azuread_service_principal.some_id.get('id')
This is the same as directly entering "${ data_azuread_service_principal.some_id.id }"
as the value.
NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use super
, self
,
or $
to refer to the root object. Instead, make an explicit outer object using local
.
Args:
dataSrcLabel
(string
): The name label of the block.application_id
(string
): The application ID (client ID) of the application associated with this service principal Whennull
, theapplication_id
field will be omitted from the resulting object.client_id
(string
): The client ID of the application associated with this service principal Whennull
, theclient_id
field will be omitted from the resulting object.display_name
(string
): The display name of the application associated with this service principal Whennull
, thedisplay_name
field will be omitted from the resulting object.object_id
(string
): The object ID of the service principal Whennull
, theobject_id
field will be omitted from the resulting object.timeouts
(obj
): Set thetimeouts
field on the resulting data source block. Whennull
, thetimeouts
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the azuread.data.service_principal.timeouts.new constructor.
Returns:
- A mixin object that injects the new data source into the root Terraform configuration.
newAttrs()
azuread.data.service_principal.newAttrs
constructs a new object with attributes and blocks configured for the service_principal
Terraform data source.
Unlike azuread.data.service_principal.new, this function will not inject the data source
block into the root Terraform document. Instead, this must be passed in as the attrs
argument for the
tf.withData function to build a complete block.
This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.
Args:
application_id
(string
): The application ID (client ID) of the application associated with this service principal Whennull
, theapplication_id
field will be omitted from the resulting object.client_id
(string
): The client ID of the application associated with this service principal Whennull
, theclient_id
field will be omitted from the resulting object.display_name
(string
): The display name of the application associated with this service principal Whennull
, thedisplay_name
field will be omitted from the resulting object.object_id
(string
): The object ID of the service principal Whennull
, theobject_id
field will be omitted from the resulting object.timeouts
(obj
): Set thetimeouts
field on the resulting object. Whennull
, thetimeouts
sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the azuread.data.service_principal.timeouts.new constructor.
Returns:
- An attribute object that can be used with tf.withData to construct a new
service_principal
data source into the root Terraform configuration.
withApplicationId()
azuread.string.withApplicationId
constructs a mixin object that can be merged into the string
Terraform data source block to set or update the application_id field.
Args:
dataSrcLabel
(string
): The name label of the block to update.value
(string
): The value to set for theapplication_id
field.
withClientId()
azuread.string.withClientId
constructs a mixin object that can be merged into the string
Terraform data source block to set or update the client_id field.
Args:
dataSrcLabel
(string
): The name label of the block to update.value
(string
): The value to set for theclient_id
field.
withDisplayName()
azuread.string.withDisplayName
constructs a mixin object that can be merged into the string
Terraform data source block to set or update the display_name field.
Args:
dataSrcLabel
(string
): The name label of the block to update.value
(string
): The value to set for thedisplay_name
field.
withObjectId()
azuread.string.withObjectId
constructs a mixin object that can be merged into the string
Terraform data source block to set or update the object_id field.
Args:
dataSrcLabel
(string
): The name label of the block to update.value
(string
): The value to set for theobject_id
field.
withTimeouts()
azuread.obj.withTimeouts
constructs a mixin object that can be merged into the obj
Terraform data source block to set or update the timeouts field.
This function will replace the map with the passed in value
. If you wish to instead merge the
passed in value to the existing map, use the azuread.obj.withTimeoutsMixin function.
Args:
dataSrcLabel
(string
): The name label of the block to update.value
(obj
): The value to set for thetimeouts
field.
withTimeoutsMixin()
azuread.obj.withTimeoutsMixin
constructs a mixin object that can be merged into the obj
Terraform data source block to set or update the timeouts field.
This function will merge the passed in value to the existing map. If you wish
to instead replace the entire map with the passed in value
, use the azuread.obj.withTimeouts
function.
Args:
dataSrcLabel
(string
): The name label of the block to update.value
(obj
): The value to set for thetimeouts
field.
new()
azuread.service_principal.timeouts.new
constructs a new object with attributes and blocks configured for the timeouts
Terraform sub block.
Args:
read
(string
): Set theread
field on the resulting object. Whennull
, theread
field will be omitted from the resulting object.
Returns:
- An attribute object that represents the
timeouts
sub block.