From d5bb333735f60c6f8bf264fa5cbe5575d46d4484 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" Date: Fri, 14 Jul 2023 01:51:42 +0000 Subject: [PATCH] Generate libsonnet source from libgenerator PR https://github.com/tf-libsonnet/libgenerator/pull/190 Signed-off-by: tflibsonnet-ci <120686569+tflibsonnet-ci@users.noreply.github.com> --- 2.x/_gen/data/user.libsonnet | 18 ++++++++++-- 2.x/_gen/data/users.libsonnet | 18 ++++++++++-- .../conditional_access_policy.libsonnet | 18 ++++++++++-- docs/2.x/conditional_access_policy.md | 28 +++++++++++++++++++ docs/2.x/data/user.md | 19 +++++++++++++ docs/2.x/data/users.md | 19 +++++++++++++ 6 files changed, 114 insertions(+), 6 deletions(-) diff --git a/2.x/_gen/data/user.libsonnet b/2.x/_gen/data/user.libsonnet index 8614c6e..e8e8b42 100644 --- a/2.x/_gen/data/user.libsonnet +++ b/2.x/_gen/data/user.libsonnet @@ -2,9 +2,10 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='user', url='', help='`user` represents the `azuread_user` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.data.user.new` injects a new `data_azuread_user` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.user.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.user` using the reference:\n\n $._ref.data_azuread_user.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_user.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `mail` (`string`): The SMTP address for the user When `null`, the `mail` field will be omitted from the resulting object.\n - `mail_nickname` (`string`): The email alias of the user When `null`, the `mail_nickname` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the user When `null`, the `object_id` field will be omitted from the resulting object.\n - `user_principal_name` (`string`): The user principal name (UPN) of the user When `null`, the `user_principal_name` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.user.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.data.user.new` injects a new `data_azuread_user` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.user.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.user` using the reference:\n\n $._ref.data_azuread_user.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_user.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `employee_id` (`string`): The employee identifier assigned to the user by the organisation When `null`, the `employee_id` field will be omitted from the resulting object.\n - `mail` (`string`): The SMTP address for the user When `null`, the `mail` field will be omitted from the resulting object.\n - `mail_nickname` (`string`): The email alias of the user When `null`, the `mail_nickname` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the user When `null`, the `object_id` field will be omitted from the resulting object.\n - `user_principal_name` (`string`): The user principal name (UPN) of the user When `null`, the `user_principal_name` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.user.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, + employee_id=null, mail=null, mail_nickname=null, object_id=null, @@ -15,6 +16,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type='azuread_user', label=dataSrcLabel, attrs=self.newAttrs( + employee_id=employee_id, mail=mail, mail_nickname=mail_nickname, object_id=object_id, @@ -23,14 +25,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.data.user.newAttrs` constructs a new object with attributes and blocks configured for the `user`\nTerraform data source.\n\nUnlike [azuread.data.user.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `mail` (`string`): The SMTP address for the user When `null`, the `mail` field will be omitted from the resulting object.\n - `mail_nickname` (`string`): The email alias of the user When `null`, the `mail_nickname` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the user When `null`, the `object_id` field will be omitted from the resulting object.\n - `user_principal_name` (`string`): The user principal name (UPN) of the user When `null`, the `user_principal_name` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.user.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `user` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.data.user.newAttrs` constructs a new object with attributes and blocks configured for the `user`\nTerraform data source.\n\nUnlike [azuread.data.user.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `employee_id` (`string`): The employee identifier assigned to the user by the organisation When `null`, the `employee_id` field will be omitted from the resulting object.\n - `mail` (`string`): The SMTP address for the user When `null`, the `mail` field will be omitted from the resulting object.\n - `mail_nickname` (`string`): The email alias of the user When `null`, the `mail_nickname` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the user When `null`, the `object_id` field will be omitted from the resulting object.\n - `user_principal_name` (`string`): The user principal name (UPN) of the user When `null`, the `user_principal_name` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.user.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `user` data source into the root Terraform configuration.\n', args=[]), newAttrs( + employee_id=null, mail=null, mail_nickname=null, object_id=null, timeouts=null, user_principal_name=null ):: std.prune(a={ + employee_id: employee_id, mail: mail, mail_nickname: mail_nickname, object_id: object_id, @@ -45,6 +49,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); read: read, }), }, + '#withEmployeeId':: d.fn(help='`azuread.string.withEmployeeId` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the employee_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 `employee_id` field.\n', args=[]), + withEmployeeId(dataSrcLabel, value): { + data+: { + azuread_user+: { + [dataSrcLabel]+: { + employee_id: value, + }, + }, + }, + }, '#withMail':: d.fn(help='`azuread.string.withMail` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the mail 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 `mail` field.\n', args=[]), withMail(dataSrcLabel, value): { data+: { diff --git a/2.x/_gen/data/users.libsonnet b/2.x/_gen/data/users.libsonnet index fcac3f3..51fc11e 100644 --- a/2.x/_gen/data/users.libsonnet +++ b/2.x/_gen/data/users.libsonnet @@ -2,9 +2,10 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet'); local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); { '#':: d.pkg(name='users', url='', help='`users` represents the `azuread_users` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.data.users.new` injects a new `data_azuread_users` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.users.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.users` using the reference:\n\n $._ref.data_azuread_users.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_users.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `ignore_missing` (`bool`): Ignore missing users and return users that were found. The data source will still fail if no users are found When `null`, the `ignore_missing` field will be omitted from the resulting object.\n - `mail_nicknames` (`list`): The email aliases of the users When `null`, the `mail_nicknames` field will be omitted from the resulting object.\n - `object_ids` (`list`): The object IDs of the users When `null`, the `object_ids` field will be omitted from the resulting object.\n - `return_all` (`bool`): Fetch all users with no filter and return all that were found. The data source will still fail if no users are found. When `null`, the `return_all` field will be omitted from the resulting object.\n - `user_principal_names` (`list`): The user principal names (UPNs) of the users When `null`, the `user_principal_names` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.users.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.data.users.new` injects a new `data_azuread_users` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.users.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.users` using the reference:\n\n $._ref.data_azuread_users.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_users.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `employee_ids` (`list`): The employee identifier assigned to the user by the organisation When `null`, the `employee_ids` field will be omitted from the resulting object.\n - `ignore_missing` (`bool`): Ignore missing users and return users that were found. The data source will still fail if no users are found When `null`, the `ignore_missing` field will be omitted from the resulting object.\n - `mail_nicknames` (`list`): The email aliases of the users When `null`, the `mail_nicknames` field will be omitted from the resulting object.\n - `object_ids` (`list`): The object IDs of the users When `null`, the `object_ids` field will be omitted from the resulting object.\n - `return_all` (`bool`): Fetch all users with no filter and return all that were found. The data source will still fail if no users are found. When `null`, the `return_all` field will be omitted from the resulting object.\n - `user_principal_names` (`list`): The user principal names (UPNs) of the users When `null`, the `user_principal_names` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.users.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, + employee_ids=null, ignore_missing=null, mail_nicknames=null, object_ids=null, @@ -16,6 +17,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); type='azuread_users', label=dataSrcLabel, attrs=self.newAttrs( + employee_ids=employee_ids, ignore_missing=ignore_missing, mail_nicknames=mail_nicknames, object_ids=object_ids, @@ -25,8 +27,9 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.data.users.newAttrs` constructs a new object with attributes and blocks configured for the `users`\nTerraform data source.\n\nUnlike [azuread.data.users.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `ignore_missing` (`bool`): Ignore missing users and return users that were found. The data source will still fail if no users are found When `null`, the `ignore_missing` field will be omitted from the resulting object.\n - `mail_nicknames` (`list`): The email aliases of the users When `null`, the `mail_nicknames` field will be omitted from the resulting object.\n - `object_ids` (`list`): The object IDs of the users When `null`, the `object_ids` field will be omitted from the resulting object.\n - `return_all` (`bool`): Fetch all users with no filter and return all that were found. The data source will still fail if no users are found. When `null`, the `return_all` field will be omitted from the resulting object.\n - `user_principal_names` (`list`): The user principal names (UPNs) of the users When `null`, the `user_principal_names` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.users.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `users` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.data.users.newAttrs` constructs a new object with attributes and blocks configured for the `users`\nTerraform data source.\n\nUnlike [azuread.data.users.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `employee_ids` (`list`): The employee identifier assigned to the user by the organisation When `null`, the `employee_ids` field will be omitted from the resulting object.\n - `ignore_missing` (`bool`): Ignore missing users and return users that were found. The data source will still fail if no users are found When `null`, the `ignore_missing` field will be omitted from the resulting object.\n - `mail_nicknames` (`list`): The email aliases of the users When `null`, the `mail_nicknames` field will be omitted from the resulting object.\n - `object_ids` (`list`): The object IDs of the users When `null`, the `object_ids` field will be omitted from the resulting object.\n - `return_all` (`bool`): Fetch all users with no filter and return all that were found. The data source will still fail if no users are found. When `null`, the `return_all` field will be omitted from the resulting object.\n - `user_principal_names` (`list`): The user principal names (UPNs) of the users When `null`, the `user_principal_names` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.users.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `users` data source into the root Terraform configuration.\n', args=[]), newAttrs( + employee_ids=null, ignore_missing=null, mail_nicknames=null, object_ids=null, @@ -34,6 +37,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); timeouts=null, user_principal_names=null ):: std.prune(a={ + employee_ids: employee_ids, ignore_missing: ignore_missing, mail_nicknames: mail_nicknames, object_ids: object_ids, @@ -49,6 +53,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); read: read, }), }, + '#withEmployeeIds':: d.fn(help='`azuread.list.withEmployeeIds` constructs a mixin object that can be merged into the `list`\nTerraform data source block to set or update the employee_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 `employee_ids` field.\n', args=[]), + withEmployeeIds(dataSrcLabel, value): { + data+: { + azuread_users+: { + [dataSrcLabel]+: { + employee_ids: value, + }, + }, + }, + }, '#withIgnoreMissing':: d.fn(help='`azuread.bool.withIgnoreMissing` constructs a mixin object that can be merged into the `bool`\nTerraform data source block to set or update the ignore_missing field.\n\n\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`bool`): The value to set for the `ignore_missing` field.\n', args=[]), withIgnoreMissing(dataSrcLabel, value): { data+: { diff --git a/2.x/_gen/resources/conditional_access_policy.libsonnet b/2.x/_gen/resources/conditional_access_policy.libsonnet index 1a9e27f..79151e0 100644 --- a/2.x/_gen/resources/conditional_access_policy.libsonnet +++ b/2.x/_gen/resources/conditional_access_policy.libsonnet @@ -15,6 +15,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); included_user_actions: included_user_actions, }), }, + client_applications:: { + '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.client_applications.new` constructs a new object with attributes and blocks configured for the `client_applications`\nTerraform sub block.\n\n\n\n**Args**:\n - `excluded_service_principals` (`list`): Set the `excluded_service_principals` field on the resulting object. When `null`, the `excluded_service_principals` field will be omitted from the resulting object.\n - `included_service_principals` (`list`): Set the `included_service_principals` field on the resulting object. When `null`, the `included_service_principals` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `client_applications` sub block.\n', args=[]), + new( + excluded_service_principals=null, + included_service_principals=null + ):: std.prune(a={ + excluded_service_principals: excluded_service_principals, + included_service_principals: included_service_principals, + }), + }, devices:: { filter:: { '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.devices.filter.new` constructs a new object with attributes and blocks configured for the `filter`\nTerraform sub block.\n\n\n\n**Args**:\n - `mode` (`string`): Set the `mode` field on the resulting object.\n - `rule` (`string`): Set the `rule` field on the resulting object.\n\n**Returns**:\n - An attribute object that represents the `filter` sub block.\n', args=[]), @@ -43,10 +53,11 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); included_locations: included_locations, }), }, - '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.new` constructs a new object with attributes and blocks configured for the `conditions`\nTerraform sub block.\n\n\n\n**Args**:\n - `client_app_types` (`list`): Set the `client_app_types` field on the resulting object.\n - `sign_in_risk_levels` (`list`): Set the `sign_in_risk_levels` field on the resulting object. When `null`, the `sign_in_risk_levels` field will be omitted from the resulting object.\n - `user_risk_levels` (`list`): Set the `user_risk_levels` field on the resulting object. When `null`, the `user_risk_levels` field will be omitted from the resulting object.\n - `applications` (`list[obj]`): Set the `applications` field on the resulting object. When `null`, the `applications` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.applications.new](#fn-conditionsapplicationsnew) constructor.\n - `devices` (`list[obj]`): Set the `devices` field on the resulting object. When `null`, the `devices` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.devices.new](#fn-conditionsdevicesnew) constructor.\n - `locations` (`list[obj]`): Set the `locations` field on the resulting object. When `null`, the `locations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.locations.new](#fn-conditionslocationsnew) constructor.\n - `platforms` (`list[obj]`): Set the `platforms` field on the resulting object. When `null`, the `platforms` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.platforms.new](#fn-conditionsplatformsnew) constructor.\n - `users` (`list[obj]`): Set the `users` field on the resulting object. When `null`, the `users` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.users.new](#fn-conditionsusersnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `conditions` sub block.\n', args=[]), + '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.new` constructs a new object with attributes and blocks configured for the `conditions`\nTerraform sub block.\n\n\n\n**Args**:\n - `client_app_types` (`list`): Set the `client_app_types` field on the resulting object.\n - `sign_in_risk_levels` (`list`): Set the `sign_in_risk_levels` field on the resulting object. When `null`, the `sign_in_risk_levels` field will be omitted from the resulting object.\n - `user_risk_levels` (`list`): Set the `user_risk_levels` field on the resulting object. When `null`, the `user_risk_levels` field will be omitted from the resulting object.\n - `applications` (`list[obj]`): Set the `applications` field on the resulting object. When `null`, the `applications` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.applications.new](#fn-conditionsapplicationsnew) constructor.\n - `client_applications` (`list[obj]`): Set the `client_applications` field on the resulting object. When `null`, the `client_applications` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.client_applications.new](#fn-conditionsclient_applicationsnew) constructor.\n - `devices` (`list[obj]`): Set the `devices` field on the resulting object. When `null`, the `devices` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.devices.new](#fn-conditionsdevicesnew) constructor.\n - `locations` (`list[obj]`): Set the `locations` field on the resulting object. When `null`, the `locations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.locations.new](#fn-conditionslocationsnew) constructor.\n - `platforms` (`list[obj]`): Set the `platforms` field on the resulting object. When `null`, the `platforms` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.platforms.new](#fn-conditionsplatformsnew) constructor.\n - `users` (`list[obj]`): Set the `users` field on the resulting object. When `null`, the `users` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.users.new](#fn-conditionsusersnew) constructor.\n\n**Returns**:\n - An attribute object that represents the `conditions` sub block.\n', args=[]), new( client_app_types, applications=null, + client_applications=null, devices=null, locations=null, platforms=null, @@ -56,6 +67,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); ):: std.prune(a={ applications: applications, client_app_types: client_app_types, + client_applications: client_applications, devices: devices, locations: locations, platforms: platforms, @@ -146,16 +158,18 @@ 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 - `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_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_period=null ):: std.prune(a={ application_enforced_restrictions_enabled: application_enforced_restrictions_enabled, cloud_app_security_policy: cloud_app_security_policy, + disable_resilience_defaults: disable_resilience_defaults, persistent_browser_mode: persistent_browser_mode, sign_in_frequency: sign_in_frequency, sign_in_frequency_period: sign_in_frequency_period, diff --git a/docs/2.x/conditional_access_policy.md b/docs/2.x/conditional_access_policy.md index fba49ff..5c65bb8 100644 --- a/docs/2.x/conditional_access_policy.md +++ b/docs/2.x/conditional_access_policy.md @@ -29,6 +29,8 @@ This package contains functions and utilities for setting up the resource using * [`fn new()`](#fn-conditionsnew) * [`obj conditions.applications`](#obj-conditionsapplications) * [`fn new()`](#fn-conditionsapplicationsnew) + * [`obj conditions.client_applications`](#obj-conditionsclient_applications) + * [`fn new()`](#fn-conditionsclient_applicationsnew) * [`obj conditions.devices`](#obj-conditionsdevices) * [`fn new()`](#fn-conditionsdevicesnew) * [`obj conditions.devices.filter`](#obj-conditionsdevicesfilter) @@ -315,6 +317,7 @@ Terraform sub block. - `sign_in_risk_levels` (`list`): Set the `sign_in_risk_levels` field on the resulting object. When `null`, the `sign_in_risk_levels` field will be omitted from the resulting object. - `user_risk_levels` (`list`): Set the `user_risk_levels` field on the resulting object. When `null`, the `user_risk_levels` field will be omitted from the resulting object. - `applications` (`list[obj]`): Set the `applications` field on the resulting object. When `null`, the `applications` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.applications.new](#fn-conditionsapplicationsnew) constructor. + - `client_applications` (`list[obj]`): Set the `client_applications` field on the resulting object. When `null`, the `client_applications` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.client_applications.new](#fn-conditionsclient_applicationsnew) constructor. - `devices` (`list[obj]`): Set the `devices` field on the resulting object. When `null`, the `devices` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.devices.new](#fn-conditionsdevicesnew) constructor. - `locations` (`list[obj]`): Set the `locations` field on the resulting object. When `null`, the `locations` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.locations.new](#fn-conditionslocationsnew) constructor. - `platforms` (`list[obj]`): Set the `platforms` field on the resulting object. When `null`, the `platforms` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.platforms.new](#fn-conditionsplatformsnew) constructor. @@ -349,6 +352,30 @@ Terraform sub block. - An attribute object that represents the `applications` sub block. +## obj conditions.client_applications + + + +### fn conditions.client_applications.new + +```ts +new() +``` + + +`azuread.conditional_access_policy.conditions.client_applications.new` constructs a new object with attributes and blocks configured for the `client_applications` +Terraform sub block. + + + +**Args**: + - `excluded_service_principals` (`list`): Set the `excluded_service_principals` field on the resulting object. When `null`, the `excluded_service_principals` field will be omitted from the resulting object. + - `included_service_principals` (`list`): Set the `included_service_principals` field on the resulting object. When `null`, the `included_service_principals` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `client_applications` sub block. + + ## obj conditions.devices @@ -517,6 +544,7 @@ Terraform sub block. **Args**: - `application_enforced_restrictions_enabled` (`bool`): Set the `application_enforced_restrictions_enabled` field on the resulting object. When `null`, the `application_enforced_restrictions_enabled` field will be omitted from the resulting object. - `cloud_app_security_policy` (`string`): Set the `cloud_app_security_policy` field on the resulting object. When `null`, the `cloud_app_security_policy` field will be omitted from the resulting object. + - `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_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. diff --git a/docs/2.x/data/user.md b/docs/2.x/data/user.md index d62a8bf..785e545 100644 --- a/docs/2.x/data/user.md +++ b/docs/2.x/data/user.md @@ -15,6 +15,7 @@ This package contains functions and utilities for setting up the data source usi * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) +* [`fn withEmployeeId()`](#fn-withemployeeid) * [`fn withMail()`](#fn-withmail) * [`fn withMailNickname()`](#fn-withmailnickname) * [`fn withObjectId()`](#fn-withobjectid) @@ -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. + - `employee_id` (`string`): The employee identifier assigned to the user by the organisation When `null`, the `employee_id` field will be omitted from the resulting object. - `mail` (`string`): The SMTP address for the user When `null`, the `mail` field will be omitted from the resulting object. - `mail_nickname` (`string`): The email alias of the user When `null`, the `mail_nickname` field will be omitted from the resulting object. - `object_id` (`string`): The object ID of the user When `null`, the `object_id` field will be omitted from the resulting object. @@ -81,6 +83,7 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: + - `employee_id` (`string`): The employee identifier assigned to the user by the organisation When `null`, the `employee_id` field will be omitted from the resulting object. - `mail` (`string`): The SMTP address for the user When `null`, the `mail` field will be omitted from the resulting object. - `mail_nickname` (`string`): The email alias of the user When `null`, the `mail_nickname` field will be omitted from the resulting object. - `object_id` (`string`): The object ID of the user When `null`, the `object_id` field will be omitted from the resulting object. @@ -91,6 +94,22 @@ injecting into a complete block. - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `user` data source into the root Terraform configuration. +### fn withEmployeeId + +```ts +withEmployeeId() +``` + +`azuread.string.withEmployeeId` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the employee_id field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `employee_id` field. + + ### fn withMail ```ts diff --git a/docs/2.x/data/users.md b/docs/2.x/data/users.md index 3f9867e..4929253 100644 --- a/docs/2.x/data/users.md +++ b/docs/2.x/data/users.md @@ -15,6 +15,7 @@ This package contains functions and utilities for setting up the data source usi * [`fn new()`](#fn-new) * [`fn newAttrs()`](#fn-newattrs) +* [`fn withEmployeeIds()`](#fn-withemployeeids) * [`fn withIgnoreMissing()`](#fn-withignoremissing) * [`fn withMailNicknames()`](#fn-withmailnicknames) * [`fn withObjectIds()`](#fn-withobjectids) @@ -54,6 +55,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using **Args**: - `dataSrcLabel` (`string`): The name label of the block. + - `employee_ids` (`list`): The employee identifier assigned to the user by the organisation When `null`, the `employee_ids` field will be omitted from the resulting object. - `ignore_missing` (`bool`): Ignore missing users and return users that were found. The data source will still fail if no users are found When `null`, the `ignore_missing` field will be omitted from the resulting object. - `mail_nicknames` (`list`): The email aliases of the users When `null`, the `mail_nicknames` field will be omitted from the resulting object. - `object_ids` (`list`): The object IDs of the users When `null`, the `object_ids` field will be omitted from the resulting object. @@ -83,6 +85,7 @@ This is most useful when you need to preprocess the attributes with functions, c injecting into a complete block. **Args**: + - `employee_ids` (`list`): The employee identifier assigned to the user by the organisation When `null`, the `employee_ids` field will be omitted from the resulting object. - `ignore_missing` (`bool`): Ignore missing users and return users that were found. The data source will still fail if no users are found When `null`, the `ignore_missing` field will be omitted from the resulting object. - `mail_nicknames` (`list`): The email aliases of the users When `null`, the `mail_nicknames` field will be omitted from the resulting object. - `object_ids` (`list`): The object IDs of the users When `null`, the `object_ids` field will be omitted from the resulting object. @@ -94,6 +97,22 @@ injecting into a complete block. - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `users` data source into the root Terraform configuration. +### fn withEmployeeIds + +```ts +withEmployeeIds() +``` + +`azuread.list.withEmployeeIds` constructs a mixin object that can be merged into the `list` +Terraform data source block to set or update the employee_ids field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`list`): The value to set for the `employee_ids` field. + + ### fn withIgnoreMissing ```ts