diff --git a/2.x/_gen/data/application.libsonnet b/2.x/_gen/data/application.libsonnet index 5c26fe1..8144a7b 100644 --- a/2.x/_gen/data/application.libsonnet +++ b/2.x/_gen/data/application.libsonnet @@ -2,10 +2,11 @@ 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`): 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':: 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 - `client_id` (`string`): The Client ID (also called Application ID) When `null`, the `client_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, + client_id=null, display_name=null, object_id=null, timeouts=null, @@ -15,20 +16,23 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); label=dataSrcLabel, attrs=self.newAttrs( application_id=application_id, + client_id=client_id, display_name=display_name, object_id=object_id, timeouts=timeouts ), _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`): 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':: 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 - `client_id` (`string`): The Client ID (also called Application ID) When `null`, the `client_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, + client_id=null, display_name=null, object_id=null, timeouts=null ):: std.prune(a={ application_id: application_id, + client_id: client_id, display_name: display_name, object_id: object_id, timeouts: timeouts, @@ -51,6 +55,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withClientId':: d.fn(help='`azuread.string.withClientId` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the client_id field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `client_id` field.\n', args=[]), + withClientId(dataSrcLabel, value): { + data+: { + azuread_application+: { + [dataSrcLabel]+: { + client_id: value, + }, + }, + }, + }, '#withDisplayName':: d.fn(help='`azuread.string.withDisplayName` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the display_name field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `display_name` field.\n', args=[]), withDisplayName(dataSrcLabel, value): { data+: { diff --git a/2.x/_gen/data/service_principal.libsonnet b/2.x/_gen/data/service_principal.libsonnet index 7fa7c1b..b294184 100644 --- a/2.x/_gen/data/service_principal.libsonnet +++ b/2.x/_gen/data/service_principal.libsonnet @@ -2,10 +2,11 @@ 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`): 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':: 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 - `client_id` (`string`): The client ID of the application associated with this service principal When `null`, the `client_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, + client_id=null, display_name=null, object_id=null, timeouts=null, @@ -15,20 +16,23 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); label=dataSrcLabel, attrs=self.newAttrs( application_id=application_id, + client_id=client_id, display_name=display_name, object_id=object_id, timeouts=timeouts ), _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`): 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':: 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 - `client_id` (`string`): The client ID of the application associated with this service principal When `null`, the `client_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, + client_id=null, display_name=null, object_id=null, timeouts=null ):: std.prune(a={ application_id: application_id, + client_id: client_id, display_name: display_name, object_id: object_id, timeouts: timeouts, @@ -51,6 +55,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withClientId':: d.fn(help='`azuread.string.withClientId` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the client_id field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `client_id` field.\n', args=[]), + withClientId(dataSrcLabel, value): { + data+: { + azuread_service_principal+: { + [dataSrcLabel]+: { + client_id: value, + }, + }, + }, + }, '#withDisplayName':: d.fn(help='`azuread.string.withDisplayName` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the display_name field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `display_name` field.\n', args=[]), withDisplayName(dataSrcLabel, value): { data+: { diff --git a/2.x/_gen/data/service_principals.libsonnet b/2.x/_gen/data/service_principals.libsonnet index a3c99ee..fa036b5 100644 --- a/2.x/_gen/data/service_principals.libsonnet +++ b/2.x/_gen/data/service_principals.libsonnet @@ -2,10 +2,11 @@ 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`): 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':: 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 - `client_ids` (`list`): The client IDs of the applications associated with the service principals When `null`, the `client_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, + client_ids=null, display_names=null, ignore_missing=null, object_ids=null, @@ -17,6 +18,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); label=dataSrcLabel, attrs=self.newAttrs( application_ids=application_ids, + client_ids=client_ids, display_names=display_names, ignore_missing=ignore_missing, object_ids=object_ids, @@ -25,9 +27,10 @@ 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`): 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':: 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 - `client_ids` (`list`): The client IDs of the applications associated with the service principals When `null`, the `client_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, + client_ids=null, display_names=null, ignore_missing=null, object_ids=null, @@ -35,6 +38,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts=null ):: std.prune(a={ application_ids: application_ids, + client_ids: client_ids, display_names: display_names, ignore_missing: ignore_missing, object_ids: object_ids, @@ -59,6 +63,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withClientIds':: d.fn(help='`azuread.list.withClientIds` constructs a mixin object that can be merged into the `list`\nTerraform data source block to set or update the client_ids field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `client_ids` field.\n', args=[]), + withClientIds(dataSrcLabel, value): { + data+: { + azuread_service_principals+: { + [dataSrcLabel]+: { + client_ids: value, + }, + }, + }, + }, '#withDisplayNames':: d.fn(help='`azuread.list.withDisplayNames` constructs a mixin object that can be merged into the `list`\nTerraform data source block to set or update the display_names field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `display_names` field.\n', args=[]), withDisplayNames(dataSrcLabel, value): { data+: { diff --git a/2.x/_gen/main.libsonnet b/2.x/_gen/main.libsonnet index 12b87fa..ff17948 100644 --- a/2.x/_gen/main.libsonnet +++ b/2.x/_gen/main.libsonnet @@ -13,15 +13,28 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); administrative_unit_role_member: (import 'resources/administrative_unit_role_member.libsonnet'), app_role_assignment: (import 'resources/app_role_assignment.libsonnet'), application: (import 'resources/application.libsonnet'), + application_api_access: (import 'resources/application_api_access.libsonnet'), + application_app_role: (import 'resources/application_app_role.libsonnet'), application_certificate: (import 'resources/application_certificate.libsonnet'), + application_fallback_public_client: (import 'resources/application_fallback_public_client.libsonnet'), application_federated_identity_credential: (import 'resources/application_federated_identity_credential.libsonnet'), + application_from_template: (import 'resources/application_from_template.libsonnet'), + application_identifier_uri: (import 'resources/application_identifier_uri.libsonnet'), + application_known_clients: (import 'resources/application_known_clients.libsonnet'), + application_optional_claims: (import 'resources/application_optional_claims.libsonnet'), + application_owner: (import 'resources/application_owner.libsonnet'), application_password: (import 'resources/application_password.libsonnet'), + application_permission_scope: (import 'resources/application_permission_scope.libsonnet'), application_pre_authorized: (import 'resources/application_pre_authorized.libsonnet'), + application_redirect_uris: (import 'resources/application_redirect_uris.libsonnet'), + application_registration: (import 'resources/application_registration.libsonnet'), + authentication_strength_policy: (import 'resources/authentication_strength_policy.libsonnet'), claims_mapping_policy: (import 'resources/claims_mapping_policy.libsonnet'), conditional_access_policy: (import 'resources/conditional_access_policy.libsonnet'), custom_directory_role: (import 'resources/custom_directory_role.libsonnet'), directory_role: (import 'resources/directory_role.libsonnet'), directory_role_assignment: (import 'resources/directory_role_assignment.libsonnet'), + directory_role_eligibility_schedule_request: (import 'resources/directory_role_eligibility_schedule_request.libsonnet'), directory_role_member: (import 'resources/directory_role_member.libsonnet'), group: (import 'resources/group.libsonnet'), group_member: (import 'resources/group_member.libsonnet'), diff --git a/2.x/_gen/resources/application_api_access.libsonnet b/2.x/_gen/resources/application_api_access.libsonnet new file mode 100644 index 0000000..88ac153 --- /dev/null +++ b/2.x/_gen/resources/application_api_access.libsonnet @@ -0,0 +1,114 @@ +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_api_access', url='', help='`application_api_access` represents the `azuread_application_api_access` 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_api_access.new` injects a new `azuread_application_api_access` 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_api_access.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application_api_access` using the reference:\n\n $._ref.azuread_application_api_access.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application_api_access.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 - `api_client_id` (`string`): The client ID of the API to which access is being granted\n - `application_id` (`string`): The resource ID of the application to which this API access is granted\n - `role_ids` (`list`): A set of role IDs to be granted to the application, as published by the API When `null`, the `role_ids` field will be omitted from the resulting object.\n - `scope_ids` (`list`): A set of scope IDs to be granted to the application, as published by the API When `null`, the `scope_ids` 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_api_access.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, + api_client_id, + application_id, + role_ids=null, + scope_ids=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='azuread_application_api_access', + label=resourceLabel, + attrs=self.newAttrs( + api_client_id=api_client_id, + application_id=application_id, + role_ids=role_ids, + scope_ids=scope_ids, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`azuread.application_api_access.newAttrs` constructs a new object with attributes and blocks configured for the `application_api_access`\nTerraform resource.\n\nUnlike [azuread.application_api_access.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 - `api_client_id` (`string`): The client ID of the API to which access is being granted\n - `application_id` (`string`): The resource ID of the application to which this API access is granted\n - `role_ids` (`list`): A set of role IDs to be granted to the application, as published by the API When `null`, the `role_ids` field will be omitted from the resulting object.\n - `scope_ids` (`list`): A set of scope IDs to be granted to the application, as published by the API When `null`, the `scope_ids` 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_api_access.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_api_access` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + api_client_id, + application_id, + role_ids=null, + scope_ids=null, + timeouts=null + ):: std.prune(a={ + api_client_id: api_client_id, + application_id: application_id, + role_ids: role_ids, + scope_ids: scope_ids, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`azuread.application_api_access.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, + read=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + read: read, + update: update, + }), + }, + '#withApiClientId':: d.fn(help='`azuread.string.withApiClientId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the api_client_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `api_client_id` field.\n', args=[]), + withApiClientId(resourceLabel, value): { + resource+: { + azuread_application_api_access+: { + [resourceLabel]+: { + api_client_id: value, + }, + }, + }, + }, + '#withApplicationId':: d.fn(help='`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `application_id` field.\n', args=[]), + withApplicationId(resourceLabel, value): { + resource+: { + azuread_application_api_access+: { + [resourceLabel]+: { + application_id: value, + }, + }, + }, + }, + '#withRoleIds':: d.fn(help='`azuread.list.withRoleIds` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the role_ids field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `role_ids` field.\n', args=[]), + withRoleIds(resourceLabel, value): { + resource+: { + azuread_application_api_access+: { + [resourceLabel]+: { + role_ids: value, + }, + }, + }, + }, + '#withScopeIds':: d.fn(help='`azuread.list.withScopeIds` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the scope_ids field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `scope_ids` field.\n', args=[]), + withScopeIds(resourceLabel, value): { + resource+: { + azuread_application_api_access+: { + [resourceLabel]+: { + scope_ids: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + azuread_application_api_access+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + azuread_application_api_access+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/2.x/_gen/resources/application_app_role.libsonnet b/2.x/_gen/resources/application_app_role.libsonnet new file mode 100644 index 0000000..bd56f74 --- /dev/null +++ b/2.x/_gen/resources/application_app_role.libsonnet @@ -0,0 +1,142 @@ +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_app_role', url='', help='`application_app_role` represents the `azuread_application_app_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.application_app_role.new` injects a new `azuread_application_app_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.application_app_role.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application_app_role` using the reference:\n\n $._ref.azuread_application_app_role.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application_app_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 - `allowed_member_types` (`list`): Specifies whether this app role definition can be assigned to users and groups by setting to `User`, or to other applications (that are accessing this application in a standalone scenario) by setting to `Application`, or to both\n - `application_id` (`string`): The resource ID of the application to which this app role should be applied\n - `description` (`string`): Description of the app role that appears when the role is being assigned and, if the role functions as an application permissions, during the consent experiences\n - `display_name` (`string`): Display name for the app role that appears during app role assignment and in consent experiences\n - `role_id` (`string`): The unique identifier of the app role\n - `value` (`string`): The value that is used for the `roles` claim in ID tokens and OAuth access tokens that are authenticating an assigned service or user principal When `null`, the `value` 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_app_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, + allowed_member_types, + application_id, + description, + display_name, + role_id, + timeouts=null, + value=null, + _meta={} + ):: tf.withResource( + type='azuread_application_app_role', + label=resourceLabel, + attrs=self.newAttrs( + allowed_member_types=allowed_member_types, + application_id=application_id, + description=description, + display_name=display_name, + role_id=role_id, + timeouts=timeouts, + value=value + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`azuread.application_app_role.newAttrs` constructs a new object with attributes and blocks configured for the `application_app_role`\nTerraform resource.\n\nUnlike [azuread.application_app_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 - `allowed_member_types` (`list`): Specifies whether this app role definition can be assigned to users and groups by setting to `User`, or to other applications (that are accessing this application in a standalone scenario) by setting to `Application`, or to both\n - `application_id` (`string`): The resource ID of the application to which this app role should be applied\n - `description` (`string`): Description of the app role that appears when the role is being assigned and, if the role functions as an application permissions, during the consent experiences\n - `display_name` (`string`): Display name for the app role that appears during app role assignment and in consent experiences\n - `role_id` (`string`): The unique identifier of the app role\n - `value` (`string`): The value that is used for the `roles` claim in ID tokens and OAuth access tokens that are authenticating an assigned service or user principal When `null`, the `value` 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_app_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 `application_app_role` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + allowed_member_types, + application_id, + description, + display_name, + role_id, + timeouts=null, + value=null + ):: std.prune(a={ + allowed_member_types: allowed_member_types, + application_id: application_id, + description: description, + display_name: display_name, + role_id: role_id, + timeouts: timeouts, + value: value, + }), + timeouts:: { + '#new':: d.fn(help='\n`azuread.application_app_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, + read=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + read: read, + update: update, + }), + }, + '#withAllowedMemberTypes':: d.fn(help='`azuread.list.withAllowedMemberTypes` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the allowed_member_types field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `allowed_member_types` field.\n', args=[]), + withAllowedMemberTypes(resourceLabel, value): { + resource+: { + azuread_application_app_role+: { + [resourceLabel]+: { + allowed_member_types: value, + }, + }, + }, + }, + '#withApplicationId':: d.fn(help='`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `application_id` field.\n', args=[]), + withApplicationId(resourceLabel, value): { + resource+: { + azuread_application_app_role+: { + [resourceLabel]+: { + application_id: value, + }, + }, + }, + }, + '#withDescription':: d.fn(help='`azuread.string.withDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `description` field.\n', args=[]), + withDescription(resourceLabel, value): { + resource+: { + azuread_application_app_role+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withDisplayName':: d.fn(help='`azuread.string.withDisplayName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the display_name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `display_name` field.\n', args=[]), + withDisplayName(resourceLabel, value): { + resource+: { + azuread_application_app_role+: { + [resourceLabel]+: { + display_name: value, + }, + }, + }, + }, + '#withRoleId':: d.fn(help='`azuread.string.withRoleId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the role_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `role_id` field.\n', args=[]), + withRoleId(resourceLabel, value): { + resource+: { + azuread_application_app_role+: { + [resourceLabel]+: { + role_id: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + azuread_application_app_role+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + azuread_application_app_role+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withValue':: d.fn(help='`azuread.string.withValue` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the value field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `value` field.\n', args=[]), + withValue(resourceLabel, value): { + resource+: { + azuread_application_app_role+: { + [resourceLabel]+: { + value: value, + }, + }, + }, + }, +} diff --git a/2.x/_gen/resources/application_certificate.libsonnet b/2.x/_gen/resources/application_certificate.libsonnet index bc4bb5a..e5dc958 100644 --- a/2.x/_gen/resources/application_certificate.libsonnet +++ b/2.x/_gen/resources/application_certificate.libsonnet @@ -2,11 +2,12 @@ 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`): 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':: 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_id` (`string`): The resource ID of the application for which this certificate should be created When `null`, the `application_id` field will be omitted from the resulting object.\n - `application_object_id` (`string`): The object ID of the application for which this certificate should be created When `null`, the `application_object_id` field will be omitted from the resulting object.\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` argument\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, value, + application_id=null, + application_object_id=null, encoding=null, end_date=null, end_date_relative=null, @@ -19,6 +20,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type='azuread_application_certificate', label=resourceLabel, attrs=self.newAttrs( + application_id=application_id, application_object_id=application_object_id, encoding=encoding, end_date=end_date, @@ -31,10 +33,11 @@ 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`): 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':: 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_id` (`string`): The resource ID of the application for which this certificate should be created When `null`, the `application_id` field will be omitted from the resulting object.\n - `application_object_id` (`string`): The object ID of the application for which this certificate should be created When `null`, the `application_object_id` field will be omitted from the resulting object.\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` argument\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, + application_id=null, + application_object_id=null, encoding=null, end_date=null, end_date_relative=null, @@ -43,6 +46,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts=null, type=null ):: std.prune(a={ + application_id: application_id, application_object_id: application_object_id, encoding: encoding, end_date: end_date, @@ -67,6 +71,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); update: update, }), }, + '#withApplicationId':: d.fn(help='`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `application_id` field.\n', args=[]), + withApplicationId(resourceLabel, value): { + resource+: { + azuread_application_certificate+: { + [resourceLabel]+: { + application_id: value, + }, + }, + }, + }, '#withApplicationObjectId':: d.fn(help='`azuread.string.withApplicationObjectId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_object_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `application_object_id` field.\n', args=[]), withApplicationObjectId(resourceLabel, value): { resource+: { diff --git a/2.x/_gen/resources/application_fallback_public_client.libsonnet b/2.x/_gen/resources/application_fallback_public_client.libsonnet new file mode 100644 index 0000000..d58014a --- /dev/null +++ b/2.x/_gen/resources/application_fallback_public_client.libsonnet @@ -0,0 +1,80 @@ +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_fallback_public_client', url='', help='`application_fallback_public_client` represents the `azuread_application_fallback_public_client` 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_fallback_public_client.new` injects a new `azuread_application_fallback_public_client` 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_fallback_public_client.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application_fallback_public_client` using the reference:\n\n $._ref.azuread_application_fallback_public_client.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application_fallback_public_client.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_id` (`string`): The resource ID of the application to which the fallback public client setting should be applied\n - `enabled` (`bool`): Specifies explicitly 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 `enabled` 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_fallback_public_client.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, + enabled=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='azuread_application_fallback_public_client', + label=resourceLabel, + attrs=self.newAttrs(application_id=application_id, enabled=enabled, timeouts=timeouts), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`azuread.application_fallback_public_client.newAttrs` constructs a new object with attributes and blocks configured for the `application_fallback_public_client`\nTerraform resource.\n\nUnlike [azuread.application_fallback_public_client.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_id` (`string`): The resource ID of the application to which the fallback public client setting should be applied\n - `enabled` (`bool`): Specifies explicitly whether the application is a public client. Appropriate for apps using token grant flows that don't use a redirect URI When `null`, the `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.application_fallback_public_client.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_fallback_public_client` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + application_id, + enabled=null, + timeouts=null + ):: std.prune(a={ + application_id: application_id, + enabled: enabled, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`azuread.application_fallback_public_client.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, + read=null + ):: std.prune(a={ + create: create, + delete: delete, + read: read, + }), + }, + '#withApplicationId':: d.fn(help='`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `application_id` field.\n', args=[]), + withApplicationId(resourceLabel, value): { + resource+: { + azuread_application_fallback_public_client+: { + [resourceLabel]+: { + application_id: value, + }, + }, + }, + }, + '#withEnabled':: d.fn(help='`azuread.bool.withEnabled` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the enabled field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`bool`): The value to set for the `enabled` field.\n', args=[]), + withEnabled(resourceLabel, value): { + resource+: { + azuread_application_fallback_public_client+: { + [resourceLabel]+: { + enabled: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + azuread_application_fallback_public_client+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + azuread_application_fallback_public_client+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/2.x/_gen/resources/application_federated_identity_credential.libsonnet b/2.x/_gen/resources/application_federated_identity_credential.libsonnet index 669dda3..8c74092 100644 --- a/2.x/_gen/resources/application_federated_identity_credential.libsonnet +++ b/2.x/_gen/resources/application_federated_identity_credential.libsonnet @@ -2,14 +2,15 @@ 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`): 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':: 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_id` (`string`): The resource ID of the application for which this federated identity credential should be created When `null`, the `application_id` field will be omitted from the resulting object.\n - `application_object_id` (`string`): The object ID of the application for which this federated identity credential should be created When `null`, the `application_object_id` field will be omitted from the resulting object.\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, audiences, display_name, issuer, subject, + application_id=null, + application_object_id=null, description=null, timeouts=null, _meta={} @@ -17,6 +18,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type='azuread_application_federated_identity_credential', label=resourceLabel, attrs=self.newAttrs( + application_id=application_id, application_object_id=application_object_id, audiences=audiences, description=description, @@ -27,16 +29,18 @@ 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`): 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':: 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_id` (`string`): The resource ID of the application for which this federated identity credential should be created When `null`, the `application_id` field will be omitted from the resulting object.\n - `application_object_id` (`string`): The object ID of the application for which this federated identity credential should be created When `null`, the `application_object_id` field will be omitted from the resulting object.\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, display_name, issuer, subject, + application_id=null, + application_object_id=null, description=null, timeouts=null ):: std.prune(a={ + application_id: application_id, application_object_id: application_object_id, audiences: audiences, description: description, @@ -59,6 +63,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); update: update, }), }, + '#withApplicationId':: d.fn(help='`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `application_id` field.\n', args=[]), + withApplicationId(resourceLabel, value): { + resource+: { + azuread_application_federated_identity_credential+: { + [resourceLabel]+: { + application_id: value, + }, + }, + }, + }, '#withApplicationObjectId':: d.fn(help='`azuread.string.withApplicationObjectId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_object_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `application_object_id` field.\n', args=[]), withApplicationObjectId(resourceLabel, value): { resource+: { diff --git a/2.x/_gen/resources/application_from_template.libsonnet b/2.x/_gen/resources/application_from_template.libsonnet new file mode 100644 index 0000000..60bf39f --- /dev/null +++ b/2.x/_gen/resources/application_from_template.libsonnet @@ -0,0 +1,82 @@ +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_from_template', url='', help='`application_from_template` represents the `azuread_application_from_template` 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_from_template.new` injects a new `azuread_application_from_template` 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_from_template.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application_from_template` using the reference:\n\n $._ref.azuread_application_from_template.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application_from_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 - `resourceLabel` (`string`): The name label of the block.\n - `display_name` (`string`): The display name for the application\n - `template_id` (`string`): The UUID of the template to instantiate for this 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_from_template.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, + template_id, + timeouts=null, + _meta={} + ):: tf.withResource( + type='azuread_application_from_template', + label=resourceLabel, + attrs=self.newAttrs(display_name=display_name, template_id=template_id, timeouts=timeouts), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`azuread.application_from_template.newAttrs` constructs a new object with attributes and blocks configured for the `application_from_template`\nTerraform resource.\n\nUnlike [azuread.application_from_template.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 for the application\n - `template_id` (`string`): The UUID of the template to instantiate for this 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_from_template.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_from_template` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + display_name, + template_id, + timeouts=null + ):: std.prune(a={ + display_name: display_name, + template_id: template_id, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`azuread.application_from_template.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, + read=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + read: read, + update: update, + }), + }, + '#withDisplayName':: d.fn(help='`azuread.string.withDisplayName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the display_name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `display_name` field.\n', args=[]), + withDisplayName(resourceLabel, value): { + resource+: { + azuread_application_from_template+: { + [resourceLabel]+: { + display_name: value, + }, + }, + }, + }, + '#withTemplateId':: d.fn(help='`azuread.string.withTemplateId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the template_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `template_id` field.\n', args=[]), + withTemplateId(resourceLabel, value): { + resource+: { + azuread_application_from_template+: { + [resourceLabel]+: { + template_id: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + azuread_application_from_template+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + azuread_application_from_template+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/2.x/_gen/resources/application_identifier_uri.libsonnet b/2.x/_gen/resources/application_identifier_uri.libsonnet new file mode 100644 index 0000000..5ed9630 --- /dev/null +++ b/2.x/_gen/resources/application_identifier_uri.libsonnet @@ -0,0 +1,80 @@ +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_identifier_uri', url='', help='`application_identifier_uri` represents the `azuread_application_identifier_uri` 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_identifier_uri.new` injects a new `azuread_application_identifier_uri` 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_identifier_uri.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application_identifier_uri` using the reference:\n\n $._ref.azuread_application_identifier_uri.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application_identifier_uri.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_id` (`string`): The resource ID of the application to which the identifier URI should be added\n - `identifier_uri` (`string`): The user-defined URI that uniquely identifies an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant\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_identifier_uri.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, + identifier_uri, + timeouts=null, + _meta={} + ):: tf.withResource( + type='azuread_application_identifier_uri', + label=resourceLabel, + attrs=self.newAttrs(application_id=application_id, identifier_uri=identifier_uri, timeouts=timeouts), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`azuread.application_identifier_uri.newAttrs` constructs a new object with attributes and blocks configured for the `application_identifier_uri`\nTerraform resource.\n\nUnlike [azuread.application_identifier_uri.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_id` (`string`): The resource ID of the application to which the identifier URI should be added\n - `identifier_uri` (`string`): The user-defined URI that uniquely identifies an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant\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_identifier_uri.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_identifier_uri` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + application_id, + identifier_uri, + timeouts=null + ):: std.prune(a={ + application_id: application_id, + identifier_uri: identifier_uri, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`azuread.application_identifier_uri.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, + read=null + ):: std.prune(a={ + create: create, + delete: delete, + read: read, + }), + }, + '#withApplicationId':: d.fn(help='`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `application_id` field.\n', args=[]), + withApplicationId(resourceLabel, value): { + resource+: { + azuread_application_identifier_uri+: { + [resourceLabel]+: { + application_id: value, + }, + }, + }, + }, + '#withIdentifierUri':: d.fn(help='`azuread.string.withIdentifierUri` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the identifier_uri field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `identifier_uri` field.\n', args=[]), + withIdentifierUri(resourceLabel, value): { + resource+: { + azuread_application_identifier_uri+: { + [resourceLabel]+: { + identifier_uri: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + azuread_application_identifier_uri+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + azuread_application_identifier_uri+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/2.x/_gen/resources/application_known_clients.libsonnet b/2.x/_gen/resources/application_known_clients.libsonnet new file mode 100644 index 0000000..42df302 --- /dev/null +++ b/2.x/_gen/resources/application_known_clients.libsonnet @@ -0,0 +1,82 @@ +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_known_clients', url='', help='`application_known_clients` represents the `azuread_application_known_clients` 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_known_clients.new` injects a new `azuread_application_known_clients` 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_known_clients.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application_known_clients` using the reference:\n\n $._ref.azuread_application_known_clients.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application_known_clients.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_id` (`string`): The resource ID of the application to which this API access is granted\n - `known_client_ids` (`list`): A list of known client IDs, used for bundling consent if you have a solution that includes an API and a client 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_known_clients.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, + known_client_ids, + timeouts=null, + _meta={} + ):: tf.withResource( + type='azuread_application_known_clients', + label=resourceLabel, + attrs=self.newAttrs(application_id=application_id, known_client_ids=known_client_ids, timeouts=timeouts), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`azuread.application_known_clients.newAttrs` constructs a new object with attributes and blocks configured for the `application_known_clients`\nTerraform resource.\n\nUnlike [azuread.application_known_clients.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_id` (`string`): The resource ID of the application to which this API access is granted\n - `known_client_ids` (`list`): A list of known client IDs, used for bundling consent if you have a solution that includes an API and a client 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_known_clients.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_known_clients` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + application_id, + known_client_ids, + timeouts=null + ):: std.prune(a={ + application_id: application_id, + known_client_ids: known_client_ids, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`azuread.application_known_clients.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, + read=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + read: read, + update: update, + }), + }, + '#withApplicationId':: d.fn(help='`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `application_id` field.\n', args=[]), + withApplicationId(resourceLabel, value): { + resource+: { + azuread_application_known_clients+: { + [resourceLabel]+: { + application_id: value, + }, + }, + }, + }, + '#withKnownClientIds':: d.fn(help='`azuread.list.withKnownClientIds` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the known_client_ids field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `known_client_ids` field.\n', args=[]), + withKnownClientIds(resourceLabel, value): { + resource+: { + azuread_application_known_clients+: { + [resourceLabel]+: { + known_client_ids: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + azuread_application_known_clients+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + azuread_application_known_clients+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/2.x/_gen/resources/application_optional_claims.libsonnet b/2.x/_gen/resources/application_optional_claims.libsonnet new file mode 100644 index 0000000..a96ad87 --- /dev/null +++ b/2.x/_gen/resources/application_optional_claims.libsonnet @@ -0,0 +1,186 @@ +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_optional_claims', url='', help='`application_optional_claims` represents the `azuread_application_optional_claims` Terraform resource.\n\n\n\nThis package contains functions and utilities for setting up the resource using Jsonnet code.\n'), + access_token:: { + '#new':: d.fn(help='\n`azuread.application_optional_claims.access_token.new` constructs a new object with attributes and blocks configured for the `access_token`\nTerraform sub block.\n\n\n\n**Args**:\n - `additional_properties` (`list`): List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim When `null`, the `additional_properties` field will be omitted from the resulting object.\n - `essential` (`bool`): Whether the claim specified by the client is necessary to ensure a smooth authorization experience When `null`, the `essential` field will be omitted from the resulting object.\n - `name` (`string`): The name of the optional claim\n - `source` (`string`): The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object When `null`, the `source` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `access_token` sub block.\n', args=[]), + new( + name, + additional_properties=null, + essential=null, + source=null + ):: std.prune(a={ + additional_properties: additional_properties, + essential: essential, + name: name, + source: source, + }), + }, + id_token:: { + '#new':: d.fn(help='\n`azuread.application_optional_claims.id_token.new` constructs a new object with attributes and blocks configured for the `id_token`\nTerraform sub block.\n\n\n\n**Args**:\n - `additional_properties` (`list`): List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim When `null`, the `additional_properties` field will be omitted from the resulting object.\n - `essential` (`bool`): Whether the claim specified by the client is necessary to ensure a smooth authorization experience When `null`, the `essential` field will be omitted from the resulting object.\n - `name` (`string`): The name of the optional claim\n - `source` (`string`): The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object When `null`, the `source` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `id_token` sub block.\n', args=[]), + new( + name, + additional_properties=null, + essential=null, + source=null + ):: std.prune(a={ + additional_properties: additional_properties, + essential: essential, + name: name, + source: source, + }), + }, + '#new':: d.fn(help="\n`azuread.application_optional_claims.new` injects a new `azuread_application_optional_claims` 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_optional_claims.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application_optional_claims` using the reference:\n\n $._ref.azuread_application_optional_claims.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application_optional_claims.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_id` (`string`): The resource ID of the application to which these optional claims belong\n - `access_token` (`list[obj]`): Set the `access_token` field on the resulting resource block. 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-access_tokennew) constructor.\n - `id_token` (`list[obj]`): Set the `id_token` field on the resulting resource block. 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-id_tokennew) constructor.\n - `saml2_token` (`list[obj]`): Set the `saml2_token` field on the resulting resource block. 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-saml2_tokennew) 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_optional_claims.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, + access_token=null, + id_token=null, + saml2_token=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='azuread_application_optional_claims', + label=resourceLabel, + attrs=self.newAttrs( + access_token=access_token, + application_id=application_id, + id_token=id_token, + saml2_token=saml2_token, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`azuread.application_optional_claims.newAttrs` constructs a new object with attributes and blocks configured for the `application_optional_claims`\nTerraform resource.\n\nUnlike [azuread.application_optional_claims.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_id` (`string`): The resource ID of the application to which these optional claims belong\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-access_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-id_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-saml2_tokennew) 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_optional_claims.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_optional_claims` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + application_id, + access_token=null, + id_token=null, + saml2_token=null, + timeouts=null + ):: std.prune(a={ + access_token: access_token, + application_id: application_id, + id_token: id_token, + saml2_token: saml2_token, + timeouts: timeouts, + }), + saml2_token:: { + '#new':: d.fn(help='\n`azuread.application_optional_claims.saml2_token.new` constructs a new object with attributes and blocks configured for the `saml2_token`\nTerraform sub block.\n\n\n\n**Args**:\n - `additional_properties` (`list`): List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim When `null`, the `additional_properties` field will be omitted from the resulting object.\n - `essential` (`bool`): Whether the claim specified by the client is necessary to ensure a smooth authorization experience When `null`, the `essential` field will be omitted from the resulting object.\n - `name` (`string`): The name of the optional claim\n - `source` (`string`): The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object When `null`, the `source` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `saml2_token` sub block.\n', args=[]), + new( + name, + additional_properties=null, + essential=null, + source=null + ):: std.prune(a={ + additional_properties: additional_properties, + essential: essential, + name: name, + source: source, + }), + }, + timeouts:: { + '#new':: d.fn(help='\n`azuread.application_optional_claims.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, + read=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + read: read, + update: update, + }), + }, + '#withAccessToken':: d.fn(help='`azuread.list[obj].withAccessToken` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the access_token field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [azuread.list[obj].withAccessTokenMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `access_token` field.\n', args=[]), + withAccessToken(resourceLabel, value): { + resource+: { + azuread_application_optional_claims+: { + [resourceLabel]+: { + access_token: value, + }, + }, + }, + }, + '#withAccessTokenMixin':: d.fn(help='`azuread.list[obj].withAccessTokenMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the access_token field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [azuread.list[obj].withAccessToken](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `access_token` field.\n', args=[]), + withAccessTokenMixin(resourceLabel, value): { + resource+: { + azuread_application_optional_claims+: { + [resourceLabel]+: { + access_token+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withApplicationId':: d.fn(help='`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `application_id` field.\n', args=[]), + withApplicationId(resourceLabel, value): { + resource+: { + azuread_application_optional_claims+: { + [resourceLabel]+: { + application_id: value, + }, + }, + }, + }, + '#withIdToken':: d.fn(help='`azuread.list[obj].withIdToken` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the id_token field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [azuread.list[obj].withIdTokenMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `id_token` field.\n', args=[]), + withIdToken(resourceLabel, value): { + resource+: { + azuread_application_optional_claims+: { + [resourceLabel]+: { + id_token: value, + }, + }, + }, + }, + '#withIdTokenMixin':: d.fn(help='`azuread.list[obj].withIdTokenMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the id_token field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [azuread.list[obj].withIdToken](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `id_token` field.\n', args=[]), + withIdTokenMixin(resourceLabel, value): { + resource+: { + azuread_application_optional_claims+: { + [resourceLabel]+: { + id_token+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withSaml2Token':: d.fn(help='`azuread.list[obj].withSaml2Token` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the saml2_token field.\n\nThis function will replace the array with the passed in `value`. If you wish to instead append the\npassed in value to the existing array, use the [azuread.list[obj].withSaml2TokenMixin](TODO) function.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `saml2_token` field.\n', args=[]), + withSaml2Token(resourceLabel, value): { + resource+: { + azuread_application_optional_claims+: { + [resourceLabel]+: { + saml2_token: value, + }, + }, + }, + }, + '#withSaml2TokenMixin':: d.fn(help='`azuread.list[obj].withSaml2TokenMixin` constructs a mixin object that can be merged into the `list[obj]`\nTerraform resource block to set or update the saml2_token field.\n\nThis function will append the passed in array or object to the existing array. If you wish\nto instead replace the array with the passed in `value`, use the [azuread.list[obj].withSaml2Token](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list[obj]`): The value to set for the `saml2_token` field.\n', args=[]), + withSaml2TokenMixin(resourceLabel, value): { + resource+: { + azuread_application_optional_claims+: { + [resourceLabel]+: { + saml2_token+: if std.isArray(v=value) then value else [value], + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + azuread_application_optional_claims+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + azuread_application_optional_claims+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/2.x/_gen/resources/application_owner.libsonnet b/2.x/_gen/resources/application_owner.libsonnet new file mode 100644 index 0000000..230c92e --- /dev/null +++ b/2.x/_gen/resources/application_owner.libsonnet @@ -0,0 +1,80 @@ +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_owner', url='', help='`application_owner` represents the `azuread_application_owner` 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_owner.new` injects a new `azuread_application_owner` 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_owner.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application_owner` using the reference:\n\n $._ref.azuread_application_owner.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application_owner.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_id` (`string`): The resource ID of the application to which the owner should be added\n - `owner_object_id` (`string`): Object ID of the principal that will be granted ownership of the 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_owner.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, + owner_object_id, + timeouts=null, + _meta={} + ):: tf.withResource( + type='azuread_application_owner', + label=resourceLabel, + attrs=self.newAttrs(application_id=application_id, owner_object_id=owner_object_id, timeouts=timeouts), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`azuread.application_owner.newAttrs` constructs a new object with attributes and blocks configured for the `application_owner`\nTerraform resource.\n\nUnlike [azuread.application_owner.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_id` (`string`): The resource ID of the application to which the owner should be added\n - `owner_object_id` (`string`): Object ID of the principal that will be granted ownership of the 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_owner.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_owner` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + application_id, + owner_object_id, + timeouts=null + ):: std.prune(a={ + application_id: application_id, + owner_object_id: owner_object_id, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`azuread.application_owner.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, + read=null + ):: std.prune(a={ + create: create, + delete: delete, + read: read, + }), + }, + '#withApplicationId':: d.fn(help='`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `application_id` field.\n', args=[]), + withApplicationId(resourceLabel, value): { + resource+: { + azuread_application_owner+: { + [resourceLabel]+: { + application_id: value, + }, + }, + }, + }, + '#withOwnerObjectId':: d.fn(help='`azuread.string.withOwnerObjectId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the owner_object_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `owner_object_id` field.\n', args=[]), + withOwnerObjectId(resourceLabel, value): { + resource+: { + azuread_application_owner+: { + [resourceLabel]+: { + owner_object_id: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + azuread_application_owner+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + azuread_application_owner+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/2.x/_gen/resources/application_password.libsonnet b/2.x/_gen/resources/application_password.libsonnet index 9d92de6..662c57f 100644 --- a/2.x/_gen/resources/application_password.libsonnet +++ b/2.x/_gen/resources/application_password.libsonnet @@ -2,10 +2,11 @@ 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`): 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':: 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_id` (`string`): The resource ID of the application for which this password should be created When `null`, the `application_id` field will be omitted from the resulting object.\n - `application_object_id` (`string`): The object ID of the application for which this password should be created When `null`, the `application_object_id` field will be omitted from the resulting object.\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, + application_id=null, + application_object_id=null, display_name=null, end_date=null, end_date_relative=null, @@ -17,6 +18,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type='azuread_application_password', label=resourceLabel, attrs=self.newAttrs( + application_id=application_id, application_object_id=application_object_id, display_name=display_name, end_date=end_date, @@ -27,9 +29,10 @@ 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`): 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':: 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_id` (`string`): The resource ID of the application for which this password should be created When `null`, the `application_id` field will be omitted from the resulting object.\n - `application_object_id` (`string`): The object ID of the application for which this password should be created When `null`, the `application_object_id` field will be omitted from the resulting object.\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, + application_id=null, + application_object_id=null, display_name=null, end_date=null, end_date_relative=null, @@ -37,6 +40,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); start_date=null, timeouts=null ):: std.prune(a={ + application_id: application_id, application_object_id: application_object_id, display_name: display_name, end_date: end_date, @@ -59,6 +63,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); update: update, }), }, + '#withApplicationId':: d.fn(help='`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `application_id` field.\n', args=[]), + withApplicationId(resourceLabel, value): { + resource+: { + azuread_application_password+: { + [resourceLabel]+: { + application_id: value, + }, + }, + }, + }, '#withApplicationObjectId':: d.fn(help='`azuread.string.withApplicationObjectId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_object_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `application_object_id` field.\n', args=[]), withApplicationObjectId(resourceLabel, value): { resource+: { diff --git a/2.x/_gen/resources/application_permission_scope.libsonnet b/2.x/_gen/resources/application_permission_scope.libsonnet new file mode 100644 index 0000000..ec95a58 --- /dev/null +++ b/2.x/_gen/resources/application_permission_scope.libsonnet @@ -0,0 +1,170 @@ +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_permission_scope', url='', help='`application_permission_scope` represents the `azuread_application_permission_scope` 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_permission_scope.new` injects a new `azuread_application_permission_scope` 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_permission_scope.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application_permission_scope` using the reference:\n\n $._ref.azuread_application_permission_scope.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application_permission_scope.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 - `admin_consent_description` (`string`): Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users\n - `admin_consent_display_name` (`string`): Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users\n - `application_id` (`string`): The resource ID of the application to which this permission scope should be applied\n - `scope_id` (`string`): The unique identifier of the permission scope\n - `type` (`string`): Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions When `null`, the `type` field will be omitted from the resulting object.\n - `user_consent_description` (`string`): Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf When `null`, the `user_consent_description` field will be omitted from the resulting object.\n - `user_consent_display_name` (`string`): Display name for the delegated permission that appears in the end user consent experience When `null`, the `user_consent_display_name` field will be omitted from the resulting object.\n - `value` (`string`): The value that is used for the `scp` claim in OAuth access tokens\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_permission_scope.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, + admin_consent_description, + admin_consent_display_name, + application_id, + scope_id, + value, + timeouts=null, + type=null, + user_consent_description=null, + user_consent_display_name=null, + _meta={} + ):: tf.withResource( + type='azuread_application_permission_scope', + label=resourceLabel, + attrs=self.newAttrs( + admin_consent_description=admin_consent_description, + admin_consent_display_name=admin_consent_display_name, + application_id=application_id, + scope_id=scope_id, + timeouts=timeouts, + type=type, + user_consent_description=user_consent_description, + user_consent_display_name=user_consent_display_name, + value=value + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`azuread.application_permission_scope.newAttrs` constructs a new object with attributes and blocks configured for the `application_permission_scope`\nTerraform resource.\n\nUnlike [azuread.application_permission_scope.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 - `admin_consent_description` (`string`): Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users\n - `admin_consent_display_name` (`string`): Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users\n - `application_id` (`string`): The resource ID of the application to which this permission scope should be applied\n - `scope_id` (`string`): The unique identifier of the permission scope\n - `type` (`string`): Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions When `null`, the `type` field will be omitted from the resulting object.\n - `user_consent_description` (`string`): Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf When `null`, the `user_consent_description` field will be omitted from the resulting object.\n - `user_consent_display_name` (`string`): Display name for the delegated permission that appears in the end user consent experience When `null`, the `user_consent_display_name` field will be omitted from the resulting object.\n - `value` (`string`): The value that is used for the `scp` claim in OAuth access tokens\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_permission_scope.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_permission_scope` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + admin_consent_description, + admin_consent_display_name, + application_id, + scope_id, + value, + timeouts=null, + type=null, + user_consent_description=null, + user_consent_display_name=null + ):: std.prune(a={ + admin_consent_description: admin_consent_description, + admin_consent_display_name: admin_consent_display_name, + application_id: application_id, + scope_id: scope_id, + timeouts: timeouts, + type: type, + user_consent_description: user_consent_description, + user_consent_display_name: user_consent_display_name, + value: value, + }), + timeouts:: { + '#new':: d.fn(help='\n`azuread.application_permission_scope.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, + read=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + read: read, + update: update, + }), + }, + '#withAdminConsentDescription':: d.fn(help='`azuread.string.withAdminConsentDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the admin_consent_description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `admin_consent_description` field.\n', args=[]), + withAdminConsentDescription(resourceLabel, value): { + resource+: { + azuread_application_permission_scope+: { + [resourceLabel]+: { + admin_consent_description: value, + }, + }, + }, + }, + '#withAdminConsentDisplayName':: d.fn(help='`azuread.string.withAdminConsentDisplayName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the admin_consent_display_name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `admin_consent_display_name` field.\n', args=[]), + withAdminConsentDisplayName(resourceLabel, value): { + resource+: { + azuread_application_permission_scope+: { + [resourceLabel]+: { + admin_consent_display_name: value, + }, + }, + }, + }, + '#withApplicationId':: d.fn(help='`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `application_id` field.\n', args=[]), + withApplicationId(resourceLabel, value): { + resource+: { + azuread_application_permission_scope+: { + [resourceLabel]+: { + application_id: value, + }, + }, + }, + }, + '#withScopeId':: d.fn(help='`azuread.string.withScopeId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the scope_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `scope_id` field.\n', args=[]), + withScopeId(resourceLabel, value): { + resource+: { + azuread_application_permission_scope+: { + [resourceLabel]+: { + scope_id: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + azuread_application_permission_scope+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + azuread_application_permission_scope+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withType':: d.fn(help='`azuread.string.withType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the type field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `type` field.\n', args=[]), + withType(resourceLabel, value): { + resource+: { + azuread_application_permission_scope+: { + [resourceLabel]+: { + type: value, + }, + }, + }, + }, + '#withUserConsentDescription':: d.fn(help='`azuread.string.withUserConsentDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the user_consent_description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `user_consent_description` field.\n', args=[]), + withUserConsentDescription(resourceLabel, value): { + resource+: { + azuread_application_permission_scope+: { + [resourceLabel]+: { + user_consent_description: value, + }, + }, + }, + }, + '#withUserConsentDisplayName':: d.fn(help='`azuread.string.withUserConsentDisplayName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the user_consent_display_name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `user_consent_display_name` field.\n', args=[]), + withUserConsentDisplayName(resourceLabel, value): { + resource+: { + azuread_application_permission_scope+: { + [resourceLabel]+: { + user_consent_display_name: value, + }, + }, + }, + }, + '#withValue':: d.fn(help='`azuread.string.withValue` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the value field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `value` field.\n', args=[]), + withValue(resourceLabel, value): { + resource+: { + azuread_application_permission_scope+: { + [resourceLabel]+: { + value: value, + }, + }, + }, + }, +} diff --git a/2.x/_gen/resources/application_pre_authorized.libsonnet b/2.x/_gen/resources/application_pre_authorized.libsonnet index 5440edc..b589de9 100644 --- a/2.x/_gen/resources/application_pre_authorized.libsonnet +++ b/2.x/_gen/resources/application_pre_authorized.libsonnet @@ -2,34 +2,42 @@ 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`): 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':: 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_id` (`string`): The resource ID of the application to which this pre-authorized application should be added When `null`, the `application_id` field will be omitted from the resulting object.\n - `application_object_id` (`string`): The object ID of the application to which this pre-authorized application should be added When `null`, the `application_object_id` field will be omitted from the resulting object.\n - `authorized_app_id` (`string`): The application ID of the pre-authorized application When `null`, the `authorized_app_id` field will be omitted from the resulting object.\n - `authorized_client_id` (`string`): The client ID of the pre-authorized application When `null`, the `authorized_client_id` field will be omitted from the resulting object.\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, - authorized_app_id, permission_ids, + application_id=null, + application_object_id=null, + authorized_app_id=null, + authorized_client_id=null, timeouts=null, _meta={} ):: tf.withResource( type='azuread_application_pre_authorized', label=resourceLabel, attrs=self.newAttrs( + application_id=application_id, application_object_id=application_object_id, authorized_app_id=authorized_app_id, + authorized_client_id=authorized_client_id, permission_ids=permission_ids, timeouts=timeouts ), _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`): 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':: 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_id` (`string`): The resource ID of the application to which this pre-authorized application should be added When `null`, the `application_id` field will be omitted from the resulting object.\n - `application_object_id` (`string`): The object ID of the application to which this pre-authorized application should be added When `null`, the `application_object_id` field will be omitted from the resulting object.\n - `authorized_app_id` (`string`): The application ID of the pre-authorized application When `null`, the `authorized_app_id` field will be omitted from the resulting object.\n - `authorized_client_id` (`string`): The client ID of the pre-authorized application When `null`, the `authorized_client_id` field will be omitted from the resulting object.\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, permission_ids, + application_id=null, + application_object_id=null, + authorized_app_id=null, + authorized_client_id=null, timeouts=null ):: std.prune(a={ + application_id: application_id, application_object_id: application_object_id, authorized_app_id: authorized_app_id, + authorized_client_id: authorized_client_id, permission_ids: permission_ids, timeouts: timeouts, }), @@ -47,6 +55,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); update: update, }), }, + '#withApplicationId':: d.fn(help='`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `application_id` field.\n', args=[]), + withApplicationId(resourceLabel, value): { + resource+: { + azuread_application_pre_authorized+: { + [resourceLabel]+: { + application_id: value, + }, + }, + }, + }, '#withApplicationObjectId':: d.fn(help='`azuread.string.withApplicationObjectId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_object_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `application_object_id` field.\n', args=[]), withApplicationObjectId(resourceLabel, value): { resource+: { @@ -67,6 +85,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withAuthorizedClientId':: d.fn(help='`azuread.string.withAuthorizedClientId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the authorized_client_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `authorized_client_id` field.\n', args=[]), + withAuthorizedClientId(resourceLabel, value): { + resource+: { + azuread_application_pre_authorized+: { + [resourceLabel]+: { + authorized_client_id: value, + }, + }, + }, + }, '#withPermissionIds':: d.fn(help='`azuread.list.withPermissionIds` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the permission_ids field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `permission_ids` field.\n', args=[]), withPermissionIds(resourceLabel, value): { resource+: { diff --git a/2.x/_gen/resources/application_redirect_uris.libsonnet b/2.x/_gen/resources/application_redirect_uris.libsonnet new file mode 100644 index 0000000..e601c1c --- /dev/null +++ b/2.x/_gen/resources/application_redirect_uris.libsonnet @@ -0,0 +1,100 @@ +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_redirect_uris', url='', help='`application_redirect_uris` represents the `azuread_application_redirect_uris` 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_redirect_uris.new` injects a new `azuread_application_redirect_uris` 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_redirect_uris.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application_redirect_uris` using the reference:\n\n $._ref.azuread_application_redirect_uris.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application_redirect_uris.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_id` (`string`): The resource ID of the application to which these redirect URIs belong\n - `redirect_uris` (`list`): A set of redirect URIs\n - `type` (`string`): The type of redirect URIs to assign to the 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_redirect_uris.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, + redirect_uris, + type, + timeouts=null, + _meta={} + ):: tf.withResource( + type='azuread_application_redirect_uris', + label=resourceLabel, + attrs=self.newAttrs( + application_id=application_id, + redirect_uris=redirect_uris, + timeouts=timeouts, + type=type + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`azuread.application_redirect_uris.newAttrs` constructs a new object with attributes and blocks configured for the `application_redirect_uris`\nTerraform resource.\n\nUnlike [azuread.application_redirect_uris.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_id` (`string`): The resource ID of the application to which these redirect URIs belong\n - `redirect_uris` (`list`): A set of redirect URIs\n - `type` (`string`): The type of redirect URIs to assign to the 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_redirect_uris.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_redirect_uris` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + application_id, + redirect_uris, + type, + timeouts=null + ):: std.prune(a={ + application_id: application_id, + redirect_uris: redirect_uris, + timeouts: timeouts, + type: type, + }), + timeouts:: { + '#new':: d.fn(help='\n`azuread.application_redirect_uris.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, + read=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + read: read, + update: update, + }), + }, + '#withApplicationId':: d.fn(help='`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the application_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `application_id` field.\n', args=[]), + withApplicationId(resourceLabel, value): { + resource+: { + azuread_application_redirect_uris+: { + [resourceLabel]+: { + application_id: value, + }, + }, + }, + }, + '#withRedirectUris':: d.fn(help='`azuread.list.withRedirectUris` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the redirect_uris field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `redirect_uris` field.\n', args=[]), + withRedirectUris(resourceLabel, value): { + resource+: { + azuread_application_redirect_uris+: { + [resourceLabel]+: { + redirect_uris: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + azuread_application_redirect_uris+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + azuread_application_redirect_uris+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, + '#withType':: d.fn(help='`azuread.string.withType` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the type field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `type` field.\n', args=[]), + withType(resourceLabel, value): { + resource+: { + azuread_application_redirect_uris+: { + [resourceLabel]+: { + type: value, + }, + }, + }, + }, +} diff --git a/2.x/_gen/resources/application_registration.libsonnet b/2.x/_gen/resources/application_registration.libsonnet new file mode 100644 index 0000000..aaa1fdc --- /dev/null +++ b/2.x/_gen/resources/application_registration.libsonnet @@ -0,0 +1,268 @@ +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_registration', url='', help='`application_registration` represents the `azuread_application_registration` 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_registration.new` injects a new `azuread_application_registration` 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_registration.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.application_registration` using the reference:\n\n $._ref.azuread_application_registration.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_application_registration.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`): Description of the application as shown to end users When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the application\n - `group_membership_claims` (`list`): Configures the `groups` claim that the app expects issued in a user or OAuth access token When `null`, the `group_membership_claims` field will be omitted from the resulting object.\n - `homepage_url` (`string`): URL of the home page for the application When `null`, the `homepage_url` field will be omitted from the resulting object.\n - `implicit_access_token_issuance_enabled` (`bool`): Whether this application can request an access token using OAuth implicit flow When `null`, the `implicit_access_token_issuance_enabled` field will be omitted from the resulting object.\n - `implicit_id_token_issuance_enabled` (`bool`): Whether this application can request an ID token using OAuth implicit flow When `null`, the `implicit_id_token_issuance_enabled` field will be omitted from the resulting object.\n - `logout_url` (`string`): URL of the logout page for the application, where the session is cleared for single sign-out When `null`, the `logout_url` field will be omitted from the resulting object.\n - `marketing_url` (`string`): URL of the marketing page for the application When `null`, the `marketing_url` field will be omitted from the resulting object.\n - `notes` (`string`): User-specified notes relevant for the management of the application When `null`, the `notes` field will be omitted from the resulting object.\n - `privacy_statement_url` (`string`): URL of the privacy statement for the application When `null`, the `privacy_statement_url` field will be omitted from the resulting object.\n - `requested_access_token_version` (`number`): The access token version expected by this resource When `null`, the `requested_access_token_version` field will be omitted from the resulting object.\n - `service_management_reference` (`string`): References application or contact information from a service or asset management database When `null`, the `service_management_reference` 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 support page for the application When `null`, the `support_url` field will be omitted from the resulting object.\n - `terms_of_service_url` (`string`): URL of the terms of service statement for the application When `null`, the `terms_of_service_url` 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_registration.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, + description=null, + group_membership_claims=null, + homepage_url=null, + implicit_access_token_issuance_enabled=null, + implicit_id_token_issuance_enabled=null, + logout_url=null, + marketing_url=null, + notes=null, + privacy_statement_url=null, + requested_access_token_version=null, + service_management_reference=null, + sign_in_audience=null, + support_url=null, + terms_of_service_url=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='azuread_application_registration', + label=resourceLabel, + attrs=self.newAttrs( + description=description, + display_name=display_name, + group_membership_claims=group_membership_claims, + homepage_url=homepage_url, + implicit_access_token_issuance_enabled=implicit_access_token_issuance_enabled, + implicit_id_token_issuance_enabled=implicit_id_token_issuance_enabled, + logout_url=logout_url, + marketing_url=marketing_url, + notes=notes, + privacy_statement_url=privacy_statement_url, + requested_access_token_version=requested_access_token_version, + service_management_reference=service_management_reference, + sign_in_audience=sign_in_audience, + support_url=support_url, + terms_of_service_url=terms_of_service_url, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`azuread.application_registration.newAttrs` constructs a new object with attributes and blocks configured for the `application_registration`\nTerraform resource.\n\nUnlike [azuread.application_registration.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`): Description of the application as shown to end users When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the application\n - `group_membership_claims` (`list`): Configures the `groups` claim that the app expects issued in a user or OAuth access token When `null`, the `group_membership_claims` field will be omitted from the resulting object.\n - `homepage_url` (`string`): URL of the home page for the application When `null`, the `homepage_url` field will be omitted from the resulting object.\n - `implicit_access_token_issuance_enabled` (`bool`): Whether this application can request an access token using OAuth implicit flow When `null`, the `implicit_access_token_issuance_enabled` field will be omitted from the resulting object.\n - `implicit_id_token_issuance_enabled` (`bool`): Whether this application can request an ID token using OAuth implicit flow When `null`, the `implicit_id_token_issuance_enabled` field will be omitted from the resulting object.\n - `logout_url` (`string`): URL of the logout page for the application, where the session is cleared for single sign-out When `null`, the `logout_url` field will be omitted from the resulting object.\n - `marketing_url` (`string`): URL of the marketing page for the application When `null`, the `marketing_url` field will be omitted from the resulting object.\n - `notes` (`string`): User-specified notes relevant for the management of the application When `null`, the `notes` field will be omitted from the resulting object.\n - `privacy_statement_url` (`string`): URL of the privacy statement for the application When `null`, the `privacy_statement_url` field will be omitted from the resulting object.\n - `requested_access_token_version` (`number`): The access token version expected by this resource When `null`, the `requested_access_token_version` field will be omitted from the resulting object.\n - `service_management_reference` (`string`): References application or contact information from a service or asset management database When `null`, the `service_management_reference` 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 support page for the application When `null`, the `support_url` field will be omitted from the resulting object.\n - `terms_of_service_url` (`string`): URL of the terms of service statement for the application When `null`, the `terms_of_service_url` 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_registration.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_registration` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + display_name, + description=null, + group_membership_claims=null, + homepage_url=null, + implicit_access_token_issuance_enabled=null, + implicit_id_token_issuance_enabled=null, + logout_url=null, + marketing_url=null, + notes=null, + privacy_statement_url=null, + requested_access_token_version=null, + service_management_reference=null, + sign_in_audience=null, + support_url=null, + terms_of_service_url=null, + timeouts=null + ):: std.prune(a={ + description: description, + display_name: display_name, + group_membership_claims: group_membership_claims, + homepage_url: homepage_url, + implicit_access_token_issuance_enabled: implicit_access_token_issuance_enabled, + implicit_id_token_issuance_enabled: implicit_id_token_issuance_enabled, + logout_url: logout_url, + marketing_url: marketing_url, + notes: notes, + privacy_statement_url: privacy_statement_url, + requested_access_token_version: requested_access_token_version, + service_management_reference: service_management_reference, + sign_in_audience: sign_in_audience, + support_url: support_url, + terms_of_service_url: terms_of_service_url, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`azuread.application_registration.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, + read=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + read: read, + update: update, + }), + }, + '#withDescription':: d.fn(help='`azuread.string.withDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `description` field.\n', args=[]), + withDescription(resourceLabel, value): { + resource+: { + azuread_application_registration+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withDisplayName':: d.fn(help='`azuread.string.withDisplayName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the display_name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `display_name` field.\n', args=[]), + withDisplayName(resourceLabel, value): { + resource+: { + azuread_application_registration+: { + [resourceLabel]+: { + display_name: value, + }, + }, + }, + }, + '#withGroupMembershipClaims':: d.fn(help='`azuread.list.withGroupMembershipClaims` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the group_membership_claims field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `group_membership_claims` field.\n', args=[]), + withGroupMembershipClaims(resourceLabel, value): { + resource+: { + azuread_application_registration+: { + [resourceLabel]+: { + group_membership_claims: value, + }, + }, + }, + }, + '#withHomepageUrl':: d.fn(help='`azuread.string.withHomepageUrl` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the homepage_url field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `homepage_url` field.\n', args=[]), + withHomepageUrl(resourceLabel, value): { + resource+: { + azuread_application_registration+: { + [resourceLabel]+: { + homepage_url: value, + }, + }, + }, + }, + '#withImplicitAccessTokenIssuanceEnabled':: d.fn(help='`azuread.bool.withImplicitAccessTokenIssuanceEnabled` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the implicit_access_token_issuance_enabled field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`bool`): The value to set for the `implicit_access_token_issuance_enabled` field.\n', args=[]), + withImplicitAccessTokenIssuanceEnabled(resourceLabel, value): { + resource+: { + azuread_application_registration+: { + [resourceLabel]+: { + implicit_access_token_issuance_enabled: value, + }, + }, + }, + }, + '#withImplicitIdTokenIssuanceEnabled':: d.fn(help='`azuread.bool.withImplicitIdTokenIssuanceEnabled` constructs a mixin object that can be merged into the `bool`\nTerraform resource block to set or update the implicit_id_token_issuance_enabled field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`bool`): The value to set for the `implicit_id_token_issuance_enabled` field.\n', args=[]), + withImplicitIdTokenIssuanceEnabled(resourceLabel, value): { + resource+: { + azuread_application_registration+: { + [resourceLabel]+: { + implicit_id_token_issuance_enabled: value, + }, + }, + }, + }, + '#withLogoutUrl':: d.fn(help='`azuread.string.withLogoutUrl` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the logout_url field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `logout_url` field.\n', args=[]), + withLogoutUrl(resourceLabel, value): { + resource+: { + azuread_application_registration+: { + [resourceLabel]+: { + logout_url: value, + }, + }, + }, + }, + '#withMarketingUrl':: d.fn(help='`azuread.string.withMarketingUrl` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the marketing_url field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `marketing_url` field.\n', args=[]), + withMarketingUrl(resourceLabel, value): { + resource+: { + azuread_application_registration+: { + [resourceLabel]+: { + marketing_url: value, + }, + }, + }, + }, + '#withNotes':: d.fn(help='`azuread.string.withNotes` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the notes field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `notes` field.\n', args=[]), + withNotes(resourceLabel, value): { + resource+: { + azuread_application_registration+: { + [resourceLabel]+: { + notes: value, + }, + }, + }, + }, + '#withPrivacyStatementUrl':: d.fn(help='`azuread.string.withPrivacyStatementUrl` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the privacy_statement_url field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `privacy_statement_url` field.\n', args=[]), + withPrivacyStatementUrl(resourceLabel, value): { + resource+: { + azuread_application_registration+: { + [resourceLabel]+: { + privacy_statement_url: value, + }, + }, + }, + }, + '#withRequestedAccessTokenVersion':: d.fn(help='`azuread.number.withRequestedAccessTokenVersion` constructs a mixin object that can be merged into the `number`\nTerraform resource block to set or update the requested_access_token_version field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`number`): The value to set for the `requested_access_token_version` field.\n', args=[]), + withRequestedAccessTokenVersion(resourceLabel, value): { + resource+: { + azuread_application_registration+: { + [resourceLabel]+: { + requested_access_token_version: value, + }, + }, + }, + }, + '#withServiceManagementReference':: d.fn(help='`azuread.string.withServiceManagementReference` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the service_management_reference field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `service_management_reference` field.\n', args=[]), + withServiceManagementReference(resourceLabel, value): { + resource+: { + azuread_application_registration+: { + [resourceLabel]+: { + service_management_reference: value, + }, + }, + }, + }, + '#withSignInAudience':: d.fn(help='`azuread.string.withSignInAudience` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the sign_in_audience field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `sign_in_audience` field.\n', args=[]), + withSignInAudience(resourceLabel, value): { + resource+: { + azuread_application_registration+: { + [resourceLabel]+: { + sign_in_audience: value, + }, + }, + }, + }, + '#withSupportUrl':: d.fn(help='`azuread.string.withSupportUrl` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the support_url field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `support_url` field.\n', args=[]), + withSupportUrl(resourceLabel, value): { + resource+: { + azuread_application_registration+: { + [resourceLabel]+: { + support_url: value, + }, + }, + }, + }, + '#withTermsOfServiceUrl':: d.fn(help='`azuread.string.withTermsOfServiceUrl` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the terms_of_service_url field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `terms_of_service_url` field.\n', args=[]), + withTermsOfServiceUrl(resourceLabel, value): { + resource+: { + azuread_application_registration+: { + [resourceLabel]+: { + terms_of_service_url: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + azuread_application_registration+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + azuread_application_registration+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/2.x/_gen/resources/authentication_strength_policy.libsonnet b/2.x/_gen/resources/authentication_strength_policy.libsonnet new file mode 100644 index 0000000..4fbd16f --- /dev/null +++ b/2.x/_gen/resources/authentication_strength_policy.libsonnet @@ -0,0 +1,100 @@ +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='authentication_strength_policy', url='', help='`authentication_strength_policy` represents the `azuread_authentication_strength_policy` 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.authentication_strength_policy.new` injects a new `azuread_authentication_strength_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.authentication_strength_policy.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.authentication_strength_policy` using the reference:\n\n $._ref.azuread_authentication_strength_policy.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_authentication_strength_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 - `allowed_combinations` (`list`): The allowed MFA methods for this policy\n - `description` (`string`): The description for the authentication strength policy When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the authentication strength policy\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.authentication_strength_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, + allowed_combinations, + display_name, + description=null, + timeouts=null, + _meta={} + ):: tf.withResource( + type='azuread_authentication_strength_policy', + label=resourceLabel, + attrs=self.newAttrs( + allowed_combinations=allowed_combinations, + description=description, + display_name=display_name, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`azuread.authentication_strength_policy.newAttrs` constructs a new object with attributes and blocks configured for the `authentication_strength_policy`\nTerraform resource.\n\nUnlike [azuread.authentication_strength_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 - `allowed_combinations` (`list`): The allowed MFA methods for this policy\n - `description` (`string`): The description for the authentication strength policy When `null`, the `description` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the authentication strength policy\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.authentication_strength_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 `authentication_strength_policy` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + allowed_combinations, + display_name, + description=null, + timeouts=null + ):: std.prune(a={ + allowed_combinations: allowed_combinations, + description: description, + display_name: display_name, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`azuread.authentication_strength_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, + read=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + read: read, + update: update, + }), + }, + '#withAllowedCombinations':: d.fn(help='`azuread.list.withAllowedCombinations` constructs a mixin object that can be merged into the `list`\nTerraform resource block to set or update the allowed_combinations field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`list`): The value to set for the `allowed_combinations` field.\n', args=[]), + withAllowedCombinations(resourceLabel, value): { + resource+: { + azuread_authentication_strength_policy+: { + [resourceLabel]+: { + allowed_combinations: value, + }, + }, + }, + }, + '#withDescription':: d.fn(help='`azuread.string.withDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `description` field.\n', args=[]), + withDescription(resourceLabel, value): { + resource+: { + azuread_authentication_strength_policy+: { + [resourceLabel]+: { + description: value, + }, + }, + }, + }, + '#withDisplayName':: d.fn(help='`azuread.string.withDisplayName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the display_name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `display_name` field.\n', args=[]), + withDisplayName(resourceLabel, value): { + resource+: { + azuread_authentication_strength_policy+: { + [resourceLabel]+: { + display_name: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + azuread_authentication_strength_policy+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + azuread_authentication_strength_policy+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/2.x/_gen/resources/conditional_access_policy.libsonnet b/2.x/_gen/resources/conditional_access_policy.libsonnet index 64be8d8..9b80f19 100644 --- a/2.x/_gen/resources/conditional_access_policy.libsonnet +++ b/2.x/_gen/resources/conditional_access_policy.libsonnet @@ -88,32 +88,78 @@ 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`): 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=[]), + excluded_guests_or_external_users:: { + external_tenants:: { + '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.users.excluded_guests_or_external_users.external_tenants.new` constructs a new object with attributes and blocks configured for the `external_tenants`\nTerraform sub block.\n\n\n\n**Args**:\n - `members` (`list`): Set the `members` field on the resulting object. When `null`, the `members` field will be omitted from the resulting object.\n - `membership_kind` (`string`): Set the `membership_kind` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `external_tenants` sub block.\n', args=[]), + new( + membership_kind, + members=null + ):: std.prune(a={ + members: members, + membership_kind: membership_kind, + }), + }, + '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.users.excluded_guests_or_external_users.new` constructs a new object with attributes and blocks configured for the `excluded_guests_or_external_users`\nTerraform sub block.\n\n\n\n**Args**:\n - `guest_or_external_user_types` (`list`): Set the `guest_or_external_user_types` field on the resulting object.\n - `external_tenants` (`list[obj]`): Set the `external_tenants` field on the resulting object. When `null`, the `external_tenants` 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.excluded_guests_or_external_users.external_tenants.new](#fn-conditionsconditionsusersexternal_tenantsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `excluded_guests_or_external_users` sub block.\n', args=[]), + new( + guest_or_external_user_types, + external_tenants=null + ):: std.prune(a={ + external_tenants: external_tenants, + guest_or_external_user_types: guest_or_external_user_types, + }), + }, + included_guests_or_external_users:: { + external_tenants:: { + '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.users.included_guests_or_external_users.external_tenants.new` constructs a new object with attributes and blocks configured for the `external_tenants`\nTerraform sub block.\n\n\n\n**Args**:\n - `members` (`list`): Set the `members` field on the resulting object. When `null`, the `members` field will be omitted from the resulting object.\n - `membership_kind` (`string`): Set the `membership_kind` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `external_tenants` sub block.\n', args=[]), + new( + membership_kind, + members=null + ):: std.prune(a={ + members: members, + membership_kind: membership_kind, + }), + }, + '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.users.included_guests_or_external_users.new` constructs a new object with attributes and blocks configured for the `included_guests_or_external_users`\nTerraform sub block.\n\n\n\n**Args**:\n - `guest_or_external_user_types` (`list`): Set the `guest_or_external_user_types` field on the resulting object.\n - `external_tenants` (`list[obj]`): Set the `external_tenants` field on the resulting object. When `null`, the `external_tenants` 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.included_guests_or_external_users.external_tenants.new](#fn-conditionsconditionsusersexternal_tenantsnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `included_guests_or_external_users` sub block.\n', args=[]), + new( + guest_or_external_user_types, + external_tenants=null + ):: std.prune(a={ + external_tenants: external_tenants, + guest_or_external_user_types: guest_or_external_user_types, + }), + }, + '#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 - `excluded_guests_or_external_users` (`list[obj]`): Set the `excluded_guests_or_external_users` field on the resulting object. When `null`, the `excluded_guests_or_external_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.excluded_guests_or_external_users.new](#fn-conditionsconditionsexcluded_guests_or_external_usersnew) constructor.\n - `included_guests_or_external_users` (`list[obj]`): Set the `included_guests_or_external_users` field on the resulting object. When `null`, the `included_guests_or_external_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.included_guests_or_external_users.new](#fn-conditionsconditionsincluded_guests_or_external_usersnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `users` sub block.\n', args=[]), new( excluded_groups=null, + excluded_guests_or_external_users=null, excluded_roles=null, excluded_users=null, included_groups=null, + included_guests_or_external_users=null, included_roles=null, included_users=null ):: std.prune(a={ excluded_groups: excluded_groups, + excluded_guests_or_external_users: excluded_guests_or_external_users, excluded_roles: excluded_roles, excluded_users: excluded_users, included_groups: included_groups, + included_guests_or_external_users: included_guests_or_external_users, included_roles: included_roles, included_users: included_users, }), }, }, 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`): Set the `built_in_controls` field on the resulting object. When `null`, the `built_in_controls` field will be omitted from 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':: 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 - `authentication_strength_policy_id` (`string`): Set the `authentication_strength_policy_id` field on the resulting object. When `null`, the `authentication_strength_policy_id` field will be omitted from the resulting object.\n - `built_in_controls` (`list`): Set the `built_in_controls` field on the resulting object. When `null`, the `built_in_controls` field will be omitted from 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( operator, + authentication_strength_policy_id=null, built_in_controls=null, custom_authentication_factors=null, terms_of_use=null ):: std.prune(a={ + authentication_strength_policy_id: authentication_strength_policy_id, built_in_controls: built_in_controls, custom_authentication_factors: custom_authentication_factors, operator: operator, @@ -160,13 +206,15 @@ 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`): 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 - `disable_resilience_defaults` (`bool`): Set the `disable_resilience_defaults` field on the resulting object. When `null`, the `disable_resilience_defaults` 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':: 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 - `disable_resilience_defaults` (`bool`): Set the `disable_resilience_defaults` field on the resulting object. When `null`, the `disable_resilience_defaults` 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_authentication_type` (`string`): Set the `sign_in_frequency_authentication_type` field on the resulting object. When `null`, the `sign_in_frequency_authentication_type` field will be omitted from the resulting object.\n - `sign_in_frequency_interval` (`string`): Set the `sign_in_frequency_interval` field on the resulting object. When `null`, the `sign_in_frequency_interval` 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, disable_resilience_defaults=null, persistent_browser_mode=null, sign_in_frequency=null, + sign_in_frequency_authentication_type=null, + sign_in_frequency_interval=null, sign_in_frequency_period=null ):: std.prune(a={ application_enforced_restrictions_enabled: application_enforced_restrictions_enabled, @@ -174,6 +222,8 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); disable_resilience_defaults: disable_resilience_defaults, persistent_browser_mode: persistent_browser_mode, sign_in_frequency: sign_in_frequency, + sign_in_frequency_authentication_type: sign_in_frequency_authentication_type, + sign_in_frequency_interval: sign_in_frequency_interval, sign_in_frequency_period: sign_in_frequency_period, }), }, diff --git a/2.x/_gen/resources/directory_role.libsonnet b/2.x/_gen/resources/directory_role.libsonnet index 3d22660..8c631e5 100644 --- a/2.x/_gen/resources/directory_role.libsonnet +++ b/2.x/_gen/resources/directory_role.libsonnet @@ -26,17 +26,15 @@ 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`): 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':: 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\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), new( create=null, delete=null, - read=null, - update=null + read=null ):: std.prune(a={ create: create, delete: delete, read: read, - update: update, }), }, '#withDisplayName':: d.fn(help='`azuread.string.withDisplayName` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the display_name field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `display_name` field.\n', args=[]), diff --git a/2.x/_gen/resources/directory_role_eligibility_schedule_request.libsonnet b/2.x/_gen/resources/directory_role_eligibility_schedule_request.libsonnet new file mode 100644 index 0000000..ca14c43 --- /dev/null +++ b/2.x/_gen/resources/directory_role_eligibility_schedule_request.libsonnet @@ -0,0 +1,114 @@ +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_eligibility_schedule_request', url='', help='`directory_role_eligibility_schedule_request` represents the `azuread_directory_role_eligibility_schedule_request` 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_eligibility_schedule_request.new` injects a new `azuread_directory_role_eligibility_schedule_request` 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_eligibility_schedule_request.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.directory_role_eligibility_schedule_request` using the reference:\n\n $._ref.azuread_directory_role_eligibility_schedule_request.some_id.get('id')\n\nThis is the same as directly entering `\"${ azuread_directory_role_eligibility_schedule_request.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 - `directory_scope_id` (`string`): Identifier of the directory object representing the scope of the role eligibility schedule request\n - `justification` (`string`): Justification for why the role is assigned\n - `principal_id` (`string`): The object ID of the member principal\n - `role_definition_id` (`string`): The object ID of the directory role for this role eligibility schedule request\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_eligibility_schedule_request.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, + directory_scope_id, + justification, + principal_id, + role_definition_id, + timeouts=null, + _meta={} + ):: tf.withResource( + type='azuread_directory_role_eligibility_schedule_request', + label=resourceLabel, + attrs=self.newAttrs( + directory_scope_id=directory_scope_id, + justification=justification, + principal_id=principal_id, + role_definition_id=role_definition_id, + timeouts=timeouts + ), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`azuread.directory_role_eligibility_schedule_request.newAttrs` constructs a new object with attributes and blocks configured for the `directory_role_eligibility_schedule_request`\nTerraform resource.\n\nUnlike [azuread.directory_role_eligibility_schedule_request.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 - `directory_scope_id` (`string`): Identifier of the directory object representing the scope of the role eligibility schedule request\n - `justification` (`string`): Justification for why the role is assigned\n - `principal_id` (`string`): The object ID of the member principal\n - `role_definition_id` (`string`): The object ID of the directory role for this role eligibility schedule request\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_eligibility_schedule_request.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_eligibility_schedule_request` resource into the root Terraform configuration.\n', args=[]), + newAttrs( + directory_scope_id, + justification, + principal_id, + role_definition_id, + timeouts=null + ):: std.prune(a={ + directory_scope_id: directory_scope_id, + justification: justification, + principal_id: principal_id, + role_definition_id: role_definition_id, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`azuread.directory_role_eligibility_schedule_request.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, + read=null, + update=null + ):: std.prune(a={ + create: create, + delete: delete, + read: read, + update: update, + }), + }, + '#withDirectoryScopeId':: d.fn(help='`azuread.string.withDirectoryScopeId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the directory_scope_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `directory_scope_id` field.\n', args=[]), + withDirectoryScopeId(resourceLabel, value): { + resource+: { + azuread_directory_role_eligibility_schedule_request+: { + [resourceLabel]+: { + directory_scope_id: value, + }, + }, + }, + }, + '#withJustification':: d.fn(help='`azuread.string.withJustification` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the justification field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `justification` field.\n', args=[]), + withJustification(resourceLabel, value): { + resource+: { + azuread_directory_role_eligibility_schedule_request+: { + [resourceLabel]+: { + justification: value, + }, + }, + }, + }, + '#withPrincipalId':: d.fn(help='`azuread.string.withPrincipalId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the principal_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `principal_id` field.\n', args=[]), + withPrincipalId(resourceLabel, value): { + resource+: { + azuread_directory_role_eligibility_schedule_request+: { + [resourceLabel]+: { + principal_id: value, + }, + }, + }, + }, + '#withRoleDefinitionId':: d.fn(help='`azuread.string.withRoleDefinitionId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the role_definition_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `role_definition_id` field.\n', args=[]), + withRoleDefinitionId(resourceLabel, value): { + resource+: { + azuread_directory_role_eligibility_schedule_request+: { + [resourceLabel]+: { + role_definition_id: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will replace the map with the passed in `value`. If you wish to instead merge the\npassed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function.\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(resourceLabel, value): { + resource+: { + azuread_directory_role_eligibility_schedule_request+: { + [resourceLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform resource block to set or update the timeouts field.\n\nThis function will merge the passed in value to the existing map. If you wish\nto instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO)\nfunction.\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(resourceLabel, value): { + resource+: { + azuread_directory_role_eligibility_schedule_request+: { + [resourceLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/2.x/_gen/resources/service_principal.libsonnet b/2.x/_gen/resources/service_principal.libsonnet index 2bb521e..f8271c3 100644 --- a/2.x/_gen/resources/service_principal.libsonnet +++ b/2.x/_gen/resources/service_principal.libsonnet @@ -30,13 +30,14 @@ 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`): 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':: 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 When `null`, the `application_id` field will be omitted from the resulting object.\n - `client_id` (`string`): The client ID of the application for which to create a service principal When `null`, the `client_id` field will be omitted from the resulting object.\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, account_enabled=null, alternative_names=null, app_role_assignment_required=null, + application_id=null, + client_id=null, description=null, feature_tags=null, features=null, @@ -58,6 +59,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); alternative_names=alternative_names, app_role_assignment_required=app_role_assignment_required, application_id=application_id, + client_id=client_id, description=description, feature_tags=feature_tags, features=features, @@ -73,12 +75,13 @@ 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`): 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':: 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 When `null`, the `application_id` field will be omitted from the resulting object.\n - `client_id` (`string`): The client ID of the application for which to create a service principal When `null`, the `client_id` field will be omitted from the resulting object.\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, alternative_names=null, app_role_assignment_required=null, + application_id=null, + client_id=null, description=null, feature_tags=null, features=null, @@ -96,6 +99,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); alternative_names: alternative_names, app_role_assignment_required: app_role_assignment_required, application_id: application_id, + client_id: client_id, description: description, feature_tags: feature_tags, features: features, @@ -171,6 +175,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withClientId':: d.fn(help='`azuread.string.withClientId` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the client_id field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `client_id` field.\n', args=[]), + withClientId(resourceLabel, value): { + resource+: { + azuread_service_principal+: { + [resourceLabel]+: { + client_id: value, + }, + }, + }, + }, '#withDescription':: d.fn(help='`azuread.string.withDescription` constructs a mixin object that can be merged into the `string`\nTerraform resource block to set or update the description field.\n\n\n\n**Args**:\n - `resourceLabel` (`string`): The name label of the block to update.\n - `value` (`string`): The value to set for the `description` field.\n', args=[]), withDescription(resourceLabel, value): { resource+: { diff --git a/docs/2.x/README.md b/docs/2.x/README.md index 804e0fd..c26ec6f 100644 --- a/docs/2.x/README.md +++ b/docs/2.x/README.md @@ -22,16 +22,29 @@ project. * [administrative_unit_role_member](administrative_unit_role_member.md) * [app_role_assignment](app_role_assignment.md) * [application](application.md) +* [application_api_access](application_api_access.md) +* [application_app_role](application_app_role.md) * [application_certificate](application_certificate.md) +* [application_fallback_public_client](application_fallback_public_client.md) * [application_federated_identity_credential](application_federated_identity_credential.md) +* [application_from_template](application_from_template.md) +* [application_identifier_uri](application_identifier_uri.md) +* [application_known_clients](application_known_clients.md) +* [application_optional_claims](application_optional_claims.md) +* [application_owner](application_owner.md) * [application_password](application_password.md) +* [application_permission_scope](application_permission_scope.md) * [application_pre_authorized](application_pre_authorized.md) +* [application_redirect_uris](application_redirect_uris.md) +* [application_registration](application_registration.md) +* [authentication_strength_policy](authentication_strength_policy.md) * [claims_mapping_policy](claims_mapping_policy.md) * [conditional_access_policy](conditional_access_policy.md) * [custom_directory_role](custom_directory_role.md) * [data](data/index.md) * [directory_role](directory_role.md) * [directory_role_assignment](directory_role_assignment.md) +* [directory_role_eligibility_schedule_request](directory_role_eligibility_schedule_request.md) * [directory_role_member](directory_role_member.md) * [group](group.md) * [group_member](group_member.md) diff --git a/docs/2.x/application_api_access.md b/docs/2.x/application_api_access.md new file mode 100644 index 0000000..6909d35 --- /dev/null +++ b/docs/2.x/application_api_access.md @@ -0,0 +1,217 @@ +--- +permalink: /application_api_access/ +--- + +# application_api_access + +`application_api_access` represents the `azuread_application_api_access` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withApiClientId()`](#fn-withapiclientid) +* [`fn withApplicationId()`](#fn-withapplicationid) +* [`fn withRoleIds()`](#fn-withroleids) +* [`fn withScopeIds()`](#fn-withscopeids) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`azuread.application_api_access.new` injects a new `azuread_application_api_access` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + azuread.application_api_access.new('some_id') + +You can get the reference to the `id` field of the created `azuread.application_api_access` using the reference: + + $._ref.azuread_application_api_access.some_id.get('id') + +This is the same as directly entering `"${ azuread_application_api_access.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `api_client_id` (`string`): The client ID of the API to which access is being granted + - `application_id` (`string`): The resource ID of the application to which this API access is granted + - `role_ids` (`list`): A set of role IDs to be granted to the application, as published by the API When `null`, the `role_ids` field will be omitted from the resulting object. + - `scope_ids` (`list`): A set of scope IDs to be granted to the application, as published by the API When `null`, the `scope_ids` field will be omitted from the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.application_api_access.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`azuread.application_api_access.newAttrs` constructs a new object with attributes and blocks configured for the `application_api_access` +Terraform resource. + +Unlike [azuread.application_api_access.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `api_client_id` (`string`): The client ID of the API to which access is being granted + - `application_id` (`string`): The resource ID of the application to which this API access is granted + - `role_ids` (`list`): A set of role IDs to be granted to the application, as published by the API When `null`, the `role_ids` field will be omitted from the resulting object. + - `scope_ids` (`list`): A set of scope IDs to be granted to the application, as published by the API When `null`, the `scope_ids` field will be omitted from the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.application_api_access.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_api_access` resource into the root Terraform configuration. + + +### fn withApiClientId + +```ts +withApiClientId() +``` + +`azuread.string.withApiClientId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the api_client_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `api_client_id` field. + + +### fn withApplicationId + +```ts +withApplicationId() +``` + +`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the application_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `application_id` field. + + +### fn withRoleIds + +```ts +withRoleIds() +``` + +`azuread.list.withRoleIds` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the role_ids field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `role_ids` field. + + +### fn withScopeIds + +```ts +withScopeIds() +``` + +`azuread.list.withScopeIds` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the scope_ids field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `scope_ids` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`azuread.application_api_access.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/application_app_role.md b/docs/2.x/application_app_role.md new file mode 100644 index 0000000..c873dfe --- /dev/null +++ b/docs/2.x/application_app_role.md @@ -0,0 +1,255 @@ +--- +permalink: /application_app_role/ +--- + +# application_app_role + +`application_app_role` represents the `azuread_application_app_role` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withAllowedMemberTypes()`](#fn-withallowedmembertypes) +* [`fn withApplicationId()`](#fn-withapplicationid) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withDisplayName()`](#fn-withdisplayname) +* [`fn withRoleId()`](#fn-withroleid) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withValue()`](#fn-withvalue) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`azuread.application_app_role.new` injects a new `azuread_application_app_role` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + azuread.application_app_role.new('some_id') + +You can get the reference to the `id` field of the created `azuread.application_app_role` using the reference: + + $._ref.azuread_application_app_role.some_id.get('id') + +This is the same as directly entering `"${ azuread_application_app_role.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `allowed_member_types` (`list`): Specifies whether this app role definition can be assigned to users and groups by setting to `User`, or to other applications (that are accessing this application in a standalone scenario) by setting to `Application`, or to both + - `application_id` (`string`): The resource ID of the application to which this app role should be applied + - `description` (`string`): Description of the app role that appears when the role is being assigned and, if the role functions as an application permissions, during the consent experiences + - `display_name` (`string`): Display name for the app role that appears during app role assignment and in consent experiences + - `role_id` (`string`): The unique identifier of the app role + - `value` (`string`): The value that is used for the `roles` claim in ID tokens and OAuth access tokens that are authenticating an assigned service or user principal When `null`, the `value` field will be omitted from the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.application_app_role.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`azuread.application_app_role.newAttrs` constructs a new object with attributes and blocks configured for the `application_app_role` +Terraform resource. + +Unlike [azuread.application_app_role.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `allowed_member_types` (`list`): Specifies whether this app role definition can be assigned to users and groups by setting to `User`, or to other applications (that are accessing this application in a standalone scenario) by setting to `Application`, or to both + - `application_id` (`string`): The resource ID of the application to which this app role should be applied + - `description` (`string`): Description of the app role that appears when the role is being assigned and, if the role functions as an application permissions, during the consent experiences + - `display_name` (`string`): Display name for the app role that appears during app role assignment and in consent experiences + - `role_id` (`string`): The unique identifier of the app role + - `value` (`string`): The value that is used for the `roles` claim in ID tokens and OAuth access tokens that are authenticating an assigned service or user principal When `null`, the `value` field will be omitted from the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.application_app_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 `application_app_role` resource into the root Terraform configuration. + + +### fn withAllowedMemberTypes + +```ts +withAllowedMemberTypes() +``` + +`azuread.list.withAllowedMemberTypes` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the allowed_member_types field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `allowed_member_types` field. + + +### fn withApplicationId + +```ts +withApplicationId() +``` + +`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the application_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `application_id` field. + + +### fn withDescription + +```ts +withDescription() +``` + +`azuread.string.withDescription` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the description field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `description` field. + + +### fn withDisplayName + +```ts +withDisplayName() +``` + +`azuread.string.withDisplayName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the display_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `display_name` field. + + +### fn withRoleId + +```ts +withRoleId() +``` + +`azuread.string.withRoleId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the role_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `role_id` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withValue + +```ts +withValue() +``` + +`azuread.string.withValue` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the value field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `value` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`azuread.application_app_role.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/application_certificate.md b/docs/2.x/application_certificate.md index bf20831..9c8c657 100644 --- a/docs/2.x/application_certificate.md +++ b/docs/2.x/application_certificate.md @@ -15,6 +15,7 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) +* [`fn withApplicationId()`](#fn-withapplicationid) * [`fn withApplicationObjectId()`](#fn-withapplicationobjectid) * [`fn withEncoding()`](#fn-withencoding) * [`fn withEndDate()`](#fn-withenddate) @@ -57,14 +58,15 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `application_object_id` (`string`): The object ID of the application for which this certificate should be created + - `application_id` (`string`): The resource ID of the application for which this certificate should be created When `null`, the `application_id` field will be omitted from the resulting object. + - `application_object_id` (`string`): The object ID of the application for which this certificate should be created When `null`, the `application_object_id` field will be omitted from the resulting object. - `encoding` (`string`): Specifies the encoding used for the supplied certificate data When `null`, the `encoding` field will be omitted from the resulting object. - `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. - `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. - `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. - `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 + - `value` (`string`): The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the `encoding` argument - `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**: @@ -89,20 +91,37 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `application_object_id` (`string`): The object ID of the application for which this certificate should be created + - `application_id` (`string`): The resource ID of the application for which this certificate should be created When `null`, the `application_id` field will be omitted from the resulting object. + - `application_object_id` (`string`): The object ID of the application for which this certificate should be created When `null`, the `application_object_id` field will be omitted from the resulting object. - `encoding` (`string`): Specifies the encoding used for the supplied certificate data When `null`, the `encoding` field will be omitted from the resulting object. - `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. - `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. - `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. - `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 + - `value` (`string`): The certificate data, which can be PEM encoded, base64 encoded DER or hexadecimal encoded DER. See also the `encoding` argument - `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. +### fn withApplicationId + +```ts +withApplicationId() +``` + +`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the application_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `application_id` field. + + ### fn withApplicationObjectId ```ts diff --git a/docs/2.x/application_fallback_public_client.md b/docs/2.x/application_fallback_public_client.md new file mode 100644 index 0000000..a4e4097 --- /dev/null +++ b/docs/2.x/application_fallback_public_client.md @@ -0,0 +1,178 @@ +--- +permalink: /application_fallback_public_client/ +--- + +# application_fallback_public_client + +`application_fallback_public_client` represents the `azuread_application_fallback_public_client` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withApplicationId()`](#fn-withapplicationid) +* [`fn withEnabled()`](#fn-withenabled) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`azuread.application_fallback_public_client.new` injects a new `azuread_application_fallback_public_client` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + azuread.application_fallback_public_client.new('some_id') + +You can get the reference to the `id` field of the created `azuread.application_fallback_public_client` using the reference: + + $._ref.azuread_application_fallback_public_client.some_id.get('id') + +This is the same as directly entering `"${ azuread_application_fallback_public_client.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `application_id` (`string`): The resource ID of the application to which the fallback public client setting should be applied + - `enabled` (`bool`): Specifies explicitly whether the application is a public client. Appropriate for apps using token grant flows that don't use a redirect URI When `null`, the `enabled` field will be omitted from the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.application_fallback_public_client.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`azuread.application_fallback_public_client.newAttrs` constructs a new object with attributes and blocks configured for the `application_fallback_public_client` +Terraform resource. + +Unlike [azuread.application_fallback_public_client.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `application_id` (`string`): The resource ID of the application to which the fallback public client setting should be applied + - `enabled` (`bool`): Specifies explicitly whether the application is a public client. Appropriate for apps using token grant flows that don't use a redirect URI When `null`, the `enabled` field will be omitted from the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.application_fallback_public_client.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_fallback_public_client` resource into the root Terraform configuration. + + +### fn withApplicationId + +```ts +withApplicationId() +``` + +`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the application_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `application_id` field. + + +### fn withEnabled + +```ts +withEnabled() +``` + +`azuread.bool.withEnabled` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the enabled field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `enabled` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`azuread.application_fallback_public_client.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object. + +**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 d66407a..6576440 100644 --- a/docs/2.x/application_federated_identity_credential.md +++ b/docs/2.x/application_federated_identity_credential.md @@ -15,6 +15,7 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) +* [`fn withApplicationId()`](#fn-withapplicationid) * [`fn withApplicationObjectId()`](#fn-withapplicationobjectid) * [`fn withAudiences()`](#fn-withaudiences) * [`fn withDescription()`](#fn-withdescription) @@ -55,7 +56,8 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `application_object_id` (`string`): The object ID of the application for which this federated identity credential should be created + - `application_id` (`string`): The resource ID of the application for which this federated identity credential should be created When `null`, the `application_id` field will be omitted from the resulting object. + - `application_object_id` (`string`): The object ID of the application for which this federated identity credential should be created When `null`, the `application_object_id` field will be omitted from the resulting object. - `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. - `description` (`string`): A description for the federated identity credential When `null`, the `description` field will be omitted from the resulting object. - `display_name` (`string`): A unique display name for the federated identity credential @@ -85,7 +87,8 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `application_object_id` (`string`): The object ID of the application for which this federated identity credential should be created + - `application_id` (`string`): The resource ID of the application for which this federated identity credential should be created When `null`, the `application_id` field will be omitted from the resulting object. + - `application_object_id` (`string`): The object ID of the application for which this federated identity credential should be created When `null`, the `application_object_id` field will be omitted from the resulting object. - `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. - `description` (`string`): A description for the federated identity credential When `null`, the `description` field will be omitted from the resulting object. - `display_name` (`string`): A unique display name for the federated identity credential @@ -97,6 +100,22 @@ injecting into a complete block. - 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. +### fn withApplicationId + +```ts +withApplicationId() +``` + +`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the application_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `application_id` field. + + ### fn withApplicationObjectId ```ts diff --git a/docs/2.x/application_from_template.md b/docs/2.x/application_from_template.md new file mode 100644 index 0000000..b8a56e5 --- /dev/null +++ b/docs/2.x/application_from_template.md @@ -0,0 +1,179 @@ +--- +permalink: /application_from_template/ +--- + +# application_from_template + +`application_from_template` represents the `azuread_application_from_template` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withDisplayName()`](#fn-withdisplayname) +* [`fn withTemplateId()`](#fn-withtemplateid) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`azuread.application_from_template.new` injects a new `azuread_application_from_template` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + azuread.application_from_template.new('some_id') + +You can get the reference to the `id` field of the created `azuread.application_from_template` using the reference: + + $._ref.azuread_application_from_template.some_id.get('id') + +This is the same as directly entering `"${ azuread_application_from_template.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `display_name` (`string`): The display name for the application + - `template_id` (`string`): The UUID of the template to instantiate for this application + - `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_from_template.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`azuread.application_from_template.newAttrs` constructs a new object with attributes and blocks configured for the `application_from_template` +Terraform resource. + +Unlike [azuread.application_from_template.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `display_name` (`string`): The display name for the application + - `template_id` (`string`): The UUID of the template to instantiate for this application + - `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_from_template.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_from_template` resource into the root Terraform configuration. + + +### fn withDisplayName + +```ts +withDisplayName() +``` + +`azuread.string.withDisplayName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the display_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `display_name` field. + + +### fn withTemplateId + +```ts +withTemplateId() +``` + +`azuread.string.withTemplateId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the template_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `template_id` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`azuread.application_from_template.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/application_identifier_uri.md b/docs/2.x/application_identifier_uri.md new file mode 100644 index 0000000..2189871 --- /dev/null +++ b/docs/2.x/application_identifier_uri.md @@ -0,0 +1,178 @@ +--- +permalink: /application_identifier_uri/ +--- + +# application_identifier_uri + +`application_identifier_uri` represents the `azuread_application_identifier_uri` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withApplicationId()`](#fn-withapplicationid) +* [`fn withIdentifierUri()`](#fn-withidentifieruri) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`azuread.application_identifier_uri.new` injects a new `azuread_application_identifier_uri` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + azuread.application_identifier_uri.new('some_id') + +You can get the reference to the `id` field of the created `azuread.application_identifier_uri` using the reference: + + $._ref.azuread_application_identifier_uri.some_id.get('id') + +This is the same as directly entering `"${ azuread_application_identifier_uri.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `application_id` (`string`): The resource ID of the application to which the identifier URI should be added + - `identifier_uri` (`string`): The user-defined URI that uniquely identifies an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant + - `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_identifier_uri.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`azuread.application_identifier_uri.newAttrs` constructs a new object with attributes and blocks configured for the `application_identifier_uri` +Terraform resource. + +Unlike [azuread.application_identifier_uri.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `application_id` (`string`): The resource ID of the application to which the identifier URI should be added + - `identifier_uri` (`string`): The user-defined URI that uniquely identifies an application within its Azure AD tenant, or within a verified custom domain if the application is multi-tenant + - `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_identifier_uri.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_identifier_uri` resource into the root Terraform configuration. + + +### fn withApplicationId + +```ts +withApplicationId() +``` + +`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the application_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `application_id` field. + + +### fn withIdentifierUri + +```ts +withIdentifierUri() +``` + +`azuread.string.withIdentifierUri` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the identifier_uri field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `identifier_uri` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`azuread.application_identifier_uri.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/application_known_clients.md b/docs/2.x/application_known_clients.md new file mode 100644 index 0000000..587a791 --- /dev/null +++ b/docs/2.x/application_known_clients.md @@ -0,0 +1,179 @@ +--- +permalink: /application_known_clients/ +--- + +# application_known_clients + +`application_known_clients` represents the `azuread_application_known_clients` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withApplicationId()`](#fn-withapplicationid) +* [`fn withKnownClientIds()`](#fn-withknownclientids) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`azuread.application_known_clients.new` injects a new `azuread_application_known_clients` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + azuread.application_known_clients.new('some_id') + +You can get the reference to the `id` field of the created `azuread.application_known_clients` using the reference: + + $._ref.azuread_application_known_clients.some_id.get('id') + +This is the same as directly entering `"${ azuread_application_known_clients.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `application_id` (`string`): The resource ID of the application to which this API access is granted + - `known_client_ids` (`list`): A list of known client IDs, used for bundling consent if you have a solution that includes an API and a client application + - `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_known_clients.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`azuread.application_known_clients.newAttrs` constructs a new object with attributes and blocks configured for the `application_known_clients` +Terraform resource. + +Unlike [azuread.application_known_clients.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `application_id` (`string`): The resource ID of the application to which this API access is granted + - `known_client_ids` (`list`): A list of known client IDs, used for bundling consent if you have a solution that includes an API and a client application + - `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_known_clients.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_known_clients` resource into the root Terraform configuration. + + +### fn withApplicationId + +```ts +withApplicationId() +``` + +`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the application_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `application_id` field. + + +### fn withKnownClientIds + +```ts +withKnownClientIds() +``` + +`azuread.list.withKnownClientIds` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the known_client_ids field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `known_client_ids` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`azuread.application_known_clients.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/application_optional_claims.md b/docs/2.x/application_optional_claims.md new file mode 100644 index 0000000..1941d7b --- /dev/null +++ b/docs/2.x/application_optional_claims.md @@ -0,0 +1,367 @@ +--- +permalink: /application_optional_claims/ +--- + +# application_optional_claims + +`application_optional_claims` represents the `azuread_application_optional_claims` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withAccessToken()`](#fn-withaccesstoken) +* [`fn withAccessTokenMixin()`](#fn-withaccesstokenmixin) +* [`fn withApplicationId()`](#fn-withapplicationid) +* [`fn withIdToken()`](#fn-withidtoken) +* [`fn withIdTokenMixin()`](#fn-withidtokenmixin) +* [`fn withSaml2Token()`](#fn-withsaml2token) +* [`fn withSaml2TokenMixin()`](#fn-withsaml2tokenmixin) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj access_token`](#obj-access_token) + * [`fn new()`](#fn-access_tokennew) +* [`obj id_token`](#obj-id_token) + * [`fn new()`](#fn-id_tokennew) +* [`obj saml2_token`](#obj-saml2_token) + * [`fn new()`](#fn-saml2_tokennew) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`azuread.application_optional_claims.new` injects a new `azuread_application_optional_claims` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + azuread.application_optional_claims.new('some_id') + +You can get the reference to the `id` field of the created `azuread.application_optional_claims` using the reference: + + $._ref.azuread_application_optional_claims.some_id.get('id') + +This is the same as directly entering `"${ azuread_application_optional_claims.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `application_id` (`string`): The resource ID of the application to which these optional claims belong + - `access_token` (`list[obj]`): Set the `access_token` field on the resulting resource block. 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-access_tokennew) constructor. + - `id_token` (`list[obj]`): Set the `id_token` field on the resulting resource block. 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-id_tokennew) constructor. + - `saml2_token` (`list[obj]`): Set the `saml2_token` field on the resulting resource block. 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-saml2_tokennew) 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_optional_claims.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`azuread.application_optional_claims.newAttrs` constructs a new object with attributes and blocks configured for the `application_optional_claims` +Terraform resource. + +Unlike [azuread.application_optional_claims.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `application_id` (`string`): The resource ID of the application to which these optional claims belong + - `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-access_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-id_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-saml2_tokennew) 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_optional_claims.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_optional_claims` resource into the root Terraform configuration. + + +### fn withAccessToken + +```ts +withAccessToken() +``` + +`azuread.list[obj].withAccessToken` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the access_token field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [azuread.list[obj].withAccessTokenMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `access_token` field. + + +### fn withAccessTokenMixin + +```ts +withAccessTokenMixin() +``` + +`azuread.list[obj].withAccessTokenMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the access_token field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [azuread.list[obj].withAccessToken](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `access_token` field. + + +### fn withApplicationId + +```ts +withApplicationId() +``` + +`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the application_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `application_id` field. + + +### fn withIdToken + +```ts +withIdToken() +``` + +`azuread.list[obj].withIdToken` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the id_token field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [azuread.list[obj].withIdTokenMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `id_token` field. + + +### fn withIdTokenMixin + +```ts +withIdTokenMixin() +``` + +`azuread.list[obj].withIdTokenMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the id_token field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [azuread.list[obj].withIdToken](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `id_token` field. + + +### fn withSaml2Token + +```ts +withSaml2Token() +``` + +`azuread.list[obj].withSaml2Token` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the saml2_token field. + +This function will replace the array with the passed in `value`. If you wish to instead append the +passed in value to the existing array, use the [azuread.list[obj].withSaml2TokenMixin](TODO) function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `saml2_token` field. + + +### fn withSaml2TokenMixin + +```ts +withSaml2TokenMixin() +``` + +`azuread.list[obj].withSaml2TokenMixin` constructs a mixin object that can be merged into the `list[obj]` +Terraform resource block to set or update the saml2_token field. + +This function will append the passed in array or object to the existing array. If you wish +to instead replace the array with the passed in `value`, use the [azuread.list[obj].withSaml2Token](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list[obj]`): The value to set for the `saml2_token` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj access_token + + + +### fn access_token.new + +```ts +new() +``` + + +`azuread.application_optional_claims.access_token.new` constructs a new object with attributes and blocks configured for the `access_token` +Terraform sub block. + + + +**Args**: + - `additional_properties` (`list`): List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim When `null`, the `additional_properties` field will be omitted from the resulting object. + - `essential` (`bool`): Whether the claim specified by the client is necessary to ensure a smooth authorization experience When `null`, the `essential` field will be omitted from the resulting object. + - `name` (`string`): The name of the optional claim + - `source` (`string`): The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object When `null`, the `source` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `access_token` sub block. + + +## obj id_token + + + +### fn id_token.new + +```ts +new() +``` + + +`azuread.application_optional_claims.id_token.new` constructs a new object with attributes and blocks configured for the `id_token` +Terraform sub block. + + + +**Args**: + - `additional_properties` (`list`): List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim When `null`, the `additional_properties` field will be omitted from the resulting object. + - `essential` (`bool`): Whether the claim specified by the client is necessary to ensure a smooth authorization experience When `null`, the `essential` field will be omitted from the resulting object. + - `name` (`string`): The name of the optional claim + - `source` (`string`): The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object When `null`, the `source` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `id_token` sub block. + + +## obj saml2_token + + + +### fn saml2_token.new + +```ts +new() +``` + + +`azuread.application_optional_claims.saml2_token.new` constructs a new object with attributes and blocks configured for the `saml2_token` +Terraform sub block. + + + +**Args**: + - `additional_properties` (`list`): List of additional properties of the claim. If a property exists in this list, it modifies the behaviour of the optional claim When `null`, the `additional_properties` field will be omitted from the resulting object. + - `essential` (`bool`): Whether the claim specified by the client is necessary to ensure a smooth authorization experience When `null`, the `essential` field will be omitted from the resulting object. + - `name` (`string`): The name of the optional claim + - `source` (`string`): The source of the claim. If `source` is absent, the claim is a predefined optional claim. If `source` is `user`, the value of `name` is the extension property from the user object When `null`, the `source` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `saml2_token` sub block. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`azuread.application_optional_claims.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/application_owner.md b/docs/2.x/application_owner.md new file mode 100644 index 0000000..9b72c18 --- /dev/null +++ b/docs/2.x/application_owner.md @@ -0,0 +1,178 @@ +--- +permalink: /application_owner/ +--- + +# application_owner + +`application_owner` represents the `azuread_application_owner` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withApplicationId()`](#fn-withapplicationid) +* [`fn withOwnerObjectId()`](#fn-withownerobjectid) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`azuread.application_owner.new` injects a new `azuread_application_owner` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + azuread.application_owner.new('some_id') + +You can get the reference to the `id` field of the created `azuread.application_owner` using the reference: + + $._ref.azuread_application_owner.some_id.get('id') + +This is the same as directly entering `"${ azuread_application_owner.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `application_id` (`string`): The resource ID of the application to which the owner should be added + - `owner_object_id` (`string`): Object ID of the principal that will be granted ownership of the application + - `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_owner.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`azuread.application_owner.newAttrs` constructs a new object with attributes and blocks configured for the `application_owner` +Terraform resource. + +Unlike [azuread.application_owner.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `application_id` (`string`): The resource ID of the application to which the owner should be added + - `owner_object_id` (`string`): Object ID of the principal that will be granted ownership of the application + - `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_owner.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_owner` resource into the root Terraform configuration. + + +### fn withApplicationId + +```ts +withApplicationId() +``` + +`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the application_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `application_id` field. + + +### fn withOwnerObjectId + +```ts +withOwnerObjectId() +``` + +`azuread.string.withOwnerObjectId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the owner_object_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `owner_object_id` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`azuread.application_owner.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object. + +**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 ef095d4..689ab27 100644 --- a/docs/2.x/application_password.md +++ b/docs/2.x/application_password.md @@ -15,6 +15,7 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) +* [`fn withApplicationId()`](#fn-withapplicationid) * [`fn withApplicationObjectId()`](#fn-withapplicationobjectid) * [`fn withDisplayName()`](#fn-withdisplayname) * [`fn withEndDate()`](#fn-withenddate) @@ -55,7 +56,8 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the block. - - `application_object_id` (`string`): The object ID of the application for which this password should be created + - `application_id` (`string`): The resource ID of the application for which this password should be created When `null`, the `application_id` field will be omitted from the resulting object. + - `application_object_id` (`string`): The object ID of the application for which this password should be created When `null`, the `application_object_id` field will be omitted from the resulting object. - `display_name` (`string`): A display name for the password When `null`, the `display_name` field will be omitted from the resulting object. - `end_date` (`string`): The end date until which the password is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`) When `null`, the `end_date` field will be omitted from the resulting object. - `end_date_relative` (`string`): A relative duration for which the password is valid until, for example `240h` (10 days) or `2400h30m`. Changing this field forces a new resource to be created When `null`, the `end_date_relative` field will be omitted from the resulting object. @@ -85,7 +87,8 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `application_object_id` (`string`): The object ID of the application for which this password should be created + - `application_id` (`string`): The resource ID of the application for which this password should be created When `null`, the `application_id` field will be omitted from the resulting object. + - `application_object_id` (`string`): The object ID of the application for which this password should be created When `null`, the `application_object_id` field will be omitted from the resulting object. - `display_name` (`string`): A display name for the password When `null`, the `display_name` field will be omitted from the resulting object. - `end_date` (`string`): The end date until which the password is valid, formatted as an RFC3339 date string (e.g. `2018-01-01T01:02:03Z`) When `null`, the `end_date` field will be omitted from the resulting object. - `end_date_relative` (`string`): A relative duration for which the password is valid until, for example `240h` (10 days) or `2400h30m`. Changing this field forces a new resource to be created When `null`, the `end_date_relative` field will be omitted from the resulting object. @@ -97,6 +100,22 @@ injecting into a complete block. - 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. +### fn withApplicationId + +```ts +withApplicationId() +``` + +`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the application_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `application_id` field. + + ### fn withApplicationObjectId ```ts diff --git a/docs/2.x/application_permission_scope.md b/docs/2.x/application_permission_scope.md new file mode 100644 index 0000000..9fc7b1e --- /dev/null +++ b/docs/2.x/application_permission_scope.md @@ -0,0 +1,293 @@ +--- +permalink: /application_permission_scope/ +--- + +# application_permission_scope + +`application_permission_scope` represents the `azuread_application_permission_scope` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withAdminConsentDescription()`](#fn-withadminconsentdescription) +* [`fn withAdminConsentDisplayName()`](#fn-withadminconsentdisplayname) +* [`fn withApplicationId()`](#fn-withapplicationid) +* [`fn withScopeId()`](#fn-withscopeid) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withType()`](#fn-withtype) +* [`fn withUserConsentDescription()`](#fn-withuserconsentdescription) +* [`fn withUserConsentDisplayName()`](#fn-withuserconsentdisplayname) +* [`fn withValue()`](#fn-withvalue) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`azuread.application_permission_scope.new` injects a new `azuread_application_permission_scope` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + azuread.application_permission_scope.new('some_id') + +You can get the reference to the `id` field of the created `azuread.application_permission_scope` using the reference: + + $._ref.azuread_application_permission_scope.some_id.get('id') + +This is the same as directly entering `"${ azuread_application_permission_scope.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `admin_consent_description` (`string`): Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users + - `admin_consent_display_name` (`string`): Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users + - `application_id` (`string`): The resource ID of the application to which this permission scope should be applied + - `scope_id` (`string`): The unique identifier of the permission scope + - `type` (`string`): Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions When `null`, the `type` field will be omitted from the resulting object. + - `user_consent_description` (`string`): Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf When `null`, the `user_consent_description` field will be omitted from the resulting object. + - `user_consent_display_name` (`string`): Display name for the delegated permission that appears in the end user consent experience When `null`, the `user_consent_display_name` field will be omitted from the resulting object. + - `value` (`string`): The value that is used for the `scp` claim in OAuth access tokens + - `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_permission_scope.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`azuread.application_permission_scope.newAttrs` constructs a new object with attributes and blocks configured for the `application_permission_scope` +Terraform resource. + +Unlike [azuread.application_permission_scope.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `admin_consent_description` (`string`): Delegated permission description that appears in all tenant-wide admin consent experiences, intended to be read by an administrator granting the permission on behalf of all users + - `admin_consent_display_name` (`string`): Display name for the delegated permission, intended to be read by an administrator granting the permission on behalf of all users + - `application_id` (`string`): The resource ID of the application to which this permission scope should be applied + - `scope_id` (`string`): The unique identifier of the permission scope + - `type` (`string`): Whether this delegated permission should be considered safe for non-admin users to consent to on behalf of themselves, or whether an administrator should be required for consent to the permissions When `null`, the `type` field will be omitted from the resulting object. + - `user_consent_description` (`string`): Delegated permission description that appears in the end user consent experience, intended to be read by a user consenting on their own behalf When `null`, the `user_consent_description` field will be omitted from the resulting object. + - `user_consent_display_name` (`string`): Display name for the delegated permission that appears in the end user consent experience When `null`, the `user_consent_display_name` field will be omitted from the resulting object. + - `value` (`string`): The value that is used for the `scp` claim in OAuth access tokens + - `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_permission_scope.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_permission_scope` resource into the root Terraform configuration. + + +### fn withAdminConsentDescription + +```ts +withAdminConsentDescription() +``` + +`azuread.string.withAdminConsentDescription` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the admin_consent_description field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `admin_consent_description` field. + + +### fn withAdminConsentDisplayName + +```ts +withAdminConsentDisplayName() +``` + +`azuread.string.withAdminConsentDisplayName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the admin_consent_display_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `admin_consent_display_name` field. + + +### fn withApplicationId + +```ts +withApplicationId() +``` + +`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the application_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `application_id` field. + + +### fn withScopeId + +```ts +withScopeId() +``` + +`azuread.string.withScopeId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the scope_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `scope_id` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withType + +```ts +withType() +``` + +`azuread.string.withType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `type` field. + + +### fn withUserConsentDescription + +```ts +withUserConsentDescription() +``` + +`azuread.string.withUserConsentDescription` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the user_consent_description field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `user_consent_description` field. + + +### fn withUserConsentDisplayName + +```ts +withUserConsentDisplayName() +``` + +`azuread.string.withUserConsentDisplayName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the user_consent_display_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `user_consent_display_name` field. + + +### fn withValue + +```ts +withValue() +``` + +`azuread.string.withValue` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the value field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `value` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`azuread.application_permission_scope.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/application_pre_authorized.md b/docs/2.x/application_pre_authorized.md index fe85828..5d48504 100644 --- a/docs/2.x/application_pre_authorized.md +++ b/docs/2.x/application_pre_authorized.md @@ -15,8 +15,10 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) +* [`fn withApplicationId()`](#fn-withapplicationid) * [`fn withApplicationObjectId()`](#fn-withapplicationobjectid) * [`fn withAuthorizedAppId()`](#fn-withauthorizedappid) +* [`fn withAuthorizedClientId()`](#fn-withauthorizedclientid) * [`fn withPermissionIds()`](#fn-withpermissionids) * [`fn withTimeouts()`](#fn-withtimeouts) * [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) @@ -52,8 +54,10 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `resourceLabel` (`string`): The name label of the 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 + - `application_id` (`string`): The resource ID of the application to which this pre-authorized application should be added When `null`, the `application_id` field will be omitted from the resulting object. + - `application_object_id` (`string`): The object ID of the application to which this pre-authorized application should be added When `null`, the `application_object_id` field will be omitted from the resulting object. + - `authorized_app_id` (`string`): The application ID of the pre-authorized application When `null`, the `authorized_app_id` field will be omitted from the resulting object. + - `authorized_client_id` (`string`): The client ID of the pre-authorized application When `null`, the `authorized_client_id` field will be omitted from the resulting object. - `permission_ids` (`list`): The IDs of the permission scopes required by the pre-authorized application - `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. @@ -79,8 +83,10 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: - - `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 + - `application_id` (`string`): The resource ID of the application to which this pre-authorized application should be added When `null`, the `application_id` field will be omitted from the resulting object. + - `application_object_id` (`string`): The object ID of the application to which this pre-authorized application should be added When `null`, the `application_object_id` field will be omitted from the resulting object. + - `authorized_app_id` (`string`): The application ID of the pre-authorized application When `null`, the `authorized_app_id` field will be omitted from the resulting object. + - `authorized_client_id` (`string`): The client ID of the pre-authorized application When `null`, the `authorized_client_id` field will be omitted from the resulting object. - `permission_ids` (`list`): The IDs of the permission scopes required by the pre-authorized application - `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. @@ -88,6 +94,22 @@ injecting into a complete block. - 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. +### fn withApplicationId + +```ts +withApplicationId() +``` + +`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the application_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `application_id` field. + + ### fn withApplicationObjectId ```ts @@ -120,6 +142,22 @@ Terraform resource block to set or update the authorized_app_id field. - `value` (`string`): The value to set for the `authorized_app_id` field. +### fn withAuthorizedClientId + +```ts +withAuthorizedClientId() +``` + +`azuread.string.withAuthorizedClientId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the authorized_client_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `authorized_client_id` field. + + ### fn withPermissionIds ```ts diff --git a/docs/2.x/application_redirect_uris.md b/docs/2.x/application_redirect_uris.md new file mode 100644 index 0000000..0fdcdd5 --- /dev/null +++ b/docs/2.x/application_redirect_uris.md @@ -0,0 +1,198 @@ +--- +permalink: /application_redirect_uris/ +--- + +# application_redirect_uris + +`application_redirect_uris` represents the `azuread_application_redirect_uris` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withApplicationId()`](#fn-withapplicationid) +* [`fn withRedirectUris()`](#fn-withredirecturis) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`fn withType()`](#fn-withtype) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`azuread.application_redirect_uris.new` injects a new `azuread_application_redirect_uris` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + azuread.application_redirect_uris.new('some_id') + +You can get the reference to the `id` field of the created `azuread.application_redirect_uris` using the reference: + + $._ref.azuread_application_redirect_uris.some_id.get('id') + +This is the same as directly entering `"${ azuread_application_redirect_uris.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `application_id` (`string`): The resource ID of the application to which these redirect URIs belong + - `redirect_uris` (`list`): A set of redirect URIs + - `type` (`string`): The type of redirect URIs to assign to the application + - `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_redirect_uris.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`azuread.application_redirect_uris.newAttrs` constructs a new object with attributes and blocks configured for the `application_redirect_uris` +Terraform resource. + +Unlike [azuread.application_redirect_uris.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `application_id` (`string`): The resource ID of the application to which these redirect URIs belong + - `redirect_uris` (`list`): A set of redirect URIs + - `type` (`string`): The type of redirect URIs to assign to the application + - `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_redirect_uris.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_redirect_uris` resource into the root Terraform configuration. + + +### fn withApplicationId + +```ts +withApplicationId() +``` + +`azuread.string.withApplicationId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the application_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `application_id` field. + + +### fn withRedirectUris + +```ts +withRedirectUris() +``` + +`azuread.list.withRedirectUris` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the redirect_uris field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `redirect_uris` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withType + +```ts +withType() +``` + +`azuread.string.withType` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the type field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `type` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`azuread.application_redirect_uris.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/application_registration.md b/docs/2.x/application_registration.md new file mode 100644 index 0000000..efe6ce6 --- /dev/null +++ b/docs/2.x/application_registration.md @@ -0,0 +1,426 @@ +--- +permalink: /application_registration/ +--- + +# application_registration + +`application_registration` represents the `azuread_application_registration` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withDisplayName()`](#fn-withdisplayname) +* [`fn withGroupMembershipClaims()`](#fn-withgroupmembershipclaims) +* [`fn withHomepageUrl()`](#fn-withhomepageurl) +* [`fn withImplicitAccessTokenIssuanceEnabled()`](#fn-withimplicitaccesstokenissuanceenabled) +* [`fn withImplicitIdTokenIssuanceEnabled()`](#fn-withimplicitidtokenissuanceenabled) +* [`fn withLogoutUrl()`](#fn-withlogouturl) +* [`fn withMarketingUrl()`](#fn-withmarketingurl) +* [`fn withNotes()`](#fn-withnotes) +* [`fn withPrivacyStatementUrl()`](#fn-withprivacystatementurl) +* [`fn withRequestedAccessTokenVersion()`](#fn-withrequestedaccesstokenversion) +* [`fn withServiceManagementReference()`](#fn-withservicemanagementreference) +* [`fn withSignInAudience()`](#fn-withsigninaudience) +* [`fn withSupportUrl()`](#fn-withsupporturl) +* [`fn withTermsOfServiceUrl()`](#fn-withtermsofserviceurl) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`azuread.application_registration.new` injects a new `azuread_application_registration` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + azuread.application_registration.new('some_id') + +You can get the reference to the `id` field of the created `azuread.application_registration` using the reference: + + $._ref.azuread_application_registration.some_id.get('id') + +This is the same as directly entering `"${ azuread_application_registration.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `description` (`string`): Description of the application as shown to end users When `null`, the `description` field will be omitted from the resulting object. + - `display_name` (`string`): The display name for the application + - `group_membership_claims` (`list`): Configures the `groups` claim that the app expects issued in a user or OAuth access token When `null`, the `group_membership_claims` field will be omitted from the resulting object. + - `homepage_url` (`string`): URL of the home page for the application When `null`, the `homepage_url` field will be omitted from the resulting object. + - `implicit_access_token_issuance_enabled` (`bool`): Whether this application can request an access token using OAuth implicit flow When `null`, the `implicit_access_token_issuance_enabled` field will be omitted from the resulting object. + - `implicit_id_token_issuance_enabled` (`bool`): Whether this application can request an ID token using OAuth implicit flow When `null`, the `implicit_id_token_issuance_enabled` field will be omitted from the resulting object. + - `logout_url` (`string`): URL of the logout page for the application, where the session is cleared for single sign-out When `null`, the `logout_url` field will be omitted from the resulting object. + - `marketing_url` (`string`): URL of the marketing page for the application When `null`, the `marketing_url` field will be omitted from the resulting object. + - `notes` (`string`): User-specified notes relevant for the management of the application When `null`, the `notes` field will be omitted from the resulting object. + - `privacy_statement_url` (`string`): URL of the privacy statement for the application When `null`, the `privacy_statement_url` field will be omitted from the resulting object. + - `requested_access_token_version` (`number`): The access token version expected by this resource When `null`, the `requested_access_token_version` field will be omitted from the resulting object. + - `service_management_reference` (`string`): References application or contact information from a service or asset management database When `null`, the `service_management_reference` field will be omitted from the resulting object. + - `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. + - `support_url` (`string`): URL of the support page for the application When `null`, the `support_url` field will be omitted from the resulting object. + - `terms_of_service_url` (`string`): URL of the terms of service statement for the application When `null`, the `terms_of_service_url` field will be omitted from the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting resource block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.application_registration.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`azuread.application_registration.newAttrs` constructs a new object with attributes and blocks configured for the `application_registration` +Terraform resource. + +Unlike [azuread.application_registration.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `description` (`string`): Description of the application as shown to end users When `null`, the `description` field will be omitted from the resulting object. + - `display_name` (`string`): The display name for the application + - `group_membership_claims` (`list`): Configures the `groups` claim that the app expects issued in a user or OAuth access token When `null`, the `group_membership_claims` field will be omitted from the resulting object. + - `homepage_url` (`string`): URL of the home page for the application When `null`, the `homepage_url` field will be omitted from the resulting object. + - `implicit_access_token_issuance_enabled` (`bool`): Whether this application can request an access token using OAuth implicit flow When `null`, the `implicit_access_token_issuance_enabled` field will be omitted from the resulting object. + - `implicit_id_token_issuance_enabled` (`bool`): Whether this application can request an ID token using OAuth implicit flow When `null`, the `implicit_id_token_issuance_enabled` field will be omitted from the resulting object. + - `logout_url` (`string`): URL of the logout page for the application, where the session is cleared for single sign-out When `null`, the `logout_url` field will be omitted from the resulting object. + - `marketing_url` (`string`): URL of the marketing page for the application When `null`, the `marketing_url` field will be omitted from the resulting object. + - `notes` (`string`): User-specified notes relevant for the management of the application When `null`, the `notes` field will be omitted from the resulting object. + - `privacy_statement_url` (`string`): URL of the privacy statement for the application When `null`, the `privacy_statement_url` field will be omitted from the resulting object. + - `requested_access_token_version` (`number`): The access token version expected by this resource When `null`, the `requested_access_token_version` field will be omitted from the resulting object. + - `service_management_reference` (`string`): References application or contact information from a service or asset management database When `null`, the `service_management_reference` field will be omitted from the resulting object. + - `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. + - `support_url` (`string`): URL of the support page for the application When `null`, the `support_url` field will be omitted from the resulting object. + - `terms_of_service_url` (`string`): URL of the terms of service statement for the application When `null`, the `terms_of_service_url` field will be omitted from the resulting object. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.application_registration.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_registration` resource into the root Terraform configuration. + + +### fn withDescription + +```ts +withDescription() +``` + +`azuread.string.withDescription` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the description field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `description` field. + + +### fn withDisplayName + +```ts +withDisplayName() +``` + +`azuread.string.withDisplayName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the display_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `display_name` field. + + +### fn withGroupMembershipClaims + +```ts +withGroupMembershipClaims() +``` + +`azuread.list.withGroupMembershipClaims` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the group_membership_claims field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `group_membership_claims` field. + + +### fn withHomepageUrl + +```ts +withHomepageUrl() +``` + +`azuread.string.withHomepageUrl` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the homepage_url field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `homepage_url` field. + + +### fn withImplicitAccessTokenIssuanceEnabled + +```ts +withImplicitAccessTokenIssuanceEnabled() +``` + +`azuread.bool.withImplicitAccessTokenIssuanceEnabled` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the implicit_access_token_issuance_enabled field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `implicit_access_token_issuance_enabled` field. + + +### fn withImplicitIdTokenIssuanceEnabled + +```ts +withImplicitIdTokenIssuanceEnabled() +``` + +`azuread.bool.withImplicitIdTokenIssuanceEnabled` constructs a mixin object that can be merged into the `bool` +Terraform resource block to set or update the implicit_id_token_issuance_enabled field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`bool`): The value to set for the `implicit_id_token_issuance_enabled` field. + + +### fn withLogoutUrl + +```ts +withLogoutUrl() +``` + +`azuread.string.withLogoutUrl` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the logout_url field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `logout_url` field. + + +### fn withMarketingUrl + +```ts +withMarketingUrl() +``` + +`azuread.string.withMarketingUrl` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the marketing_url field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `marketing_url` field. + + +### fn withNotes + +```ts +withNotes() +``` + +`azuread.string.withNotes` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the notes field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `notes` field. + + +### fn withPrivacyStatementUrl + +```ts +withPrivacyStatementUrl() +``` + +`azuread.string.withPrivacyStatementUrl` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the privacy_statement_url field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `privacy_statement_url` field. + + +### fn withRequestedAccessTokenVersion + +```ts +withRequestedAccessTokenVersion() +``` + +`azuread.number.withRequestedAccessTokenVersion` constructs a mixin object that can be merged into the `number` +Terraform resource block to set or update the requested_access_token_version field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`number`): The value to set for the `requested_access_token_version` field. + + +### fn withServiceManagementReference + +```ts +withServiceManagementReference() +``` + +`azuread.string.withServiceManagementReference` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the service_management_reference field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `service_management_reference` field. + + +### fn withSignInAudience + +```ts +withSignInAudience() +``` + +`azuread.string.withSignInAudience` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the sign_in_audience field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `sign_in_audience` field. + + +### fn withSupportUrl + +```ts +withSupportUrl() +``` + +`azuread.string.withSupportUrl` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the support_url field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `support_url` field. + + +### fn withTermsOfServiceUrl + +```ts +withTermsOfServiceUrl() +``` + +`azuread.string.withTermsOfServiceUrl` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the terms_of_service_url field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `terms_of_service_url` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`azuread.application_registration.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/authentication_strength_policy.md b/docs/2.x/authentication_strength_policy.md new file mode 100644 index 0000000..277da58 --- /dev/null +++ b/docs/2.x/authentication_strength_policy.md @@ -0,0 +1,198 @@ +--- +permalink: /authentication_strength_policy/ +--- + +# authentication_strength_policy + +`authentication_strength_policy` represents the `azuread_authentication_strength_policy` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withAllowedCombinations()`](#fn-withallowedcombinations) +* [`fn withDescription()`](#fn-withdescription) +* [`fn withDisplayName()`](#fn-withdisplayname) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`azuread.authentication_strength_policy.new` injects a new `azuread_authentication_strength_policy` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + azuread.authentication_strength_policy.new('some_id') + +You can get the reference to the `id` field of the created `azuread.authentication_strength_policy` using the reference: + + $._ref.azuread_authentication_strength_policy.some_id.get('id') + +This is the same as directly entering `"${ azuread_authentication_strength_policy.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `allowed_combinations` (`list`): The allowed MFA methods for this policy + - `description` (`string`): The description for the authentication strength policy When `null`, the `description` field will be omitted from the resulting object. + - `display_name` (`string`): The display name for the authentication strength policy + - `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.authentication_strength_policy.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`azuread.authentication_strength_policy.newAttrs` constructs a new object with attributes and blocks configured for the `authentication_strength_policy` +Terraform resource. + +Unlike [azuread.authentication_strength_policy.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `allowed_combinations` (`list`): The allowed MFA methods for this policy + - `description` (`string`): The description for the authentication strength policy When `null`, the `description` field will be omitted from the resulting object. + - `display_name` (`string`): The display name for the authentication strength policy + - `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.authentication_strength_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 `authentication_strength_policy` resource into the root Terraform configuration. + + +### fn withAllowedCombinations + +```ts +withAllowedCombinations() +``` + +`azuread.list.withAllowedCombinations` constructs a mixin object that can be merged into the `list` +Terraform resource block to set or update the allowed_combinations field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `allowed_combinations` field. + + +### fn withDescription + +```ts +withDescription() +``` + +`azuread.string.withDescription` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the description field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `description` field. + + +### fn withDisplayName + +```ts +withDisplayName() +``` + +`azuread.string.withDisplayName` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the display_name field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `display_name` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`azuread.authentication_strength_policy.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/conditional_access_policy.md b/docs/2.x/conditional_access_policy.md index e707ce8..7f8beb8 100644 --- a/docs/2.x/conditional_access_policy.md +++ b/docs/2.x/conditional_access_policy.md @@ -41,6 +41,14 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-conditionsplatformsnew) * [`obj conditions.users`](#obj-conditionsusers) * [`fn new()`](#fn-conditionsusersnew) + * [`obj conditions.users.excluded_guests_or_external_users`](#obj-conditionsusersexcluded_guests_or_external_users) + * [`fn new()`](#fn-conditionsusersexcluded_guests_or_external_usersnew) + * [`obj conditions.users.excluded_guests_or_external_users.external_tenants`](#obj-conditionsusersexcluded_guests_or_external_usersexternal_tenants) + * [`fn new()`](#fn-conditionsusersexcluded_guests_or_external_usersexternal_tenantsnew) + * [`obj conditions.users.included_guests_or_external_users`](#obj-conditionsusersincluded_guests_or_external_users) + * [`fn new()`](#fn-conditionsusersincluded_guests_or_external_usersnew) + * [`obj conditions.users.included_guests_or_external_users.external_tenants`](#obj-conditionsusersincluded_guests_or_external_usersexternal_tenants) + * [`fn new()`](#fn-conditionsusersincluded_guests_or_external_usersexternal_tenantsnew) * [`obj grant_controls`](#obj-grant_controls) * [`fn new()`](#fn-grant_controlsnew) * [`obj session_controls`](#obj-session_controls) @@ -495,11 +503,109 @@ Terraform sub block. - `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. + - `excluded_guests_or_external_users` (`list[obj]`): Set the `excluded_guests_or_external_users` field on the resulting object. When `null`, the `excluded_guests_or_external_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.excluded_guests_or_external_users.new](#fn-conditionsconditionsexcluded_guests_or_external_usersnew) constructor. + - `included_guests_or_external_users` (`list[obj]`): Set the `included_guests_or_external_users` field on the resulting object. When `null`, the `included_guests_or_external_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.included_guests_or_external_users.new](#fn-conditionsconditionsincluded_guests_or_external_usersnew) constructor. **Returns**: - An attribute object that represents the `users` sub block. +## obj conditions.users.excluded_guests_or_external_users + + + +### fn conditions.users.excluded_guests_or_external_users.new + +```ts +new() +``` + + +`azuread.conditional_access_policy.conditions.users.excluded_guests_or_external_users.new` constructs a new object with attributes and blocks configured for the `excluded_guests_or_external_users` +Terraform sub block. + + + +**Args**: + - `guest_or_external_user_types` (`list`): Set the `guest_or_external_user_types` field on the resulting object. + - `external_tenants` (`list[obj]`): Set the `external_tenants` field on the resulting object. When `null`, the `external_tenants` 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.excluded_guests_or_external_users.external_tenants.new](#fn-conditionsconditionsusersexternal_tenantsnew) constructor. + +**Returns**: + - An attribute object that represents the `excluded_guests_or_external_users` sub block. + + +## obj conditions.users.excluded_guests_or_external_users.external_tenants + + + +### fn conditions.users.excluded_guests_or_external_users.external_tenants.new + +```ts +new() +``` + + +`azuread.conditional_access_policy.conditions.users.excluded_guests_or_external_users.external_tenants.new` constructs a new object with attributes and blocks configured for the `external_tenants` +Terraform sub block. + + + +**Args**: + - `members` (`list`): Set the `members` field on the resulting object. When `null`, the `members` field will be omitted from the resulting object. + - `membership_kind` (`string`): Set the `membership_kind` field on the resulting object. + +**Returns**: + - An attribute object that represents the `external_tenants` sub block. + + +## obj conditions.users.included_guests_or_external_users + + + +### fn conditions.users.included_guests_or_external_users.new + +```ts +new() +``` + + +`azuread.conditional_access_policy.conditions.users.included_guests_or_external_users.new` constructs a new object with attributes and blocks configured for the `included_guests_or_external_users` +Terraform sub block. + + + +**Args**: + - `guest_or_external_user_types` (`list`): Set the `guest_or_external_user_types` field on the resulting object. + - `external_tenants` (`list[obj]`): Set the `external_tenants` field on the resulting object. When `null`, the `external_tenants` 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.included_guests_or_external_users.external_tenants.new](#fn-conditionsconditionsusersexternal_tenantsnew) constructor. + +**Returns**: + - An attribute object that represents the `included_guests_or_external_users` sub block. + + +## obj conditions.users.included_guests_or_external_users.external_tenants + + + +### fn conditions.users.included_guests_or_external_users.external_tenants.new + +```ts +new() +``` + + +`azuread.conditional_access_policy.conditions.users.included_guests_or_external_users.external_tenants.new` constructs a new object with attributes and blocks configured for the `external_tenants` +Terraform sub block. + + + +**Args**: + - `members` (`list`): Set the `members` field on the resulting object. When `null`, the `members` field will be omitted from the resulting object. + - `membership_kind` (`string`): Set the `membership_kind` field on the resulting object. + +**Returns**: + - An attribute object that represents the `external_tenants` sub block. + + ## obj grant_controls @@ -517,6 +623,7 @@ Terraform sub block. **Args**: + - `authentication_strength_policy_id` (`string`): Set the `authentication_strength_policy_id` field on the resulting object. When `null`, the `authentication_strength_policy_id` field will be omitted from the resulting object. - `built_in_controls` (`list`): Set the `built_in_controls` field on the resulting object. When `null`, the `built_in_controls` field will be omitted from 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. @@ -548,6 +655,8 @@ Terraform sub block. - `disable_resilience_defaults` (`bool`): Set the `disable_resilience_defaults` field on the resulting object. When `null`, the `disable_resilience_defaults` 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_authentication_type` (`string`): Set the `sign_in_frequency_authentication_type` field on the resulting object. When `null`, the `sign_in_frequency_authentication_type` field will be omitted from the resulting object. + - `sign_in_frequency_interval` (`string`): Set the `sign_in_frequency_interval` field on the resulting object. When `null`, the `sign_in_frequency_interval` 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**: diff --git a/docs/2.x/data/application.md b/docs/2.x/data/application.md index 2977c3f..1e04284 100644 --- a/docs/2.x/data/application.md +++ b/docs/2.x/data/application.md @@ -16,6 +16,7 @@ This package contains functions and utilities for setting up the data source usi * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) * [`fn withApplicationId()`](#fn-withapplicationid) +* [`fn withClientId()`](#fn-withclientid) * [`fn withDisplayName()`](#fn-withdisplayname) * [`fn withObjectId()`](#fn-withobjectid) * [`fn withTimeouts()`](#fn-withtimeouts) @@ -53,6 +54,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `dataSrcLabel` (`string`): The name label of the block. - `application_id` (`string`): The Application ID (also called Client ID) When `null`, the `application_id` field will be omitted from the resulting object. + - `client_id` (`string`): The Client ID (also called Application ID) When `null`, the `client_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`): 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. @@ -80,6 +82,7 @@ injecting into a complete block. **Args**: - `application_id` (`string`): The Application ID (also called Client ID) When `null`, the `application_id` field will be omitted from the resulting object. + - `client_id` (`string`): The Client ID (also called Application ID) When `null`, the `client_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`): 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. @@ -104,6 +107,22 @@ Terraform data source block to set or update the application_id field. - `value` (`string`): The value to set for the `application_id` field. +### fn withClientId + +```ts +withClientId() +``` + +`azuread.string.withClientId` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the client_id field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `client_id` field. + + ### fn withDisplayName ```ts diff --git a/docs/2.x/data/service_principal.md b/docs/2.x/data/service_principal.md index d221cf5..4bd3c36 100644 --- a/docs/2.x/data/service_principal.md +++ b/docs/2.x/data/service_principal.md @@ -16,6 +16,7 @@ This package contains functions and utilities for setting up the data source usi * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) * [`fn withApplicationId()`](#fn-withapplicationid) +* [`fn withClientId()`](#fn-withclientid) * [`fn withDisplayName()`](#fn-withdisplayname) * [`fn withObjectId()`](#fn-withobjectid) * [`fn withTimeouts()`](#fn-withtimeouts) @@ -53,6 +54,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `dataSrcLabel` (`string`): The name label of the block. - `application_id` (`string`): The application ID (client ID) of the application associated with this service principal When `null`, the `application_id` field will be omitted from the resulting object. + - `client_id` (`string`): The client ID of the application associated with this service principal When `null`, the `client_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`): 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. @@ -80,6 +82,7 @@ injecting into a complete block. **Args**: - `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. + - `client_id` (`string`): The client ID of the application associated with this service principal When `null`, the `client_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`): 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. @@ -104,6 +107,22 @@ Terraform data source block to set or update the application_id field. - `value` (`string`): The value to set for the `application_id` field. +### fn withClientId + +```ts +withClientId() +``` + +`azuread.string.withClientId` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the client_id field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `client_id` field. + + ### fn withDisplayName ```ts diff --git a/docs/2.x/data/service_principals.md b/docs/2.x/data/service_principals.md index 090ca98..4a0c180 100644 --- a/docs/2.x/data/service_principals.md +++ b/docs/2.x/data/service_principals.md @@ -16,6 +16,7 @@ This package contains functions and utilities for setting up the data source usi * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) * [`fn withApplicationIds()`](#fn-withapplicationids) +* [`fn withClientIds()`](#fn-withclientids) * [`fn withDisplayNames()`](#fn-withdisplaynames) * [`fn withIgnoreMissing()`](#fn-withignoremissing) * [`fn withObjectIds()`](#fn-withobjectids) @@ -55,6 +56,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `dataSrcLabel` (`string`): The name label of the block. - `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. + - `client_ids` (`list`): The client IDs of the applications associated with the service principals When `null`, the `client_ids` field will be omitted from the resulting object. - `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. - `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. @@ -84,6 +86,7 @@ injecting into a complete block. **Args**: - `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. + - `client_ids` (`list`): The client IDs of the applications associated with the service principals When `null`, the `client_ids` field will be omitted from the resulting object. - `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. - `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. @@ -110,6 +113,22 @@ Terraform data source block to set or update the application_ids field. - `value` (`list`): The value to set for the `application_ids` field. +### fn withClientIds + +```ts +withClientIds() +``` + +`azuread.list.withClientIds` constructs a mixin object that can be merged into the `list` +Terraform data source block to set or update the client_ids field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `client_ids` field. + + ### fn withDisplayNames ```ts diff --git a/docs/2.x/directory_role.md b/docs/2.x/directory_role.md index 1168214..acc3dd8 100644 --- a/docs/2.x/directory_role.md +++ b/docs/2.x/directory_role.md @@ -173,7 +173,6 @@ Terraform sub block. - `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_eligibility_schedule_request.md b/docs/2.x/directory_role_eligibility_schedule_request.md new file mode 100644 index 0000000..2a79e00 --- /dev/null +++ b/docs/2.x/directory_role_eligibility_schedule_request.md @@ -0,0 +1,217 @@ +--- +permalink: /directory_role_eligibility_schedule_request/ +--- + +# directory_role_eligibility_schedule_request + +`directory_role_eligibility_schedule_request` represents the `azuread_directory_role_eligibility_schedule_request` Terraform resource. + + + +This package contains functions and utilities for setting up the resource using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withDirectoryScopeId()`](#fn-withdirectoryscopeid) +* [`fn withJustification()`](#fn-withjustification) +* [`fn withPrincipalId()`](#fn-withprincipalid) +* [`fn withRoleDefinitionId()`](#fn-withroledefinitionid) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`azuread.directory_role_eligibility_schedule_request.new` injects a new `azuread_directory_role_eligibility_schedule_request` Terraform `resource` +block into the root module document. + +Additionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the +resource. For example, if you added a new instance to the root using: + + # arguments omitted for brevity + azuread.directory_role_eligibility_schedule_request.new('some_id') + +You can get the reference to the `id` field of the created `azuread.directory_role_eligibility_schedule_request` using the reference: + + $._ref.azuread_directory_role_eligibility_schedule_request.some_id.get('id') + +This is the same as directly entering `"${ azuread_directory_role_eligibility_schedule_request.some_id.id }"` as the value. + +NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`, +or `$` to refer to the root object. Instead, make an explicit outer object using `local`. + +**Args**: + - `resourceLabel` (`string`): The name label of the block. + - `directory_scope_id` (`string`): Identifier of the directory object representing the scope of the role eligibility schedule request + - `justification` (`string`): Justification for why the role is assigned + - `principal_id` (`string`): The object ID of the member principal + - `role_definition_id` (`string`): The object ID of the directory role for this role eligibility schedule request + - `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_eligibility_schedule_request.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new resource into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`azuread.directory_role_eligibility_schedule_request.newAttrs` constructs a new object with attributes and blocks configured for the `directory_role_eligibility_schedule_request` +Terraform resource. + +Unlike [azuread.directory_role_eligibility_schedule_request.new](#fn-new), this function will not inject the `resource` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withResource](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withresource) function to build a complete block. + +This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to +injecting into a complete block. + +**Args**: + - `directory_scope_id` (`string`): Identifier of the directory object representing the scope of the role eligibility schedule request + - `justification` (`string`): Justification for why the role is assigned + - `principal_id` (`string`): The object ID of the member principal + - `role_definition_id` (`string`): The object ID of the directory role for this role eligibility schedule request + - `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_eligibility_schedule_request.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_eligibility_schedule_request` resource into the root Terraform configuration. + + +### fn withDirectoryScopeId + +```ts +withDirectoryScopeId() +``` + +`azuread.string.withDirectoryScopeId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the directory_scope_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `directory_scope_id` field. + + +### fn withJustification + +```ts +withJustification() +``` + +`azuread.string.withJustification` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the justification field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `justification` field. + + +### fn withPrincipalId + +```ts +withPrincipalId() +``` + +`azuread.string.withPrincipalId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the principal_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `principal_id` field. + + +### fn withRoleDefinitionId + +```ts +withRoleDefinitionId() +``` + +`azuread.string.withRoleDefinitionId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the role_definition_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `role_definition_id` field. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will replace the map with the passed in `value`. If you wish to instead merge the +passed in value to the existing map, use the [azuread.obj.withTimeoutsMixin](TODO) function. + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +### fn withTimeoutsMixin + +```ts +withTimeoutsMixin() +``` + +`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj` +Terraform resource block to set or update the timeouts field. + +This function will merge the passed in value to the existing map. If you wish +to instead replace the entire map with the passed in `value`, use the [azuread.obj.withTimeouts](TODO) +function. + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`obj`): The value to set for the `timeouts` field. + + +## obj timeouts + + + +### fn timeouts.new + +```ts +new() +``` + + +`azuread.directory_role_eligibility_schedule_request.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object. + - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object. + - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object. + - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/service_principal.md b/docs/2.x/service_principal.md index c319e89..585ec23 100644 --- a/docs/2.x/service_principal.md +++ b/docs/2.x/service_principal.md @@ -19,6 +19,7 @@ This package contains functions and utilities for setting up the resource using * [`fn withAlternativeNames()`](#fn-withalternativenames) * [`fn withAppRoleAssignmentRequired()`](#fn-withapproleassignmentrequired) * [`fn withApplicationId()`](#fn-withapplicationid) +* [`fn withClientId()`](#fn-withclientid) * [`fn withDescription()`](#fn-withdescription) * [`fn withFeatureTags()`](#fn-withfeaturetags) * [`fn withFeatureTagsMixin()`](#fn-withfeaturetagsmixin) @@ -76,7 +77,8 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `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. - `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. - `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. - - `application_id` (`string`): The application ID (client ID) of the application for which to create a service principal + - `application_id` (`string`): The application ID (client ID) of the application for which to create a service principal When `null`, the `application_id` field will be omitted from the resulting object. + - `client_id` (`string`): The client ID of the application for which to create a service principal When `null`, the `client_id` field will be omitted from the resulting object. - `description` (`string`): Description of the service principal provided for internal end-users When `null`, the `description` field will be omitted from the resulting object. - `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. - `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. @@ -115,7 +117,8 @@ injecting into a complete block. - `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. - `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. - `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. - - `application_id` (`string`): The application ID (client ID) of the application for which to create a service principal + - `application_id` (`string`): The application ID (client ID) of the application for which to create a service principal When `null`, the `application_id` field will be omitted from the resulting object. + - `client_id` (`string`): The client ID of the application for which to create a service principal When `null`, the `client_id` field will be omitted from the resulting object. - `description` (`string`): Description of the service principal provided for internal end-users When `null`, the `description` field will be omitted from the resulting object. - `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. - `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. @@ -197,6 +200,22 @@ Terraform resource block to set or update the application_id field. - `value` (`string`): The value to set for the `application_id` field. +### fn withClientId + +```ts +withClientId() +``` + +`azuread.string.withClientId` constructs a mixin object that can be merged into the `string` +Terraform resource block to set or update the client_id field. + + + +**Args**: + - `resourceLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `client_id` field. + + ### fn withDescription ```ts