Skip to content

Latest commit

 

History

History
198 lines (122 loc) · 6.95 KB

synchronization_job.md

File metadata and controls

198 lines (122 loc) · 6.95 KB
Raw
permalink
/synchronization_job/

synchronization_job

synchronization_job represents the azuread_synchronization_job Terraform resource.

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

Index

Fields

fn new

new()

azuread.synchronization_job.new injects a new azuread_synchronization_job 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.synchronization_job.new('some_id')

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

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

This is the same as directly entering "${ azuread_synchronization_job.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.
  • enabled (bool): Whether or not the synchronization job is enabled When null, the enabled field will be omitted from the resulting object.
  • service_principal_id (string): The object ID of the service principal for which this synchronization job should be created
  • template_id (string): Identifier of the synchronization template this job is based on.
  • 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.synchronization_job.timeouts.new constructor.

Returns:

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

fn newAttrs

newAttrs()

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

Unlike azuread.synchronization_job.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:

  • enabled (bool): Whether or not the synchronization job is enabled When null, the enabled field will be omitted from the resulting object.
  • service_principal_id (string): The object ID of the service principal for which this synchronization job should be created
  • template_id (string): Identifier of the synchronization template this job is based on.
  • 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.synchronization_job.timeouts.new constructor.

Returns:

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

fn withEnabled

withEnabled()

azuread.bool.withEnabled constructs a mixin object that can be merged into the bool Terraform resource block to set or update the enabled field.

Args:

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

fn withServicePrincipalId

withServicePrincipalId()

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

Args:

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

fn withTemplateId

withTemplateId()

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

Args:

  • resourceLabel (string): The name label of the block to update.
  • value (string): The value to set for the template_id 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.synchronization_job.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.