Skip to content

Latest commit

 

History

History
274 lines (170 loc) · 10.9 KB

application_password.md

File metadata and controls

274 lines (170 loc) · 10.9 KB
Raw
permalink
/application_password/

application_password

application_password represents the azuread_application_password Terraform resource.

This package contains functions and utilities for setting up the resource using Jsonnet code.

Index

Fields

fn new

new()

azuread.application_password.new injects a new azuread_application_password Terraform resource 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.application_password.new('some_id')

You can get the reference to the id field of the created azuread.application_password using the reference:

$._ref.azuread_application_password.some_id.get('id')

This is the same as directly entering "${ azuread_application_password.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:

  • resourceLabel (string): The name label of the block.
  • application_id (string): The resource ID of the application for which this password should be created When null, the application_id field will be omitted from the resulting object.
  • application_object_id (string): The object ID of the application for which this password should be created When null, the application_object_id field will be omitted from the resulting object.
  • display_name (string): A display name for the password When null, the display_name field will be omitted from the resulting object.
  • end_date (string): The end date until which the password is valid, formatted as an RFC3339 date string (e.g. 2018-01-01T01:02:03Z) When null, the end_date field will be omitted from the resulting object.
  • end_date_relative (string): A relative duration for which the password is valid until, for example 240h (10 days) or 2400h30m. Changing this field forces a new resource to be created When null, the end_date_relative field will be omitted from the resulting object.
  • rotate_when_changed (obj): Arbitrary map of values that, when changed, will trigger rotation of the password When null, the rotate_when_changed field will be omitted from the resulting object.
  • start_date (string): The start date from which the password is valid, formatted as an RFC3339 date string (e.g. 2018-01-01T01:02:03Z). If this isn't specified, the current date is used When null, the start_date field will be omitted from the resulting object.
  • timeouts (obj): Set the timeouts field on the resulting resource block. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the azuread.application_password.timeouts.new constructor.

Returns:

  • A mixin object that injects the new resource into the root Terraform configuration.

fn newAttrs

newAttrs()

azuread.application_password.newAttrs constructs a new object with attributes and blocks configured for the application_password Terraform resource.

Unlike azuread.application_password.new, this function will not inject the resource block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withResource 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 resource ID of the application for which this password should be created When null, the application_id field will be omitted from the resulting object.
  • application_object_id (string): The object ID of the application for which this password should be created When null, the application_object_id field will be omitted from the resulting object.
  • display_name (string): A display name for the password When null, the display_name field will be omitted from the resulting object.
  • end_date (string): The end date until which the password is valid, formatted as an RFC3339 date string (e.g. 2018-01-01T01:02:03Z) When null, the end_date field will be omitted from the resulting object.
  • end_date_relative (string): A relative duration for which the password is valid until, for example 240h (10 days) or 2400h30m. Changing this field forces a new resource to be created When null, the end_date_relative field will be omitted from the resulting object.
  • rotate_when_changed (obj): Arbitrary map of values that, when changed, will trigger rotation of the password When null, the rotate_when_changed field will be omitted from the resulting object.
  • start_date (string): The start date from which the password is valid, formatted as an RFC3339 date string (e.g. 2018-01-01T01:02:03Z). If this isn't specified, the current date is used When null, the start_date field will be omitted from the resulting object.
  • timeouts (obj): Set the timeouts field on the resulting object. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the azuread.application_password.timeouts.new constructor.

Returns:

  • An attribute object that can be used with tf.withResource to construct a new application_password resource into the root Terraform configuration.

fn withApplicationId

withApplicationId()

azuread.string.withApplicationId constructs a mixin object that can be merged into the string Terraform resource block to set or update the application_id field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the application_id field.

fn withApplicationObjectId

withApplicationObjectId()

azuread.string.withApplicationObjectId constructs a mixin object that can be merged into the string Terraform resource block to set or update the application_object_id field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the application_object_id field.

fn withDisplayName

withDisplayName()

azuread.string.withDisplayName constructs a mixin object that can be merged into the string Terraform resource block to set or update the display_name field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the display_name field.

fn withEndDate

withEndDate()

azuread.string.withEndDate constructs a mixin object that can be merged into the string Terraform resource block to set or update the end_date field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the end_date field.

fn withEndDateRelative

withEndDateRelative()

azuread.string.withEndDateRelative constructs a mixin object that can be merged into the string Terraform resource block to set or update the end_date_relative field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the end_date_relative field.

fn withRotateWhenChanged

withRotateWhenChanged()

azuread.obj.withRotateWhenChanged constructs a mixin object that can be merged into the obj Terraform resource block to set or update the rotate_when_changed field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (obj): The value to set for the rotate_when_changed field.

fn withStartDate

withStartDate()

azuread.string.withStartDate constructs a mixin object that can be merged into the string Terraform resource block to set or update the start_date field.

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the start_date field.

fn withTimeouts

withTimeouts()

azuread.obj.withTimeouts constructs a mixin object that can be merged into the obj Terraform resource 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:

  • resourceLabel (string): The name label of the block to update.
  • value (obj): The value to set for the timeouts field.

fn withTimeoutsMixin

withTimeoutsMixin()

azuread.obj.withTimeoutsMixin constructs a mixin object that can be merged into the obj Terraform resource 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:

  • resourceLabel (string): The name label of the block to update.
  • value (obj): The value to set for the timeouts field.

obj timeouts

fn timeouts.new

new()

azuread.application_password.timeouts.new constructs a new object with attributes and blocks configured for the timeouts Terraform sub block.

Args:

  • create (string): Set the create field on the resulting object. When null, the create field will be omitted from the resulting object.
  • delete (string): Set the delete field on the resulting object. When null, the delete field will be omitted from the resulting object.
  • read (string): Set the read field on the resulting object. When null, the read field will be omitted from the resulting object.
  • update (string): Set the update field on the resulting object. When null, the update field will be omitted from the resulting object.

Returns:

  • An attribute object that represents the timeouts sub block.