From 6acbdacbfaecf361294cd343cc5e6f2d6143850e Mon Sep 17 00:00:00 2001 From: tflibsonnet-ci <120686569+tflibsonnet-ci@users.noreply.github.com> Date: Mon, 19 Dec 2022 15:54:32 -0600 Subject: [PATCH] Add alternative docs when description is missing (#7) --- 2.x/_gen/data/administrative_unit.libsonnet | 6 +- 2.x/_gen/data/application.libsonnet | 6 +- .../application_published_app_ids.libsonnet | 6 +- 2.x/_gen/data/application_template.libsonnet | 6 +- 2.x/_gen/data/client_config.libsonnet | 6 +- 2.x/_gen/data/directory_object.libsonnet | 6 +- 2.x/_gen/data/domains.libsonnet | 6 +- 2.x/_gen/data/group.libsonnet | 6 +- 2.x/_gen/data/groups.libsonnet | 6 +- 2.x/_gen/data/service_principal.libsonnet | 6 +- 2.x/_gen/data/service_principals.libsonnet | 6 +- 2.x/_gen/data/user.libsonnet | 6 +- 2.x/_gen/data/users.libsonnet | 6 +- .../resources/administrative_unit.libsonnet | 6 +- .../administrative_unit_member.libsonnet | 6 +- .../resources/app_role_assignment.libsonnet | 6 +- 2.x/_gen/resources/application.libsonnet | 14 +-- .../application_certificate.libsonnet | 6 +- ...on_federated_identity_credential.libsonnet | 6 +- .../resources/application_password.libsonnet | 6 +- .../application_pre_authorized.libsonnet | 6 +- .../conditional_access_policy.libsonnet | 24 ++--- .../resources/custom_directory_role.libsonnet | 6 +- 2.x/_gen/resources/directory_role.libsonnet | 6 +- .../directory_role_assignment.libsonnet | 6 +- .../resources/directory_role_member.libsonnet | 6 +- 2.x/_gen/resources/group.libsonnet | 8 +- 2.x/_gen/resources/group_member.libsonnet | 6 +- 2.x/_gen/resources/invitation.libsonnet | 6 +- 2.x/_gen/resources/named_location.libsonnet | 10 +- .../resources/service_principal.libsonnet | 6 +- .../service_principal_certificate.libsonnet | 6 +- ...cipal_delegated_permission_grant.libsonnet | 6 +- .../service_principal_password.libsonnet | 6 +- .../resources/synchronization_job.libsonnet | 6 +- .../synchronization_secret.libsonnet | 6 +- 2.x/_gen/resources/user.libsonnet | 6 +- docs/2.x/administrative_unit.md | 12 +-- docs/2.x/administrative_unit_member.md | 12 +-- docs/2.x/app_role_assignment.md | 10 +- docs/2.x/application.md | 54 +++++----- docs/2.x/application_certificate.md | 12 +-- ...plication_federated_identity_credential.md | 12 +-- docs/2.x/application_password.md | 12 +-- docs/2.x/application_pre_authorized.md | 12 +-- docs/2.x/conditional_access_policy.md | 98 +++++++++---------- docs/2.x/custom_directory_role.md | 12 +-- docs/2.x/data/administrative_unit.md | 12 +-- docs/2.x/data/application.md | 6 +- .../2.x/data/application_published_app_ids.md | 6 +- docs/2.x/data/application_template.md | 6 +- docs/2.x/data/client_config.md | 6 +- docs/2.x/data/directory_object.md | 6 +- docs/2.x/data/domains.md | 6 +- docs/2.x/data/group.md | 6 +- docs/2.x/data/groups.md | 6 +- docs/2.x/data/service_principal.md | 6 +- docs/2.x/data/service_principals.md | 6 +- docs/2.x/data/user.md | 6 +- docs/2.x/data/users.md | 6 +- docs/2.x/directory_role.md | 12 +-- docs/2.x/directory_role_assignment.md | 12 +-- docs/2.x/directory_role_member.md | 12 +-- docs/2.x/group.md | 14 +-- docs/2.x/group_member.md | 12 +-- docs/2.x/invitation.md | 12 +-- docs/2.x/named_location.md | 32 +++--- docs/2.x/service_principal.md | 12 +-- docs/2.x/service_principal_certificate.md | 12 +-- ...ce_principal_delegated_permission_grant.md | 12 +-- docs/2.x/service_principal_password.md | 12 +-- docs/2.x/synchronization_job.md | 12 +-- docs/2.x/synchronization_secret.md | 16 +-- docs/2.x/user.md | 12 +-- 74 files changed, 389 insertions(+), 389 deletions(-) diff --git a/2.x/_gen/data/administrative_unit.libsonnet b/2.x/_gen/data/administrative_unit.libsonnet index 3349d2e..e5eb52a 100644 --- a/2.x/_gen/data/administrative_unit.libsonnet +++ b/2.x/_gen/data/administrative_unit.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='administrative_unit', url='', help='`administrative_unit` represents the `azuread_administrative_unit` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.data.administrative_unit.new` injects a new `data_azuread_administrative_unit` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.administrative_unit.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.administrative_unit` using the reference:\n\n $._ref.data_azuread_administrative_unit.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_administrative_unit.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `display_name` (`string`): The display name for the administrative unit When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the administrative unit When `null`, the `object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.data.administrative_unit.new` injects a new `data_azuread_administrative_unit` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.administrative_unit.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.administrative_unit` using the reference:\n\n $._ref.data_azuread_administrative_unit.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_administrative_unit.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `display_name` (`string`): The display name for the administrative unit When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the administrative unit When `null`, the `object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, display_name=null, @@ -15,7 +15,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs(display_name=display_name, object_id=object_id, timeouts=timeouts), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.data.administrative_unit.newAttrs` constructs a new object with attributes and blocks configured for the `administrative_unit`\nTerraform data source.\n\nUnlike [azuread.data.administrative_unit.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name` (`string`): The display name for the administrative unit When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the administrative unit When `null`, the `object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `administrative_unit` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.data.administrative_unit.newAttrs` constructs a new object with attributes and blocks configured for the `administrative_unit`\nTerraform data source.\n\nUnlike [azuread.data.administrative_unit.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name` (`string`): The display name for the administrative unit When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the administrative unit When `null`, the `object_id` field will be omitted from the resulting object.\n - `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.data.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `administrative_unit` data source into the root Terraform configuration.\n', args=[]), newAttrs( display_name=null, object_id=null, @@ -26,7 +26,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.administrative_unit.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.administrative_unit.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/data/application.libsonnet b/2.x/_gen/data/application.libsonnet index 233a9c8..5c26fe1 100644 --- a/2.x/_gen/data/application.libsonnet +++ b/2.x/_gen/data/application.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='application', url='', help='`application` represents the `azuread_application` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.data.application.new` injects a new `data_azuread_application` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.application.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.application` using the reference:\n\n $._ref.data_azuread_application.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_application.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `application_id` (`string`): The Application ID (also called Client ID) When `null`, the `application_id` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the application When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The application\u0026#39;s object ID When `null`, the `object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.application.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.data.application.new` injects a new `data_azuread_application` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.application.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.application` using the reference:\n\n $._ref.data_azuread_application.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_application.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `application_id` (`string`): The Application ID (also called Client ID) When `null`, the `application_id` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the application When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The application\u0026#39;s object ID When `null`, the `object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.application.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, application_id=null, @@ -21,7 +21,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.data.application.newAttrs` constructs a new object with attributes and blocks configured for the `application`\nTerraform data source.\n\nUnlike [azuread.data.application.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `application_id` (`string`): The Application ID (also called Client ID) When `null`, the `application_id` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the application When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The application's object ID When `null`, the `object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.application.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `application` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.data.application.newAttrs` constructs a new object with attributes and blocks configured for the `application`\nTerraform data source.\n\nUnlike [azuread.data.application.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `application_id` (`string`): The Application ID (also called Client ID) When `null`, the `application_id` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the application When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The application's object ID When `null`, the `object_id` field will be omitted from the resulting object.\n - `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.data.application.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `application` data source into the root Terraform configuration.\n', args=[]), newAttrs( application_id=null, display_name=null, @@ -34,7 +34,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.application.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.application.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( read=null ):: std.prune(a={ diff --git a/2.x/_gen/data/application_published_app_ids.libsonnet b/2.x/_gen/data/application_published_app_ids.libsonnet index 3d77109..9c1b429 100644 --- a/2.x/_gen/data/application_published_app_ids.libsonnet +++ b/2.x/_gen/data/application_published_app_ids.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='application_published_app_ids', url='', help='`application_published_app_ids` represents the `azuread_application_published_app_ids` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.data.application_published_app_ids.new` injects a new `data_azuread_application_published_app_ids` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.application_published_app_ids.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.application_published_app_ids` using the reference:\n\n $._ref.data_azuread_application_published_app_ids.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_application_published_app_ids.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `timeouts` (`obj`): 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.data.application_published_app_ids.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.data.application_published_app_ids.new` injects a new `data_azuread_application_published_app_ids` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.application_published_app_ids.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.application_published_app_ids` using the reference:\n\n $._ref.data_azuread_application_published_app_ids.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_application_published_app_ids.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.application_published_app_ids.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, timeouts=null, @@ -13,14 +13,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs(timeouts=timeouts), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.data.application_published_app_ids.newAttrs` constructs a new object with attributes and blocks configured for the `application_published_app_ids`\nTerraform data source.\n\nUnlike [azuread.data.application_published_app_ids.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `timeouts` (`obj`): 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.data.application_published_app_ids.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `application_published_app_ids` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.data.application_published_app_ids.newAttrs` constructs a new object with attributes and blocks configured for the `application_published_app_ids`\nTerraform data source.\n\nUnlike [azuread.data.application_published_app_ids.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `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.data.application_published_app_ids.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `application_published_app_ids` data source into the root Terraform configuration.\n', args=[]), newAttrs( timeouts=null ):: std.prune(a={ timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.application_published_app_ids.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.application_published_app_ids.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( read=null ):: std.prune(a={ diff --git a/2.x/_gen/data/application_template.libsonnet b/2.x/_gen/data/application_template.libsonnet index 1e29d92..6186d21 100644 --- a/2.x/_gen/data/application_template.libsonnet +++ b/2.x/_gen/data/application_template.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='application_template', url='', help='`application_template` represents the `azuread_application_template` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.data.application_template.new` injects a new `data_azuread_application_template` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.application_template.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.application_template` using the reference:\n\n $._ref.data_azuread_application_template.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_application_template.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `display_name` (`string`): The display name for the application template When `null`, the `display_name` field will be omitted from the resulting object.\n - `template_id` (`string`): The application template\u0026#39;s ID When `null`, the `template_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.application_template.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.data.application_template.new` injects a new `data_azuread_application_template` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.application_template.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.application_template` using the reference:\n\n $._ref.data_azuread_application_template.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_application_template.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `display_name` (`string`): The display name for the application template When `null`, the `display_name` field will be omitted from the resulting object.\n - `template_id` (`string`): The application template\u0026#39;s ID When `null`, the `template_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.application_template.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, display_name=null, @@ -15,7 +15,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs(display_name=display_name, template_id=template_id, timeouts=timeouts), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.data.application_template.newAttrs` constructs a new object with attributes and blocks configured for the `application_template`\nTerraform data source.\n\nUnlike [azuread.data.application_template.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name` (`string`): The display name for the application template When `null`, the `display_name` field will be omitted from the resulting object.\n - `template_id` (`string`): The application template's ID When `null`, the `template_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.application_template.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `application_template` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.data.application_template.newAttrs` constructs a new object with attributes and blocks configured for the `application_template`\nTerraform data source.\n\nUnlike [azuread.data.application_template.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name` (`string`): The display name for the application template When `null`, the `display_name` field will be omitted from the resulting object.\n - `template_id` (`string`): The application template's ID When `null`, the `template_id` field will be omitted from the resulting object.\n - `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.data.application_template.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `application_template` data source into the root Terraform configuration.\n', args=[]), newAttrs( display_name=null, template_id=null, @@ -26,7 +26,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.application_template.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.application_template.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( read=null ):: std.prune(a={ diff --git a/2.x/_gen/data/client_config.libsonnet b/2.x/_gen/data/client_config.libsonnet index 306722e..e27d3fe 100644 --- a/2.x/_gen/data/client_config.libsonnet +++ b/2.x/_gen/data/client_config.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='client_config', url='', help='`client_config` represents the `azuread_client_config` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.data.client_config.new` injects a new `data_azuread_client_config` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.client_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.client_config` using the reference:\n\n $._ref.data_azuread_client_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_client_config.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `timeouts` (`obj`): 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.data.client_config.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.data.client_config.new` injects a new `data_azuread_client_config` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.client_config.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.client_config` using the reference:\n\n $._ref.data_azuread_client_config.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_client_config.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.client_config.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, timeouts=null, @@ -13,14 +13,14 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs(timeouts=timeouts), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.data.client_config.newAttrs` constructs a new object with attributes and blocks configured for the `client_config`\nTerraform data source.\n\nUnlike [azuread.data.client_config.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `timeouts` (`obj`): 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.data.client_config.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `client_config` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.data.client_config.newAttrs` constructs a new object with attributes and blocks configured for the `client_config`\nTerraform data source.\n\nUnlike [azuread.data.client_config.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `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.data.client_config.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `client_config` data source into the root Terraform configuration.\n', args=[]), newAttrs( timeouts=null ):: std.prune(a={ timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.client_config.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.client_config.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( read=null ):: std.prune(a={ diff --git a/2.x/_gen/data/directory_object.libsonnet b/2.x/_gen/data/directory_object.libsonnet index e7d3d83..7140246 100644 --- a/2.x/_gen/data/directory_object.libsonnet +++ b/2.x/_gen/data/directory_object.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='directory_object', url='', help='`directory_object` represents the `azuread_directory_object` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.data.directory_object.new` injects a new `data_azuread_directory_object` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.directory_object.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.directory_object` using the reference:\n\n $._ref.data_azuread_directory_object.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_directory_object.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `object_id` (`string`): The object ID of the principal\n - `timeouts` (`obj`): 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.data.directory_object.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.data.directory_object.new` injects a new `data_azuread_directory_object` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.directory_object.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.directory_object` using the reference:\n\n $._ref.data_azuread_directory_object.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_directory_object.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `object_id` (`string`): The object ID of the principal\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.directory_object.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, object_id, @@ -14,7 +14,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs(object_id=object_id, timeouts=timeouts), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.data.directory_object.newAttrs` constructs a new object with attributes and blocks configured for the `directory_object`\nTerraform data source.\n\nUnlike [azuread.data.directory_object.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `object_id` (`string`): The object ID of the principal\n - `timeouts` (`obj`): 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.data.directory_object.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `directory_object` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.data.directory_object.newAttrs` constructs a new object with attributes and blocks configured for the `directory_object`\nTerraform data source.\n\nUnlike [azuread.data.directory_object.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `object_id` (`string`): The object ID of the principal\n - `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.data.directory_object.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `directory_object` data source into the root Terraform configuration.\n', args=[]), newAttrs( object_id, timeouts=null @@ -23,7 +23,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.directory_object.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.directory_object.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( read=null ):: std.prune(a={ diff --git a/2.x/_gen/data/domains.libsonnet b/2.x/_gen/data/domains.libsonnet index 1850a93..c9bb61a 100644 --- a/2.x/_gen/data/domains.libsonnet +++ b/2.x/_gen/data/domains.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='domains', url='', help='`domains` represents the `azuread_domains` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.data.domains.new` injects a new `data_azuread_domains` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.domains.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.domains` using the reference:\n\n $._ref.data_azuread_domains.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_domains.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `admin_managed` (`bool`): Set to `true` to only return domains whose DNS is managed by Microsoft 365 When `null`, the `admin_managed` field will be omitted from the resulting object.\n - `include_unverified` (`bool`): Set to `true` if unverified Azure AD domains should be included When `null`, the `include_unverified` field will be omitted from the resulting object.\n - `only_default` (`bool`): Set to `true` to only return the default domain When `null`, the `only_default` field will be omitted from the resulting object.\n - `only_initial` (`bool`): Set to `true` to only return the initial domain, which is your primary Azure Active Directory tenant domain When `null`, the `only_initial` field will be omitted from the resulting object.\n - `only_root` (`bool`): Set to `true` to only return verified root domains. Excludes subdomains and unverified domains When `null`, the `only_root` field will be omitted from the resulting object.\n - `supports_services` (`list`): A list of supported services that must be supported by a domain When `null`, the `supports_services` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.domains.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.data.domains.new` injects a new `data_azuread_domains` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.domains.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.domains` using the reference:\n\n $._ref.data_azuread_domains.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_domains.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `admin_managed` (`bool`): Set to `true` to only return domains whose DNS is managed by Microsoft 365 When `null`, the `admin_managed` field will be omitted from the resulting object.\n - `include_unverified` (`bool`): Set to `true` if unverified Azure AD domains should be included When `null`, the `include_unverified` field will be omitted from the resulting object.\n - `only_default` (`bool`): Set to `true` to only return the default domain When `null`, the `only_default` field will be omitted from the resulting object.\n - `only_initial` (`bool`): Set to `true` to only return the initial domain, which is your primary Azure Active Directory tenant domain When `null`, the `only_initial` field will be omitted from the resulting object.\n - `only_root` (`bool`): Set to `true` to only return verified root domains. Excludes subdomains and unverified domains When `null`, the `only_root` field will be omitted from the resulting object.\n - `supports_services` (`list`): A list of supported services that must be supported by a domain When `null`, the `supports_services` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.domains.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, admin_managed=null, @@ -27,7 +27,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.data.domains.newAttrs` constructs a new object with attributes and blocks configured for the `domains`\nTerraform data source.\n\nUnlike [azuread.data.domains.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `admin_managed` (`bool`): Set to `true` to only return domains whose DNS is managed by Microsoft 365 When `null`, the `admin_managed` field will be omitted from the resulting object.\n - `include_unverified` (`bool`): Set to `true` if unverified Azure AD domains should be included When `null`, the `include_unverified` field will be omitted from the resulting object.\n - `only_default` (`bool`): Set to `true` to only return the default domain When `null`, the `only_default` field will be omitted from the resulting object.\n - `only_initial` (`bool`): Set to `true` to only return the initial domain, which is your primary Azure Active Directory tenant domain When `null`, the `only_initial` field will be omitted from the resulting object.\n - `only_root` (`bool`): Set to `true` to only return verified root domains. Excludes subdomains and unverified domains When `null`, the `only_root` field will be omitted from the resulting object.\n - `supports_services` (`list`): A list of supported services that must be supported by a domain When `null`, the `supports_services` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.domains.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `domains` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.data.domains.newAttrs` constructs a new object with attributes and blocks configured for the `domains`\nTerraform data source.\n\nUnlike [azuread.data.domains.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `admin_managed` (`bool`): Set to `true` to only return domains whose DNS is managed by Microsoft 365 When `null`, the `admin_managed` field will be omitted from the resulting object.\n - `include_unverified` (`bool`): Set to `true` if unverified Azure AD domains should be included When `null`, the `include_unverified` field will be omitted from the resulting object.\n - `only_default` (`bool`): Set to `true` to only return the default domain When `null`, the `only_default` field will be omitted from the resulting object.\n - `only_initial` (`bool`): Set to `true` to only return the initial domain, which is your primary Azure Active Directory tenant domain When `null`, the `only_initial` field will be omitted from the resulting object.\n - `only_root` (`bool`): Set to `true` to only return verified root domains. Excludes subdomains and unverified domains When `null`, the `only_root` field will be omitted from the resulting object.\n - `supports_services` (`list`): A list of supported services that must be supported by a domain When `null`, the `supports_services` field will be omitted from the resulting object.\n - `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.data.domains.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `domains` data source into the root Terraform configuration.\n', args=[]), newAttrs( admin_managed=null, include_unverified=null, @@ -46,7 +46,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.domains.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.domains.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( read=null ):: std.prune(a={ diff --git a/2.x/_gen/data/group.libsonnet b/2.x/_gen/data/group.libsonnet index cc8b08c..9d32c43 100644 --- a/2.x/_gen/data/group.libsonnet +++ b/2.x/_gen/data/group.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='group', url='', help='`group` represents the `azuread_group` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.data.group.new` injects a new `data_azuread_group` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.group.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.group` using the reference:\n\n $._ref.data_azuread_group.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_group.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `display_name` (`string`): The display name for the group When `null`, the `display_name` field will be omitted from the resulting object.\n - `mail_enabled` (`bool`): Whether the group is mail-enabled When `null`, the `mail_enabled` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the group When `null`, the `object_id` field will be omitted from the resulting object.\n - `security_enabled` (`bool`): Whether the group is a security group When `null`, the `security_enabled` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.group.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.data.group.new` injects a new `data_azuread_group` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.group.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.group` using the reference:\n\n $._ref.data_azuread_group.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_group.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `display_name` (`string`): The display name for the group When `null`, the `display_name` field will be omitted from the resulting object.\n - `mail_enabled` (`bool`): Whether the group is mail-enabled When `null`, the `mail_enabled` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the group When `null`, the `object_id` field will be omitted from the resulting object.\n - `security_enabled` (`bool`): Whether the group is a security group When `null`, the `security_enabled` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.group.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, display_name=null, @@ -23,7 +23,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.data.group.newAttrs` constructs a new object with attributes and blocks configured for the `group`\nTerraform data source.\n\nUnlike [azuread.data.group.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name` (`string`): The display name for the group When `null`, the `display_name` field will be omitted from the resulting object.\n - `mail_enabled` (`bool`): Whether the group is mail-enabled When `null`, the `mail_enabled` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the group When `null`, the `object_id` field will be omitted from the resulting object.\n - `security_enabled` (`bool`): Whether the group is a security group When `null`, the `security_enabled` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.group.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `group` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.data.group.newAttrs` constructs a new object with attributes and blocks configured for the `group`\nTerraform data source.\n\nUnlike [azuread.data.group.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name` (`string`): The display name for the group When `null`, the `display_name` field will be omitted from the resulting object.\n - `mail_enabled` (`bool`): Whether the group is mail-enabled When `null`, the `mail_enabled` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the group When `null`, the `object_id` field will be omitted from the resulting object.\n - `security_enabled` (`bool`): Whether the group is a security group When `null`, the `security_enabled` field will be omitted from the resulting object.\n - `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.data.group.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `group` data source into the root Terraform configuration.\n', args=[]), newAttrs( display_name=null, mail_enabled=null, @@ -38,7 +38,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.group.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.group.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( read=null ):: std.prune(a={ diff --git a/2.x/_gen/data/groups.libsonnet b/2.x/_gen/data/groups.libsonnet index ebf60d9..82931f8 100644 --- a/2.x/_gen/data/groups.libsonnet +++ b/2.x/_gen/data/groups.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='groups', url='', help='`groups` represents the `azuread_groups` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.data.groups.new` injects a new `data_azuread_groups` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.groups.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.groups` using the reference:\n\n $._ref.data_azuread_groups.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_groups.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `display_name_prefix` (`string`): Common display name prefix of the groups When `null`, the `display_name_prefix` field will be omitted from the resulting object.\n - `display_names` (`list`): The display names of the groups When `null`, the `display_names` field will be omitted from the resulting object.\n - `ignore_missing` (`bool`): Ignore missing groups and return groups that were found. The data source will still fail if no groups are found When `null`, the `ignore_missing` field will be omitted from the resulting object.\n - `mail_enabled` (`bool`): Whether the groups are mail-enabled When `null`, the `mail_enabled` field will be omitted from the resulting object.\n - `object_ids` (`list`): The object IDs of the groups When `null`, the `object_ids` field will be omitted from the resulting object.\n - `return_all` (`bool`): Retrieve all groups with no filter When `null`, the `return_all` field will be omitted from the resulting object.\n - `security_enabled` (`bool`): Whether the groups are security-enabled When `null`, the `security_enabled` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.groups.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.data.groups.new` injects a new `data_azuread_groups` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.groups.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.groups` using the reference:\n\n $._ref.data_azuread_groups.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_groups.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `display_name_prefix` (`string`): Common display name prefix of the groups When `null`, the `display_name_prefix` field will be omitted from the resulting object.\n - `display_names` (`list`): The display names of the groups When `null`, the `display_names` field will be omitted from the resulting object.\n - `ignore_missing` (`bool`): Ignore missing groups and return groups that were found. The data source will still fail if no groups are found When `null`, the `ignore_missing` field will be omitted from the resulting object.\n - `mail_enabled` (`bool`): Whether the groups are mail-enabled When `null`, the `mail_enabled` field will be omitted from the resulting object.\n - `object_ids` (`list`): The object IDs of the groups When `null`, the `object_ids` field will be omitted from the resulting object.\n - `return_all` (`bool`): Retrieve all groups with no filter When `null`, the `return_all` field will be omitted from the resulting object.\n - `security_enabled` (`bool`): Whether the groups are security-enabled When `null`, the `security_enabled` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.groups.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, display_name_prefix=null, @@ -29,7 +29,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.data.groups.newAttrs` constructs a new object with attributes and blocks configured for the `groups`\nTerraform data source.\n\nUnlike [azuread.data.groups.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name_prefix` (`string`): Common display name prefix of the groups When `null`, the `display_name_prefix` field will be omitted from the resulting object.\n - `display_names` (`list`): The display names of the groups When `null`, the `display_names` field will be omitted from the resulting object.\n - `ignore_missing` (`bool`): Ignore missing groups and return groups that were found. The data source will still fail if no groups are found When `null`, the `ignore_missing` field will be omitted from the resulting object.\n - `mail_enabled` (`bool`): Whether the groups are mail-enabled When `null`, the `mail_enabled` field will be omitted from the resulting object.\n - `object_ids` (`list`): The object IDs of the groups When `null`, the `object_ids` field will be omitted from the resulting object.\n - `return_all` (`bool`): Retrieve all groups with no filter When `null`, the `return_all` field will be omitted from the resulting object.\n - `security_enabled` (`bool`): Whether the groups are security-enabled When `null`, the `security_enabled` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.groups.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `groups` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.data.groups.newAttrs` constructs a new object with attributes and blocks configured for the `groups`\nTerraform data source.\n\nUnlike [azuread.data.groups.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name_prefix` (`string`): Common display name prefix of the groups When `null`, the `display_name_prefix` field will be omitted from the resulting object.\n - `display_names` (`list`): The display names of the groups When `null`, the `display_names` field will be omitted from the resulting object.\n - `ignore_missing` (`bool`): Ignore missing groups and return groups that were found. The data source will still fail if no groups are found When `null`, the `ignore_missing` field will be omitted from the resulting object.\n - `mail_enabled` (`bool`): Whether the groups are mail-enabled When `null`, the `mail_enabled` field will be omitted from the resulting object.\n - `object_ids` (`list`): The object IDs of the groups When `null`, the `object_ids` field will be omitted from the resulting object.\n - `return_all` (`bool`): Retrieve all groups with no filter When `null`, the `return_all` field will be omitted from the resulting object.\n - `security_enabled` (`bool`): Whether the groups are security-enabled When `null`, the `security_enabled` field will be omitted from the resulting object.\n - `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.data.groups.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `groups` data source into the root Terraform configuration.\n', args=[]), newAttrs( display_name_prefix=null, display_names=null, @@ -50,7 +50,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.groups.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.groups.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( read=null ):: std.prune(a={ diff --git a/2.x/_gen/data/service_principal.libsonnet b/2.x/_gen/data/service_principal.libsonnet index bc290a2..7fa7c1b 100644 --- a/2.x/_gen/data/service_principal.libsonnet +++ b/2.x/_gen/data/service_principal.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='service_principal', url='', help='`service_principal` represents the `azuread_service_principal` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.data.service_principal.new` injects a new `data_azuread_service_principal` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.service_principal.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.service_principal` using the reference:\n\n $._ref.data_azuread_service_principal.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_service_principal.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `application_id` (`string`): The application ID (client ID) of the application associated with this service principal When `null`, the `application_id` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name of the application associated with this service principal When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the service principal When `null`, the `object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.service_principal.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.data.service_principal.new` injects a new `data_azuread_service_principal` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.service_principal.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.service_principal` using the reference:\n\n $._ref.data_azuread_service_principal.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_service_principal.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `application_id` (`string`): The application ID (client ID) of the application associated with this service principal When `null`, the `application_id` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name of the application associated with this service principal When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the service principal When `null`, the `object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.service_principal.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, application_id=null, @@ -21,7 +21,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.data.service_principal.newAttrs` constructs a new object with attributes and blocks configured for the `service_principal`\nTerraform data source.\n\nUnlike [azuread.data.service_principal.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `application_id` (`string`): The application ID (client ID) of the application associated with this service principal When `null`, the `application_id` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name of the application associated with this service principal When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the service principal When `null`, the `object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.service_principal.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `service_principal` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.data.service_principal.newAttrs` constructs a new object with attributes and blocks configured for the `service_principal`\nTerraform data source.\n\nUnlike [azuread.data.service_principal.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `application_id` (`string`): The application ID (client ID) of the application associated with this service principal When `null`, the `application_id` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name of the application associated with this service principal When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the service principal When `null`, the `object_id` field will be omitted from the resulting object.\n - `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.data.service_principal.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `service_principal` data source into the root Terraform configuration.\n', args=[]), newAttrs( application_id=null, display_name=null, @@ -34,7 +34,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.service_principal.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.service_principal.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( read=null ):: std.prune(a={ diff --git a/2.x/_gen/data/service_principals.libsonnet b/2.x/_gen/data/service_principals.libsonnet index b894a77..a3c99ee 100644 --- a/2.x/_gen/data/service_principals.libsonnet +++ b/2.x/_gen/data/service_principals.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='service_principals', url='', help='`service_principals` represents the `azuread_service_principals` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.data.service_principals.new` injects a new `data_azuread_service_principals` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.service_principals.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.service_principals` using the reference:\n\n $._ref.data_azuread_service_principals.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_service_principals.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `application_ids` (`list`): The application IDs (client IDs) of the applications associated with the service principals When `null`, the `application_ids` field will be omitted from the resulting object.\n - `display_names` (`list`): The display names of the applications associated with the service principals When `null`, the `display_names` field will be omitted from the resulting object.\n - `ignore_missing` (`bool`): Ignore missing service principals and return the service principals that were found. The data source will still fail if no service principals are found When `null`, the `ignore_missing` field will be omitted from the resulting object.\n - `object_ids` (`list`): The object IDs of the service principals When `null`, the `object_ids` field will be omitted from the resulting object.\n - `return_all` (`bool`): 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. When `null`, the `return_all` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.service_principals.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.data.service_principals.new` injects a new `data_azuread_service_principals` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.service_principals.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.service_principals` using the reference:\n\n $._ref.data_azuread_service_principals.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_service_principals.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `application_ids` (`list`): The application IDs (client IDs) of the applications associated with the service principals When `null`, the `application_ids` field will be omitted from the resulting object.\n - `display_names` (`list`): The display names of the applications associated with the service principals When `null`, the `display_names` field will be omitted from the resulting object.\n - `ignore_missing` (`bool`): Ignore missing service principals and return the service principals that were found. The data source will still fail if no service principals are found When `null`, the `ignore_missing` field will be omitted from the resulting object.\n - `object_ids` (`list`): The object IDs of the service principals When `null`, the `object_ids` field will be omitted from the resulting object.\n - `return_all` (`bool`): 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. When `null`, the `return_all` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.service_principals.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, application_ids=null, @@ -25,7 +25,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.data.service_principals.newAttrs` constructs a new object with attributes and blocks configured for the `service_principals`\nTerraform data source.\n\nUnlike [azuread.data.service_principals.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `application_ids` (`list`): The application IDs (client IDs) of the applications associated with the service principals When `null`, the `application_ids` field will be omitted from the resulting object.\n - `display_names` (`list`): The display names of the applications associated with the service principals When `null`, the `display_names` field will be omitted from the resulting object.\n - `ignore_missing` (`bool`): Ignore missing service principals and return the service principals that were found. The data source will still fail if no service principals are found When `null`, the `ignore_missing` field will be omitted from the resulting object.\n - `object_ids` (`list`): The object IDs of the service principals When `null`, the `object_ids` field will be omitted from the resulting object.\n - `return_all` (`bool`): 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. When `null`, the `return_all` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.service_principals.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `service_principals` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.data.service_principals.newAttrs` constructs a new object with attributes and blocks configured for the `service_principals`\nTerraform data source.\n\nUnlike [azuread.data.service_principals.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `application_ids` (`list`): The application IDs (client IDs) of the applications associated with the service principals When `null`, the `application_ids` field will be omitted from the resulting object.\n - `display_names` (`list`): The display names of the applications associated with the service principals When `null`, the `display_names` field will be omitted from the resulting object.\n - `ignore_missing` (`bool`): Ignore missing service principals and return the service principals that were found. The data source will still fail if no service principals are found When `null`, the `ignore_missing` field will be omitted from the resulting object.\n - `object_ids` (`list`): The object IDs of the service principals When `null`, the `object_ids` field will be omitted from the resulting object.\n - `return_all` (`bool`): 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. When `null`, the `return_all` field will be omitted from the resulting object.\n - `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.data.service_principals.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `service_principals` data source into the root Terraform configuration.\n', args=[]), newAttrs( application_ids=null, display_names=null, @@ -42,7 +42,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.service_principals.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.service_principals.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( read=null ):: std.prune(a={ diff --git a/2.x/_gen/data/user.libsonnet b/2.x/_gen/data/user.libsonnet index 71b1253..eeb1eef 100644 --- a/2.x/_gen/data/user.libsonnet +++ b/2.x/_gen/data/user.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='user', url='', help='`user` represents the `azuread_user` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.data.user.new` injects a new `data_azuread_user` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.user.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.user` using the reference:\n\n $._ref.data_azuread_user.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_user.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `mail_nickname` (`string`): The email alias of the user When `null`, the `mail_nickname` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the user When `null`, the `object_id` field will be omitted from the resulting object.\n - `user_principal_name` (`string`): The user principal name (UPN) of the user When `null`, the `user_principal_name` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.user.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.data.user.new` injects a new `data_azuread_user` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.user.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.user` using the reference:\n\n $._ref.data_azuread_user.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_user.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `mail_nickname` (`string`): The email alias of the user When `null`, the `mail_nickname` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the user When `null`, the `object_id` field will be omitted from the resulting object.\n - `user_principal_name` (`string`): The user principal name (UPN) of the user When `null`, the `user_principal_name` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.user.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, mail_nickname=null, @@ -21,7 +21,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.data.user.newAttrs` constructs a new object with attributes and blocks configured for the `user`\nTerraform data source.\n\nUnlike [azuread.data.user.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `mail_nickname` (`string`): The email alias of the user When `null`, the `mail_nickname` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the user When `null`, the `object_id` field will be omitted from the resulting object.\n - `user_principal_name` (`string`): The user principal name (UPN) of the user When `null`, the `user_principal_name` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.user.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `user` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.data.user.newAttrs` constructs a new object with attributes and blocks configured for the `user`\nTerraform data source.\n\nUnlike [azuread.data.user.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `mail_nickname` (`string`): The email alias of the user When `null`, the `mail_nickname` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the user When `null`, the `object_id` field will be omitted from the resulting object.\n - `user_principal_name` (`string`): The user principal name (UPN) of the user When `null`, the `user_principal_name` field will be omitted from the resulting object.\n - `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.data.user.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `user` data source into the root Terraform configuration.\n', args=[]), newAttrs( mail_nickname=null, object_id=null, @@ -34,7 +34,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); user_principal_name: user_principal_name, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.user.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.user.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( read=null ):: std.prune(a={ diff --git a/2.x/_gen/data/users.libsonnet b/2.x/_gen/data/users.libsonnet index 332b604..fcac3f3 100644 --- a/2.x/_gen/data/users.libsonnet +++ b/2.x/_gen/data/users.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='users', url='', help='`users` represents the `azuread_users` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.data.users.new` injects a new `data_azuread_users` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.users.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.users` using the reference:\n\n $._ref.data_azuread_users.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_users.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `ignore_missing` (`bool`): Ignore missing users and return users that were found. The data source will still fail if no users are found When `null`, the `ignore_missing` field will be omitted from the resulting object.\n - `mail_nicknames` (`list`): The email aliases of the users When `null`, the `mail_nicknames` field will be omitted from the resulting object.\n - `object_ids` (`list`): The object IDs of the users When `null`, the `object_ids` field will be omitted from the resulting object.\n - `return_all` (`bool`): Fetch all users with no filter and return all that were found. The data source will still fail if no users are found. When `null`, the `return_all` field will be omitted from the resulting object.\n - `user_principal_names` (`list`): The user principal names (UPNs) of the users When `null`, the `user_principal_names` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.users.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.data.users.new` injects a new `data_azuread_users` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.users.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.users` using the reference:\n\n $._ref.data_azuread_users.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_users.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `ignore_missing` (`bool`): Ignore missing users and return users that were found. The data source will still fail if no users are found When `null`, the `ignore_missing` field will be omitted from the resulting object.\n - `mail_nicknames` (`list`): The email aliases of the users When `null`, the `mail_nicknames` field will be omitted from the resulting object.\n - `object_ids` (`list`): The object IDs of the users When `null`, the `object_ids` field will be omitted from the resulting object.\n - `return_all` (`bool`): Fetch all users with no filter and return all that were found. The data source will still fail if no users are found. When `null`, the `return_all` field will be omitted from the resulting object.\n - `user_principal_names` (`list`): The user principal names (UPNs) of the users When `null`, the `user_principal_names` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.users.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, ignore_missing=null, @@ -25,7 +25,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.data.users.newAttrs` constructs a new object with attributes and blocks configured for the `users`\nTerraform data source.\n\nUnlike [azuread.data.users.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `ignore_missing` (`bool`): Ignore missing users and return users that were found. The data source will still fail if no users are found When `null`, the `ignore_missing` field will be omitted from the resulting object.\n - `mail_nicknames` (`list`): The email aliases of the users When `null`, the `mail_nicknames` field will be omitted from the resulting object.\n - `object_ids` (`list`): The object IDs of the users When `null`, the `object_ids` field will be omitted from the resulting object.\n - `return_all` (`bool`): Fetch all users with no filter and return all that were found. The data source will still fail if no users are found. When `null`, the `return_all` field will be omitted from the resulting object.\n - `user_principal_names` (`list`): The user principal names (UPNs) of the users When `null`, the `user_principal_names` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.data.users.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `users` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.data.users.newAttrs` constructs a new object with attributes and blocks configured for the `users`\nTerraform data source.\n\nUnlike [azuread.data.users.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `ignore_missing` (`bool`): Ignore missing users and return users that were found. The data source will still fail if no users are found When `null`, the `ignore_missing` field will be omitted from the resulting object.\n - `mail_nicknames` (`list`): The email aliases of the users When `null`, the `mail_nicknames` field will be omitted from the resulting object.\n - `object_ids` (`list`): The object IDs of the users When `null`, the `object_ids` field will be omitted from the resulting object.\n - `return_all` (`bool`): Fetch all users with no filter and return all that were found. The data source will still fail if no users are found. When `null`, the `return_all` field will be omitted from the resulting object.\n - `user_principal_names` (`list`): The user principal names (UPNs) of the users When `null`, the `user_principal_names` field will be omitted from the resulting object.\n - `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.data.users.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `users` data source into the root Terraform configuration.\n', args=[]), newAttrs( ignore_missing=null, mail_nicknames=null, @@ -42,7 +42,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); user_principal_names: user_principal_names, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.users.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.users.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( read=null ):: std.prune(a={ diff --git a/2.x/_gen/resources/administrative_unit.libsonnet b/2.x/_gen/resources/administrative_unit.libsonnet index 2c2a603..e5e3944 100644 --- a/2.x/_gen/resources/administrative_unit.libsonnet +++ b/2.x/_gen/resources/administrative_unit.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='administrative_unit', url='', help='`administrative_unit` represents the `azuread_administrative_unit` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.administrative_unit.new` injects a new `azuread_administrative_unit` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.administrative_unit.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.administrative_unit` using the reference:\n\n $._ref.azuread_administrative_unit.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_administrative_unit.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): The description for the administrative unit When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the administrative unit\n - `hidden_membership_enabled` (`bool`): Whether the administrative unit and its members are hidden or publicly viewable in the directory When `null`, the `hidden_membership_enabled` field will be omitted from the resulting object.\n - `members` (`list`): A set of object IDs of members who should be present in this administrative unit. Supported object types are Users or Groups When `null`, the `members` field will be omitted from the resulting object.\n - `prevent_duplicate_names` (`bool`): If `true`, will return an error if an existing administrative unit is found with the same name When `null`, the `prevent_duplicate_names` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.administrative_unit.new` injects a new `azuread_administrative_unit` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.administrative_unit.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.administrative_unit` using the reference:\n\n $._ref.azuread_administrative_unit.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_administrative_unit.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): The description for the administrative unit When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the administrative unit\n - `hidden_membership_enabled` (`bool`): Whether the administrative unit and its members are hidden or publicly viewable in the directory When `null`, the `hidden_membership_enabled` field will be omitted from the resulting object.\n - `members` (`list`): A set of object IDs of members who should be present in this administrative unit. Supported object types are Users or Groups When `null`, the `members` field will be omitted from the resulting object.\n - `prevent_duplicate_names` (`bool`): If `true`, will return an error if an existing administrative unit is found with the same name When `null`, the `prevent_duplicate_names` field will be omitted from the resulting object.\n - `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.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, display_name, @@ -25,7 +25,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.administrative_unit.newAttrs` constructs a new object with attributes and blocks configured for the `administrative_unit`\nTerraform resource.\n\nUnlike [azuread.administrative_unit.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): The description for the administrative unit When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the administrative unit\n - `hidden_membership_enabled` (`bool`): Whether the administrative unit and its members are hidden or publicly viewable in the directory When `null`, the `hidden_membership_enabled` field will be omitted from the resulting object.\n - `members` (`list`): A set of object IDs of members who should be present in this administrative unit. Supported object types are Users or Groups When `null`, the `members` field will be omitted from the resulting object.\n - `prevent_duplicate_names` (`bool`): If `true`, will return an error if an existing administrative unit is found with the same name When `null`, the `prevent_duplicate_names` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `administrative_unit` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.administrative_unit.newAttrs` constructs a new object with attributes and blocks configured for the `administrative_unit`\nTerraform resource.\n\nUnlike [azuread.administrative_unit.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): The description for the administrative unit When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the administrative unit\n - `hidden_membership_enabled` (`bool`): Whether the administrative unit and its members are hidden or publicly viewable in the directory When `null`, the `hidden_membership_enabled` field will be omitted from the resulting object.\n - `members` (`list`): A set of object IDs of members who should be present in this administrative unit. Supported object types are Users or Groups When `null`, the `members` field will be omitted from the resulting object.\n - `prevent_duplicate_names` (`bool`): If `true`, will return an error if an existing administrative unit is found with the same name When `null`, the `prevent_duplicate_names` field will be omitted from the resulting object.\n - `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.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `administrative_unit` resource into the root Terraform configuration.\n', args=[]), newAttrs( display_name, description=null, @@ -42,7 +42,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.administrative_unit.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.administrative_unit.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/administrative_unit_member.libsonnet b/2.x/_gen/resources/administrative_unit_member.libsonnet index 03de3c5..6722782 100644 --- a/2.x/_gen/resources/administrative_unit_member.libsonnet +++ b/2.x/_gen/resources/administrative_unit_member.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='administrative_unit_member', url='', help='`administrative_unit_member` represents the `azuread_administrative_unit_member` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.administrative_unit_member.new` injects a new `azuread_administrative_unit_member` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.administrative_unit_member.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.administrative_unit_member` using the reference:\n\n $._ref.azuread_administrative_unit_member.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_administrative_unit_member.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `administrative_unit_object_id` (`string`): The object ID of the administrative unit When `null`, the `administrative_unit_object_id` field will be omitted from the resulting object.\n - `member_object_id` (`string`): The object ID of the member When `null`, the `member_object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.administrative_unit_member.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.administrative_unit_member.new` injects a new `azuread_administrative_unit_member` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.administrative_unit_member.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.administrative_unit_member` using the reference:\n\n $._ref.azuread_administrative_unit_member.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_administrative_unit_member.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `administrative_unit_object_id` (`string`): The object ID of the administrative unit When `null`, the `administrative_unit_object_id` field will be omitted from the resulting object.\n - `member_object_id` (`string`): The object ID of the member When `null`, the `member_object_id` field will be omitted from the resulting object.\n - `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.administrative_unit_member.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, administrative_unit_object_id=null, @@ -15,7 +15,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs(administrative_unit_object_id=administrative_unit_object_id, member_object_id=member_object_id, timeouts=timeouts), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.administrative_unit_member.newAttrs` constructs a new object with attributes and blocks configured for the `administrative_unit_member`\nTerraform resource.\n\nUnlike [azuread.administrative_unit_member.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `administrative_unit_object_id` (`string`): The object ID of the administrative unit When `null`, the `administrative_unit_object_id` field will be omitted from the resulting object.\n - `member_object_id` (`string`): The object ID of the member When `null`, the `member_object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.administrative_unit_member.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `administrative_unit_member` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.administrative_unit_member.newAttrs` constructs a new object with attributes and blocks configured for the `administrative_unit_member`\nTerraform resource.\n\nUnlike [azuread.administrative_unit_member.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `administrative_unit_object_id` (`string`): The object ID of the administrative unit When `null`, the `administrative_unit_object_id` field will be omitted from the resulting object.\n - `member_object_id` (`string`): The object ID of the member When `null`, the `member_object_id` field will be omitted from the resulting object.\n - `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.administrative_unit_member.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `administrative_unit_member` resource into the root Terraform configuration.\n', args=[]), newAttrs( administrative_unit_object_id=null, member_object_id=null, @@ -26,7 +26,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.administrative_unit_member.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.administrative_unit_member.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/app_role_assignment.libsonnet b/2.x/_gen/resources/app_role_assignment.libsonnet index 84bfd93..d6e1120 100644 --- a/2.x/_gen/resources/app_role_assignment.libsonnet +++ b/2.x/_gen/resources/app_role_assignment.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='app_role_assignment', url='', help='`app_role_assignment` represents the `azuread_app_role_assignment` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.app_role_assignment.new` injects a new `azuread_app_role_assignment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.app_role_assignment.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.app_role_assignment` using the reference:\n\n $._ref.azuread_app_role_assignment.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_app_role_assignment.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `app_role_id` (`string`): The ID of the app role to be assigned\n - `principal_object_id` (`string`): The object ID of the user, group or service principal to be assigned this app role\n - `resource_object_id` (`string`): The object ID of the service principal representing the resource\n - `timeouts` (`obj`): 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.app_role_assignment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.app_role_assignment.new` injects a new `azuread_app_role_assignment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.app_role_assignment.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.app_role_assignment` using the reference:\n\n $._ref.azuread_app_role_assignment.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_app_role_assignment.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `app_role_id` (`string`): The ID of the app role to be assigned\n - `principal_object_id` (`string`): The object ID of the user, group or service principal to be assigned this app role\n - `resource_object_id` (`string`): The object ID of the service principal representing the resource\n - `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.app_role_assignment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, app_role_id, @@ -21,7 +21,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.app_role_assignment.newAttrs` constructs a new object with attributes and blocks configured for the `app_role_assignment`\nTerraform resource.\n\nUnlike [azuread.app_role_assignment.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `app_role_id` (`string`): The ID of the app role to be assigned\n - `principal_object_id` (`string`): The object ID of the user, group or service principal to be assigned this app role\n - `resource_object_id` (`string`): The object ID of the service principal representing the resource\n - `timeouts` (`obj`): 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.app_role_assignment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `app_role_assignment` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.app_role_assignment.newAttrs` constructs a new object with attributes and blocks configured for the `app_role_assignment`\nTerraform resource.\n\nUnlike [azuread.app_role_assignment.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `app_role_id` (`string`): The ID of the app role to be assigned\n - `principal_object_id` (`string`): The object ID of the user, group or service principal to be assigned this app role\n - `resource_object_id` (`string`): The object ID of the service principal representing the resource\n - `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.app_role_assignment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `app_role_assignment` resource into the root Terraform configuration.\n', args=[]), newAttrs( app_role_id, principal_object_id, @@ -34,7 +34,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.app_role_assignment.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.app_role_assignment.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/application.libsonnet b/2.x/_gen/resources/application.libsonnet index 614c265..5bb5406 100644 --- a/2.x/_gen/resources/application.libsonnet +++ b/2.x/_gen/resources/application.libsonnet @@ -66,7 +66,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); hide: hide, }), }, - '#new':: d.fn(help="\n`azuread.application.new` injects a new `azuread_application` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.application.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application` using the reference:\n\n $._ref.azuread_application.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `device_only_auth_enabled` (`bool`): Specifies whether this application supports device authentication without a user. When `null`, the `device_only_auth_enabled` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the application\n - `fallback_public_client_enabled` (`bool`): Specifies whether the application is a public client. Appropriate for apps using token grant flows that don\u0026#39;t use a redirect URI When `null`, the `fallback_public_client_enabled` field will be omitted from the resulting object.\n - `group_membership_claims` (`list`): Configures the `groups` claim issued in a user or OAuth 2.0 access token that the app expects When `null`, the `group_membership_claims` field will be omitted from the resulting object.\n - `identifier_uris` (`list`): The user-defined URI(s) that uniquely identify an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant When `null`, the `identifier_uris` field will be omitted from the resulting object.\n - `logo_image` (`string`): Base64 encoded logo image in gif, png or jpeg format When `null`, the `logo_image` field will be omitted from the resulting object.\n - `marketing_url` (`string`): URL of the application\u0026#39;s marketing page When `null`, the `marketing_url` field will be omitted from the resulting object.\n - `oauth2_post_response_required` (`bool`): Specifies whether, as part of OAuth 2.0 token requests, Azure AD allows POST requests, as opposed to GET requests. When `null`, the `oauth2_post_response_required` field will be omitted from the resulting object.\n - `owners` (`list`): A list of object IDs of principals that will be granted ownership of the application When `null`, the `owners` field will be omitted from the resulting object.\n - `prevent_duplicate_names` (`bool`): If `true`, will return an error if an existing application is found with the same name When `null`, the `prevent_duplicate_names` field will be omitted from the resulting object.\n - `privacy_statement_url` (`string`): URL of the application\u0026#39;s privacy statement When `null`, the `privacy_statement_url` field will be omitted from the resulting object.\n - `sign_in_audience` (`string`): The Microsoft account types that are supported for the current application When `null`, the `sign_in_audience` field will be omitted from the resulting object.\n - `support_url` (`string`): URL of the application\u0026#39;s support page When `null`, the `support_url` field will be omitted from the resulting object.\n - `tags` (`list`): A set of tags to apply to the application When `null`, the `tags` field will be omitted from the resulting object.\n - `template_id` (`string`): Unique ID of the application template from which this application is created When `null`, the `template_id` field will be omitted from the resulting object.\n - `terms_of_service_url` (`string`): URL of the application\u0026#39;s terms of service statement When `null`, the `terms_of_service_url` field will be omitted from the resulting object.\n - `api` (`list[obj]`): When `null`, the `api` 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.api.new](#fn-apinew) constructor.\n - `app_role` (`list[obj]`): When `null`, the `app_role` 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.app_role.new](#fn-app_rolenew) constructor.\n - `feature_tags` (`list[obj]`): Block of features to configure for this application using tags When `null`, the `feature_tags` 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.feature_tags.new](#fn-feature_tagsnew) constructor.\n - `optional_claims` (`list[obj]`): When `null`, the `optional_claims` 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.optional_claims.new](#fn-optional_claimsnew) constructor.\n - `public_client` (`list[obj]`): When `null`, the `public_client` 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.public_client.new](#fn-public_clientnew) constructor.\n - `required_resource_access` (`list[obj]`): When `null`, the `required_resource_access` 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.required_resource_access.new](#fn-required_resource_accessnew) constructor.\n - `single_page_application` (`list[obj]`): When `null`, the `single_page_application` 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.single_page_application.new](#fn-single_page_applicationnew) constructor.\n - `timeouts` (`obj`): 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.timeouts.new](#fn-timeoutsnew) constructor.\n - `web` (`list[obj]`): When `null`, the `web` 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.web.new](#fn-webnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.application.new` injects a new `azuread_application` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.application.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application` using the reference:\n\n $._ref.azuread_application.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `device_only_auth_enabled` (`bool`): Specifies whether this application supports device authentication without a user. When `null`, the `device_only_auth_enabled` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the application\n - `fallback_public_client_enabled` (`bool`): Specifies whether the application is a public client. Appropriate for apps using token grant flows that don\u0026#39;t use a redirect URI When `null`, the `fallback_public_client_enabled` field will be omitted from the resulting object.\n - `group_membership_claims` (`list`): Configures the `groups` claim issued in a user or OAuth 2.0 access token that the app expects When `null`, the `group_membership_claims` field will be omitted from the resulting object.\n - `identifier_uris` (`list`): The user-defined URI(s) that uniquely identify an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant When `null`, the `identifier_uris` field will be omitted from the resulting object.\n - `logo_image` (`string`): Base64 encoded logo image in gif, png or jpeg format When `null`, the `logo_image` field will be omitted from the resulting object.\n - `marketing_url` (`string`): URL of the application\u0026#39;s marketing page When `null`, the `marketing_url` field will be omitted from the resulting object.\n - `oauth2_post_response_required` (`bool`): Specifies whether, as part of OAuth 2.0 token requests, Azure AD allows POST requests, as opposed to GET requests. When `null`, the `oauth2_post_response_required` field will be omitted from the resulting object.\n - `owners` (`list`): A list of object IDs of principals that will be granted ownership of the application When `null`, the `owners` field will be omitted from the resulting object.\n - `prevent_duplicate_names` (`bool`): If `true`, will return an error if an existing application is found with the same name When `null`, the `prevent_duplicate_names` field will be omitted from the resulting object.\n - `privacy_statement_url` (`string`): URL of the application\u0026#39;s privacy statement When `null`, the `privacy_statement_url` field will be omitted from the resulting object.\n - `sign_in_audience` (`string`): The Microsoft account types that are supported for the current application When `null`, the `sign_in_audience` field will be omitted from the resulting object.\n - `support_url` (`string`): URL of the application\u0026#39;s support page When `null`, the `support_url` field will be omitted from the resulting object.\n - `tags` (`list`): A set of tags to apply to the application When `null`, the `tags` field will be omitted from the resulting object.\n - `template_id` (`string`): Unique ID of the application template from which this application is created When `null`, the `template_id` field will be omitted from the resulting object.\n - `terms_of_service_url` (`string`): URL of the application\u0026#39;s terms of service statement When `null`, the `terms_of_service_url` field will be omitted from the resulting object.\n - `api` (`list[obj]`): Set the `api` field on the resulting resource block. When `null`, the `api` 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.api.new](#fn-apinew) constructor.\n - `app_role` (`list[obj]`): Set the `app_role` field on the resulting resource block. When `null`, the `app_role` 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.app_role.new](#fn-app_rolenew) constructor.\n - `feature_tags` (`list[obj]`): Block of features to configure for this application using tags When `null`, the `feature_tags` 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.feature_tags.new](#fn-feature_tagsnew) constructor.\n - `optional_claims` (`list[obj]`): Set the `optional_claims` field on the resulting resource block. When `null`, the `optional_claims` 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.optional_claims.new](#fn-optional_claimsnew) constructor.\n - `public_client` (`list[obj]`): Set the `public_client` field on the resulting resource block. When `null`, the `public_client` 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.public_client.new](#fn-public_clientnew) constructor.\n - `required_resource_access` (`list[obj]`): Set the `required_resource_access` field on the resulting resource block. When `null`, the `required_resource_access` 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.required_resource_access.new](#fn-required_resource_accessnew) constructor.\n - `single_page_application` (`list[obj]`): Set the `single_page_application` field on the resulting resource block. When `null`, the `single_page_application` 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.single_page_application.new](#fn-single_page_applicationnew) constructor.\n - `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.timeouts.new](#fn-timeoutsnew) constructor.\n - `web` (`list[obj]`): Set the `web` field on the resulting resource block. When `null`, the `web` 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.web.new](#fn-webnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, display_name, @@ -127,7 +127,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.application.newAttrs` constructs a new object with attributes and blocks configured for the `application`\nTerraform resource.\n\nUnlike [azuread.application.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `device_only_auth_enabled` (`bool`): Specifies whether this application supports device authentication without a user. When `null`, the `device_only_auth_enabled` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the application\n - `fallback_public_client_enabled` (`bool`): Specifies whether the application is a public client. Appropriate for apps using token grant flows that don't use a redirect URI When `null`, the `fallback_public_client_enabled` field will be omitted from the resulting object.\n - `group_membership_claims` (`list`): Configures the `groups` claim issued in a user or OAuth 2.0 access token that the app expects When `null`, the `group_membership_claims` field will be omitted from the resulting object.\n - `identifier_uris` (`list`): The user-defined URI(s) that uniquely identify an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant When `null`, the `identifier_uris` field will be omitted from the resulting object.\n - `logo_image` (`string`): Base64 encoded logo image in gif, png or jpeg format When `null`, the `logo_image` field will be omitted from the resulting object.\n - `marketing_url` (`string`): URL of the application's marketing page When `null`, the `marketing_url` field will be omitted from the resulting object.\n - `oauth2_post_response_required` (`bool`): Specifies whether, as part of OAuth 2.0 token requests, Azure AD allows POST requests, as opposed to GET requests. When `null`, the `oauth2_post_response_required` field will be omitted from the resulting object.\n - `owners` (`list`): A list of object IDs of principals that will be granted ownership of the application When `null`, the `owners` field will be omitted from the resulting object.\n - `prevent_duplicate_names` (`bool`): If `true`, will return an error if an existing application is found with the same name When `null`, the `prevent_duplicate_names` field will be omitted from the resulting object.\n - `privacy_statement_url` (`string`): URL of the application's privacy statement When `null`, the `privacy_statement_url` field will be omitted from the resulting object.\n - `sign_in_audience` (`string`): The Microsoft account types that are supported for the current application When `null`, the `sign_in_audience` field will be omitted from the resulting object.\n - `support_url` (`string`): URL of the application's support page When `null`, the `support_url` field will be omitted from the resulting object.\n - `tags` (`list`): A set of tags to apply to the application When `null`, the `tags` field will be omitted from the resulting object.\n - `template_id` (`string`): Unique ID of the application template from which this application is created When `null`, the `template_id` field will be omitted from the resulting object.\n - `terms_of_service_url` (`string`): URL of the application's terms of service statement When `null`, the `terms_of_service_url` field will be omitted from the resulting object.\n - `api` (`list[obj]`): When `null`, the `api` 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.api.new](#fn-apinew) constructor.\n - `app_role` (`list[obj]`): When `null`, the `app_role` 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.app_role.new](#fn-app_rolenew) constructor.\n - `feature_tags` (`list[obj]`): Block of features to configure for this application using tags When `null`, the `feature_tags` 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.feature_tags.new](#fn-feature_tagsnew) constructor.\n - `optional_claims` (`list[obj]`): When `null`, the `optional_claims` 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.optional_claims.new](#fn-optional_claimsnew) constructor.\n - `public_client` (`list[obj]`): When `null`, the `public_client` 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.public_client.new](#fn-public_clientnew) constructor.\n - `required_resource_access` (`list[obj]`): When `null`, the `required_resource_access` 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.required_resource_access.new](#fn-required_resource_accessnew) constructor.\n - `single_page_application` (`list[obj]`): When `null`, the `single_page_application` 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.single_page_application.new](#fn-single_page_applicationnew) constructor.\n - `timeouts` (`obj`): 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.timeouts.new](#fn-timeoutsnew) constructor.\n - `web` (`list[obj]`): When `null`, the `web` 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.web.new](#fn-webnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `application` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.application.newAttrs` constructs a new object with attributes and blocks configured for the `application`\nTerraform resource.\n\nUnlike [azuread.application.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `device_only_auth_enabled` (`bool`): Specifies whether this application supports device authentication without a user. When `null`, the `device_only_auth_enabled` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the application\n - `fallback_public_client_enabled` (`bool`): Specifies whether the application is a public client. Appropriate for apps using token grant flows that don't use a redirect URI When `null`, the `fallback_public_client_enabled` field will be omitted from the resulting object.\n - `group_membership_claims` (`list`): Configures the `groups` claim issued in a user or OAuth 2.0 access token that the app expects When `null`, the `group_membership_claims` field will be omitted from the resulting object.\n - `identifier_uris` (`list`): The user-defined URI(s) that uniquely identify an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant When `null`, the `identifier_uris` field will be omitted from the resulting object.\n - `logo_image` (`string`): Base64 encoded logo image in gif, png or jpeg format When `null`, the `logo_image` field will be omitted from the resulting object.\n - `marketing_url` (`string`): URL of the application's marketing page When `null`, the `marketing_url` field will be omitted from the resulting object.\n - `oauth2_post_response_required` (`bool`): Specifies whether, as part of OAuth 2.0 token requests, Azure AD allows POST requests, as opposed to GET requests. When `null`, the `oauth2_post_response_required` field will be omitted from the resulting object.\n - `owners` (`list`): A list of object IDs of principals that will be granted ownership of the application When `null`, the `owners` field will be omitted from the resulting object.\n - `prevent_duplicate_names` (`bool`): If `true`, will return an error if an existing application is found with the same name When `null`, the `prevent_duplicate_names` field will be omitted from the resulting object.\n - `privacy_statement_url` (`string`): URL of the application's privacy statement When `null`, the `privacy_statement_url` field will be omitted from the resulting object.\n - `sign_in_audience` (`string`): The Microsoft account types that are supported for the current application When `null`, the `sign_in_audience` field will be omitted from the resulting object.\n - `support_url` (`string`): URL of the application's support page When `null`, the `support_url` field will be omitted from the resulting object.\n - `tags` (`list`): A set of tags to apply to the application When `null`, the `tags` field will be omitted from the resulting object.\n - `template_id` (`string`): Unique ID of the application template from which this application is created When `null`, the `template_id` field will be omitted from the resulting object.\n - `terms_of_service_url` (`string`): URL of the application's terms of service statement When `null`, the `terms_of_service_url` field will be omitted from the resulting object.\n - `api` (`list[obj]`): Set the `api` field on the resulting object. When `null`, the `api` 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.api.new](#fn-apinew) constructor.\n - `app_role` (`list[obj]`): Set the `app_role` field on the resulting object. When `null`, the `app_role` 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.app_role.new](#fn-app_rolenew) constructor.\n - `feature_tags` (`list[obj]`): Block of features to configure for this application using tags When `null`, the `feature_tags` 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.feature_tags.new](#fn-feature_tagsnew) constructor.\n - `optional_claims` (`list[obj]`): Set the `optional_claims` field on the resulting object. When `null`, the `optional_claims` 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.optional_claims.new](#fn-optional_claimsnew) constructor.\n - `public_client` (`list[obj]`): Set the `public_client` field on the resulting object. When `null`, the `public_client` 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.public_client.new](#fn-public_clientnew) constructor.\n - `required_resource_access` (`list[obj]`): Set the `required_resource_access` field on the resulting object. When `null`, the `required_resource_access` 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.required_resource_access.new](#fn-required_resource_accessnew) constructor.\n - `single_page_application` (`list[obj]`): Set the `single_page_application` field on the resulting object. When `null`, the `single_page_application` 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.single_page_application.new](#fn-single_page_applicationnew) constructor.\n - `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.timeouts.new](#fn-timeoutsnew) constructor.\n - `web` (`list[obj]`): Set the `web` field on the resulting object. When `null`, the `web` 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.web.new](#fn-webnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `application` resource into the root Terraform configuration.\n', args=[]), newAttrs( display_name, api=null, @@ -210,7 +210,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); source: source, }), }, - '#new':: d.fn(help='\n`azuread.application.optional_claims.new` constructs a new object with attributes and blocks configured for the `optional_claims`\nTerraform sub block.\n\n\n\n**Args**:\n - `access_token` (`list[obj]`): When `null`, the `access_token` 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.optional_claims.access_token.new](#fn-optional_claimsaccess_tokennew) constructor.\n - `id_token` (`list[obj]`): When `null`, the `id_token` 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.optional_claims.id_token.new](#fn-optional_claimsid_tokennew) constructor.\n - `saml2_token` (`list[obj]`): When `null`, the `saml2_token` 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.optional_claims.saml2_token.new](#fn-optional_claimssaml2_tokennew) constructor.\n\n**Returns**:\n - An attribute object that represents the `optional_claims` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.application.optional_claims.new` constructs a new object with attributes and blocks configured for the `optional_claims`\nTerraform sub block.\n\n\n\n**Args**:\n - `access_token` (`list[obj]`): Set the `access_token` field on the resulting object. When `null`, the `access_token` 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.optional_claims.access_token.new](#fn-optional_claimsaccess_tokennew) constructor.\n - `id_token` (`list[obj]`): Set the `id_token` field on the resulting object. When `null`, the `id_token` 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.optional_claims.id_token.new](#fn-optional_claimsid_tokennew) constructor.\n - `saml2_token` (`list[obj]`): Set the `saml2_token` field on the resulting object. When `null`, the `saml2_token` 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.optional_claims.saml2_token.new](#fn-optional_claimssaml2_tokennew) constructor.\n\n**Returns**:\n - An attribute object that represents the `optional_claims` sub block.\n', args=[]), new( access_token=null, id_token=null, @@ -244,7 +244,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, required_resource_access:: { - '#new':: d.fn(help='\n`azuread.application.required_resource_access.new` constructs a new object with attributes and blocks configured for the `required_resource_access`\nTerraform sub block.\n\n\n\n**Args**:\n - `resource_app_id` (`string`): \n - `resource_access` (`list[obj]`): When `null`, the `resource_access` 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.required_resource_access.resource_access.new](#fn-required_resource_accessresource_accessnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `required_resource_access` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.application.required_resource_access.new` constructs a new object with attributes and blocks configured for the `required_resource_access`\nTerraform sub block.\n\n\n\n**Args**:\n - `resource_app_id` (`string`): Set the `resource_app_id` field on the resulting object.\n - `resource_access` (`list[obj]`): Set the `resource_access` field on the resulting object. When `null`, the `resource_access` 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.required_resource_access.resource_access.new](#fn-required_resource_accessresource_accessnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `required_resource_access` sub block.\n', args=[]), new( resource_app_id, resource_access=null @@ -253,7 +253,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); resource_app_id: resource_app_id, }), resource_access:: { - '#new':: d.fn(help='\n`azuread.application.required_resource_access.resource_access.new` constructs a new object with attributes and blocks configured for the `resource_access`\nTerraform sub block.\n\n\n\n**Args**:\n - `type` (`string`): \n\n**Returns**:\n - An attribute object that represents the `resource_access` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.application.required_resource_access.resource_access.new` constructs a new object with attributes and blocks configured for the `resource_access`\nTerraform sub block.\n\n\n\n**Args**:\n - `type` (`string`): Set the `type` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `resource_access` sub block.\n', args=[]), new( type ):: std.prune(a={ @@ -270,7 +270,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, timeouts:: { - '#new':: d.fn(help='\n`azuread.application.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.application.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, @@ -294,7 +294,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); id_token_issuance_enabled: id_token_issuance_enabled, }), }, - '#new':: d.fn(help='\n`azuread.application.web.new` constructs a new object with attributes and blocks configured for the `web`\nTerraform sub block.\n\n\n\n**Args**:\n - `homepage_url` (`string`): Home page or landing page of the application When `null`, the `homepage_url` field will be omitted from the resulting object.\n - `logout_url` (`string`): The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols When `null`, the `logout_url` field will be omitted from the resulting object.\n - `redirect_uris` (`list`): The URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent When `null`, the `redirect_uris` field will be omitted from the resulting object.\n - `implicit_grant` (`list[obj]`): When `null`, the `implicit_grant` 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.web.implicit_grant.new](#fn-webimplicit_grantnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `web` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.application.web.new` constructs a new object with attributes and blocks configured for the `web`\nTerraform sub block.\n\n\n\n**Args**:\n - `homepage_url` (`string`): Home page or landing page of the application When `null`, the `homepage_url` field will be omitted from the resulting object.\n - `logout_url` (`string`): The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols When `null`, the `logout_url` field will be omitted from the resulting object.\n - `redirect_uris` (`list`): The URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent When `null`, the `redirect_uris` field will be omitted from the resulting object.\n - `implicit_grant` (`list[obj]`): Set the `implicit_grant` field on the resulting object. When `null`, the `implicit_grant` 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.web.implicit_grant.new](#fn-webimplicit_grantnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `web` sub block.\n', args=[]), new( homepage_url=null, implicit_grant=null, diff --git a/2.x/_gen/resources/application_certificate.libsonnet b/2.x/_gen/resources/application_certificate.libsonnet index 1296d84..bc4bb5a 100644 --- a/2.x/_gen/resources/application_certificate.libsonnet +++ b/2.x/_gen/resources/application_certificate.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='application_certificate', url='', help='`application_certificate` represents the `azuread_application_certificate` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.application_certificate.new` injects a new `azuread_application_certificate` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.application_certificate.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application_certificate` using the reference:\n\n $._ref.azuread_application_certificate.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application_certificate.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `application_object_id` (`string`): The object ID of the application for which this certificate should be created\n - `encoding` (`string`): Specifies the encoding used for the supplied certificate data When `null`, the `encoding` field will be omitted from the resulting object.\n - `end_date` (`string`): The end date until which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If omitted, the API will decide a suitable expiry date, which is typically around 2 years from the start date When `null`, the `end_date` field will be omitted from the resulting object.\n - `end_date_relative` (`string`): A relative duration for which the certificate is valid until, for example `240h` (10 days) or `2400h30m` When `null`, the `end_date_relative` field will be omitted from the resulting object.\n - `key_id` (`string`): A UUID used to uniquely identify this certificate. If omitted, a random UUID will be automatically generated When `null`, the `key_id` field will be omitted from the resulting object.\n - `start_date` (`string`): The start date from which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn\u0026#39;t specified, the current date and time are use When `null`, the `start_date` field will be omitted from the resulting object.\n - `type` (`string`): The type of key/certificate When `null`, the `type` field will be omitted from the resulting object.\n - `value` (`string`): The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the `encoding` argumen\n - `timeouts` (`obj`): 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_certificate.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.application_certificate.new` injects a new `azuread_application_certificate` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.application_certificate.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application_certificate` using the reference:\n\n $._ref.azuread_application_certificate.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application_certificate.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `application_object_id` (`string`): The object ID of the application for which this certificate should be created\n - `encoding` (`string`): Specifies the encoding used for the supplied certificate data When `null`, the `encoding` field will be omitted from the resulting object.\n - `end_date` (`string`): The end date until which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If omitted, the API will decide a suitable expiry date, which is typically around 2 years from the start date When `null`, the `end_date` field will be omitted from the resulting object.\n - `end_date_relative` (`string`): A relative duration for which the certificate is valid until, for example `240h` (10 days) or `2400h30m` When `null`, the `end_date_relative` field will be omitted from the resulting object.\n - `key_id` (`string`): A UUID used to uniquely identify this certificate. If omitted, a random UUID will be automatically generated When `null`, the `key_id` field will be omitted from the resulting object.\n - `start_date` (`string`): The start date from which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn\u0026#39;t specified, the current date and time are use When `null`, the `start_date` field will be omitted from the resulting object.\n - `type` (`string`): The type of key/certificate When `null`, the `type` field will be omitted from the resulting object.\n - `value` (`string`): The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the `encoding` argumen\n - `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_certificate.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, application_object_id, @@ -31,7 +31,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.application_certificate.newAttrs` constructs a new object with attributes and blocks configured for the `application_certificate`\nTerraform resource.\n\nUnlike [azuread.application_certificate.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `application_object_id` (`string`): The object ID of the application for which this certificate should be created\n - `encoding` (`string`): Specifies the encoding used for the supplied certificate data When `null`, the `encoding` field will be omitted from the resulting object.\n - `end_date` (`string`): The end date until which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If omitted, the API will decide a suitable expiry date, which is typically around 2 years from the start date When `null`, the `end_date` field will be omitted from the resulting object.\n - `end_date_relative` (`string`): A relative duration for which the certificate is valid until, for example `240h` (10 days) or `2400h30m` When `null`, the `end_date_relative` field will be omitted from the resulting object.\n - `key_id` (`string`): A UUID used to uniquely identify this certificate. If omitted, a random UUID will be automatically generated When `null`, the `key_id` field will be omitted from the resulting object.\n - `start_date` (`string`): The start date from which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the current date and time are use When `null`, the `start_date` field will be omitted from the resulting object.\n - `type` (`string`): The type of key/certificate When `null`, the `type` field will be omitted from the resulting object.\n - `value` (`string`): The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the `encoding` argumen\n - `timeouts` (`obj`): 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_certificate.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `application_certificate` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.application_certificate.newAttrs` constructs a new object with attributes and blocks configured for the `application_certificate`\nTerraform resource.\n\nUnlike [azuread.application_certificate.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `application_object_id` (`string`): The object ID of the application for which this certificate should be created\n - `encoding` (`string`): Specifies the encoding used for the supplied certificate data When `null`, the `encoding` field will be omitted from the resulting object.\n - `end_date` (`string`): The end date until which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If omitted, the API will decide a suitable expiry date, which is typically around 2 years from the start date When `null`, the `end_date` field will be omitted from the resulting object.\n - `end_date_relative` (`string`): A relative duration for which the certificate is valid until, for example `240h` (10 days) or `2400h30m` When `null`, the `end_date_relative` field will be omitted from the resulting object.\n - `key_id` (`string`): A UUID used to uniquely identify this certificate. If omitted, a random UUID will be automatically generated When `null`, the `key_id` field will be omitted from the resulting object.\n - `start_date` (`string`): The start date from which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the current date and time are use When `null`, the `start_date` field will be omitted from the resulting object.\n - `type` (`string`): The type of key/certificate When `null`, the `type` field will be omitted from the resulting object.\n - `value` (`string`): The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the `encoding` argumen\n - `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_certificate.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `application_certificate` resource into the root Terraform configuration.\n', args=[]), newAttrs( application_object_id, value, @@ -54,7 +54,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); value: value, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.application_certificate.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.application_certificate.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/application_federated_identity_credential.libsonnet b/2.x/_gen/resources/application_federated_identity_credential.libsonnet index 36ba3e5..669dda3 100644 --- a/2.x/_gen/resources/application_federated_identity_credential.libsonnet +++ b/2.x/_gen/resources/application_federated_identity_credential.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='application_federated_identity_credential', url='', help='`application_federated_identity_credential` represents the `azuread_application_federated_identity_credential` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.application_federated_identity_credential.new` injects a new `azuread_application_federated_identity_credential` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.application_federated_identity_credential.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application_federated_identity_credential` using the reference:\n\n $._ref.azuread_application_federated_identity_credential.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application_federated_identity_credential.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `application_object_id` (`string`): The object ID of the application for which this federated identity credential should be created\n - `audiences` (`list`): List of audiences that can appear in the external token. This specifies what should be accepted in the `aud` claim of incoming tokens.\n - `description` (`string`): A description for the federated identity credential When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): A unique display name for the federated identity credential\n - `issuer` (`string`): The URL of the external identity provider, which must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app.\n - `subject` (`string`): The identifier of the external software workload within the external identity provider. The combination of issuer and subject must be unique on the app.\n - `timeouts` (`obj`): 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_federated_identity_credential.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.application_federated_identity_credential.new` injects a new `azuread_application_federated_identity_credential` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.application_federated_identity_credential.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application_federated_identity_credential` using the reference:\n\n $._ref.azuread_application_federated_identity_credential.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application_federated_identity_credential.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `application_object_id` (`string`): The object ID of the application for which this federated identity credential should be created\n - `audiences` (`list`): List of audiences that can appear in the external token. This specifies what should be accepted in the `aud` claim of incoming tokens.\n - `description` (`string`): A description for the federated identity credential When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): A unique display name for the federated identity credential\n - `issuer` (`string`): The URL of the external identity provider, which must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app.\n - `subject` (`string`): The identifier of the external software workload within the external identity provider. The combination of issuer and subject must be unique on the app.\n - `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_federated_identity_credential.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, application_object_id, @@ -27,7 +27,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.application_federated_identity_credential.newAttrs` constructs a new object with attributes and blocks configured for the `application_federated_identity_credential`\nTerraform resource.\n\nUnlike [azuread.application_federated_identity_credential.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `application_object_id` (`string`): The object ID of the application for which this federated identity credential should be created\n - `audiences` (`list`): List of audiences that can appear in the external token. This specifies what should be accepted in the `aud` claim of incoming tokens.\n - `description` (`string`): A description for the federated identity credential When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): A unique display name for the federated identity credential\n - `issuer` (`string`): The URL of the external identity provider, which must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app.\n - `subject` (`string`): The identifier of the external software workload within the external identity provider. The combination of issuer and subject must be unique on the app.\n - `timeouts` (`obj`): 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_federated_identity_credential.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `application_federated_identity_credential` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.application_federated_identity_credential.newAttrs` constructs a new object with attributes and blocks configured for the `application_federated_identity_credential`\nTerraform resource.\n\nUnlike [azuread.application_federated_identity_credential.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `application_object_id` (`string`): The object ID of the application for which this federated identity credential should be created\n - `audiences` (`list`): List of audiences that can appear in the external token. This specifies what should be accepted in the `aud` claim of incoming tokens.\n - `description` (`string`): A description for the federated identity credential When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): A unique display name for the federated identity credential\n - `issuer` (`string`): The URL of the external identity provider, which must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app.\n - `subject` (`string`): The identifier of the external software workload within the external identity provider. The combination of issuer and subject must be unique on the app.\n - `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_federated_identity_credential.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `application_federated_identity_credential` resource into the root Terraform configuration.\n', args=[]), newAttrs( application_object_id, audiences, @@ -46,7 +46,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.application_federated_identity_credential.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.application_federated_identity_credential.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/application_password.libsonnet b/2.x/_gen/resources/application_password.libsonnet index 7f187c9..9d92de6 100644 --- a/2.x/_gen/resources/application_password.libsonnet +++ b/2.x/_gen/resources/application_password.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='application_password', url='', help='`application_password` represents the `azuread_application_password` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.application_password.new` injects a new `azuread_application_password` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.application_password.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application_password` using the reference:\n\n $._ref.azuread_application_password.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application_password.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `application_object_id` (`string`): The object ID of the application for which this password should be created\n - `display_name` (`string`): A display name for the password When `null`, the `display_name` field will be omitted from the resulting object.\n - `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.\n - `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.\n - `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.\n - `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\u0026#39;t specified, the current date is used When `null`, the `start_date` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.application_password.new` injects a new `azuread_application_password` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.application_password.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application_password` using the reference:\n\n $._ref.azuread_application_password.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application_password.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `application_object_id` (`string`): The object ID of the application for which this password should be created\n - `display_name` (`string`): A display name for the password When `null`, the `display_name` field will be omitted from the resulting object.\n - `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.\n - `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.\n - `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.\n - `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\u0026#39;t specified, the current date is used When `null`, the `start_date` field will be omitted from the resulting object.\n - `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](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, application_object_id, @@ -27,7 +27,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.application_password.newAttrs` constructs a new object with attributes and blocks configured for the `application_password`\nTerraform resource.\n\nUnlike [azuread.application_password.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `application_object_id` (`string`): The object ID of the application for which this password should be created\n - `display_name` (`string`): A display name for the password When `null`, the `display_name` field will be omitted from the resulting object.\n - `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.\n - `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.\n - `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.\n - `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.\n - `timeouts` (`obj`): 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](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `application_password` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.application_password.newAttrs` constructs a new object with attributes and blocks configured for the `application_password`\nTerraform resource.\n\nUnlike [azuread.application_password.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `application_object_id` (`string`): The object ID of the application for which this password should be created\n - `display_name` (`string`): A display name for the password When `null`, the `display_name` field will be omitted from the resulting object.\n - `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.\n - `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.\n - `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.\n - `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.\n - `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](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `application_password` resource into the root Terraform configuration.\n', args=[]), newAttrs( application_object_id, display_name=null, @@ -46,7 +46,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.application_password.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.application_password.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/application_pre_authorized.libsonnet b/2.x/_gen/resources/application_pre_authorized.libsonnet index 222fba4..5440edc 100644 --- a/2.x/_gen/resources/application_pre_authorized.libsonnet +++ b/2.x/_gen/resources/application_pre_authorized.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='application_pre_authorized', url='', help='`application_pre_authorized` represents the `azuread_application_pre_authorized` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.application_pre_authorized.new` injects a new `azuread_application_pre_authorized` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.application_pre_authorized.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application_pre_authorized` using the reference:\n\n $._ref.azuread_application_pre_authorized.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application_pre_authorized.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `application_object_id` (`string`): The object ID of the application to which this pre-authorized application should be added\n - `authorized_app_id` (`string`): The application ID of the pre-authorized application\n - `permission_ids` (`list`): The IDs of the permission scopes required by the pre-authorized application\n - `timeouts` (`obj`): 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_pre_authorized.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.application_pre_authorized.new` injects a new `azuread_application_pre_authorized` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.application_pre_authorized.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application_pre_authorized` using the reference:\n\n $._ref.azuread_application_pre_authorized.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application_pre_authorized.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `application_object_id` (`string`): The object ID of the application to which this pre-authorized application should be added\n - `authorized_app_id` (`string`): The application ID of the pre-authorized application\n - `permission_ids` (`list`): The IDs of the permission scopes required by the pre-authorized application\n - `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_pre_authorized.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, application_object_id, @@ -21,7 +21,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.application_pre_authorized.newAttrs` constructs a new object with attributes and blocks configured for the `application_pre_authorized`\nTerraform resource.\n\nUnlike [azuread.application_pre_authorized.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `application_object_id` (`string`): The object ID of the application to which this pre-authorized application should be added\n - `authorized_app_id` (`string`): The application ID of the pre-authorized application\n - `permission_ids` (`list`): The IDs of the permission scopes required by the pre-authorized application\n - `timeouts` (`obj`): 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_pre_authorized.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `application_pre_authorized` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.application_pre_authorized.newAttrs` constructs a new object with attributes and blocks configured for the `application_pre_authorized`\nTerraform resource.\n\nUnlike [azuread.application_pre_authorized.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `application_object_id` (`string`): The object ID of the application to which this pre-authorized application should be added\n - `authorized_app_id` (`string`): The application ID of the pre-authorized application\n - `permission_ids` (`list`): The IDs of the permission scopes required by the pre-authorized application\n - `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_pre_authorized.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `application_pre_authorized` resource into the root Terraform configuration.\n', args=[]), newAttrs( application_object_id, authorized_app_id, @@ -34,7 +34,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.application_pre_authorized.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.application_pre_authorized.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/conditional_access_policy.libsonnet b/2.x/_gen/resources/conditional_access_policy.libsonnet index ec00038..1a9e27f 100644 --- a/2.x/_gen/resources/conditional_access_policy.libsonnet +++ b/2.x/_gen/resources/conditional_access_policy.libsonnet @@ -4,7 +4,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); '#':: d.pkg(name='conditional_access_policy', url='', help='`conditional_access_policy` represents the `azuread_conditional_access_policy` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), conditions:: { applications:: { - '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.applications.new` constructs a new object with attributes and blocks configured for the `applications`\nTerraform sub block.\n\n\n\n**Args**:\n - `excluded_applications` (`list`): When `null`, the `excluded_applications` field will be omitted from the resulting object.\n - `included_applications` (`list`): When `null`, the `included_applications` field will be omitted from the resulting object.\n - `included_user_actions` (`list`): When `null`, the `included_user_actions` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `applications` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.applications.new` constructs a new object with attributes and blocks configured for the `applications`\nTerraform sub block.\n\n\n\n**Args**:\n - `excluded_applications` (`list`): Set the `excluded_applications` field on the resulting object. When `null`, the `excluded_applications` field will be omitted from the resulting object.\n - `included_applications` (`list`): Set the `included_applications` field on the resulting object. When `null`, the `included_applications` field will be omitted from the resulting object.\n - `included_user_actions` (`list`): Set the `included_user_actions` field on the resulting object. When `null`, the `included_user_actions` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `applications` sub block.\n', args=[]), new( excluded_applications=null, included_applications=null, @@ -17,7 +17,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, devices:: { filter:: { - '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.devices.filter.new` constructs a new object with attributes and blocks configured for the `filter`\nTerraform sub block.\n\n\n\n**Args**:\n - `mode` (`string`): \n - `rule` (`string`): \n\n**Returns**:\n - An attribute object that represents the `filter` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.devices.filter.new` constructs a new object with attributes and blocks configured for the `filter`\nTerraform sub block.\n\n\n\n**Args**:\n - `mode` (`string`): Set the `mode` field on the resulting object.\n - `rule` (`string`): Set the `rule` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `filter` sub block.\n', args=[]), new( mode, rule @@ -26,7 +26,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); rule: rule, }), }, - '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.devices.new` constructs a new object with attributes and blocks configured for the `devices`\nTerraform sub block.\n\n\n\n**Args**:\n - `filter` (`list[obj]`): When `null`, the `filter` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.devices.filter.new](#fn-conditionsconditionsfilternew) constructor.\n\n**Returns**:\n - An attribute object that represents the `devices` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.devices.new` constructs a new object with attributes and blocks configured for the `devices`\nTerraform sub block.\n\n\n\n**Args**:\n - `filter` (`list[obj]`): Set the `filter` field on the resulting object. When `null`, the `filter` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.devices.filter.new](#fn-conditionsconditionsfilternew) constructor.\n\n**Returns**:\n - An attribute object that represents the `devices` sub block.\n', args=[]), new( filter=null ):: std.prune(a={ @@ -34,7 +34,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, locations:: { - '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.locations.new` constructs a new object with attributes and blocks configured for the `locations`\nTerraform sub block.\n\n\n\n**Args**:\n - `excluded_locations` (`list`): When `null`, the `excluded_locations` field will be omitted from the resulting object.\n - `included_locations` (`list`): \n\n**Returns**:\n - An attribute object that represents the `locations` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.locations.new` constructs a new object with attributes and blocks configured for the `locations`\nTerraform sub block.\n\n\n\n**Args**:\n - `excluded_locations` (`list`): Set the `excluded_locations` field on the resulting object. When `null`, the `excluded_locations` field will be omitted from the resulting object.\n - `included_locations` (`list`): Set the `included_locations` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `locations` sub block.\n', args=[]), new( included_locations, excluded_locations=null @@ -43,7 +43,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); included_locations: included_locations, }), }, - '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.new` constructs a new object with attributes and blocks configured for the `conditions`\nTerraform sub block.\n\n\n\n**Args**:\n - `client_app_types` (`list`): \n - `sign_in_risk_levels` (`list`): When `null`, the `sign_in_risk_levels` field will be omitted from the resulting object.\n - `user_risk_levels` (`list`): When `null`, the `user_risk_levels` field will be omitted from the resulting object.\n - `applications` (`list[obj]`): When `null`, the `applications` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.applications.new](#fn-conditionsapplicationsnew) constructor.\n - `devices` (`list[obj]`): When `null`, the `devices` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.devices.new](#fn-conditionsdevicesnew) constructor.\n - `locations` (`list[obj]`): When `null`, the `locations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.locations.new](#fn-conditionslocationsnew) constructor.\n - `platforms` (`list[obj]`): When `null`, the `platforms` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.platforms.new](#fn-conditionsplatformsnew) constructor.\n - `users` (`list[obj]`): When `null`, the `users` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.users.new](#fn-conditionsusersnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `conditions` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.new` constructs a new object with attributes and blocks configured for the `conditions`\nTerraform sub block.\n\n\n\n**Args**:\n - `client_app_types` (`list`): Set the `client_app_types` field on the resulting object.\n - `sign_in_risk_levels` (`list`): Set the `sign_in_risk_levels` field on the resulting object. When `null`, the `sign_in_risk_levels` field will be omitted from the resulting object.\n - `user_risk_levels` (`list`): Set the `user_risk_levels` field on the resulting object. When `null`, the `user_risk_levels` field will be omitted from the resulting object.\n - `applications` (`list[obj]`): Set the `applications` field on the resulting object. When `null`, the `applications` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.applications.new](#fn-conditionsapplicationsnew) constructor.\n - `devices` (`list[obj]`): Set the `devices` field on the resulting object. When `null`, the `devices` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.devices.new](#fn-conditionsdevicesnew) constructor.\n - `locations` (`list[obj]`): Set the `locations` field on the resulting object. When `null`, the `locations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.locations.new](#fn-conditionslocationsnew) constructor.\n - `platforms` (`list[obj]`): Set the `platforms` field on the resulting object. When `null`, the `platforms` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.platforms.new](#fn-conditionsplatformsnew) constructor.\n - `users` (`list[obj]`): Set the `users` field on the resulting object. When `null`, the `users` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.users.new](#fn-conditionsusersnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `conditions` sub block.\n', args=[]), new( client_app_types, applications=null, @@ -64,7 +64,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); users: users, }), platforms:: { - '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.platforms.new` constructs a new object with attributes and blocks configured for the `platforms`\nTerraform sub block.\n\n\n\n**Args**:\n - `excluded_platforms` (`list`): When `null`, the `excluded_platforms` field will be omitted from the resulting object.\n - `included_platforms` (`list`): \n\n**Returns**:\n - An attribute object that represents the `platforms` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.platforms.new` constructs a new object with attributes and blocks configured for the `platforms`\nTerraform sub block.\n\n\n\n**Args**:\n - `excluded_platforms` (`list`): Set the `excluded_platforms` field on the resulting object. When `null`, the `excluded_platforms` field will be omitted from the resulting object.\n - `included_platforms` (`list`): Set the `included_platforms` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `platforms` sub block.\n', args=[]), new( included_platforms, excluded_platforms=null @@ -74,7 +74,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, users:: { - '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.users.new` constructs a new object with attributes and blocks configured for the `users`\nTerraform sub block.\n\n\n\n**Args**:\n - `excluded_groups` (`list`): When `null`, the `excluded_groups` field will be omitted from the resulting object.\n - `excluded_roles` (`list`): When `null`, the `excluded_roles` field will be omitted from the resulting object.\n - `excluded_users` (`list`): When `null`, the `excluded_users` field will be omitted from the resulting object.\n - `included_groups` (`list`): When `null`, the `included_groups` field will be omitted from the resulting object.\n - `included_roles` (`list`): When `null`, the `included_roles` field will be omitted from the resulting object.\n - `included_users` (`list`): When `null`, the `included_users` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `users` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.users.new` constructs a new object with attributes and blocks configured for the `users`\nTerraform sub block.\n\n\n\n**Args**:\n - `excluded_groups` (`list`): Set the `excluded_groups` field on the resulting object. When `null`, the `excluded_groups` field will be omitted from the resulting object.\n - `excluded_roles` (`list`): Set the `excluded_roles` field on the resulting object. When `null`, the `excluded_roles` field will be omitted from the resulting object.\n - `excluded_users` (`list`): Set the `excluded_users` field on the resulting object. When `null`, the `excluded_users` field will be omitted from the resulting object.\n - `included_groups` (`list`): Set the `included_groups` field on the resulting object. When `null`, the `included_groups` field will be omitted from the resulting object.\n - `included_roles` (`list`): Set the `included_roles` field on the resulting object. When `null`, the `included_roles` field will be omitted from the resulting object.\n - `included_users` (`list`): Set the `included_users` field on the resulting object. When `null`, the `included_users` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `users` sub block.\n', args=[]), new( excluded_groups=null, excluded_roles=null, @@ -93,7 +93,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, grant_controls:: { - '#new':: d.fn(help='\n`azuread.conditional_access_policy.grant_controls.new` constructs a new object with attributes and blocks configured for the `grant_controls`\nTerraform sub block.\n\n\n\n**Args**:\n - `built_in_controls` (`list`): \n - `custom_authentication_factors` (`list`): When `null`, the `custom_authentication_factors` field will be omitted from the resulting object.\n - `operator` (`string`): \n - `terms_of_use` (`list`): When `null`, the `terms_of_use` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `grant_controls` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.conditional_access_policy.grant_controls.new` constructs a new object with attributes and blocks configured for the `grant_controls`\nTerraform sub block.\n\n\n\n**Args**:\n - `built_in_controls` (`list`): Set the `built_in_controls` field on the resulting object.\n - `custom_authentication_factors` (`list`): Set the `custom_authentication_factors` field on the resulting object. When `null`, the `custom_authentication_factors` field will be omitted from the resulting object.\n - `operator` (`string`): Set the `operator` field on the resulting object.\n - `terms_of_use` (`list`): Set the `terms_of_use` field on the resulting object. When `null`, the `terms_of_use` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `grant_controls` sub block.\n', args=[]), new( built_in_controls, operator, @@ -106,7 +106,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); terms_of_use: terms_of_use, }), }, - '#new':: d.fn(help="\n`azuread.conditional_access_policy.new` injects a new `azuread_conditional_access_policy` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.conditional_access_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.conditional_access_policy` using the reference:\n\n $._ref.azuread_conditional_access_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_conditional_access_policy.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `display_name` (`string`): \n - `state` (`string`): \n - `conditions` (`list[obj]`): When `null`, the `conditions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.new](#fn-conditionsnew) constructor.\n - `grant_controls` (`list[obj]`): When `null`, the `grant_controls` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.grant_controls.new](#fn-grant_controlsnew) constructor.\n - `session_controls` (`list[obj]`): When `null`, the `session_controls` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.session_controls.new](#fn-session_controlsnew) constructor.\n - `timeouts` (`obj`): 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.conditional_access_policy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.conditional_access_policy.new` injects a new `azuread_conditional_access_policy` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.conditional_access_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.conditional_access_policy` using the reference:\n\n $._ref.azuread_conditional_access_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_conditional_access_policy.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `display_name` (`string`): Set the `display_name` field on the resulting resource block.\n - `state` (`string`): Set the `state` field on the resulting resource block.\n - `conditions` (`list[obj]`): Set the `conditions` field on the resulting resource block. When `null`, the `conditions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.new](#fn-conditionsnew) constructor.\n - `grant_controls` (`list[obj]`): Set the `grant_controls` field on the resulting resource block. When `null`, the `grant_controls` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.grant_controls.new](#fn-grant_controlsnew) constructor.\n - `session_controls` (`list[obj]`): Set the `session_controls` field on the resulting resource block. When `null`, the `session_controls` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.session_controls.new](#fn-session_controlsnew) constructor.\n - `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.conditional_access_policy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, display_name, @@ -129,7 +129,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.conditional_access_policy.newAttrs` constructs a new object with attributes and blocks configured for the `conditional_access_policy`\nTerraform resource.\n\nUnlike [azuread.conditional_access_policy.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name` (`string`): \n - `state` (`string`): \n - `conditions` (`list[obj]`): When `null`, the `conditions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.new](#fn-conditionsnew) constructor.\n - `grant_controls` (`list[obj]`): When `null`, the `grant_controls` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.grant_controls.new](#fn-grant_controlsnew) constructor.\n - `session_controls` (`list[obj]`): When `null`, the `session_controls` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.session_controls.new](#fn-session_controlsnew) constructor.\n - `timeouts` (`obj`): 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.conditional_access_policy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `conditional_access_policy` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.conditional_access_policy.newAttrs` constructs a new object with attributes and blocks configured for the `conditional_access_policy`\nTerraform resource.\n\nUnlike [azuread.conditional_access_policy.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name` (`string`): Set the `display_name` field on the resulting object.\n - `state` (`string`): Set the `state` field on the resulting object.\n - `conditions` (`list[obj]`): Set the `conditions` field on the resulting object. When `null`, the `conditions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.new](#fn-conditionsnew) constructor.\n - `grant_controls` (`list[obj]`): Set the `grant_controls` field on the resulting object. When `null`, the `grant_controls` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.grant_controls.new](#fn-grant_controlsnew) constructor.\n - `session_controls` (`list[obj]`): Set the `session_controls` field on the resulting object. When `null`, the `session_controls` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.session_controls.new](#fn-session_controlsnew) constructor.\n - `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.conditional_access_policy.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `conditional_access_policy` resource into the root Terraform configuration.\n', args=[]), newAttrs( display_name, state, @@ -146,7 +146,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), session_controls:: { - '#new':: d.fn(help='\n`azuread.conditional_access_policy.session_controls.new` constructs a new object with attributes and blocks configured for the `session_controls`\nTerraform sub block.\n\n\n\n**Args**:\n - `application_enforced_restrictions_enabled` (`bool`): When `null`, the `application_enforced_restrictions_enabled` field will be omitted from the resulting object.\n - `cloud_app_security_policy` (`string`): When `null`, the `cloud_app_security_policy` field will be omitted from the resulting object.\n - `persistent_browser_mode` (`string`): When `null`, the `persistent_browser_mode` field will be omitted from the resulting object.\n - `sign_in_frequency` (`number`): When `null`, the `sign_in_frequency` field will be omitted from the resulting object.\n - `sign_in_frequency_period` (`string`): When `null`, the `sign_in_frequency_period` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `session_controls` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.conditional_access_policy.session_controls.new` constructs a new object with attributes and blocks configured for the `session_controls`\nTerraform sub block.\n\n\n\n**Args**:\n - `application_enforced_restrictions_enabled` (`bool`): Set the `application_enforced_restrictions_enabled` field on the resulting object. When `null`, the `application_enforced_restrictions_enabled` field will be omitted from the resulting object.\n - `cloud_app_security_policy` (`string`): Set the `cloud_app_security_policy` field on the resulting object. When `null`, the `cloud_app_security_policy` field will be omitted from the resulting object.\n - `persistent_browser_mode` (`string`): Set the `persistent_browser_mode` field on the resulting object. When `null`, the `persistent_browser_mode` field will be omitted from the resulting object.\n - `sign_in_frequency` (`number`): Set the `sign_in_frequency` field on the resulting object. When `null`, the `sign_in_frequency` field will be omitted from the resulting object.\n - `sign_in_frequency_period` (`string`): Set the `sign_in_frequency_period` field on the resulting object. When `null`, the `sign_in_frequency_period` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `session_controls` sub block.\n', args=[]), new( application_enforced_restrictions_enabled=null, cloud_app_security_policy=null, @@ -162,7 +162,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, timeouts:: { - '#new':: d.fn(help='\n`azuread.conditional_access_policy.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.conditional_access_policy.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/custom_directory_role.libsonnet b/2.x/_gen/resources/custom_directory_role.libsonnet index f5245f5..e34b818 100644 --- a/2.x/_gen/resources/custom_directory_role.libsonnet +++ b/2.x/_gen/resources/custom_directory_role.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='custom_directory_role', url='', help='`custom_directory_role` represents the `azuread_custom_directory_role` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.custom_directory_role.new` injects a new `azuread_custom_directory_role` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.custom_directory_role.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.custom_directory_role` using the reference:\n\n $._ref.azuread_custom_directory_role.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_custom_directory_role.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): The description of the custom directory role When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name of the custom directory role\n - `enabled` (`bool`): Indicates whether the role is enabled for assignment\n - `template_id` (`string`): Custom template identifier that is typically used if one needs an identifier to be the same across different directories. When `null`, the `template_id` field will be omitted from the resulting object.\n - `version` (`string`): The version of the role definition.\n - `permissions` (`list[obj]`): List of permissions that are included in the custom directory role When `null`, the `permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.custom_directory_role.permissions.new](#fn-permissionsnew) constructor.\n - `timeouts` (`obj`): 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.custom_directory_role.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.custom_directory_role.new` injects a new `azuread_custom_directory_role` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.custom_directory_role.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.custom_directory_role` using the reference:\n\n $._ref.azuread_custom_directory_role.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_custom_directory_role.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `description` (`string`): The description of the custom directory role When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name of the custom directory role\n - `enabled` (`bool`): Indicates whether the role is enabled for assignment\n - `template_id` (`string`): Custom template identifier that is typically used if one needs an identifier to be the same across different directories. When `null`, the `template_id` field will be omitted from the resulting object.\n - `version` (`string`): The version of the role definition.\n - `permissions` (`list[obj]`): List of permissions that are included in the custom directory role When `null`, the `permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.custom_directory_role.permissions.new](#fn-permissionsnew) constructor.\n - `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.custom_directory_role.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, display_name, @@ -27,7 +27,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.custom_directory_role.newAttrs` constructs a new object with attributes and blocks configured for the `custom_directory_role`\nTerraform resource.\n\nUnlike [azuread.custom_directory_role.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): The description of the custom directory role When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name of the custom directory role\n - `enabled` (`bool`): Indicates whether the role is enabled for assignment\n - `template_id` (`string`): Custom template identifier that is typically used if one needs an identifier to be the same across different directories. When `null`, the `template_id` field will be omitted from the resulting object.\n - `version` (`string`): The version of the role definition.\n - `permissions` (`list[obj]`): List of permissions that are included in the custom directory role When `null`, the `permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.custom_directory_role.permissions.new](#fn-permissionsnew) constructor.\n - `timeouts` (`obj`): 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.custom_directory_role.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `custom_directory_role` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.custom_directory_role.newAttrs` constructs a new object with attributes and blocks configured for the `custom_directory_role`\nTerraform resource.\n\nUnlike [azuread.custom_directory_role.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `description` (`string`): The description of the custom directory role When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name of the custom directory role\n - `enabled` (`bool`): Indicates whether the role is enabled for assignment\n - `template_id` (`string`): Custom template identifier that is typically used if one needs an identifier to be the same across different directories. When `null`, the `template_id` field will be omitted from the resulting object.\n - `version` (`string`): The version of the role definition.\n - `permissions` (`list[obj]`): List of permissions that are included in the custom directory role When `null`, the `permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.custom_directory_role.permissions.new](#fn-permissionsnew) constructor.\n - `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.custom_directory_role.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `custom_directory_role` resource into the root Terraform configuration.\n', args=[]), newAttrs( display_name, enabled, @@ -54,7 +54,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, timeouts:: { - '#new':: d.fn(help='\n`azuread.custom_directory_role.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.custom_directory_role.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/directory_role.libsonnet b/2.x/_gen/resources/directory_role.libsonnet index d9bd024..3d22660 100644 --- a/2.x/_gen/resources/directory_role.libsonnet +++ b/2.x/_gen/resources/directory_role.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='directory_role', url='', help='`directory_role` represents the `azuread_directory_role` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.directory_role.new` injects a new `azuread_directory_role` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.directory_role.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.directory_role` using the reference:\n\n $._ref.azuread_directory_role.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_directory_role.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `display_name` (`string`): The display name of the directory role When `null`, the `display_name` field will be omitted from the resulting object.\n - `template_id` (`string`): The object ID of the template associated with the directory role When `null`, the `template_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.directory_role.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.directory_role.new` injects a new `azuread_directory_role` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.directory_role.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.directory_role` using the reference:\n\n $._ref.azuread_directory_role.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_directory_role.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `display_name` (`string`): The display name of the directory role When `null`, the `display_name` field will be omitted from the resulting object.\n - `template_id` (`string`): The object ID of the template associated with the directory role When `null`, the `template_id` field will be omitted from the resulting object.\n - `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.directory_role.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, display_name=null, @@ -15,7 +15,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs(display_name=display_name, template_id=template_id, timeouts=timeouts), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.directory_role.newAttrs` constructs a new object with attributes and blocks configured for the `directory_role`\nTerraform resource.\n\nUnlike [azuread.directory_role.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name` (`string`): The display name of the directory role When `null`, the `display_name` field will be omitted from the resulting object.\n - `template_id` (`string`): The object ID of the template associated with the directory role When `null`, the `template_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.directory_role.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `directory_role` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.directory_role.newAttrs` constructs a new object with attributes and blocks configured for the `directory_role`\nTerraform resource.\n\nUnlike [azuread.directory_role.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name` (`string`): The display name of the directory role When `null`, the `display_name` field will be omitted from the resulting object.\n - `template_id` (`string`): The object ID of the template associated with the directory role When `null`, the `template_id` field will be omitted from the resulting object.\n - `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.directory_role.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `directory_role` resource into the root Terraform configuration.\n', args=[]), newAttrs( display_name=null, template_id=null, @@ -26,7 +26,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.directory_role.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.directory_role.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/directory_role_assignment.libsonnet b/2.x/_gen/resources/directory_role_assignment.libsonnet index 14e58bc..ccb3629 100644 --- a/2.x/_gen/resources/directory_role_assignment.libsonnet +++ b/2.x/_gen/resources/directory_role_assignment.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='directory_role_assignment', url='', help='`directory_role_assignment` represents the `azuread_directory_role_assignment` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.directory_role_assignment.new` injects a new `azuread_directory_role_assignment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.directory_role_assignment.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.directory_role_assignment` using the reference:\n\n $._ref.azuread_directory_role_assignment.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_directory_role_assignment.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `app_scope_id` (`string`): Identifier of the app-specific scope when the assignment scope is app-specific When `null`, the `app_scope_id` field will be omitted from the resulting object.\n - `app_scope_object_id` (`string`): Identifier of the app-specific scope when the assignment scope is app-specific When `null`, the `app_scope_object_id` field will be omitted from the resulting object.\n - `directory_scope_id` (`string`): Identifier of the directory object representing the scope of the assignment When `null`, the `directory_scope_id` field will be omitted from the resulting object.\n - `directory_scope_object_id` (`string`): Identifier of the directory object representing the scope of the assignment When `null`, the `directory_scope_object_id` field will be omitted from the resulting object.\n - `principal_object_id` (`string`): The object ID of the member principal\n - `role_id` (`string`): The object ID of the directory role for this assignment\n - `timeouts` (`obj`): 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.directory_role_assignment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.directory_role_assignment.new` injects a new `azuread_directory_role_assignment` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.directory_role_assignment.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.directory_role_assignment` using the reference:\n\n $._ref.azuread_directory_role_assignment.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_directory_role_assignment.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `app_scope_id` (`string`): Identifier of the app-specific scope when the assignment scope is app-specific When `null`, the `app_scope_id` field will be omitted from the resulting object.\n - `app_scope_object_id` (`string`): Identifier of the app-specific scope when the assignment scope is app-specific When `null`, the `app_scope_object_id` field will be omitted from the resulting object.\n - `directory_scope_id` (`string`): Identifier of the directory object representing the scope of the assignment When `null`, the `directory_scope_id` field will be omitted from the resulting object.\n - `directory_scope_object_id` (`string`): Identifier of the directory object representing the scope of the assignment When `null`, the `directory_scope_object_id` field will be omitted from the resulting object.\n - `principal_object_id` (`string`): The object ID of the member principal\n - `role_id` (`string`): The object ID of the directory role for this assignment\n - `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.directory_role_assignment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, principal_object_id, @@ -27,7 +27,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.directory_role_assignment.newAttrs` constructs a new object with attributes and blocks configured for the `directory_role_assignment`\nTerraform resource.\n\nUnlike [azuread.directory_role_assignment.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `app_scope_id` (`string`): Identifier of the app-specific scope when the assignment scope is app-specific When `null`, the `app_scope_id` field will be omitted from the resulting object.\n - `app_scope_object_id` (`string`): Identifier of the app-specific scope when the assignment scope is app-specific When `null`, the `app_scope_object_id` field will be omitted from the resulting object.\n - `directory_scope_id` (`string`): Identifier of the directory object representing the scope of the assignment When `null`, the `directory_scope_id` field will be omitted from the resulting object.\n - `directory_scope_object_id` (`string`): Identifier of the directory object representing the scope of the assignment When `null`, the `directory_scope_object_id` field will be omitted from the resulting object.\n - `principal_object_id` (`string`): The object ID of the member principal\n - `role_id` (`string`): The object ID of the directory role for this assignment\n - `timeouts` (`obj`): 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.directory_role_assignment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `directory_role_assignment` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.directory_role_assignment.newAttrs` constructs a new object with attributes and blocks configured for the `directory_role_assignment`\nTerraform resource.\n\nUnlike [azuread.directory_role_assignment.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `app_scope_id` (`string`): Identifier of the app-specific scope when the assignment scope is app-specific When `null`, the `app_scope_id` field will be omitted from the resulting object.\n - `app_scope_object_id` (`string`): Identifier of the app-specific scope when the assignment scope is app-specific When `null`, the `app_scope_object_id` field will be omitted from the resulting object.\n - `directory_scope_id` (`string`): Identifier of the directory object representing the scope of the assignment When `null`, the `directory_scope_id` field will be omitted from the resulting object.\n - `directory_scope_object_id` (`string`): Identifier of the directory object representing the scope of the assignment When `null`, the `directory_scope_object_id` field will be omitted from the resulting object.\n - `principal_object_id` (`string`): The object ID of the member principal\n - `role_id` (`string`): The object ID of the directory role for this assignment\n - `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.directory_role_assignment.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `directory_role_assignment` resource into the root Terraform configuration.\n', args=[]), newAttrs( principal_object_id, role_id, @@ -46,7 +46,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.directory_role_assignment.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.directory_role_assignment.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/directory_role_member.libsonnet b/2.x/_gen/resources/directory_role_member.libsonnet index 23bfe0e..727772e 100644 --- a/2.x/_gen/resources/directory_role_member.libsonnet +++ b/2.x/_gen/resources/directory_role_member.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='directory_role_member', url='', help='`directory_role_member` represents the `azuread_directory_role_member` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.directory_role_member.new` injects a new `azuread_directory_role_member` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.directory_role_member.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.directory_role_member` using the reference:\n\n $._ref.azuread_directory_role_member.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_directory_role_member.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `member_object_id` (`string`): The object ID of the member When `null`, the `member_object_id` field will be omitted from the resulting object.\n - `role_object_id` (`string`): The object ID of the directory role When `null`, the `role_object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.directory_role_member.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.directory_role_member.new` injects a new `azuread_directory_role_member` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.directory_role_member.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.directory_role_member` using the reference:\n\n $._ref.azuread_directory_role_member.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_directory_role_member.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `member_object_id` (`string`): The object ID of the member When `null`, the `member_object_id` field will be omitted from the resulting object.\n - `role_object_id` (`string`): The object ID of the directory role When `null`, the `role_object_id` field will be omitted from the resulting object.\n - `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.directory_role_member.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, member_object_id=null, @@ -15,7 +15,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs(member_object_id=member_object_id, role_object_id=role_object_id, timeouts=timeouts), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.directory_role_member.newAttrs` constructs a new object with attributes and blocks configured for the `directory_role_member`\nTerraform resource.\n\nUnlike [azuread.directory_role_member.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `member_object_id` (`string`): The object ID of the member When `null`, the `member_object_id` field will be omitted from the resulting object.\n - `role_object_id` (`string`): The object ID of the directory role When `null`, the `role_object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.directory_role_member.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `directory_role_member` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.directory_role_member.newAttrs` constructs a new object with attributes and blocks configured for the `directory_role_member`\nTerraform resource.\n\nUnlike [azuread.directory_role_member.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `member_object_id` (`string`): The object ID of the member When `null`, the `member_object_id` field will be omitted from the resulting object.\n - `role_object_id` (`string`): The object ID of the directory role When `null`, the `role_object_id` field will be omitted from the resulting object.\n - `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.directory_role_member.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `directory_role_member` resource into the root Terraform configuration.\n', args=[]), newAttrs( member_object_id=null, role_object_id=null, @@ -26,7 +26,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.directory_role_member.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.directory_role_member.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/group.libsonnet b/2.x/_gen/resources/group.libsonnet index bd1c4b3..01c510a 100644 --- a/2.x/_gen/resources/group.libsonnet +++ b/2.x/_gen/resources/group.libsonnet @@ -3,7 +3,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='group', url='', help='`group` represents the `azuread_group` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), dynamic_membership:: { - '#new':: d.fn(help='\n`azuread.group.dynamic_membership.new` constructs a new object with attributes and blocks configured for the `dynamic_membership`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): \n - `rule` (`string`): Rule to determine members for a dynamic group. Required when `group_types` contains 'DynamicMembership'\n\n**Returns**:\n - An attribute object that represents the `dynamic_membership` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.group.dynamic_membership.new` constructs a new object with attributes and blocks configured for the `dynamic_membership`\nTerraform sub block.\n\n\n\n**Args**:\n - `enabled` (`bool`): Set the `enabled` field on the resulting object.\n - `rule` (`string`): Rule to determine members for a dynamic group. Required when `group_types` contains 'DynamicMembership'\n\n**Returns**:\n - An attribute object that represents the `dynamic_membership` sub block.\n', args=[]), new( enabled, rule @@ -12,7 +12,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); rule: rule, }), }, - '#new':: d.fn(help="\n`azuread.group.new` injects a new `azuread_group` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.group.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.group` using the reference:\n\n $._ref.azuread_group.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_group.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `assignable_to_role` (`bool`): Indicates whether this group can be assigned to an Azure Active Directory role. This property can only be `true` for security-enabled groups. When `null`, the `assignable_to_role` field will be omitted from the resulting object.\n - `auto_subscribe_new_members` (`bool`): Indicates whether new members added to the group will be auto-subscribed to receive email notifications. When `null`, the `auto_subscribe_new_members` field will be omitted from the resulting object.\n - `behaviors` (`list`): The group behaviours for a Microsoft 365 group When `null`, the `behaviors` field will be omitted from the resulting object.\n - `description` (`string`): The description for the group When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the group\n - `external_senders_allowed` (`bool`): Indicates whether people external to the organization can send messages to the group. When `null`, the `external_senders_allowed` field will be omitted from the resulting object.\n - `hide_from_address_lists` (`bool`): Indicates whether the group is displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups. When `null`, the `hide_from_address_lists` field will be omitted from the resulting object.\n - `hide_from_outlook_clients` (`bool`): Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. When `null`, the `hide_from_outlook_clients` field will be omitted from the resulting object.\n - `mail_enabled` (`bool`): Whether the group is a mail enabled, with a shared group mailbox. At least one of `mail_enabled` or `security_enabled` must be specified. A group can be mail enabled _and_ security enabled When `null`, the `mail_enabled` field will be omitted from the resulting object.\n - `mail_nickname` (`string`): The mail alias for the group, unique in the organisation When `null`, the `mail_nickname` field will be omitted from the resulting object.\n - `members` (`list`): A set of members who should be present in this group. Supported object types are Users, Groups or Service Principals When `null`, the `members` field will be omitted from the resulting object.\n - `owners` (`list`): A set of owners who own this group. Supported object types are Users or Service Principals When `null`, the `owners` field will be omitted from the resulting object.\n - `prevent_duplicate_names` (`bool`): If `true`, will return an error if an existing group is found with the same name When `null`, the `prevent_duplicate_names` field will be omitted from the resulting object.\n - `provisioning_options` (`list`): The group provisioning options for a Microsoft 365 group When `null`, the `provisioning_options` field will be omitted from the resulting object.\n - `security_enabled` (`bool`): Whether the group is a security group for controlling access to in-app resources. At least one of `security_enabled` or `mail_enabled` must be specified. A group can be security enabled _and_ mail enabled When `null`, the `security_enabled` field will be omitted from the resulting object.\n - `theme` (`string`): The colour theme for a Microsoft 365 group When `null`, the `theme` field will be omitted from the resulting object.\n - `types` (`list`): A set of group types to configure for the group. `Unified` specifies a Microsoft 365 group. Required when `mail_enabled` is true When `null`, the `types` field will be omitted from the resulting object.\n - `visibility` (`string`): Specifies the group join policy and group content visibility When `null`, the `visibility` field will be omitted from the resulting object.\n - `dynamic_membership` (`list[obj]`): An optional block to configure dynamic membership for the group. Cannot be used with `members` When `null`, the `dynamic_membership` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.group.dynamic_membership.new](#fn-dynamic_membershipnew) constructor.\n - `timeouts` (`obj`): 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.group.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.group.new` injects a new `azuread_group` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.group.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.group` using the reference:\n\n $._ref.azuread_group.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_group.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `assignable_to_role` (`bool`): Indicates whether this group can be assigned to an Azure Active Directory role. This property can only be `true` for security-enabled groups. When `null`, the `assignable_to_role` field will be omitted from the resulting object.\n - `auto_subscribe_new_members` (`bool`): Indicates whether new members added to the group will be auto-subscribed to receive email notifications. When `null`, the `auto_subscribe_new_members` field will be omitted from the resulting object.\n - `behaviors` (`list`): The group behaviours for a Microsoft 365 group When `null`, the `behaviors` field will be omitted from the resulting object.\n - `description` (`string`): The description for the group When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the group\n - `external_senders_allowed` (`bool`): Indicates whether people external to the organization can send messages to the group. When `null`, the `external_senders_allowed` field will be omitted from the resulting object.\n - `hide_from_address_lists` (`bool`): Indicates whether the group is displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups. When `null`, the `hide_from_address_lists` field will be omitted from the resulting object.\n - `hide_from_outlook_clients` (`bool`): Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. When `null`, the `hide_from_outlook_clients` field will be omitted from the resulting object.\n - `mail_enabled` (`bool`): Whether the group is a mail enabled, with a shared group mailbox. At least one of `mail_enabled` or `security_enabled` must be specified. A group can be mail enabled _and_ security enabled When `null`, the `mail_enabled` field will be omitted from the resulting object.\n - `mail_nickname` (`string`): The mail alias for the group, unique in the organisation When `null`, the `mail_nickname` field will be omitted from the resulting object.\n - `members` (`list`): A set of members who should be present in this group. Supported object types are Users, Groups or Service Principals When `null`, the `members` field will be omitted from the resulting object.\n - `owners` (`list`): A set of owners who own this group. Supported object types are Users or Service Principals When `null`, the `owners` field will be omitted from the resulting object.\n - `prevent_duplicate_names` (`bool`): If `true`, will return an error if an existing group is found with the same name When `null`, the `prevent_duplicate_names` field will be omitted from the resulting object.\n - `provisioning_options` (`list`): The group provisioning options for a Microsoft 365 group When `null`, the `provisioning_options` field will be omitted from the resulting object.\n - `security_enabled` (`bool`): Whether the group is a security group for controlling access to in-app resources. At least one of `security_enabled` or `mail_enabled` must be specified. A group can be security enabled _and_ mail enabled When `null`, the `security_enabled` field will be omitted from the resulting object.\n - `theme` (`string`): The colour theme for a Microsoft 365 group When `null`, the `theme` field will be omitted from the resulting object.\n - `types` (`list`): A set of group types to configure for the group. `Unified` specifies a Microsoft 365 group. Required when `mail_enabled` is true When `null`, the `types` field will be omitted from the resulting object.\n - `visibility` (`string`): Specifies the group join policy and group content visibility When `null`, the `visibility` field will be omitted from the resulting object.\n - `dynamic_membership` (`list[obj]`): An optional block to configure dynamic membership for the group. Cannot be used with `members` When `null`, the `dynamic_membership` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.group.dynamic_membership.new](#fn-dynamic_membershipnew) constructor.\n - `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.group.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, display_name, @@ -63,7 +63,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.group.newAttrs` constructs a new object with attributes and blocks configured for the `group`\nTerraform resource.\n\nUnlike [azuread.group.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `assignable_to_role` (`bool`): Indicates whether this group can be assigned to an Azure Active Directory role. This property can only be `true` for security-enabled groups. When `null`, the `assignable_to_role` field will be omitted from the resulting object.\n - `auto_subscribe_new_members` (`bool`): Indicates whether new members added to the group will be auto-subscribed to receive email notifications. When `null`, the `auto_subscribe_new_members` field will be omitted from the resulting object.\n - `behaviors` (`list`): The group behaviours for a Microsoft 365 group When `null`, the `behaviors` field will be omitted from the resulting object.\n - `description` (`string`): The description for the group When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the group\n - `external_senders_allowed` (`bool`): Indicates whether people external to the organization can send messages to the group. When `null`, the `external_senders_allowed` field will be omitted from the resulting object.\n - `hide_from_address_lists` (`bool`): Indicates whether the group is displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups. When `null`, the `hide_from_address_lists` field will be omitted from the resulting object.\n - `hide_from_outlook_clients` (`bool`): Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. When `null`, the `hide_from_outlook_clients` field will be omitted from the resulting object.\n - `mail_enabled` (`bool`): Whether the group is a mail enabled, with a shared group mailbox. At least one of `mail_enabled` or `security_enabled` must be specified. A group can be mail enabled _and_ security enabled When `null`, the `mail_enabled` field will be omitted from the resulting object.\n - `mail_nickname` (`string`): The mail alias for the group, unique in the organisation When `null`, the `mail_nickname` field will be omitted from the resulting object.\n - `members` (`list`): A set of members who should be present in this group. Supported object types are Users, Groups or Service Principals When `null`, the `members` field will be omitted from the resulting object.\n - `owners` (`list`): A set of owners who own this group. Supported object types are Users or Service Principals When `null`, the `owners` field will be omitted from the resulting object.\n - `prevent_duplicate_names` (`bool`): If `true`, will return an error if an existing group is found with the same name When `null`, the `prevent_duplicate_names` field will be omitted from the resulting object.\n - `provisioning_options` (`list`): The group provisioning options for a Microsoft 365 group When `null`, the `provisioning_options` field will be omitted from the resulting object.\n - `security_enabled` (`bool`): Whether the group is a security group for controlling access to in-app resources. At least one of `security_enabled` or `mail_enabled` must be specified. A group can be security enabled _and_ mail enabled When `null`, the `security_enabled` field will be omitted from the resulting object.\n - `theme` (`string`): The colour theme for a Microsoft 365 group When `null`, the `theme` field will be omitted from the resulting object.\n - `types` (`list`): A set of group types to configure for the group. `Unified` specifies a Microsoft 365 group. Required when `mail_enabled` is true When `null`, the `types` field will be omitted from the resulting object.\n - `visibility` (`string`): Specifies the group join policy and group content visibility When `null`, the `visibility` field will be omitted from the resulting object.\n - `dynamic_membership` (`list[obj]`): An optional block to configure dynamic membership for the group. Cannot be used with `members` When `null`, the `dynamic_membership` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.group.dynamic_membership.new](#fn-dynamic_membershipnew) constructor.\n - `timeouts` (`obj`): 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.group.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `group` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.group.newAttrs` constructs a new object with attributes and blocks configured for the `group`\nTerraform resource.\n\nUnlike [azuread.group.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `assignable_to_role` (`bool`): Indicates whether this group can be assigned to an Azure Active Directory role. This property can only be `true` for security-enabled groups. When `null`, the `assignable_to_role` field will be omitted from the resulting object.\n - `auto_subscribe_new_members` (`bool`): Indicates whether new members added to the group will be auto-subscribed to receive email notifications. When `null`, the `auto_subscribe_new_members` field will be omitted from the resulting object.\n - `behaviors` (`list`): The group behaviours for a Microsoft 365 group When `null`, the `behaviors` field will be omitted from the resulting object.\n - `description` (`string`): The description for the group When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the group\n - `external_senders_allowed` (`bool`): Indicates whether people external to the organization can send messages to the group. When `null`, the `external_senders_allowed` field will be omitted from the resulting object.\n - `hide_from_address_lists` (`bool`): Indicates whether the group is displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups. When `null`, the `hide_from_address_lists` field will be omitted from the resulting object.\n - `hide_from_outlook_clients` (`bool`): Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. When `null`, the `hide_from_outlook_clients` field will be omitted from the resulting object.\n - `mail_enabled` (`bool`): Whether the group is a mail enabled, with a shared group mailbox. At least one of `mail_enabled` or `security_enabled` must be specified. A group can be mail enabled _and_ security enabled When `null`, the `mail_enabled` field will be omitted from the resulting object.\n - `mail_nickname` (`string`): The mail alias for the group, unique in the organisation When `null`, the `mail_nickname` field will be omitted from the resulting object.\n - `members` (`list`): A set of members who should be present in this group. Supported object types are Users, Groups or Service Principals When `null`, the `members` field will be omitted from the resulting object.\n - `owners` (`list`): A set of owners who own this group. Supported object types are Users or Service Principals When `null`, the `owners` field will be omitted from the resulting object.\n - `prevent_duplicate_names` (`bool`): If `true`, will return an error if an existing group is found with the same name When `null`, the `prevent_duplicate_names` field will be omitted from the resulting object.\n - `provisioning_options` (`list`): The group provisioning options for a Microsoft 365 group When `null`, the `provisioning_options` field will be omitted from the resulting object.\n - `security_enabled` (`bool`): Whether the group is a security group for controlling access to in-app resources. At least one of `security_enabled` or `mail_enabled` must be specified. A group can be security enabled _and_ mail enabled When `null`, the `security_enabled` field will be omitted from the resulting object.\n - `theme` (`string`): The colour theme for a Microsoft 365 group When `null`, the `theme` field will be omitted from the resulting object.\n - `types` (`list`): A set of group types to configure for the group. `Unified` specifies a Microsoft 365 group. Required when `mail_enabled` is true When `null`, the `types` field will be omitted from the resulting object.\n - `visibility` (`string`): Specifies the group join policy and group content visibility When `null`, the `visibility` field will be omitted from the resulting object.\n - `dynamic_membership` (`list[obj]`): An optional block to configure dynamic membership for the group. Cannot be used with `members` When `null`, the `dynamic_membership` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.group.dynamic_membership.new](#fn-dynamic_membershipnew) constructor.\n - `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.group.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `group` resource into the root Terraform configuration.\n', args=[]), newAttrs( display_name, assignable_to_role=null, @@ -108,7 +108,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); visibility: visibility, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.group.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.group.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/group_member.libsonnet b/2.x/_gen/resources/group_member.libsonnet index a0ff1ea..48f78ea 100644 --- a/2.x/_gen/resources/group_member.libsonnet +++ b/2.x/_gen/resources/group_member.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='group_member', url='', help='`group_member` represents the `azuread_group_member` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.group_member.new` injects a new `azuread_group_member` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.group_member.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.group_member` using the reference:\n\n $._ref.azuread_group_member.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_group_member.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `group_object_id` (`string`): The object ID of the group you want to add the member to\n - `member_object_id` (`string`): The object ID of the principal you want to add as a member to the group. Supported object types are Users, Groups or Service Principals\n - `timeouts` (`obj`): 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.group_member.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.group_member.new` injects a new `azuread_group_member` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.group_member.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.group_member` using the reference:\n\n $._ref.azuread_group_member.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_group_member.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `group_object_id` (`string`): The object ID of the group you want to add the member to\n - `member_object_id` (`string`): The object ID of the principal you want to add as a member to the group. Supported object types are Users, Groups or Service Principals\n - `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.group_member.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, group_object_id, @@ -15,7 +15,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs(group_object_id=group_object_id, member_object_id=member_object_id, timeouts=timeouts), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.group_member.newAttrs` constructs a new object with attributes and blocks configured for the `group_member`\nTerraform resource.\n\nUnlike [azuread.group_member.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `group_object_id` (`string`): The object ID of the group you want to add the member to\n - `member_object_id` (`string`): The object ID of the principal you want to add as a member to the group. Supported object types are Users, Groups or Service Principals\n - `timeouts` (`obj`): 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.group_member.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `group_member` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.group_member.newAttrs` constructs a new object with attributes and blocks configured for the `group_member`\nTerraform resource.\n\nUnlike [azuread.group_member.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `group_object_id` (`string`): The object ID of the group you want to add the member to\n - `member_object_id` (`string`): The object ID of the principal you want to add as a member to the group. Supported object types are Users, Groups or Service Principals\n - `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.group_member.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `group_member` resource into the root Terraform configuration.\n', args=[]), newAttrs( group_object_id, member_object_id, @@ -26,7 +26,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.group_member.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.group_member.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/invitation.libsonnet b/2.x/_gen/resources/invitation.libsonnet index 688e12c..15f1640 100644 --- a/2.x/_gen/resources/invitation.libsonnet +++ b/2.x/_gen/resources/invitation.libsonnet @@ -14,7 +14,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); language: language, }), }, - '#new':: d.fn(help="\n`azuread.invitation.new` injects a new `azuread_invitation` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.invitation.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.invitation` using the reference:\n\n $._ref.azuread_invitation.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_invitation.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `redirect_url` (`string`): The URL that the user should be redirected to once the invitation is redeemed\n - `user_display_name` (`string`): The display name of the user being invited When `null`, the `user_display_name` field will be omitted from the resulting object.\n - `user_email_address` (`string`): The email address of the user being invited\n - `user_type` (`string`): The user type of the user being invited When `null`, the `user_type` field will be omitted from the resulting object.\n - `message` (`list[obj]`): Customize the message sent to the invited user When `null`, the `message` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.invitation.message.new](#fn-messagenew) constructor.\n - `timeouts` (`obj`): 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.invitation.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.invitation.new` injects a new `azuread_invitation` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.invitation.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.invitation` using the reference:\n\n $._ref.azuread_invitation.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_invitation.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `redirect_url` (`string`): The URL that the user should be redirected to once the invitation is redeemed\n - `user_display_name` (`string`): The display name of the user being invited When `null`, the `user_display_name` field will be omitted from the resulting object.\n - `user_email_address` (`string`): The email address of the user being invited\n - `user_type` (`string`): The user type of the user being invited When `null`, the `user_type` field will be omitted from the resulting object.\n - `message` (`list[obj]`): Customize the message sent to the invited user When `null`, the `message` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.invitation.message.new](#fn-messagenew) constructor.\n - `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.invitation.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, redirect_url, @@ -37,7 +37,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.invitation.newAttrs` constructs a new object with attributes and blocks configured for the `invitation`\nTerraform resource.\n\nUnlike [azuread.invitation.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `redirect_url` (`string`): The URL that the user should be redirected to once the invitation is redeemed\n - `user_display_name` (`string`): The display name of the user being invited When `null`, the `user_display_name` field will be omitted from the resulting object.\n - `user_email_address` (`string`): The email address of the user being invited\n - `user_type` (`string`): The user type of the user being invited When `null`, the `user_type` field will be omitted from the resulting object.\n - `message` (`list[obj]`): Customize the message sent to the invited user When `null`, the `message` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.invitation.message.new](#fn-messagenew) constructor.\n - `timeouts` (`obj`): 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.invitation.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `invitation` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.invitation.newAttrs` constructs a new object with attributes and blocks configured for the `invitation`\nTerraform resource.\n\nUnlike [azuread.invitation.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `redirect_url` (`string`): The URL that the user should be redirected to once the invitation is redeemed\n - `user_display_name` (`string`): The display name of the user being invited When `null`, the `user_display_name` field will be omitted from the resulting object.\n - `user_email_address` (`string`): The email address of the user being invited\n - `user_type` (`string`): The user type of the user being invited When `null`, the `user_type` field will be omitted from the resulting object.\n - `message` (`list[obj]`): Customize the message sent to the invited user When `null`, the `message` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.invitation.message.new](#fn-messagenew) constructor.\n - `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.invitation.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `invitation` resource into the root Terraform configuration.\n', args=[]), newAttrs( redirect_url, user_email_address, @@ -54,7 +54,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); user_type: user_type, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.invitation.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.invitation.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/named_location.libsonnet b/2.x/_gen/resources/named_location.libsonnet index 4904a0d..b7975a7 100644 --- a/2.x/_gen/resources/named_location.libsonnet +++ b/2.x/_gen/resources/named_location.libsonnet @@ -3,7 +3,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='named_location', url='', help='`named_location` represents the `azuread_named_location` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), country:: { - '#new':: d.fn(help='\n`azuread.named_location.country.new` constructs a new object with attributes and blocks configured for the `country`\nTerraform sub block.\n\n\n\n**Args**:\n - `countries_and_regions` (`list`): \n - `include_unknown_countries_and_regions` (`bool`): When `null`, the `include_unknown_countries_and_regions` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `country` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.named_location.country.new` constructs a new object with attributes and blocks configured for the `country`\nTerraform sub block.\n\n\n\n**Args**:\n - `countries_and_regions` (`list`): Set the `countries_and_regions` field on the resulting object.\n - `include_unknown_countries_and_regions` (`bool`): Set the `include_unknown_countries_and_regions` field on the resulting object. When `null`, the `include_unknown_countries_and_regions` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `country` sub block.\n', args=[]), new( countries_and_regions, include_unknown_countries_and_regions=null @@ -13,7 +13,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, ip:: { - '#new':: d.fn(help='\n`azuread.named_location.ip.new` constructs a new object with attributes and blocks configured for the `ip`\nTerraform sub block.\n\n\n\n**Args**:\n - `ip_ranges` (`list`): \n - `trusted` (`bool`): When `null`, the `trusted` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `ip` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.named_location.ip.new` constructs a new object with attributes and blocks configured for the `ip`\nTerraform sub block.\n\n\n\n**Args**:\n - `ip_ranges` (`list`): Set the `ip_ranges` field on the resulting object.\n - `trusted` (`bool`): Set the `trusted` field on the resulting object. When `null`, the `trusted` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `ip` sub block.\n', args=[]), new( ip_ranges, trusted=null @@ -22,7 +22,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); trusted: trusted, }), }, - '#new':: d.fn(help="\n`azuread.named_location.new` injects a new `azuread_named_location` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.named_location.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.named_location` using the reference:\n\n $._ref.azuread_named_location.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_named_location.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `display_name` (`string`): \n - `country` (`list[obj]`): When `null`, the `country` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.named_location.country.new](#fn-countrynew) constructor.\n - `ip` (`list[obj]`): When `null`, the `ip` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.named_location.ip.new](#fn-ipnew) constructor.\n - `timeouts` (`obj`): 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.named_location.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.named_location.new` injects a new `azuread_named_location` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.named_location.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.named_location` using the reference:\n\n $._ref.azuread_named_location.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_named_location.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `display_name` (`string`): Set the `display_name` field on the resulting resource block.\n - `country` (`list[obj]`): Set the `country` field on the resulting resource block. When `null`, the `country` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.named_location.country.new](#fn-countrynew) constructor.\n - `ip` (`list[obj]`): Set the `ip` field on the resulting resource block. When `null`, the `ip` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.named_location.ip.new](#fn-ipnew) constructor.\n - `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.named_location.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, display_name, @@ -41,7 +41,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.named_location.newAttrs` constructs a new object with attributes and blocks configured for the `named_location`\nTerraform resource.\n\nUnlike [azuread.named_location.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name` (`string`): \n - `country` (`list[obj]`): When `null`, the `country` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.named_location.country.new](#fn-countrynew) constructor.\n - `ip` (`list[obj]`): When `null`, the `ip` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.named_location.ip.new](#fn-ipnew) constructor.\n - `timeouts` (`obj`): 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.named_location.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `named_location` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.named_location.newAttrs` constructs a new object with attributes and blocks configured for the `named_location`\nTerraform resource.\n\nUnlike [azuread.named_location.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name` (`string`): Set the `display_name` field on the resulting object.\n - `country` (`list[obj]`): Set the `country` field on the resulting object. When `null`, the `country` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.named_location.country.new](#fn-countrynew) constructor.\n - `ip` (`list[obj]`): Set the `ip` field on the resulting object. When `null`, the `ip` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.named_location.ip.new](#fn-ipnew) constructor.\n - `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.named_location.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `named_location` resource into the root Terraform configuration.\n', args=[]), newAttrs( display_name, country=null, @@ -54,7 +54,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.named_location.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.named_location.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/service_principal.libsonnet b/2.x/_gen/resources/service_principal.libsonnet index 08e80a3..2bb521e 100644 --- a/2.x/_gen/resources/service_principal.libsonnet +++ b/2.x/_gen/resources/service_principal.libsonnet @@ -30,7 +30,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); visible_to_users: visible_to_users, }), }, - '#new':: d.fn(help="\n`azuread.service_principal.new` injects a new `azuread_service_principal` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.service_principal.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.service_principal` using the reference:\n\n $._ref.azuread_service_principal.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_service_principal.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `account_enabled` (`bool`): Whether or not the service principal account is enabled When `null`, the `account_enabled` field will be omitted from the resulting object.\n - `alternative_names` (`list`): A list of alternative names, used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities When `null`, the `alternative_names` field will be omitted from the resulting object.\n - `app_role_assignment_required` (`bool`): Whether this service principal requires an app role assignment to a user or group before Azure AD will issue a user or access token to the application When `null`, the `app_role_assignment_required` field will be omitted from the resulting object.\n - `application_id` (`string`): The application ID (client ID) of the application for which to create a service principal\n - `description` (`string`): Description of the service principal provided for internal end-users When `null`, the `description` field will be omitted from the resulting object.\n - `login_url` (`string`): The URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on When `null`, the `login_url` field will be omitted from the resulting object.\n - `notes` (`string`): Free text field to capture information about the service principal, typically used for operational purposes When `null`, the `notes` field will be omitted from the resulting object.\n - `notification_email_addresses` (`list`): List of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications When `null`, the `notification_email_addresses` field will be omitted from the resulting object.\n - `owners` (`list`): A list of object IDs of principals that will be granted ownership of the service principal When `null`, the `owners` field will be omitted from the resulting object.\n - `preferred_single_sign_on_mode` (`string`): The single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps When `null`, the `preferred_single_sign_on_mode` field will be omitted from the resulting object.\n - `tags` (`list`): A set of tags to apply to the service principal When `null`, the `tags` field will be omitted from the resulting object.\n - `use_existing` (`bool`): When true, the resource will return an existing service principal instead of failing with an error When `null`, the `use_existing` field will be omitted from the resulting object.\n - `feature_tags` (`list[obj]`): Block of features to configure for this service principal using tags When `null`, the `feature_tags` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.service_principal.feature_tags.new](#fn-feature_tagsnew) constructor.\n - `features` (`list[obj]`): Block of features to configure for this service principal using tags When `null`, the `features` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.service_principal.features.new](#fn-featuresnew) constructor.\n - `saml_single_sign_on` (`list[obj]`): Settings related to SAML single sign-on When `null`, the `saml_single_sign_on` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.service_principal.saml_single_sign_on.new](#fn-saml_single_sign_onnew) constructor.\n - `timeouts` (`obj`): 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.service_principal.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.service_principal.new` injects a new `azuread_service_principal` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.service_principal.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.service_principal` using the reference:\n\n $._ref.azuread_service_principal.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_service_principal.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `account_enabled` (`bool`): Whether or not the service principal account is enabled When `null`, the `account_enabled` field will be omitted from the resulting object.\n - `alternative_names` (`list`): A list of alternative names, used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities When `null`, the `alternative_names` field will be omitted from the resulting object.\n - `app_role_assignment_required` (`bool`): Whether this service principal requires an app role assignment to a user or group before Azure AD will issue a user or access token to the application When `null`, the `app_role_assignment_required` field will be omitted from the resulting object.\n - `application_id` (`string`): The application ID (client ID) of the application for which to create a service principal\n - `description` (`string`): Description of the service principal provided for internal end-users When `null`, the `description` field will be omitted from the resulting object.\n - `login_url` (`string`): The URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on When `null`, the `login_url` field will be omitted from the resulting object.\n - `notes` (`string`): Free text field to capture information about the service principal, typically used for operational purposes When `null`, the `notes` field will be omitted from the resulting object.\n - `notification_email_addresses` (`list`): List of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications When `null`, the `notification_email_addresses` field will be omitted from the resulting object.\n - `owners` (`list`): A list of object IDs of principals that will be granted ownership of the service principal When `null`, the `owners` field will be omitted from the resulting object.\n - `preferred_single_sign_on_mode` (`string`): The single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps When `null`, the `preferred_single_sign_on_mode` field will be omitted from the resulting object.\n - `tags` (`list`): A set of tags to apply to the service principal When `null`, the `tags` field will be omitted from the resulting object.\n - `use_existing` (`bool`): When true, the resource will return an existing service principal instead of failing with an error When `null`, the `use_existing` field will be omitted from the resulting object.\n - `feature_tags` (`list[obj]`): Block of features to configure for this service principal using tags When `null`, the `feature_tags` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.service_principal.feature_tags.new](#fn-feature_tagsnew) constructor.\n - `features` (`list[obj]`): Block of features to configure for this service principal using tags When `null`, the `features` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.service_principal.features.new](#fn-featuresnew) constructor.\n - `saml_single_sign_on` (`list[obj]`): Settings related to SAML single sign-on When `null`, the `saml_single_sign_on` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.service_principal.saml_single_sign_on.new](#fn-saml_single_sign_onnew) constructor.\n - `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.service_principal.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, application_id, @@ -73,7 +73,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.service_principal.newAttrs` constructs a new object with attributes and blocks configured for the `service_principal`\nTerraform resource.\n\nUnlike [azuread.service_principal.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `account_enabled` (`bool`): Whether or not the service principal account is enabled When `null`, the `account_enabled` field will be omitted from the resulting object.\n - `alternative_names` (`list`): A list of alternative names, used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities When `null`, the `alternative_names` field will be omitted from the resulting object.\n - `app_role_assignment_required` (`bool`): Whether this service principal requires an app role assignment to a user or group before Azure AD will issue a user or access token to the application When `null`, the `app_role_assignment_required` field will be omitted from the resulting object.\n - `application_id` (`string`): The application ID (client ID) of the application for which to create a service principal\n - `description` (`string`): Description of the service principal provided for internal end-users When `null`, the `description` field will be omitted from the resulting object.\n - `login_url` (`string`): The URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on When `null`, the `login_url` field will be omitted from the resulting object.\n - `notes` (`string`): Free text field to capture information about the service principal, typically used for operational purposes When `null`, the `notes` field will be omitted from the resulting object.\n - `notification_email_addresses` (`list`): List of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications When `null`, the `notification_email_addresses` field will be omitted from the resulting object.\n - `owners` (`list`): A list of object IDs of principals that will be granted ownership of the service principal When `null`, the `owners` field will be omitted from the resulting object.\n - `preferred_single_sign_on_mode` (`string`): The single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps When `null`, the `preferred_single_sign_on_mode` field will be omitted from the resulting object.\n - `tags` (`list`): A set of tags to apply to the service principal When `null`, the `tags` field will be omitted from the resulting object.\n - `use_existing` (`bool`): When true, the resource will return an existing service principal instead of failing with an error When `null`, the `use_existing` field will be omitted from the resulting object.\n - `feature_tags` (`list[obj]`): Block of features to configure for this service principal using tags When `null`, the `feature_tags` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.service_principal.feature_tags.new](#fn-feature_tagsnew) constructor.\n - `features` (`list[obj]`): Block of features to configure for this service principal using tags When `null`, the `features` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.service_principal.features.new](#fn-featuresnew) constructor.\n - `saml_single_sign_on` (`list[obj]`): Settings related to SAML single sign-on When `null`, the `saml_single_sign_on` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.service_principal.saml_single_sign_on.new](#fn-saml_single_sign_onnew) constructor.\n - `timeouts` (`obj`): 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.service_principal.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `service_principal` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.service_principal.newAttrs` constructs a new object with attributes and blocks configured for the `service_principal`\nTerraform resource.\n\nUnlike [azuread.service_principal.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `account_enabled` (`bool`): Whether or not the service principal account is enabled When `null`, the `account_enabled` field will be omitted from the resulting object.\n - `alternative_names` (`list`): A list of alternative names, used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities When `null`, the `alternative_names` field will be omitted from the resulting object.\n - `app_role_assignment_required` (`bool`): Whether this service principal requires an app role assignment to a user or group before Azure AD will issue a user or access token to the application When `null`, the `app_role_assignment_required` field will be omitted from the resulting object.\n - `application_id` (`string`): The application ID (client ID) of the application for which to create a service principal\n - `description` (`string`): Description of the service principal provided for internal end-users When `null`, the `description` field will be omitted from the resulting object.\n - `login_url` (`string`): The URL where the service provider redirects the user to Azure AD to authenticate. Azure AD uses the URL to launch the application from Microsoft 365 or the Azure AD My Apps. When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on When `null`, the `login_url` field will be omitted from the resulting object.\n - `notes` (`string`): Free text field to capture information about the service principal, typically used for operational purposes When `null`, the `notes` field will be omitted from the resulting object.\n - `notification_email_addresses` (`list`): List of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications When `null`, the `notification_email_addresses` field will be omitted from the resulting object.\n - `owners` (`list`): A list of object IDs of principals that will be granted ownership of the service principal When `null`, the `owners` field will be omitted from the resulting object.\n - `preferred_single_sign_on_mode` (`string`): The single sign-on mode configured for this application. Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps When `null`, the `preferred_single_sign_on_mode` field will be omitted from the resulting object.\n - `tags` (`list`): A set of tags to apply to the service principal When `null`, the `tags` field will be omitted from the resulting object.\n - `use_existing` (`bool`): When true, the resource will return an existing service principal instead of failing with an error When `null`, the `use_existing` field will be omitted from the resulting object.\n - `feature_tags` (`list[obj]`): Block of features to configure for this service principal using tags When `null`, the `feature_tags` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.service_principal.feature_tags.new](#fn-feature_tagsnew) constructor.\n - `features` (`list[obj]`): Block of features to configure for this service principal using tags When `null`, the `features` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.service_principal.features.new](#fn-featuresnew) constructor.\n - `saml_single_sign_on` (`list[obj]`): Settings related to SAML single sign-on When `null`, the `saml_single_sign_on` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.service_principal.saml_single_sign_on.new](#fn-saml_single_sign_onnew) constructor.\n - `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.service_principal.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `service_principal` resource into the root Terraform configuration.\n', args=[]), newAttrs( application_id, account_enabled=null, @@ -118,7 +118,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }), }, timeouts:: { - '#new':: d.fn(help='\n`azuread.service_principal.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.service_principal.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/service_principal_certificate.libsonnet b/2.x/_gen/resources/service_principal_certificate.libsonnet index afb519b..126d927 100644 --- a/2.x/_gen/resources/service_principal_certificate.libsonnet +++ b/2.x/_gen/resources/service_principal_certificate.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='service_principal_certificate', url='', help='`service_principal_certificate` represents the `azuread_service_principal_certificate` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.service_principal_certificate.new` injects a new `azuread_service_principal_certificate` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.service_principal_certificate.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.service_principal_certificate` using the reference:\n\n $._ref.azuread_service_principal_certificate.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_service_principal_certificate.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `encoding` (`string`): Specifies the encoding used for the supplied certificate data When `null`, the `encoding` field will be omitted from the resulting object.\n - `end_date` (`string`): The end date until which the certificate 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.\n - `end_date_relative` (`string`): A relative duration for which the certificate is valid until, for example `240h` (10 days) or `2400h30m`. Valid time units are \u0026#34;ns\u0026#34;, \u0026#34;us\u0026#34; (or \u0026#34;µs\u0026#34;), \u0026#34;ms\u0026#34;, \u0026#34;s\u0026#34;, \u0026#34;m\u0026#34;, \u0026#34;h\u0026#34; When `null`, the `end_date_relative` field will be omitted from the resulting object.\n - `key_id` (`string`): A UUID used to uniquely identify this certificate. If not specified a UUID will be automatically generated When `null`, the `key_id` field will be omitted from the resulting object.\n - `service_principal_id` (`string`): The object ID of the service principal for which this certificate should be created\n - `start_date` (`string`): The start date from which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn\u0026#39;t specified, the current date is used When `null`, the `start_date` field will be omitted from the resulting object.\n - `type` (`string`): The type of key/certificate When `null`, the `type` field will be omitted from the resulting object.\n - `value` (`string`): The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER\n - `timeouts` (`obj`): 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.service_principal_certificate.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.service_principal_certificate.new` injects a new `azuread_service_principal_certificate` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.service_principal_certificate.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.service_principal_certificate` using the reference:\n\n $._ref.azuread_service_principal_certificate.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_service_principal_certificate.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `encoding` (`string`): Specifies the encoding used for the supplied certificate data When `null`, the `encoding` field will be omitted from the resulting object.\n - `end_date` (`string`): The end date until which the certificate 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.\n - `end_date_relative` (`string`): A relative duration for which the certificate is valid until, for example `240h` (10 days) or `2400h30m`. Valid time units are \u0026#34;ns\u0026#34;, \u0026#34;us\u0026#34; (or \u0026#34;µs\u0026#34;), \u0026#34;ms\u0026#34;, \u0026#34;s\u0026#34;, \u0026#34;m\u0026#34;, \u0026#34;h\u0026#34; When `null`, the `end_date_relative` field will be omitted from the resulting object.\n - `key_id` (`string`): A UUID used to uniquely identify this certificate. If not specified a UUID will be automatically generated When `null`, the `key_id` field will be omitted from the resulting object.\n - `service_principal_id` (`string`): The object ID of the service principal for which this certificate should be created\n - `start_date` (`string`): The start date from which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn\u0026#39;t specified, the current date is used When `null`, the `start_date` field will be omitted from the resulting object.\n - `type` (`string`): The type of key/certificate When `null`, the `type` field will be omitted from the resulting object.\n - `value` (`string`): The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER\n - `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.service_principal_certificate.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, service_principal_id, @@ -31,7 +31,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.service_principal_certificate.newAttrs` constructs a new object with attributes and blocks configured for the `service_principal_certificate`\nTerraform resource.\n\nUnlike [azuread.service_principal_certificate.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `encoding` (`string`): Specifies the encoding used for the supplied certificate data When `null`, the `encoding` field will be omitted from the resulting object.\n - `end_date` (`string`): The end date until which the certificate 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.\n - `end_date_relative` (`string`): A relative duration for which the certificate is valid until, for example `240h` (10 days) or `2400h30m`. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h" When `null`, the `end_date_relative` field will be omitted from the resulting object.\n - `key_id` (`string`): A UUID used to uniquely identify this certificate. If not specified a UUID will be automatically generated When `null`, the `key_id` field will be omitted from the resulting object.\n - `service_principal_id` (`string`): The object ID of the service principal for which this certificate should be created\n - `start_date` (`string`): The start date from which the certificate 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.\n - `type` (`string`): The type of key/certificate When `null`, the `type` field will be omitted from the resulting object.\n - `value` (`string`): The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER\n - `timeouts` (`obj`): 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.service_principal_certificate.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `service_principal_certificate` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.service_principal_certificate.newAttrs` constructs a new object with attributes and blocks configured for the `service_principal_certificate`\nTerraform resource.\n\nUnlike [azuread.service_principal_certificate.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `encoding` (`string`): Specifies the encoding used for the supplied certificate data When `null`, the `encoding` field will be omitted from the resulting object.\n - `end_date` (`string`): The end date until which the certificate 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.\n - `end_date_relative` (`string`): A relative duration for which the certificate is valid until, for example `240h` (10 days) or `2400h30m`. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h" When `null`, the `end_date_relative` field will be omitted from the resulting object.\n - `key_id` (`string`): A UUID used to uniquely identify this certificate. If not specified a UUID will be automatically generated When `null`, the `key_id` field will be omitted from the resulting object.\n - `service_principal_id` (`string`): The object ID of the service principal for which this certificate should be created\n - `start_date` (`string`): The start date from which the certificate 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.\n - `type` (`string`): The type of key/certificate When `null`, the `type` field will be omitted from the resulting object.\n - `value` (`string`): The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER\n - `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.service_principal_certificate.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `service_principal_certificate` resource into the root Terraform configuration.\n', args=[]), newAttrs( service_principal_id, value, @@ -54,7 +54,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); value: value, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.service_principal_certificate.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.service_principal_certificate.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/service_principal_delegated_permission_grant.libsonnet b/2.x/_gen/resources/service_principal_delegated_permission_grant.libsonnet index 3a3b562..7a084cf 100644 --- a/2.x/_gen/resources/service_principal_delegated_permission_grant.libsonnet +++ b/2.x/_gen/resources/service_principal_delegated_permission_grant.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='service_principal_delegated_permission_grant', url='', help='`service_principal_delegated_permission_grant` represents the `azuread_service_principal_delegated_permission_grant` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.service_principal_delegated_permission_grant.new` injects a new `azuread_service_principal_delegated_permission_grant` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.service_principal_delegated_permission_grant.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.service_principal_delegated_permission_grant` using the reference:\n\n $._ref.azuread_service_principal_delegated_permission_grant.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_service_principal_delegated_permission_grant.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `claim_values` (`list`): A set of claim values for delegated permission scopes which should be included in access tokens for the resource\n - `resource_service_principal_object_id` (`string`): The object ID of the service principal representing the resource to be accessed\n - `service_principal_object_id` (`string`): The object ID of the service principal for which this delegated permission grant should be created\n - `user_object_id` (`string`): The object ID of the user on behalf of whom the service principal is authorized to access the resource When `null`, the `user_object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.service_principal_delegated_permission_grant.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.service_principal_delegated_permission_grant.new` injects a new `azuread_service_principal_delegated_permission_grant` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.service_principal_delegated_permission_grant.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.service_principal_delegated_permission_grant` using the reference:\n\n $._ref.azuread_service_principal_delegated_permission_grant.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_service_principal_delegated_permission_grant.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `claim_values` (`list`): A set of claim values for delegated permission scopes which should be included in access tokens for the resource\n - `resource_service_principal_object_id` (`string`): The object ID of the service principal representing the resource to be accessed\n - `service_principal_object_id` (`string`): The object ID of the service principal for which this delegated permission grant should be created\n - `user_object_id` (`string`): The object ID of the user on behalf of whom the service principal is authorized to access the resource When `null`, the `user_object_id` field will be omitted from the resulting object.\n - `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.service_principal_delegated_permission_grant.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, claim_values, @@ -23,7 +23,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.service_principal_delegated_permission_grant.newAttrs` constructs a new object with attributes and blocks configured for the `service_principal_delegated_permission_grant`\nTerraform resource.\n\nUnlike [azuread.service_principal_delegated_permission_grant.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `claim_values` (`list`): A set of claim values for delegated permission scopes which should be included in access tokens for the resource\n - `resource_service_principal_object_id` (`string`): The object ID of the service principal representing the resource to be accessed\n - `service_principal_object_id` (`string`): The object ID of the service principal for which this delegated permission grant should be created\n - `user_object_id` (`string`): The object ID of the user on behalf of whom the service principal is authorized to access the resource When `null`, the `user_object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.service_principal_delegated_permission_grant.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `service_principal_delegated_permission_grant` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.service_principal_delegated_permission_grant.newAttrs` constructs a new object with attributes and blocks configured for the `service_principal_delegated_permission_grant`\nTerraform resource.\n\nUnlike [azuread.service_principal_delegated_permission_grant.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `claim_values` (`list`): A set of claim values for delegated permission scopes which should be included in access tokens for the resource\n - `resource_service_principal_object_id` (`string`): The object ID of the service principal representing the resource to be accessed\n - `service_principal_object_id` (`string`): The object ID of the service principal for which this delegated permission grant should be created\n - `user_object_id` (`string`): The object ID of the user on behalf of whom the service principal is authorized to access the resource When `null`, the `user_object_id` field will be omitted from the resulting object.\n - `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.service_principal_delegated_permission_grant.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `service_principal_delegated_permission_grant` resource into the root Terraform configuration.\n', args=[]), newAttrs( claim_values, resource_service_principal_object_id, @@ -38,7 +38,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); user_object_id: user_object_id, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.service_principal_delegated_permission_grant.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.service_principal_delegated_permission_grant.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/service_principal_password.libsonnet b/2.x/_gen/resources/service_principal_password.libsonnet index 0ed58cc..6f78fc0 100644 --- a/2.x/_gen/resources/service_principal_password.libsonnet +++ b/2.x/_gen/resources/service_principal_password.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='service_principal_password', url='', help='`service_principal_password` represents the `azuread_service_principal_password` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.service_principal_password.new` injects a new `azuread_service_principal_password` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.service_principal_password.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.service_principal_password` using the reference:\n\n $._ref.azuread_service_principal_password.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_service_principal_password.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `display_name` (`string`): A display name for the password When `null`, the `display_name` field will be omitted from the resulting object.\n - `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.\n - `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.\n - `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.\n - `service_principal_id` (`string`): The object ID of the service principal for which this password should be created\n - `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\u0026#39;t specified, the current date is used When `null`, the `start_date` field will be omitted from the resulting object.\n - `timeouts` (`obj`): 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.service_principal_password.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.service_principal_password.new` injects a new `azuread_service_principal_password` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.service_principal_password.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.service_principal_password` using the reference:\n\n $._ref.azuread_service_principal_password.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_service_principal_password.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `display_name` (`string`): A display name for the password When `null`, the `display_name` field will be omitted from the resulting object.\n - `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.\n - `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.\n - `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.\n - `service_principal_id` (`string`): The object ID of the service principal for which this password should be created\n - `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\u0026#39;t specified, the current date is used When `null`, the `start_date` field will be omitted from the resulting object.\n - `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.service_principal_password.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, service_principal_id, @@ -27,7 +27,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.service_principal_password.newAttrs` constructs a new object with attributes and blocks configured for the `service_principal_password`\nTerraform resource.\n\nUnlike [azuread.service_principal_password.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name` (`string`): A display name for the password When `null`, the `display_name` field will be omitted from the resulting object.\n - `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.\n - `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.\n - `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.\n - `service_principal_id` (`string`): The object ID of the service principal for which this password should be created\n - `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.\n - `timeouts` (`obj`): 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.service_principal_password.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `service_principal_password` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.service_principal_password.newAttrs` constructs a new object with attributes and blocks configured for the `service_principal_password`\nTerraform resource.\n\nUnlike [azuread.service_principal_password.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name` (`string`): A display name for the password When `null`, the `display_name` field will be omitted from the resulting object.\n - `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.\n - `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.\n - `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.\n - `service_principal_id` (`string`): The object ID of the service principal for which this password should be created\n - `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.\n - `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.service_principal_password.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `service_principal_password` resource into the root Terraform configuration.\n', args=[]), newAttrs( service_principal_id, display_name=null, @@ -46,7 +46,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.service_principal_password.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.service_principal_password.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/synchronization_job.libsonnet b/2.x/_gen/resources/synchronization_job.libsonnet index 3ad1ac3..5037472 100644 --- a/2.x/_gen/resources/synchronization_job.libsonnet +++ b/2.x/_gen/resources/synchronization_job.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='synchronization_job', url='', help='`synchronization_job` represents the `azuread_synchronization_job` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.synchronization_job.new` injects a new `azuread_synchronization_job` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.synchronization_job.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.synchronization_job` using the reference:\n\n $._ref.azuread_synchronization_job.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_synchronization_job.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `enabled` (`bool`): Whether or not the synchronization job is enabled When `null`, the `enabled` field will be omitted from the resulting object.\n - `service_principal_id` (`string`): The object ID of the service principal for which this synchronization job should be created\n - `template_id` (`string`): Identifier of the synchronization template this job is based on.\n - `timeouts` (`obj`): 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](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.synchronization_job.new` injects a new `azuread_synchronization_job` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.synchronization_job.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.synchronization_job` using the reference:\n\n $._ref.azuread_synchronization_job.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_synchronization_job.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `enabled` (`bool`): Whether or not the synchronization job is enabled When `null`, the `enabled` field will be omitted from the resulting object.\n - `service_principal_id` (`string`): The object ID of the service principal for which this synchronization job should be created\n - `template_id` (`string`): Identifier of the synchronization template this job is based on.\n - `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](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, service_principal_id, @@ -21,7 +21,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.synchronization_job.newAttrs` constructs a new object with attributes and blocks configured for the `synchronization_job`\nTerraform resource.\n\nUnlike [azuread.synchronization_job.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `enabled` (`bool`): Whether or not the synchronization job is enabled When `null`, the `enabled` field will be omitted from the resulting object.\n - `service_principal_id` (`string`): The object ID of the service principal for which this synchronization job should be created\n - `template_id` (`string`): Identifier of the synchronization template this job is based on.\n - `timeouts` (`obj`): 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](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `synchronization_job` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.synchronization_job.newAttrs` constructs a new object with attributes and blocks configured for the `synchronization_job`\nTerraform resource.\n\nUnlike [azuread.synchronization_job.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `enabled` (`bool`): Whether or not the synchronization job is enabled When `null`, the `enabled` field will be omitted from the resulting object.\n - `service_principal_id` (`string`): The object ID of the service principal for which this synchronization job should be created\n - `template_id` (`string`): Identifier of the synchronization template this job is based on.\n - `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](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `synchronization_job` resource into the root Terraform configuration.\n', args=[]), newAttrs( service_principal_id, template_id, @@ -34,7 +34,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.synchronization_job.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.synchronization_job.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/synchronization_secret.libsonnet b/2.x/_gen/resources/synchronization_secret.libsonnet index 5a358fc..53e4796 100644 --- a/2.x/_gen/resources/synchronization_secret.libsonnet +++ b/2.x/_gen/resources/synchronization_secret.libsonnet @@ -12,7 +12,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); value: value, }), }, - '#new':: d.fn(help="\n`azuread.synchronization_secret.new` injects a new `azuread_synchronization_secret` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.synchronization_secret.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.synchronization_secret` using the reference:\n\n $._ref.azuread_synchronization_secret.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_synchronization_secret.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `service_principal_id` (`string`): The object ID of the service principal for which this synchronization secret should be created\n - `credential` (`list[obj]`): When `null`, the `credential` 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_secret.credential.new](#fn-credentialnew) constructor.\n - `timeouts` (`obj`): 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_secret.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.synchronization_secret.new` injects a new `azuread_synchronization_secret` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.synchronization_secret.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.synchronization_secret` using the reference:\n\n $._ref.azuread_synchronization_secret.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_synchronization_secret.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `service_principal_id` (`string`): The object ID of the service principal for which this synchronization secret should be created\n - `credential` (`list[obj]`): Set the `credential` field on the resulting resource block. When `null`, the `credential` 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_secret.credential.new](#fn-credentialnew) constructor.\n - `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_secret.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, service_principal_id, @@ -25,7 +25,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs(credential=credential, service_principal_id=service_principal_id, timeouts=timeouts), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.synchronization_secret.newAttrs` constructs a new object with attributes and blocks configured for the `synchronization_secret`\nTerraform resource.\n\nUnlike [azuread.synchronization_secret.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `service_principal_id` (`string`): The object ID of the service principal for which this synchronization secret should be created\n - `credential` (`list[obj]`): When `null`, the `credential` 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_secret.credential.new](#fn-credentialnew) constructor.\n - `timeouts` (`obj`): 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_secret.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `synchronization_secret` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.synchronization_secret.newAttrs` constructs a new object with attributes and blocks configured for the `synchronization_secret`\nTerraform resource.\n\nUnlike [azuread.synchronization_secret.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `service_principal_id` (`string`): The object ID of the service principal for which this synchronization secret should be created\n - `credential` (`list[obj]`): Set the `credential` field on the resulting object. When `null`, the `credential` 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_secret.credential.new](#fn-credentialnew) constructor.\n - `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_secret.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `synchronization_secret` resource into the root Terraform configuration.\n', args=[]), newAttrs( service_principal_id, credential=null, @@ -36,7 +36,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts: timeouts, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.synchronization_secret.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.synchronization_secret.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/2.x/_gen/resources/user.libsonnet b/2.x/_gen/resources/user.libsonnet index ee596f2..8fa9871 100644 --- a/2.x/_gen/resources/user.libsonnet +++ b/2.x/_gen/resources/user.libsonnet @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='user', url='', help='`user` represents the `azuread_user` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.user.new` injects a new `azuread_user` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.user.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.user` using the reference:\n\n $._ref.azuread_user.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_user.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `account_enabled` (`bool`): Whether or not the account should be enabled When `null`, the `account_enabled` field will be omitted from the resulting object.\n - `age_group` (`string`): The age group of the user When `null`, the `age_group` field will be omitted from the resulting object.\n - `business_phones` (`list`): The telephone numbers for the user. Only one number can be set for this property. Read-only for users synced with Azure AD Connect When `null`, the `business_phones` field will be omitted from the resulting object.\n - `city` (`string`): The city in which the user is located When `null`, the `city` field will be omitted from the resulting object.\n - `company_name` (`string`): The company name which the user is associated. This property can be useful for describing the company that an external user comes from When `null`, the `company_name` field will be omitted from the resulting object.\n - `consent_provided_for_minor` (`string`): Whether consent has been obtained for minors When `null`, the `consent_provided_for_minor` field will be omitted from the resulting object.\n - `cost_center` (`string`): The cost center associated with the user. When `null`, the `cost_center` field will be omitted from the resulting object.\n - `country` (`string`): The country/region in which the user is located, e.g. `US` or `UK` When `null`, the `country` field will be omitted from the resulting object.\n - `department` (`string`): The name for the department in which the user works When `null`, the `department` field will be omitted from the resulting object.\n - `disable_password_expiration` (`bool`): Whether the users password is exempt from expiring When `null`, the `disable_password_expiration` field will be omitted from the resulting object.\n - `disable_strong_password` (`bool`): Whether the user is allowed weaker passwords than the default policy to be specified. When `null`, the `disable_strong_password` field will be omitted from the resulting object.\n - `display_name` (`string`): The name to display in the address book for the user\n - `division` (`string`): The name of the division in which the user works. When `null`, the `division` field will be omitted from the resulting object.\n - `employee_id` (`string`): The employee identifier assigned to the user by the organisation When `null`, the `employee_id` field will be omitted from the resulting object.\n - `employee_type` (`string`): Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. When `null`, the `employee_type` field will be omitted from the resulting object.\n - `fax_number` (`string`): The fax number of the user When `null`, the `fax_number` field will be omitted from the resulting object.\n - `force_password_change` (`bool`): Whether the user is forced to change the password during the next sign-in. Only takes effect when also changing the password When `null`, the `force_password_change` field will be omitted from the resulting object.\n - `given_name` (`string`): The given name (first name) of the user When `null`, the `given_name` field will be omitted from the resulting object.\n - `job_title` (`string`): The user’s job title When `null`, the `job_title` field will be omitted from the resulting object.\n - `mail` (`string`): The SMTP address for the user. Cannot be unset. When `null`, the `mail` field will be omitted from the resulting object.\n - `mail_nickname` (`string`): The mail alias for the user. Defaults to the user name part of the user principal name (UPN) When `null`, the `mail_nickname` field will be omitted from the resulting object.\n - `manager_id` (`string`): The object ID of the user\u0026#39;s manager When `null`, the `manager_id` field will be omitted from the resulting object.\n - `mobile_phone` (`string`): The primary cellular telephone number for the user When `null`, the `mobile_phone` field will be omitted from the resulting object.\n - `office_location` (`string`): The office location in the user\u0026#39;s place of business When `null`, the `office_location` field will be omitted from the resulting object.\n - `onpremises_immutable_id` (`string`): The value used to associate an on-premise Active Directory user account with their Azure AD user object. This must be specified if you are using a federated domain for the user\u0026#39;s `user_principal_name` property when creating a new user account When `null`, the `onpremises_immutable_id` field will be omitted from the resulting object.\n - `other_mails` (`list`): Additional email addresses for the user When `null`, the `other_mails` field will be omitted from the resulting object.\n - `password` (`string`): The password for the user. The password must satisfy minimum requirements as specified by the password policy. The maximum length is 256 characters. This property is required when creating a new user When `null`, the `password` field will be omitted from the resulting object.\n - `postal_code` (`string`): The postal code for the user\u0026#39;s postal address. The postal code is specific to the user\u0026#39;s country/region. In the United States of America, this attribute contains the ZIP code When `null`, the `postal_code` field will be omitted from the resulting object.\n - `preferred_language` (`string`): The user\u0026#39;s preferred language, in ISO 639-1 notation When `null`, the `preferred_language` field will be omitted from the resulting object.\n - `show_in_address_list` (`bool`): Whether or not the Outlook global address list should include this user When `null`, the `show_in_address_list` field will be omitted from the resulting object.\n - `state` (`string`): The state or province in the user\u0026#39;s address When `null`, the `state` field will be omitted from the resulting object.\n - `street_address` (`string`): The street address of the user\u0026#39;s place of business When `null`, the `street_address` field will be omitted from the resulting object.\n - `surname` (`string`): The user\u0026#39;s surname (family name or last name) When `null`, the `surname` field will be omitted from the resulting object.\n - `usage_location` (`string`): The usage location of the user. Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. The usage location is a two letter country code (ISO standard 3166). Examples include: `NO`, `JP`, and `GB`. Cannot be reset to null once set When `null`, the `usage_location` field will be omitted from the resulting object.\n - `user_principal_name` (`string`): The user principal name (UPN) of the user\n - `timeouts` (`obj`): 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.user.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.user.new` injects a new `azuread_user` Terraform `resource`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.user.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.user` using the reference:\n\n $._ref.azuread_user.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_user.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block.\n - `account_enabled` (`bool`): Whether or not the account should be enabled When `null`, the `account_enabled` field will be omitted from the resulting object.\n - `age_group` (`string`): The age group of the user When `null`, the `age_group` field will be omitted from the resulting object.\n - `business_phones` (`list`): The telephone numbers for the user. Only one number can be set for this property. Read-only for users synced with Azure AD Connect When `null`, the `business_phones` field will be omitted from the resulting object.\n - `city` (`string`): The city in which the user is located When `null`, the `city` field will be omitted from the resulting object.\n - `company_name` (`string`): The company name which the user is associated. This property can be useful for describing the company that an external user comes from When `null`, the `company_name` field will be omitted from the resulting object.\n - `consent_provided_for_minor` (`string`): Whether consent has been obtained for minors When `null`, the `consent_provided_for_minor` field will be omitted from the resulting object.\n - `cost_center` (`string`): The cost center associated with the user. When `null`, the `cost_center` field will be omitted from the resulting object.\n - `country` (`string`): The country/region in which the user is located, e.g. `US` or `UK` When `null`, the `country` field will be omitted from the resulting object.\n - `department` (`string`): The name for the department in which the user works When `null`, the `department` field will be omitted from the resulting object.\n - `disable_password_expiration` (`bool`): Whether the users password is exempt from expiring When `null`, the `disable_password_expiration` field will be omitted from the resulting object.\n - `disable_strong_password` (`bool`): Whether the user is allowed weaker passwords than the default policy to be specified. When `null`, the `disable_strong_password` field will be omitted from the resulting object.\n - `display_name` (`string`): The name to display in the address book for the user\n - `division` (`string`): The name of the division in which the user works. When `null`, the `division` field will be omitted from the resulting object.\n - `employee_id` (`string`): The employee identifier assigned to the user by the organisation When `null`, the `employee_id` field will be omitted from the resulting object.\n - `employee_type` (`string`): Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. When `null`, the `employee_type` field will be omitted from the resulting object.\n - `fax_number` (`string`): The fax number of the user When `null`, the `fax_number` field will be omitted from the resulting object.\n - `force_password_change` (`bool`): Whether the user is forced to change the password during the next sign-in. Only takes effect when also changing the password When `null`, the `force_password_change` field will be omitted from the resulting object.\n - `given_name` (`string`): The given name (first name) of the user When `null`, the `given_name` field will be omitted from the resulting object.\n - `job_title` (`string`): The user’s job title When `null`, the `job_title` field will be omitted from the resulting object.\n - `mail` (`string`): The SMTP address for the user. Cannot be unset. When `null`, the `mail` field will be omitted from the resulting object.\n - `mail_nickname` (`string`): The mail alias for the user. Defaults to the user name part of the user principal name (UPN) When `null`, the `mail_nickname` field will be omitted from the resulting object.\n - `manager_id` (`string`): The object ID of the user\u0026#39;s manager When `null`, the `manager_id` field will be omitted from the resulting object.\n - `mobile_phone` (`string`): The primary cellular telephone number for the user When `null`, the `mobile_phone` field will be omitted from the resulting object.\n - `office_location` (`string`): The office location in the user\u0026#39;s place of business When `null`, the `office_location` field will be omitted from the resulting object.\n - `onpremises_immutable_id` (`string`): The value used to associate an on-premise Active Directory user account with their Azure AD user object. This must be specified if you are using a federated domain for the user\u0026#39;s `user_principal_name` property when creating a new user account When `null`, the `onpremises_immutable_id` field will be omitted from the resulting object.\n - `other_mails` (`list`): Additional email addresses for the user When `null`, the `other_mails` field will be omitted from the resulting object.\n - `password` (`string`): The password for the user. The password must satisfy minimum requirements as specified by the password policy. The maximum length is 256 characters. This property is required when creating a new user When `null`, the `password` field will be omitted from the resulting object.\n - `postal_code` (`string`): The postal code for the user\u0026#39;s postal address. The postal code is specific to the user\u0026#39;s country/region. In the United States of America, this attribute contains the ZIP code When `null`, the `postal_code` field will be omitted from the resulting object.\n - `preferred_language` (`string`): The user\u0026#39;s preferred language, in ISO 639-1 notation When `null`, the `preferred_language` field will be omitted from the resulting object.\n - `show_in_address_list` (`bool`): Whether or not the Outlook global address list should include this user When `null`, the `show_in_address_list` field will be omitted from the resulting object.\n - `state` (`string`): The state or province in the user\u0026#39;s address When `null`, the `state` field will be omitted from the resulting object.\n - `street_address` (`string`): The street address of the user\u0026#39;s place of business When `null`, the `street_address` field will be omitted from the resulting object.\n - `surname` (`string`): The user\u0026#39;s surname (family name or last name) When `null`, the `surname` field will be omitted from the resulting object.\n - `usage_location` (`string`): The usage location of the user. Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. The usage location is a two letter country code (ISO standard 3166). Examples include: `NO`, `JP`, and `GB`. Cannot be reset to null once set When `null`, the `usage_location` field will be omitted from the resulting object.\n - `user_principal_name` (`string`): The user principal name (UPN) of the user\n - `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.user.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new resource into the root Terraform configuration.\n", args=[]), new( resourceLabel, display_name, @@ -85,7 +85,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.user.newAttrs` constructs a new object with attributes and blocks configured for the `user`\nTerraform resource.\n\nUnlike [azuread.user.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `account_enabled` (`bool`): Whether or not the account should be enabled When `null`, the `account_enabled` field will be omitted from the resulting object.\n - `age_group` (`string`): The age group of the user When `null`, the `age_group` field will be omitted from the resulting object.\n - `business_phones` (`list`): The telephone numbers for the user. Only one number can be set for this property. Read-only for users synced with Azure AD Connect When `null`, the `business_phones` field will be omitted from the resulting object.\n - `city` (`string`): The city in which the user is located When `null`, the `city` field will be omitted from the resulting object.\n - `company_name` (`string`): The company name which the user is associated. This property can be useful for describing the company that an external user comes from When `null`, the `company_name` field will be omitted from the resulting object.\n - `consent_provided_for_minor` (`string`): Whether consent has been obtained for minors When `null`, the `consent_provided_for_minor` field will be omitted from the resulting object.\n - `cost_center` (`string`): The cost center associated with the user. When `null`, the `cost_center` field will be omitted from the resulting object.\n - `country` (`string`): The country/region in which the user is located, e.g. `US` or `UK` When `null`, the `country` field will be omitted from the resulting object.\n - `department` (`string`): The name for the department in which the user works When `null`, the `department` field will be omitted from the resulting object.\n - `disable_password_expiration` (`bool`): Whether the users password is exempt from expiring When `null`, the `disable_password_expiration` field will be omitted from the resulting object.\n - `disable_strong_password` (`bool`): Whether the user is allowed weaker passwords than the default policy to be specified. When `null`, the `disable_strong_password` field will be omitted from the resulting object.\n - `display_name` (`string`): The name to display in the address book for the user\n - `division` (`string`): The name of the division in which the user works. When `null`, the `division` field will be omitted from the resulting object.\n - `employee_id` (`string`): The employee identifier assigned to the user by the organisation When `null`, the `employee_id` field will be omitted from the resulting object.\n - `employee_type` (`string`): Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. When `null`, the `employee_type` field will be omitted from the resulting object.\n - `fax_number` (`string`): The fax number of the user When `null`, the `fax_number` field will be omitted from the resulting object.\n - `force_password_change` (`bool`): Whether the user is forced to change the password during the next sign-in. Only takes effect when also changing the password When `null`, the `force_password_change` field will be omitted from the resulting object.\n - `given_name` (`string`): The given name (first name) of the user When `null`, the `given_name` field will be omitted from the resulting object.\n - `job_title` (`string`): The user’s job title When `null`, the `job_title` field will be omitted from the resulting object.\n - `mail` (`string`): The SMTP address for the user. Cannot be unset. When `null`, the `mail` field will be omitted from the resulting object.\n - `mail_nickname` (`string`): The mail alias for the user. Defaults to the user name part of the user principal name (UPN) When `null`, the `mail_nickname` field will be omitted from the resulting object.\n - `manager_id` (`string`): The object ID of the user's manager When `null`, the `manager_id` field will be omitted from the resulting object.\n - `mobile_phone` (`string`): The primary cellular telephone number for the user When `null`, the `mobile_phone` field will be omitted from the resulting object.\n - `office_location` (`string`): The office location in the user's place of business When `null`, the `office_location` field will be omitted from the resulting object.\n - `onpremises_immutable_id` (`string`): The value used to associate an on-premise Active Directory user account with their Azure AD user object. This must be specified if you are using a federated domain for the user's `user_principal_name` property when creating a new user account When `null`, the `onpremises_immutable_id` field will be omitted from the resulting object.\n - `other_mails` (`list`): Additional email addresses for the user When `null`, the `other_mails` field will be omitted from the resulting object.\n - `password` (`string`): The password for the user. The password must satisfy minimum requirements as specified by the password policy. The maximum length is 256 characters. This property is required when creating a new user When `null`, the `password` field will be omitted from the resulting object.\n - `postal_code` (`string`): The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code When `null`, the `postal_code` field will be omitted from the resulting object.\n - `preferred_language` (`string`): The user's preferred language, in ISO 639-1 notation When `null`, the `preferred_language` field will be omitted from the resulting object.\n - `show_in_address_list` (`bool`): Whether or not the Outlook global address list should include this user When `null`, the `show_in_address_list` field will be omitted from the resulting object.\n - `state` (`string`): The state or province in the user's address When `null`, the `state` field will be omitted from the resulting object.\n - `street_address` (`string`): The street address of the user's place of business When `null`, the `street_address` field will be omitted from the resulting object.\n - `surname` (`string`): The user's surname (family name or last name) When `null`, the `surname` field will be omitted from the resulting object.\n - `usage_location` (`string`): The usage location of the user. Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. The usage location is a two letter country code (ISO standard 3166). Examples include: `NO`, `JP`, and `GB`. Cannot be reset to null once set When `null`, the `usage_location` field will be omitted from the resulting object.\n - `user_principal_name` (`string`): The user principal name (UPN) of the user\n - `timeouts` (`obj`): 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.user.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `user` resource into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.user.newAttrs` constructs a new object with attributes and blocks configured for the `user`\nTerraform resource.\n\nUnlike [azuread.user.new](#fn-new), this function will not inject the `resource`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `account_enabled` (`bool`): Whether or not the account should be enabled When `null`, the `account_enabled` field will be omitted from the resulting object.\n - `age_group` (`string`): The age group of the user When `null`, the `age_group` field will be omitted from the resulting object.\n - `business_phones` (`list`): The telephone numbers for the user. Only one number can be set for this property. Read-only for users synced with Azure AD Connect When `null`, the `business_phones` field will be omitted from the resulting object.\n - `city` (`string`): The city in which the user is located When `null`, the `city` field will be omitted from the resulting object.\n - `company_name` (`string`): The company name which the user is associated. This property can be useful for describing the company that an external user comes from When `null`, the `company_name` field will be omitted from the resulting object.\n - `consent_provided_for_minor` (`string`): Whether consent has been obtained for minors When `null`, the `consent_provided_for_minor` field will be omitted from the resulting object.\n - `cost_center` (`string`): The cost center associated with the user. When `null`, the `cost_center` field will be omitted from the resulting object.\n - `country` (`string`): The country/region in which the user is located, e.g. `US` or `UK` When `null`, the `country` field will be omitted from the resulting object.\n - `department` (`string`): The name for the department in which the user works When `null`, the `department` field will be omitted from the resulting object.\n - `disable_password_expiration` (`bool`): Whether the users password is exempt from expiring When `null`, the `disable_password_expiration` field will be omitted from the resulting object.\n - `disable_strong_password` (`bool`): Whether the user is allowed weaker passwords than the default policy to be specified. When `null`, the `disable_strong_password` field will be omitted from the resulting object.\n - `display_name` (`string`): The name to display in the address book for the user\n - `division` (`string`): The name of the division in which the user works. When `null`, the `division` field will be omitted from the resulting object.\n - `employee_id` (`string`): The employee identifier assigned to the user by the organisation When `null`, the `employee_id` field will be omitted from the resulting object.\n - `employee_type` (`string`): Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. When `null`, the `employee_type` field will be omitted from the resulting object.\n - `fax_number` (`string`): The fax number of the user When `null`, the `fax_number` field will be omitted from the resulting object.\n - `force_password_change` (`bool`): Whether the user is forced to change the password during the next sign-in. Only takes effect when also changing the password When `null`, the `force_password_change` field will be omitted from the resulting object.\n - `given_name` (`string`): The given name (first name) of the user When `null`, the `given_name` field will be omitted from the resulting object.\n - `job_title` (`string`): The user’s job title When `null`, the `job_title` field will be omitted from the resulting object.\n - `mail` (`string`): The SMTP address for the user. Cannot be unset. When `null`, the `mail` field will be omitted from the resulting object.\n - `mail_nickname` (`string`): The mail alias for the user. Defaults to the user name part of the user principal name (UPN) When `null`, the `mail_nickname` field will be omitted from the resulting object.\n - `manager_id` (`string`): The object ID of the user's manager When `null`, the `manager_id` field will be omitted from the resulting object.\n - `mobile_phone` (`string`): The primary cellular telephone number for the user When `null`, the `mobile_phone` field will be omitted from the resulting object.\n - `office_location` (`string`): The office location in the user's place of business When `null`, the `office_location` field will be omitted from the resulting object.\n - `onpremises_immutable_id` (`string`): The value used to associate an on-premise Active Directory user account with their Azure AD user object. This must be specified if you are using a federated domain for the user's `user_principal_name` property when creating a new user account When `null`, the `onpremises_immutable_id` field will be omitted from the resulting object.\n - `other_mails` (`list`): Additional email addresses for the user When `null`, the `other_mails` field will be omitted from the resulting object.\n - `password` (`string`): The password for the user. The password must satisfy minimum requirements as specified by the password policy. The maximum length is 256 characters. This property is required when creating a new user When `null`, the `password` field will be omitted from the resulting object.\n - `postal_code` (`string`): The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United States of America, this attribute contains the ZIP code When `null`, the `postal_code` field will be omitted from the resulting object.\n - `preferred_language` (`string`): The user's preferred language, in ISO 639-1 notation When `null`, the `preferred_language` field will be omitted from the resulting object.\n - `show_in_address_list` (`bool`): Whether or not the Outlook global address list should include this user When `null`, the `show_in_address_list` field will be omitted from the resulting object.\n - `state` (`string`): The state or province in the user's address When `null`, the `state` field will be omitted from the resulting object.\n - `street_address` (`string`): The street address of the user's place of business When `null`, the `street_address` field will be omitted from the resulting object.\n - `surname` (`string`): The user's surname (family name or last name) When `null`, the `surname` field will be omitted from the resulting object.\n - `usage_location` (`string`): The usage location of the user. Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. The usage location is a two letter country code (ISO standard 3166). Examples include: `NO`, `JP`, and `GB`. Cannot be reset to null once set When `null`, the `usage_location` field will be omitted from the resulting object.\n - `user_principal_name` (`string`): The user principal name (UPN) of the user\n - `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.user.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `user` resource into the root Terraform configuration.\n', args=[]), newAttrs( display_name, user_principal_name, @@ -162,7 +162,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); user_principal_name: user_principal_name, }), timeouts:: { - '#new':: d.fn(help='\n`azuread.user.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.user.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, diff --git a/docs/2.x/administrative_unit.md b/docs/2.x/administrative_unit.md index 5f0f21e..116d9d6 100644 --- a/docs/2.x/administrative_unit.md +++ b/docs/2.x/administrative_unit.md @@ -59,7 +59,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `hidden_membership_enabled` (`bool`): Whether the administrative unit and its members are hidden or publicly viewable in the directory When `null`, the `hidden_membership_enabled` field will be omitted from the resulting object. - `members` (`list`): A set of object IDs of members who should be present in this administrative unit. Supported object types are Users or Groups When `null`, the `members` field will be omitted from the resulting object. - `prevent_duplicate_names` (`bool`): If `true`, will return an error if an existing administrative unit is found with the same name When `null`, the `prevent_duplicate_names` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor. + - `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.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -88,7 +88,7 @@ injecting into a complete block. - `hidden_membership_enabled` (`bool`): Whether the administrative unit and its members are hidden or publicly viewable in the directory When `null`, the `hidden_membership_enabled` field will be omitted from the resulting object. - `members` (`list`): A set of object IDs of members who should be present in this administrative unit. Supported object types are Users or Groups When `null`, the `members` field will be omitted from the resulting object. - `prevent_duplicate_names` (`bool`): If `true`, will return an error if an existing administrative unit is found with the same name When `null`, the `prevent_duplicate_names` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor. + - `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.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `administrative_unit` resource into the root Terraform configuration. @@ -227,10 +227,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/administrative_unit_member.md b/docs/2.x/administrative_unit_member.md index 550b27f..55944f5 100644 --- a/docs/2.x/administrative_unit_member.md +++ b/docs/2.x/administrative_unit_member.md @@ -53,7 +53,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `resourceLabel` (`string`): The name label of the block. - `administrative_unit_object_id` (`string`): The object ID of the administrative unit When `null`, the `administrative_unit_object_id` field will be omitted from the resulting object. - `member_object_id` (`string`): The object ID of the member When `null`, the `member_object_id` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.administrative_unit_member.timeouts.new](#fn-timeoutsnew) constructor. + - `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.administrative_unit_member.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -79,7 +79,7 @@ injecting into a complete block. **Args**: - `administrative_unit_object_id` (`string`): The object ID of the administrative unit When `null`, the `administrative_unit_object_id` field will be omitted from the resulting object. - `member_object_id` (`string`): The object ID of the member When `null`, the `member_object_id` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.administrative_unit_member.timeouts.new](#fn-timeoutsnew) constructor. + - `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.administrative_unit_member.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `administrative_unit_member` resource into the root Terraform configuration. @@ -170,10 +170,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/app_role_assignment.md b/docs/2.x/app_role_assignment.md index 19a2607..70c0542 100644 --- a/docs/2.x/app_role_assignment.md +++ b/docs/2.x/app_role_assignment.md @@ -55,7 +55,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `app_role_id` (`string`): The ID of the app role to be assigned - `principal_object_id` (`string`): The object ID of the user, group or service principal to be assigned this app role - `resource_object_id` (`string`): The object ID of the service principal representing the resource - - `timeouts` (`obj`): 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.app_role_assignment.timeouts.new](#fn-timeoutsnew) constructor. + - `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.app_role_assignment.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -82,7 +82,7 @@ injecting into a complete block. - `app_role_id` (`string`): The ID of the app role to be assigned - `principal_object_id` (`string`): The object ID of the user, group or service principal to be assigned this app role - `resource_object_id` (`string`): The object ID of the service principal representing the resource - - `timeouts` (`obj`): 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.app_role_assignment.timeouts.new](#fn-timeoutsnew) constructor. + - `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.app_role_assignment.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `app_role_assignment` resource into the root Terraform configuration. @@ -189,9 +189,9 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. + - `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. **Returns**: - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/application.md b/docs/2.x/application.md index 190afd8..b41d2be 100644 --- a/docs/2.x/application.md +++ b/docs/2.x/application.md @@ -125,15 +125,15 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `tags` (`list`): A set of tags to apply to the application When `null`, the `tags` field will be omitted from the resulting object. - `template_id` (`string`): Unique ID of the application template from which this application is created When `null`, the `template_id` field will be omitted from the resulting object. - `terms_of_service_url` (`string`): URL of the application's terms of service statement When `null`, the `terms_of_service_url` field will be omitted from the resulting object. - - `api` (`list[obj]`): When `null`, the `api` 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.api.new](#fn-apinew) constructor. - - `app_role` (`list[obj]`): When `null`, the `app_role` 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.app_role.new](#fn-app_rolenew) constructor. + - `api` (`list[obj]`): Set the `api` field on the resulting resource block. When `null`, the `api` 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.api.new](#fn-apinew) constructor. + - `app_role` (`list[obj]`): Set the `app_role` field on the resulting resource block. When `null`, the `app_role` 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.app_role.new](#fn-app_rolenew) constructor. - `feature_tags` (`list[obj]`): Block of features to configure for this application using tags When `null`, the `feature_tags` 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.feature_tags.new](#fn-feature_tagsnew) constructor. - - `optional_claims` (`list[obj]`): When `null`, the `optional_claims` 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.optional_claims.new](#fn-optional_claimsnew) constructor. - - `public_client` (`list[obj]`): When `null`, the `public_client` 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.public_client.new](#fn-public_clientnew) constructor. - - `required_resource_access` (`list[obj]`): When `null`, the `required_resource_access` 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.required_resource_access.new](#fn-required_resource_accessnew) constructor. - - `single_page_application` (`list[obj]`): When `null`, the `single_page_application` 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.single_page_application.new](#fn-single_page_applicationnew) constructor. - - `timeouts` (`obj`): 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.timeouts.new](#fn-timeoutsnew) constructor. - - `web` (`list[obj]`): When `null`, the `web` 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.web.new](#fn-webnew) constructor. + - `optional_claims` (`list[obj]`): Set the `optional_claims` field on the resulting resource block. When `null`, the `optional_claims` 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.optional_claims.new](#fn-optional_claimsnew) constructor. + - `public_client` (`list[obj]`): Set the `public_client` field on the resulting resource block. When `null`, the `public_client` 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.public_client.new](#fn-public_clientnew) constructor. + - `required_resource_access` (`list[obj]`): Set the `required_resource_access` field on the resulting resource block. When `null`, the `required_resource_access` 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.required_resource_access.new](#fn-required_resource_accessnew) constructor. + - `single_page_application` (`list[obj]`): Set the `single_page_application` field on the resulting resource block. When `null`, the `single_page_application` 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.single_page_application.new](#fn-single_page_applicationnew) constructor. + - `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.timeouts.new](#fn-timeoutsnew) constructor. + - `web` (`list[obj]`): Set the `web` field on the resulting resource block. When `null`, the `web` 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.web.new](#fn-webnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -173,15 +173,15 @@ injecting into a complete block. - `tags` (`list`): A set of tags to apply to the application When `null`, the `tags` field will be omitted from the resulting object. - `template_id` (`string`): Unique ID of the application template from which this application is created When `null`, the `template_id` field will be omitted from the resulting object. - `terms_of_service_url` (`string`): URL of the application's terms of service statement When `null`, the `terms_of_service_url` field will be omitted from the resulting object. - - `api` (`list[obj]`): When `null`, the `api` 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.api.new](#fn-apinew) constructor. - - `app_role` (`list[obj]`): When `null`, the `app_role` 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.app_role.new](#fn-app_rolenew) constructor. + - `api` (`list[obj]`): Set the `api` field on the resulting object. When `null`, the `api` 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.api.new](#fn-apinew) constructor. + - `app_role` (`list[obj]`): Set the `app_role` field on the resulting object. When `null`, the `app_role` 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.app_role.new](#fn-app_rolenew) constructor. - `feature_tags` (`list[obj]`): Block of features to configure for this application using tags When `null`, the `feature_tags` 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.feature_tags.new](#fn-feature_tagsnew) constructor. - - `optional_claims` (`list[obj]`): When `null`, the `optional_claims` 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.optional_claims.new](#fn-optional_claimsnew) constructor. - - `public_client` (`list[obj]`): When `null`, the `public_client` 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.public_client.new](#fn-public_clientnew) constructor. - - `required_resource_access` (`list[obj]`): When `null`, the `required_resource_access` 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.required_resource_access.new](#fn-required_resource_accessnew) constructor. - - `single_page_application` (`list[obj]`): When `null`, the `single_page_application` 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.single_page_application.new](#fn-single_page_applicationnew) constructor. - - `timeouts` (`obj`): 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.timeouts.new](#fn-timeoutsnew) constructor. - - `web` (`list[obj]`): When `null`, the `web` 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.web.new](#fn-webnew) constructor. + - `optional_claims` (`list[obj]`): Set the `optional_claims` field on the resulting object. When `null`, the `optional_claims` 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.optional_claims.new](#fn-optional_claimsnew) constructor. + - `public_client` (`list[obj]`): Set the `public_client` field on the resulting object. When `null`, the `public_client` 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.public_client.new](#fn-public_clientnew) constructor. + - `required_resource_access` (`list[obj]`): Set the `required_resource_access` field on the resulting object. When `null`, the `required_resource_access` 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.required_resource_access.new](#fn-required_resource_accessnew) constructor. + - `single_page_application` (`list[obj]`): Set the `single_page_application` field on the resulting object. When `null`, the `single_page_application` 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.single_page_application.new](#fn-single_page_applicationnew) constructor. + - `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.timeouts.new](#fn-timeoutsnew) constructor. + - `web` (`list[obj]`): Set the `web` field on the resulting object. When `null`, the `web` 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.web.new](#fn-webnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `application` resource into the root Terraform configuration. @@ -900,9 +900,9 @@ Terraform sub block. **Args**: - - `access_token` (`list[obj]`): When `null`, the `access_token` 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.optional_claims.access_token.new](#fn-optional_claimsaccess_tokennew) constructor. - - `id_token` (`list[obj]`): When `null`, the `id_token` 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.optional_claims.id_token.new](#fn-optional_claimsid_tokennew) constructor. - - `saml2_token` (`list[obj]`): When `null`, the `saml2_token` 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.optional_claims.saml2_token.new](#fn-optional_claimssaml2_tokennew) constructor. + - `access_token` (`list[obj]`): Set the `access_token` field on the resulting object. When `null`, the `access_token` 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.optional_claims.access_token.new](#fn-optional_claimsaccess_tokennew) constructor. + - `id_token` (`list[obj]`): Set the `id_token` field on the resulting object. When `null`, the `id_token` 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.optional_claims.id_token.new](#fn-optional_claimsid_tokennew) constructor. + - `saml2_token` (`list[obj]`): Set the `saml2_token` field on the resulting object. When `null`, the `saml2_token` 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.optional_claims.saml2_token.new](#fn-optional_claimssaml2_tokennew) constructor. **Returns**: - An attribute object that represents the `optional_claims` sub block. @@ -1026,8 +1026,8 @@ Terraform sub block. **Args**: - - `resource_app_id` (`string`): - - `resource_access` (`list[obj]`): When `null`, the `resource_access` 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.required_resource_access.resource_access.new](#fn-required_resource_accessresource_accessnew) constructor. + - `resource_app_id` (`string`): Set the `resource_app_id` field on the resulting object. + - `resource_access` (`list[obj]`): Set the `resource_access` field on the resulting object. When `null`, the `resource_access` 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.required_resource_access.resource_access.new](#fn-required_resource_accessresource_accessnew) constructor. **Returns**: - An attribute object that represents the `required_resource_access` sub block. @@ -1050,7 +1050,7 @@ Terraform sub block. **Args**: - - `type` (`string`): + - `type` (`string`): Set the `type` field on the resulting object. **Returns**: - An attribute object that represents the `resource_access` sub block. @@ -1096,10 +1096,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. @@ -1125,7 +1125,7 @@ Terraform sub block. - `homepage_url` (`string`): Home page or landing page of the application When `null`, the `homepage_url` field will be omitted from the resulting object. - `logout_url` (`string`): The URL that will be used by Microsoft's authorization service to sign out a user using front-channel, back-channel or SAML logout protocols When `null`, the `logout_url` field will be omitted from the resulting object. - `redirect_uris` (`list`): The URLs where user tokens are sent for sign-in, or the redirect URIs where OAuth 2.0 authorization codes and access tokens are sent When `null`, the `redirect_uris` field will be omitted from the resulting object. - - `implicit_grant` (`list[obj]`): When `null`, the `implicit_grant` 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.web.implicit_grant.new](#fn-webimplicit_grantnew) constructor. + - `implicit_grant` (`list[obj]`): Set the `implicit_grant` field on the resulting object. When `null`, the `implicit_grant` 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.web.implicit_grant.new](#fn-webimplicit_grantnew) constructor. **Returns**: - An attribute object that represents the `web` sub block. diff --git a/docs/2.x/application_certificate.md b/docs/2.x/application_certificate.md index df97c34..bf20831 100644 --- a/docs/2.x/application_certificate.md +++ b/docs/2.x/application_certificate.md @@ -65,7 +65,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `start_date` (`string`): The start date from which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the current date and time are use When `null`, the `start_date` field will be omitted from the resulting object. - `type` (`string`): The type of key/certificate When `null`, the `type` field will be omitted from the resulting object. - `value` (`string`): The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the `encoding` argumen - - `timeouts` (`obj`): 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_certificate.timeouts.new](#fn-timeoutsnew) constructor. + - `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_certificate.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -97,7 +97,7 @@ injecting into a complete block. - `start_date` (`string`): The start date from which the certificate is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`). If this isn't specified, the current date and time are use When `null`, the `start_date` field will be omitted from the resulting object. - `type` (`string`): The type of key/certificate When `null`, the `type` field will be omitted from the resulting object. - `value` (`string`): The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the `encoding` argumen - - `timeouts` (`obj`): 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_certificate.timeouts.new](#fn-timeoutsnew) constructor. + - `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_certificate.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `application_certificate` resource into the root Terraform configuration. @@ -284,10 +284,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/application_federated_identity_credential.md b/docs/2.x/application_federated_identity_credential.md index 9f4419a..d66407a 100644 --- a/docs/2.x/application_federated_identity_credential.md +++ b/docs/2.x/application_federated_identity_credential.md @@ -61,7 +61,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `display_name` (`string`): A unique display name for the federated identity credential - `issuer` (`string`): The URL of the external identity provider, which must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. - `subject` (`string`): The identifier of the external software workload within the external identity provider. The combination of issuer and subject must be unique on the app. - - `timeouts` (`obj`): 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_federated_identity_credential.timeouts.new](#fn-timeoutsnew) constructor. + - `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_federated_identity_credential.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -91,7 +91,7 @@ injecting into a complete block. - `display_name` (`string`): A unique display name for the federated identity credential - `issuer` (`string`): The URL of the external identity provider, which must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. - `subject` (`string`): The identifier of the external software workload within the external identity provider. The combination of issuer and subject must be unique on the app. - - `timeouts` (`obj`): 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_federated_identity_credential.timeouts.new](#fn-timeoutsnew) constructor. + - `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_federated_identity_credential.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `application_federated_identity_credential` resource into the root Terraform configuration. @@ -246,10 +246,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/application_password.md b/docs/2.x/application_password.md index a7a8994..ef095d4 100644 --- a/docs/2.x/application_password.md +++ b/docs/2.x/application_password.md @@ -61,7 +61,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `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`): 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](#fn-timeoutsnew) constructor. + - `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](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -91,7 +91,7 @@ injecting into a complete block. - `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`): 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](#fn-timeoutsnew) constructor. + - `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](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `application_password` resource into the root Terraform configuration. @@ -246,10 +246,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/application_pre_authorized.md b/docs/2.x/application_pre_authorized.md index 7760783..fe85828 100644 --- a/docs/2.x/application_pre_authorized.md +++ b/docs/2.x/application_pre_authorized.md @@ -55,7 +55,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `application_object_id` (`string`): The object ID of the application to which this pre-authorized application should be added - `authorized_app_id` (`string`): The application ID of the pre-authorized application - `permission_ids` (`list`): The IDs of the permission scopes required by the pre-authorized application - - `timeouts` (`obj`): 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_pre_authorized.timeouts.new](#fn-timeoutsnew) constructor. + - `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_pre_authorized.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -82,7 +82,7 @@ injecting into a complete block. - `application_object_id` (`string`): The object ID of the application to which this pre-authorized application should be added - `authorized_app_id` (`string`): The application ID of the pre-authorized application - `permission_ids` (`list`): The IDs of the permission scopes required by the pre-authorized application - - `timeouts` (`obj`): 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_pre_authorized.timeouts.new](#fn-timeoutsnew) constructor. + - `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_pre_authorized.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `application_pre_authorized` resource into the root Terraform configuration. @@ -189,10 +189,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/conditional_access_policy.md b/docs/2.x/conditional_access_policy.md index 08b40d2..fba49ff 100644 --- a/docs/2.x/conditional_access_policy.md +++ b/docs/2.x/conditional_access_policy.md @@ -75,12 +75,12 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `display_name` (`string`): - - `state` (`string`): - - `conditions` (`list[obj]`): When `null`, the `conditions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.new](#fn-conditionsnew) constructor. - - `grant_controls` (`list[obj]`): When `null`, the `grant_controls` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.grant_controls.new](#fn-grant_controlsnew) constructor. - - `session_controls` (`list[obj]`): When `null`, the `session_controls` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.session_controls.new](#fn-session_controlsnew) constructor. - - `timeouts` (`obj`): 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.conditional_access_policy.timeouts.new](#fn-timeoutsnew) constructor. + - `display_name` (`string`): Set the `display_name` field on the resulting resource block. + - `state` (`string`): Set the `state` field on the resulting resource block. + - `conditions` (`list[obj]`): Set the `conditions` field on the resulting resource block. When `null`, the `conditions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.new](#fn-conditionsnew) constructor. + - `grant_controls` (`list[obj]`): Set the `grant_controls` field on the resulting resource block. When `null`, the `grant_controls` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.grant_controls.new](#fn-grant_controlsnew) constructor. + - `session_controls` (`list[obj]`): Set the `session_controls` field on the resulting resource block. When `null`, the `session_controls` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.session_controls.new](#fn-session_controlsnew) constructor. + - `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.conditional_access_policy.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -104,12 +104,12 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `display_name` (`string`): - - `state` (`string`): - - `conditions` (`list[obj]`): When `null`, the `conditions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.new](#fn-conditionsnew) constructor. - - `grant_controls` (`list[obj]`): When `null`, the `grant_controls` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.grant_controls.new](#fn-grant_controlsnew) constructor. - - `session_controls` (`list[obj]`): When `null`, the `session_controls` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.session_controls.new](#fn-session_controlsnew) constructor. - - `timeouts` (`obj`): 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.conditional_access_policy.timeouts.new](#fn-timeoutsnew) constructor. + - `display_name` (`string`): Set the `display_name` field on the resulting object. + - `state` (`string`): Set the `state` field on the resulting object. + - `conditions` (`list[obj]`): Set the `conditions` field on the resulting object. When `null`, the `conditions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.new](#fn-conditionsnew) constructor. + - `grant_controls` (`list[obj]`): Set the `grant_controls` field on the resulting object. When `null`, the `grant_controls` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.grant_controls.new](#fn-grant_controlsnew) constructor. + - `session_controls` (`list[obj]`): Set the `session_controls` field on the resulting object. When `null`, the `session_controls` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.session_controls.new](#fn-session_controlsnew) constructor. + - `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.conditional_access_policy.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `conditional_access_policy` resource into the root Terraform configuration. @@ -311,14 +311,14 @@ Terraform sub block. **Args**: - - `client_app_types` (`list`): - - `sign_in_risk_levels` (`list`): When `null`, the `sign_in_risk_levels` field will be omitted from the resulting object. - - `user_risk_levels` (`list`): When `null`, the `user_risk_levels` field will be omitted from the resulting object. - - `applications` (`list[obj]`): When `null`, the `applications` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.applications.new](#fn-conditionsapplicationsnew) constructor. - - `devices` (`list[obj]`): When `null`, the `devices` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.devices.new](#fn-conditionsdevicesnew) constructor. - - `locations` (`list[obj]`): When `null`, the `locations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.locations.new](#fn-conditionslocationsnew) constructor. - - `platforms` (`list[obj]`): When `null`, the `platforms` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.platforms.new](#fn-conditionsplatformsnew) constructor. - - `users` (`list[obj]`): When `null`, the `users` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.users.new](#fn-conditionsusersnew) constructor. + - `client_app_types` (`list`): Set the `client_app_types` field on the resulting object. + - `sign_in_risk_levels` (`list`): Set the `sign_in_risk_levels` field on the resulting object. When `null`, the `sign_in_risk_levels` field will be omitted from the resulting object. + - `user_risk_levels` (`list`): Set the `user_risk_levels` field on the resulting object. When `null`, the `user_risk_levels` field will be omitted from the resulting object. + - `applications` (`list[obj]`): Set the `applications` field on the resulting object. When `null`, the `applications` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.applications.new](#fn-conditionsapplicationsnew) constructor. + - `devices` (`list[obj]`): Set the `devices` field on the resulting object. When `null`, the `devices` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.devices.new](#fn-conditionsdevicesnew) constructor. + - `locations` (`list[obj]`): Set the `locations` field on the resulting object. When `null`, the `locations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.locations.new](#fn-conditionslocationsnew) constructor. + - `platforms` (`list[obj]`): Set the `platforms` field on the resulting object. When `null`, the `platforms` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.platforms.new](#fn-conditionsplatformsnew) constructor. + - `users` (`list[obj]`): Set the `users` field on the resulting object. When `null`, the `users` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.users.new](#fn-conditionsusersnew) constructor. **Returns**: - An attribute object that represents the `conditions` sub block. @@ -341,9 +341,9 @@ Terraform sub block. **Args**: - - `excluded_applications` (`list`): When `null`, the `excluded_applications` field will be omitted from the resulting object. - - `included_applications` (`list`): When `null`, the `included_applications` field will be omitted from the resulting object. - - `included_user_actions` (`list`): When `null`, the `included_user_actions` field will be omitted from the resulting object. + - `excluded_applications` (`list`): Set the `excluded_applications` field on the resulting object. When `null`, the `excluded_applications` field will be omitted from the resulting object. + - `included_applications` (`list`): Set the `included_applications` field on the resulting object. When `null`, the `included_applications` field will be omitted from the resulting object. + - `included_user_actions` (`list`): Set the `included_user_actions` field on the resulting object. When `null`, the `included_user_actions` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `applications` sub block. @@ -366,7 +366,7 @@ Terraform sub block. **Args**: - - `filter` (`list[obj]`): When `null`, the `filter` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.devices.filter.new](#fn-conditionsconditionsfilternew) constructor. + - `filter` (`list[obj]`): Set the `filter` field on the resulting object. When `null`, the `filter` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.devices.filter.new](#fn-conditionsconditionsfilternew) constructor. **Returns**: - An attribute object that represents the `devices` sub block. @@ -389,8 +389,8 @@ Terraform sub block. **Args**: - - `mode` (`string`): - - `rule` (`string`): + - `mode` (`string`): Set the `mode` field on the resulting object. + - `rule` (`string`): Set the `rule` field on the resulting object. **Returns**: - An attribute object that represents the `filter` sub block. @@ -413,8 +413,8 @@ Terraform sub block. **Args**: - - `excluded_locations` (`list`): When `null`, the `excluded_locations` field will be omitted from the resulting object. - - `included_locations` (`list`): + - `excluded_locations` (`list`): Set the `excluded_locations` field on the resulting object. When `null`, the `excluded_locations` field will be omitted from the resulting object. + - `included_locations` (`list`): Set the `included_locations` field on the resulting object. **Returns**: - An attribute object that represents the `locations` sub block. @@ -437,8 +437,8 @@ Terraform sub block. **Args**: - - `excluded_platforms` (`list`): When `null`, the `excluded_platforms` field will be omitted from the resulting object. - - `included_platforms` (`list`): + - `excluded_platforms` (`list`): Set the `excluded_platforms` field on the resulting object. When `null`, the `excluded_platforms` field will be omitted from the resulting object. + - `included_platforms` (`list`): Set the `included_platforms` field on the resulting object. **Returns**: - An attribute object that represents the `platforms` sub block. @@ -461,12 +461,12 @@ Terraform sub block. **Args**: - - `excluded_groups` (`list`): When `null`, the `excluded_groups` field will be omitted from the resulting object. - - `excluded_roles` (`list`): When `null`, the `excluded_roles` field will be omitted from the resulting object. - - `excluded_users` (`list`): When `null`, the `excluded_users` field will be omitted from the resulting object. - - `included_groups` (`list`): When `null`, the `included_groups` field will be omitted from the resulting object. - - `included_roles` (`list`): When `null`, the `included_roles` field will be omitted from the resulting object. - - `included_users` (`list`): When `null`, the `included_users` field will be omitted from the resulting object. + - `excluded_groups` (`list`): Set the `excluded_groups` field on the resulting object. When `null`, the `excluded_groups` field will be omitted from the resulting object. + - `excluded_roles` (`list`): Set the `excluded_roles` field on the resulting object. When `null`, the `excluded_roles` field will be omitted from the resulting object. + - `excluded_users` (`list`): Set the `excluded_users` field on the resulting object. When `null`, the `excluded_users` field will be omitted from the resulting object. + - `included_groups` (`list`): Set the `included_groups` field on the resulting object. When `null`, the `included_groups` field will be omitted from the resulting object. + - `included_roles` (`list`): Set the `included_roles` field on the resulting object. When `null`, the `included_roles` field will be omitted from the resulting object. + - `included_users` (`list`): Set the `included_users` field on the resulting object. When `null`, the `included_users` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `users` sub block. @@ -489,10 +489,10 @@ Terraform sub block. **Args**: - - `built_in_controls` (`list`): - - `custom_authentication_factors` (`list`): When `null`, the `custom_authentication_factors` field will be omitted from the resulting object. - - `operator` (`string`): - - `terms_of_use` (`list`): When `null`, the `terms_of_use` field will be omitted from the resulting object. + - `built_in_controls` (`list`): Set the `built_in_controls` field on the resulting object. + - `custom_authentication_factors` (`list`): Set the `custom_authentication_factors` field on the resulting object. When `null`, the `custom_authentication_factors` field will be omitted from the resulting object. + - `operator` (`string`): Set the `operator` field on the resulting object. + - `terms_of_use` (`list`): Set the `terms_of_use` field on the resulting object. When `null`, the `terms_of_use` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `grant_controls` sub block. @@ -515,11 +515,11 @@ Terraform sub block. **Args**: - - `application_enforced_restrictions_enabled` (`bool`): When `null`, the `application_enforced_restrictions_enabled` field will be omitted from the resulting object. - - `cloud_app_security_policy` (`string`): When `null`, the `cloud_app_security_policy` field will be omitted from the resulting object. - - `persistent_browser_mode` (`string`): When `null`, the `persistent_browser_mode` field will be omitted from the resulting object. - - `sign_in_frequency` (`number`): When `null`, the `sign_in_frequency` field will be omitted from the resulting object. - - `sign_in_frequency_period` (`string`): When `null`, the `sign_in_frequency_period` field will be omitted from the resulting object. + - `application_enforced_restrictions_enabled` (`bool`): Set the `application_enforced_restrictions_enabled` field on the resulting object. When `null`, the `application_enforced_restrictions_enabled` field will be omitted from the resulting object. + - `cloud_app_security_policy` (`string`): Set the `cloud_app_security_policy` field on the resulting object. When `null`, the `cloud_app_security_policy` field will be omitted from the resulting object. + - `persistent_browser_mode` (`string`): Set the `persistent_browser_mode` field on the resulting object. When `null`, the `persistent_browser_mode` field will be omitted from the resulting object. + - `sign_in_frequency` (`number`): Set the `sign_in_frequency` field on the resulting object. When `null`, the `sign_in_frequency` field will be omitted from the resulting object. + - `sign_in_frequency_period` (`string`): Set the `sign_in_frequency_period` field on the resulting object. When `null`, the `sign_in_frequency_period` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `session_controls` sub block. @@ -542,10 +542,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/custom_directory_role.md b/docs/2.x/custom_directory_role.md index 6802c57..dc55a8b 100644 --- a/docs/2.x/custom_directory_role.md +++ b/docs/2.x/custom_directory_role.md @@ -64,7 +64,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `template_id` (`string`): Custom template identifier that is typically used if one needs an identifier to be the same across different directories. When `null`, the `template_id` field will be omitted from the resulting object. - `version` (`string`): The version of the role definition. - `permissions` (`list[obj]`): List of permissions that are included in the custom directory role When `null`, the `permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.custom_directory_role.permissions.new](#fn-permissionsnew) constructor. - - `timeouts` (`obj`): 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.custom_directory_role.timeouts.new](#fn-timeoutsnew) constructor. + - `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.custom_directory_role.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -94,7 +94,7 @@ injecting into a complete block. - `template_id` (`string`): Custom template identifier that is typically used if one needs an identifier to be the same across different directories. When `null`, the `template_id` field will be omitted from the resulting object. - `version` (`string`): The version of the role definition. - `permissions` (`list[obj]`): List of permissions that are included in the custom directory role When `null`, the `permissions` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.custom_directory_role.permissions.new](#fn-permissionsnew) constructor. - - `timeouts` (`obj`): 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.custom_directory_role.timeouts.new](#fn-timeoutsnew) constructor. + - `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.custom_directory_role.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `custom_directory_role` resource into the root Terraform configuration. @@ -293,10 +293,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/data/administrative_unit.md b/docs/2.x/data/administrative_unit.md index 3d05701..57381cf 100644 --- a/docs/2.x/data/administrative_unit.md +++ b/docs/2.x/data/administrative_unit.md @@ -53,7 +53,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `dataSrcLabel` (`string`): The name label of the block. - `display_name` (`string`): The display name for the administrative unit When `null`, the `display_name` field will be omitted from the resulting object. - `object_id` (`string`): The object ID of the administrative unit When `null`, the `object_id` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new data source into the root Terraform configuration. @@ -79,7 +79,7 @@ injecting into a complete block. **Args**: - `display_name` (`string`): The display name for the administrative unit When `null`, the `display_name` field will be omitted from the resulting object. - `object_id` (`string`): The object ID of the administrative unit When `null`, the `object_id` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor. + - `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.data.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `administrative_unit` data source into the root Terraform configuration. @@ -170,10 +170,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/data/application.md b/docs/2.x/data/application.md index 0e3d6c6..2977c3f 100644 --- a/docs/2.x/data/application.md +++ b/docs/2.x/data/application.md @@ -55,7 +55,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `application_id` (`string`): The Application ID (also called Client ID) When `null`, the `application_id` field will be omitted from the resulting object. - `display_name` (`string`): The display name for the application When `null`, the `display_name` field will be omitted from the resulting object. - `object_id` (`string`): The application's object ID When `null`, the `object_id` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.application.timeouts.new](#fn-timeoutsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.application.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new data source into the root Terraform configuration. @@ -82,7 +82,7 @@ injecting into a complete block. - `application_id` (`string`): The Application ID (also called Client ID) When `null`, the `application_id` field will be omitted from the resulting object. - `display_name` (`string`): The display name for the application When `null`, the `display_name` field will be omitted from the resulting object. - `object_id` (`string`): The application's object ID When `null`, the `object_id` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.application.timeouts.new](#fn-timeoutsnew) constructor. + - `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.data.application.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `application` data source into the root Terraform configuration. @@ -189,7 +189,7 @@ Terraform sub block. **Args**: - - `read` (`string`): When `null`, the `read` 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. **Returns**: - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/data/application_published_app_ids.md b/docs/2.x/data/application_published_app_ids.md index d243396..bb67c73 100644 --- a/docs/2.x/data/application_published_app_ids.md +++ b/docs/2.x/data/application_published_app_ids.md @@ -49,7 +49,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `dataSrcLabel` (`string`): The name label of the block. - - `timeouts` (`obj`): 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.data.application_published_app_ids.timeouts.new](#fn-timeoutsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.application_published_app_ids.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new data source into the root Terraform configuration. @@ -73,7 +73,7 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `timeouts` (`obj`): 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.data.application_published_app_ids.timeouts.new](#fn-timeoutsnew) constructor. + - `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.data.application_published_app_ids.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `application_published_app_ids` data source into the root Terraform configuration. @@ -132,7 +132,7 @@ Terraform sub block. **Args**: - - `read` (`string`): When `null`, the `read` 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. **Returns**: - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/data/application_template.md b/docs/2.x/data/application_template.md index 071603f..8600079 100644 --- a/docs/2.x/data/application_template.md +++ b/docs/2.x/data/application_template.md @@ -53,7 +53,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `dataSrcLabel` (`string`): The name label of the block. - `display_name` (`string`): The display name for the application template When `null`, the `display_name` field will be omitted from the resulting object. - `template_id` (`string`): The application template's ID When `null`, the `template_id` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.application_template.timeouts.new](#fn-timeoutsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.application_template.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new data source into the root Terraform configuration. @@ -79,7 +79,7 @@ injecting into a complete block. **Args**: - `display_name` (`string`): The display name for the application template When `null`, the `display_name` field will be omitted from the resulting object. - `template_id` (`string`): The application template's ID When `null`, the `template_id` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.application_template.timeouts.new](#fn-timeoutsnew) constructor. + - `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.data.application_template.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `application_template` data source into the root Terraform configuration. @@ -170,7 +170,7 @@ Terraform sub block. **Args**: - - `read` (`string`): When `null`, the `read` 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. **Returns**: - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/data/client_config.md b/docs/2.x/data/client_config.md index 2686414..ba42e4e 100644 --- a/docs/2.x/data/client_config.md +++ b/docs/2.x/data/client_config.md @@ -49,7 +49,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `dataSrcLabel` (`string`): The name label of the block. - - `timeouts` (`obj`): 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.data.client_config.timeouts.new](#fn-timeoutsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.client_config.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new data source into the root Terraform configuration. @@ -73,7 +73,7 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `timeouts` (`obj`): 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.data.client_config.timeouts.new](#fn-timeoutsnew) constructor. + - `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.data.client_config.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `client_config` data source into the root Terraform configuration. @@ -132,7 +132,7 @@ Terraform sub block. **Args**: - - `read` (`string`): When `null`, the `read` 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. **Returns**: - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/data/directory_object.md b/docs/2.x/data/directory_object.md index 4da5b49..d2138a9 100644 --- a/docs/2.x/data/directory_object.md +++ b/docs/2.x/data/directory_object.md @@ -51,7 +51,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `dataSrcLabel` (`string`): The name label of the block. - `object_id` (`string`): The object ID of the principal - - `timeouts` (`obj`): 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.data.directory_object.timeouts.new](#fn-timeoutsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.directory_object.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new data source into the root Terraform configuration. @@ -76,7 +76,7 @@ injecting into a complete block. **Args**: - `object_id` (`string`): The object ID of the principal - - `timeouts` (`obj`): 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.data.directory_object.timeouts.new](#fn-timeoutsnew) constructor. + - `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.data.directory_object.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `directory_object` data source into the root Terraform configuration. @@ -151,7 +151,7 @@ Terraform sub block. **Args**: - - `read` (`string`): When `null`, the `read` 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. **Returns**: - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/data/domains.md b/docs/2.x/data/domains.md index d100f0c..5732330 100644 --- a/docs/2.x/data/domains.md +++ b/docs/2.x/data/domains.md @@ -61,7 +61,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `only_initial` (`bool`): Set to `true` to only return the initial domain, which is your primary Azure Active Directory tenant domain When `null`, the `only_initial` field will be omitted from the resulting object. - `only_root` (`bool`): Set to `true` to only return verified root domains. Excludes subdomains and unverified domains When `null`, the `only_root` field will be omitted from the resulting object. - `supports_services` (`list`): A list of supported services that must be supported by a domain When `null`, the `supports_services` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.domains.timeouts.new](#fn-timeoutsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.domains.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new data source into the root Terraform configuration. @@ -91,7 +91,7 @@ injecting into a complete block. - `only_initial` (`bool`): Set to `true` to only return the initial domain, which is your primary Azure Active Directory tenant domain When `null`, the `only_initial` field will be omitted from the resulting object. - `only_root` (`bool`): Set to `true` to only return verified root domains. Excludes subdomains and unverified domains When `null`, the `only_root` field will be omitted from the resulting object. - `supports_services` (`list`): A list of supported services that must be supported by a domain When `null`, the `supports_services` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.domains.timeouts.new](#fn-timeoutsnew) constructor. + - `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.data.domains.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `domains` data source into the root Terraform configuration. @@ -246,7 +246,7 @@ Terraform sub block. **Args**: - - `read` (`string`): When `null`, the `read` 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. **Returns**: - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/data/group.md b/docs/2.x/data/group.md index 28d8d00..0ddb070 100644 --- a/docs/2.x/data/group.md +++ b/docs/2.x/data/group.md @@ -57,7 +57,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `mail_enabled` (`bool`): Whether the group is mail-enabled When `null`, the `mail_enabled` field will be omitted from the resulting object. - `object_id` (`string`): The object ID of the group When `null`, the `object_id` field will be omitted from the resulting object. - `security_enabled` (`bool`): Whether the group is a security group When `null`, the `security_enabled` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.group.timeouts.new](#fn-timeoutsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.group.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new data source into the root Terraform configuration. @@ -85,7 +85,7 @@ injecting into a complete block. - `mail_enabled` (`bool`): Whether the group is mail-enabled When `null`, the `mail_enabled` field will be omitted from the resulting object. - `object_id` (`string`): The object ID of the group When `null`, the `object_id` field will be omitted from the resulting object. - `security_enabled` (`bool`): Whether the group is a security group When `null`, the `security_enabled` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.group.timeouts.new](#fn-timeoutsnew) constructor. + - `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.data.group.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `group` data source into the root Terraform configuration. @@ -208,7 +208,7 @@ Terraform sub block. **Args**: - - `read` (`string`): When `null`, the `read` 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. **Returns**: - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/data/groups.md b/docs/2.x/data/groups.md index 3ddac97..42d006d 100644 --- a/docs/2.x/data/groups.md +++ b/docs/2.x/data/groups.md @@ -63,7 +63,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `object_ids` (`list`): The object IDs of the groups When `null`, the `object_ids` field will be omitted from the resulting object. - `return_all` (`bool`): Retrieve all groups with no filter When `null`, the `return_all` field will be omitted from the resulting object. - `security_enabled` (`bool`): Whether the groups are security-enabled When `null`, the `security_enabled` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.groups.timeouts.new](#fn-timeoutsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.groups.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new data source into the root Terraform configuration. @@ -94,7 +94,7 @@ injecting into a complete block. - `object_ids` (`list`): The object IDs of the groups When `null`, the `object_ids` field will be omitted from the resulting object. - `return_all` (`bool`): Retrieve all groups with no filter When `null`, the `return_all` field will be omitted from the resulting object. - `security_enabled` (`bool`): Whether the groups are security-enabled When `null`, the `security_enabled` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.groups.timeouts.new](#fn-timeoutsnew) constructor. + - `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.data.groups.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `groups` data source into the root Terraform configuration. @@ -265,7 +265,7 @@ Terraform sub block. **Args**: - - `read` (`string`): When `null`, the `read` 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. **Returns**: - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/data/service_principal.md b/docs/2.x/data/service_principal.md index 864ef09..d221cf5 100644 --- a/docs/2.x/data/service_principal.md +++ b/docs/2.x/data/service_principal.md @@ -55,7 +55,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `application_id` (`string`): The application ID (client ID) of the application associated with this service principal When `null`, the `application_id` field will be omitted from the resulting object. - `display_name` (`string`): The display name of the application associated with this service principal When `null`, the `display_name` field will be omitted from the resulting object. - `object_id` (`string`): The object ID of the service principal When `null`, the `object_id` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.service_principal.timeouts.new](#fn-timeoutsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.service_principal.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new data source into the root Terraform configuration. @@ -82,7 +82,7 @@ injecting into a complete block. - `application_id` (`string`): The application ID (client ID) of the application associated with this service principal When `null`, the `application_id` field will be omitted from the resulting object. - `display_name` (`string`): The display name of the application associated with this service principal When `null`, the `display_name` field will be omitted from the resulting object. - `object_id` (`string`): The object ID of the service principal When `null`, the `object_id` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.service_principal.timeouts.new](#fn-timeoutsnew) constructor. + - `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.data.service_principal.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `service_principal` data source into the root Terraform configuration. @@ -189,7 +189,7 @@ Terraform sub block. **Args**: - - `read` (`string`): When `null`, the `read` 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. **Returns**: - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/data/service_principals.md b/docs/2.x/data/service_principals.md index e2209ce..090ca98 100644 --- a/docs/2.x/data/service_principals.md +++ b/docs/2.x/data/service_principals.md @@ -59,7 +59,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `ignore_missing` (`bool`): Ignore missing service principals and return the service principals that were found. The data source will still fail if no service principals are found When `null`, the `ignore_missing` field will be omitted from the resulting object. - `object_ids` (`list`): The object IDs of the service principals When `null`, the `object_ids` field will be omitted from the resulting object. - `return_all` (`bool`): 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. When `null`, the `return_all` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.service_principals.timeouts.new](#fn-timeoutsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.service_principals.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new data source into the root Terraform configuration. @@ -88,7 +88,7 @@ injecting into a complete block. - `ignore_missing` (`bool`): Ignore missing service principals and return the service principals that were found. The data source will still fail if no service principals are found When `null`, the `ignore_missing` field will be omitted from the resulting object. - `object_ids` (`list`): The object IDs of the service principals When `null`, the `object_ids` field will be omitted from the resulting object. - `return_all` (`bool`): 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. When `null`, the `return_all` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.service_principals.timeouts.new](#fn-timeoutsnew) constructor. + - `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.data.service_principals.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `service_principals` data source into the root Terraform configuration. @@ -227,7 +227,7 @@ Terraform sub block. **Args**: - - `read` (`string`): When `null`, the `read` 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. **Returns**: - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/data/user.md b/docs/2.x/data/user.md index 52dec12..246fddb 100644 --- a/docs/2.x/data/user.md +++ b/docs/2.x/data/user.md @@ -55,7 +55,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `mail_nickname` (`string`): The email alias of the user When `null`, the `mail_nickname` field will be omitted from the resulting object. - `object_id` (`string`): The object ID of the user When `null`, the `object_id` field will be omitted from the resulting object. - `user_principal_name` (`string`): The user principal name (UPN) of the user When `null`, the `user_principal_name` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.user.timeouts.new](#fn-timeoutsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.user.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new data source into the root Terraform configuration. @@ -82,7 +82,7 @@ injecting into a complete block. - `mail_nickname` (`string`): The email alias of the user When `null`, the `mail_nickname` field will be omitted from the resulting object. - `object_id` (`string`): The object ID of the user When `null`, the `object_id` field will be omitted from the resulting object. - `user_principal_name` (`string`): The user principal name (UPN) of the user When `null`, the `user_principal_name` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.user.timeouts.new](#fn-timeoutsnew) constructor. + - `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.data.user.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `user` data source into the root Terraform configuration. @@ -189,7 +189,7 @@ Terraform sub block. **Args**: - - `read` (`string`): When `null`, the `read` 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. **Returns**: - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/data/users.md b/docs/2.x/data/users.md index cf07db0..3f9867e 100644 --- a/docs/2.x/data/users.md +++ b/docs/2.x/data/users.md @@ -59,7 +59,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `object_ids` (`list`): The object IDs of the users When `null`, the `object_ids` field will be omitted from the resulting object. - `return_all` (`bool`): Fetch all users with no filter and return all that were found. The data source will still fail if no users are found. When `null`, the `return_all` field will be omitted from the resulting object. - `user_principal_names` (`list`): The user principal names (UPNs) of the users When `null`, the `user_principal_names` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.users.timeouts.new](#fn-timeoutsnew) constructor. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source 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.data.users.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new data source into the root Terraform configuration. @@ -88,7 +88,7 @@ injecting into a complete block. - `object_ids` (`list`): The object IDs of the users When `null`, the `object_ids` field will be omitted from the resulting object. - `return_all` (`bool`): Fetch all users with no filter and return all that were found. The data source will still fail if no users are found. When `null`, the `return_all` field will be omitted from the resulting object. - `user_principal_names` (`list`): The user principal names (UPNs) of the users When `null`, the `user_principal_names` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.data.users.timeouts.new](#fn-timeoutsnew) constructor. + - `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.data.users.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `users` data source into the root Terraform configuration. @@ -227,7 +227,7 @@ Terraform sub block. **Args**: - - `read` (`string`): When `null`, the `read` 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. **Returns**: - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/directory_role.md b/docs/2.x/directory_role.md index 9d495a9..1168214 100644 --- a/docs/2.x/directory_role.md +++ b/docs/2.x/directory_role.md @@ -53,7 +53,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `resourceLabel` (`string`): The name label of the block. - `display_name` (`string`): The display name of the directory role When `null`, the `display_name` field will be omitted from the resulting object. - `template_id` (`string`): The object ID of the template associated with the directory role When `null`, the `template_id` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.directory_role.timeouts.new](#fn-timeoutsnew) constructor. + - `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.directory_role.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -79,7 +79,7 @@ injecting into a complete block. **Args**: - `display_name` (`string`): The display name of the directory role When `null`, the `display_name` field will be omitted from the resulting object. - `template_id` (`string`): The object ID of the template associated with the directory role When `null`, the `template_id` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.directory_role.timeouts.new](#fn-timeoutsnew) constructor. + - `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.directory_role.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `directory_role` resource into the root Terraform configuration. @@ -170,10 +170,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/directory_role_assignment.md b/docs/2.x/directory_role_assignment.md index 7e79699..f421c34 100644 --- a/docs/2.x/directory_role_assignment.md +++ b/docs/2.x/directory_role_assignment.md @@ -61,7 +61,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `directory_scope_object_id` (`string`): Identifier of the directory object representing the scope of the assignment When `null`, the `directory_scope_object_id` field will be omitted from the resulting object. - `principal_object_id` (`string`): The object ID of the member principal - `role_id` (`string`): The object ID of the directory role for this assignment - - `timeouts` (`obj`): 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.directory_role_assignment.timeouts.new](#fn-timeoutsnew) constructor. + - `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.directory_role_assignment.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -91,7 +91,7 @@ injecting into a complete block. - `directory_scope_object_id` (`string`): Identifier of the directory object representing the scope of the assignment When `null`, the `directory_scope_object_id` field will be omitted from the resulting object. - `principal_object_id` (`string`): The object ID of the member principal - `role_id` (`string`): The object ID of the directory role for this assignment - - `timeouts` (`obj`): 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.directory_role_assignment.timeouts.new](#fn-timeoutsnew) constructor. + - `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.directory_role_assignment.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `directory_role_assignment` resource into the root Terraform configuration. @@ -246,10 +246,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/directory_role_member.md b/docs/2.x/directory_role_member.md index 9ff3998..d36ecb9 100644 --- a/docs/2.x/directory_role_member.md +++ b/docs/2.x/directory_role_member.md @@ -53,7 +53,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `resourceLabel` (`string`): The name label of the block. - `member_object_id` (`string`): The object ID of the member When `null`, the `member_object_id` field will be omitted from the resulting object. - `role_object_id` (`string`): The object ID of the directory role When `null`, the `role_object_id` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.directory_role_member.timeouts.new](#fn-timeoutsnew) constructor. + - `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.directory_role_member.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -79,7 +79,7 @@ injecting into a complete block. **Args**: - `member_object_id` (`string`): The object ID of the member When `null`, the `member_object_id` field will be omitted from the resulting object. - `role_object_id` (`string`): The object ID of the directory role When `null`, the `role_object_id` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.directory_role_member.timeouts.new](#fn-timeoutsnew) constructor. + - `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.directory_role_member.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `directory_role_member` resource into the root Terraform configuration. @@ -170,10 +170,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/group.md b/docs/2.x/group.md index b0be266..9086dcd 100644 --- a/docs/2.x/group.md +++ b/docs/2.x/group.md @@ -90,7 +90,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `types` (`list`): A set of group types to configure for the group. `Unified` specifies a Microsoft 365 group. Required when `mail_enabled` is true When `null`, the `types` field will be omitted from the resulting object. - `visibility` (`string`): Specifies the group join policy and group content visibility When `null`, the `visibility` field will be omitted from the resulting object. - `dynamic_membership` (`list[obj]`): An optional block to configure dynamic membership for the group. Cannot be used with `members` When `null`, the `dynamic_membership` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.group.dynamic_membership.new](#fn-dynamic_membershipnew) constructor. - - `timeouts` (`obj`): 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.group.timeouts.new](#fn-timeoutsnew) constructor. + - `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.group.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -133,7 +133,7 @@ injecting into a complete block. - `types` (`list`): A set of group types to configure for the group. `Unified` specifies a Microsoft 365 group. Required when `mail_enabled` is true When `null`, the `types` field will be omitted from the resulting object. - `visibility` (`string`): Specifies the group join policy and group content visibility When `null`, the `visibility` field will be omitted from the resulting object. - `dynamic_membership` (`list[obj]`): An optional block to configure dynamic membership for the group. Cannot be used with `members` When `null`, the `dynamic_membership` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.group.dynamic_membership.new](#fn-dynamic_membershipnew) constructor. - - `timeouts` (`obj`): 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.group.timeouts.new](#fn-timeoutsnew) constructor. + - `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.group.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `group` resource into the root Terraform configuration. @@ -517,7 +517,7 @@ Terraform sub block. **Args**: - - `enabled` (`bool`): + - `enabled` (`bool`): Set the `enabled` field on the resulting object. - `rule` (`string`): Rule to determine members for a dynamic group. Required when `group_types` contains 'DynamicMembership' **Returns**: @@ -541,10 +541,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/group_member.md b/docs/2.x/group_member.md index ac5fa7d..b4d4dc4 100644 --- a/docs/2.x/group_member.md +++ b/docs/2.x/group_member.md @@ -53,7 +53,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `resourceLabel` (`string`): The name label of the block. - `group_object_id` (`string`): The object ID of the group you want to add the member to - `member_object_id` (`string`): The object ID of the principal you want to add as a member to the group. Supported object types are Users, Groups or Service Principals - - `timeouts` (`obj`): 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.group_member.timeouts.new](#fn-timeoutsnew) constructor. + - `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.group_member.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -79,7 +79,7 @@ injecting into a complete block. **Args**: - `group_object_id` (`string`): The object ID of the group you want to add the member to - `member_object_id` (`string`): The object ID of the principal you want to add as a member to the group. Supported object types are Users, Groups or Service Principals - - `timeouts` (`obj`): 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.group_member.timeouts.new](#fn-timeoutsnew) constructor. + - `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.group_member.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `group_member` resource into the root Terraform configuration. @@ -170,10 +170,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/invitation.md b/docs/2.x/invitation.md index cc11520..e55e05f 100644 --- a/docs/2.x/invitation.md +++ b/docs/2.x/invitation.md @@ -62,7 +62,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `user_email_address` (`string`): The email address of the user being invited - `user_type` (`string`): The user type of the user being invited When `null`, the `user_type` field will be omitted from the resulting object. - `message` (`list[obj]`): Customize the message sent to the invited user When `null`, the `message` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.invitation.message.new](#fn-messagenew) constructor. - - `timeouts` (`obj`): 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.invitation.timeouts.new](#fn-timeoutsnew) constructor. + - `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.invitation.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -91,7 +91,7 @@ injecting into a complete block. - `user_email_address` (`string`): The email address of the user being invited - `user_type` (`string`): The user type of the user being invited When `null`, the `user_type` field will be omitted from the resulting object. - `message` (`list[obj]`): Customize the message sent to the invited user When `null`, the `message` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.invitation.message.new](#fn-messagenew) constructor. - - `timeouts` (`obj`): 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.invitation.timeouts.new](#fn-timeoutsnew) constructor. + - `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.invitation.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `invitation` resource into the root Terraform configuration. @@ -276,10 +276,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/named_location.md b/docs/2.x/named_location.md index b691409..91f4fdf 100644 --- a/docs/2.x/named_location.md +++ b/docs/2.x/named_location.md @@ -58,10 +58,10 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `display_name` (`string`): - - `country` (`list[obj]`): When `null`, the `country` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.named_location.country.new](#fn-countrynew) constructor. - - `ip` (`list[obj]`): When `null`, the `ip` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.named_location.ip.new](#fn-ipnew) constructor. - - `timeouts` (`obj`): 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.named_location.timeouts.new](#fn-timeoutsnew) constructor. + - `display_name` (`string`): Set the `display_name` field on the resulting resource block. + - `country` (`list[obj]`): Set the `country` field on the resulting resource block. When `null`, the `country` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.named_location.country.new](#fn-countrynew) constructor. + - `ip` (`list[obj]`): Set the `ip` field on the resulting resource block. When `null`, the `ip` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.named_location.ip.new](#fn-ipnew) constructor. + - `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.named_location.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -85,10 +85,10 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `display_name` (`string`): - - `country` (`list[obj]`): When `null`, the `country` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.named_location.country.new](#fn-countrynew) constructor. - - `ip` (`list[obj]`): When `null`, the `ip` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.named_location.ip.new](#fn-ipnew) constructor. - - `timeouts` (`obj`): 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.named_location.timeouts.new](#fn-timeoutsnew) constructor. + - `display_name` (`string`): Set the `display_name` field on the resulting object. + - `country` (`list[obj]`): Set the `country` field on the resulting object. When `null`, the `country` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.named_location.country.new](#fn-countrynew) constructor. + - `ip` (`list[obj]`): Set the `ip` field on the resulting object. When `null`, the `ip` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.named_location.ip.new](#fn-ipnew) constructor. + - `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.named_location.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `named_location` resource into the root Terraform configuration. @@ -237,8 +237,8 @@ Terraform sub block. **Args**: - - `countries_and_regions` (`list`): - - `include_unknown_countries_and_regions` (`bool`): When `null`, the `include_unknown_countries_and_regions` field will be omitted from the resulting object. + - `countries_and_regions` (`list`): Set the `countries_and_regions` field on the resulting object. + - `include_unknown_countries_and_regions` (`bool`): Set the `include_unknown_countries_and_regions` field on the resulting object. When `null`, the `include_unknown_countries_and_regions` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `country` sub block. @@ -261,8 +261,8 @@ Terraform sub block. **Args**: - - `ip_ranges` (`list`): - - `trusted` (`bool`): When `null`, the `trusted` field will be omitted from the resulting object. + - `ip_ranges` (`list`): Set the `ip_ranges` field on the resulting object. + - `trusted` (`bool`): Set the `trusted` field on the resulting object. When `null`, the `trusted` field will be omitted from the resulting object. **Returns**: - An attribute object that represents the `ip` sub block. @@ -285,10 +285,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/service_principal.md b/docs/2.x/service_principal.md index 1d6a67b..c319e89 100644 --- a/docs/2.x/service_principal.md +++ b/docs/2.x/service_principal.md @@ -88,7 +88,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `feature_tags` (`list[obj]`): Block of features to configure for this service principal using tags When `null`, the `feature_tags` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.service_principal.feature_tags.new](#fn-feature_tagsnew) constructor. - `features` (`list[obj]`): Block of features to configure for this service principal using tags When `null`, the `features` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.service_principal.features.new](#fn-featuresnew) constructor. - `saml_single_sign_on` (`list[obj]`): Settings related to SAML single sign-on When `null`, the `saml_single_sign_on` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.service_principal.saml_single_sign_on.new](#fn-saml_single_sign_onnew) constructor. - - `timeouts` (`obj`): 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.service_principal.timeouts.new](#fn-timeoutsnew) constructor. + - `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.service_principal.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -127,7 +127,7 @@ injecting into a complete block. - `feature_tags` (`list[obj]`): Block of features to configure for this service principal using tags When `null`, the `feature_tags` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.service_principal.feature_tags.new](#fn-feature_tagsnew) constructor. - `features` (`list[obj]`): Block of features to configure for this service principal using tags When `null`, the `features` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.service_principal.features.new](#fn-featuresnew) constructor. - `saml_single_sign_on` (`list[obj]`): Settings related to SAML single sign-on When `null`, the `saml_single_sign_on` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.service_principal.saml_single_sign_on.new](#fn-saml_single_sign_onnew) constructor. - - `timeouts` (`obj`): 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.service_principal.timeouts.new](#fn-timeoutsnew) constructor. + - `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.service_principal.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `service_principal` resource into the root Terraform configuration. @@ -564,10 +564,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/service_principal_certificate.md b/docs/2.x/service_principal_certificate.md index b0a7567..a48c78b 100644 --- a/docs/2.x/service_principal_certificate.md +++ b/docs/2.x/service_principal_certificate.md @@ -65,7 +65,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `start_date` (`string`): The start date from which the certificate 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. - `type` (`string`): The type of key/certificate When `null`, the `type` field will be omitted from the resulting object. - `value` (`string`): The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER - - `timeouts` (`obj`): 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.service_principal_certificate.timeouts.new](#fn-timeoutsnew) constructor. + - `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.service_principal_certificate.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -97,7 +97,7 @@ injecting into a complete block. - `start_date` (`string`): The start date from which the certificate 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. - `type` (`string`): The type of key/certificate When `null`, the `type` field will be omitted from the resulting object. - `value` (`string`): The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER - - `timeouts` (`obj`): 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.service_principal_certificate.timeouts.new](#fn-timeoutsnew) constructor. + - `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.service_principal_certificate.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `service_principal_certificate` resource into the root Terraform configuration. @@ -284,10 +284,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/service_principal_delegated_permission_grant.md b/docs/2.x/service_principal_delegated_permission_grant.md index 1649580..e8a13fe 100644 --- a/docs/2.x/service_principal_delegated_permission_grant.md +++ b/docs/2.x/service_principal_delegated_permission_grant.md @@ -57,7 +57,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `resource_service_principal_object_id` (`string`): The object ID of the service principal representing the resource to be accessed - `service_principal_object_id` (`string`): The object ID of the service principal for which this delegated permission grant should be created - `user_object_id` (`string`): The object ID of the user on behalf of whom the service principal is authorized to access the resource When `null`, the `user_object_id` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.service_principal_delegated_permission_grant.timeouts.new](#fn-timeoutsnew) constructor. + - `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.service_principal_delegated_permission_grant.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -85,7 +85,7 @@ injecting into a complete block. - `resource_service_principal_object_id` (`string`): The object ID of the service principal representing the resource to be accessed - `service_principal_object_id` (`string`): The object ID of the service principal for which this delegated permission grant should be created - `user_object_id` (`string`): The object ID of the user on behalf of whom the service principal is authorized to access the resource When `null`, the `user_object_id` field will be omitted from the resulting object. - - `timeouts` (`obj`): 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.service_principal_delegated_permission_grant.timeouts.new](#fn-timeoutsnew) constructor. + - `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.service_principal_delegated_permission_grant.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `service_principal_delegated_permission_grant` resource into the root Terraform configuration. @@ -208,10 +208,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/service_principal_password.md b/docs/2.x/service_principal_password.md index 9bc0b0a..b0f4e84 100644 --- a/docs/2.x/service_principal_password.md +++ b/docs/2.x/service_principal_password.md @@ -61,7 +61,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `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. - `service_principal_id` (`string`): The object ID of the service principal for which this password should be created - `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`): 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.service_principal_password.timeouts.new](#fn-timeoutsnew) constructor. + - `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.service_principal_password.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -91,7 +91,7 @@ injecting into a complete block. - `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. - `service_principal_id` (`string`): The object ID of the service principal for which this password should be created - `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`): 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.service_principal_password.timeouts.new](#fn-timeoutsnew) constructor. + - `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.service_principal_password.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `service_principal_password` resource into the root Terraform configuration. @@ -246,10 +246,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/synchronization_job.md b/docs/2.x/synchronization_job.md index c765c34..6753e0a 100644 --- a/docs/2.x/synchronization_job.md +++ b/docs/2.x/synchronization_job.md @@ -55,7 +55,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `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`): 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](#fn-timeoutsnew) constructor. + - `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](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -82,7 +82,7 @@ injecting into a complete 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`): 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](#fn-timeoutsnew) constructor. + - `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](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `synchronization_job` resource into the root Terraform configuration. @@ -189,10 +189,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/synchronization_secret.md b/docs/2.x/synchronization_secret.md index 3a31ea8..931690d 100644 --- a/docs/2.x/synchronization_secret.md +++ b/docs/2.x/synchronization_secret.md @@ -55,8 +55,8 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - `service_principal_id` (`string`): The object ID of the service principal for which this synchronization secret should be created - - `credential` (`list[obj]`): When `null`, the `credential` 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_secret.credential.new](#fn-credentialnew) constructor. - - `timeouts` (`obj`): 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_secret.timeouts.new](#fn-timeoutsnew) constructor. + - `credential` (`list[obj]`): Set the `credential` field on the resulting resource block. When `null`, the `credential` 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_secret.credential.new](#fn-credentialnew) constructor. + - `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_secret.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -81,8 +81,8 @@ injecting into a complete block. **Args**: - `service_principal_id` (`string`): The object ID of the service principal for which this synchronization secret should be created - - `credential` (`list[obj]`): When `null`, the `credential` 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_secret.credential.new](#fn-credentialnew) constructor. - - `timeouts` (`obj`): 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_secret.timeouts.new](#fn-timeoutsnew) constructor. + - `credential` (`list[obj]`): Set the `credential` field on the resulting object. When `null`, the `credential` 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_secret.credential.new](#fn-credentialnew) constructor. + - `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_secret.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `synchronization_secret` resource into the root Terraform configuration. @@ -218,10 +218,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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. diff --git a/docs/2.x/user.md b/docs/2.x/user.md index 650949f..20d4af7 100644 --- a/docs/2.x/user.md +++ b/docs/2.x/user.md @@ -119,7 +119,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `surname` (`string`): The user's surname (family name or last name) When `null`, the `surname` field will be omitted from the resulting object. - `usage_location` (`string`): The usage location of the user. Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. The usage location is a two letter country code (ISO standard 3166). Examples include: `NO`, `JP`, and `GB`. Cannot be reset to null once set When `null`, the `usage_location` field will be omitted from the resulting object. - `user_principal_name` (`string`): The user principal name (UPN) of the user - - `timeouts` (`obj`): 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.user.timeouts.new](#fn-timeoutsnew) constructor. + - `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.user.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - A mixin object that injects the new resource into the root Terraform configuration. @@ -178,7 +178,7 @@ injecting into a complete block. - `surname` (`string`): The user's surname (family name or last name) When `null`, the `surname` field will be omitted from the resulting object. - `usage_location` (`string`): The usage location of the user. Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries. The usage location is a two letter country code (ISO standard 3166). Examples include: `NO`, `JP`, and `GB`. Cannot be reset to null once set When `null`, the `usage_location` field will be omitted from the resulting object. - `user_principal_name` (`string`): The user principal name (UPN) of the user - - `timeouts` (`obj`): 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.user.timeouts.new](#fn-timeoutsnew) constructor. + - `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.user.timeouts.new](#fn-timeoutsnew) constructor. **Returns**: - An attribute object that can be used with [tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) to construct a new `user` resource into the root Terraform configuration. @@ -797,10 +797,10 @@ Terraform sub block. **Args**: - - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object. - - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object. - - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object. - - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object. + - `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.