diff --git a/2.x/_gen/data/directory_role_templates.libsonnet b/2.x/_gen/data/directory_role_templates.libsonnet new file mode 100644 index 0000000..5b6d22d --- /dev/null +++ b/2.x/_gen/data/directory_role_templates.libsonnet @@ -0,0 +1,50 @@ +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_templates', url='', help='`directory_role_templates` represents the `azuread_directory_role_templates` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), + '#new':: d.fn(help="\n`azuread.data.directory_role_templates.new` injects a new `data_azuread_directory_role_templates` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.directory_role_templates.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.directory_role_templates` using the reference:\n\n $._ref.data_azuread_directory_role_templates.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_directory_role_templates.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.directory_role_templates.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + new( + dataSrcLabel, + timeouts=null, + _meta={} + ):: tf.withData( + type='azuread_directory_role_templates', + label=dataSrcLabel, + attrs=self.newAttrs(timeouts=timeouts), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`azuread.data.directory_role_templates.newAttrs` constructs a new object with attributes and blocks configured for the `directory_role_templates`\nTerraform data source.\n\nUnlike [azuread.data.directory_role_templates.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.directory_role_templates.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `directory_role_templates` data source into the root Terraform configuration.\n', args=[]), + newAttrs( + timeouts=null + ):: std.prune(a={ + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`azuread.directory_role_templates.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + read=null + ):: std.prune(a={ + read: read, + }), + }, + '#withTimeouts':: d.fn(help='`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform data source 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 - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(dataSrcLabel, value): { + data+: { + azuread_directory_role_templates+: { + [dataSrcLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform data source 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 - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(dataSrcLabel, value): { + data+: { + azuread_directory_role_templates+: { + [dataSrcLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/2.x/_gen/data/main.libsonnet b/2.x/_gen/data/main.libsonnet index 9119818..ec99c6c 100644 --- a/2.x/_gen/data/main.libsonnet +++ b/2.x/_gen/data/main.libsonnet @@ -10,10 +10,12 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); application_template: (import 'application_template.libsonnet'), client_config: (import 'client_config.libsonnet'), directory_object: (import 'directory_object.libsonnet'), + directory_role_templates: (import 'directory_role_templates.libsonnet'), directory_roles: (import 'directory_roles.libsonnet'), domains: (import 'domains.libsonnet'), group: (import 'group.libsonnet'), groups: (import 'groups.libsonnet'), + named_location: (import 'named_location.libsonnet'), service_principal: (import 'service_principal.libsonnet'), service_principals: (import 'service_principals.libsonnet'), user: (import 'user.libsonnet'), diff --git a/2.x/_gen/data/named_location.libsonnet b/2.x/_gen/data/named_location.libsonnet new file mode 100644 index 0000000..25c8e0c --- /dev/null +++ b/2.x/_gen/data/named_location.libsonnet @@ -0,0 +1,63 @@ +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='named_location', url='', help='`named_location` represents the `azuread_named_location` 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.named_location.new` injects a new `data_azuread_named_location` 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.named_location.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.named_location` using the reference:\n\n $._ref.data_azuread_named_location.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_named_location.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `display_name` (`string`): Set the `display_name` field on the resulting data source block.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.named_location.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + new( + dataSrcLabel, + display_name, + timeouts=null, + _meta={} + ):: tf.withData( + type='azuread_named_location', + label=dataSrcLabel, + attrs=self.newAttrs(display_name=display_name, timeouts=timeouts), + _meta=_meta + ), + '#newAttrs':: d.fn(help='\n`azuread.data.named_location.newAttrs` constructs a new object with attributes and blocks configured for the `named_location`\nTerraform data source.\n\nUnlike [azuread.data.named_location.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name` (`string`): Set the `display_name` field on 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.named_location.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 `named_location` data source into the root Terraform configuration.\n', args=[]), + newAttrs( + display_name, + timeouts=null + ):: std.prune(a={ + display_name: display_name, + timeouts: timeouts, + }), + timeouts:: { + '#new':: d.fn(help='\n`azuread.named_location.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]), + new( + read=null + ):: std.prune(a={ + read: read, + }), + }, + '#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+: { + azuread_named_location+: { + [dataSrcLabel]+: { + display_name: value, + }, + }, + }, + }, + '#withTimeouts':: d.fn(help='`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj`\nTerraform data source 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 - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeouts(dataSrcLabel, value): { + data+: { + azuread_named_location+: { + [dataSrcLabel]+: { + timeouts: value, + }, + }, + }, + }, + '#withTimeoutsMixin':: d.fn(help='`azuread.obj.withTimeoutsMixin` constructs a mixin object that can be merged into the `obj`\nTerraform data source 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 - `dataSrcLabel` (`string`): The name label of the block to update.\n - `value` (`obj`): The value to set for the `timeouts` field.\n', args=[]), + withTimeoutsMixin(dataSrcLabel, value): { + data+: { + azuread_named_location+: { + [dataSrcLabel]+: { + timeouts+: value, + }, + }, + }, + }, +} diff --git a/2.x/_gen/resources/conditional_access_policy.libsonnet b/2.x/_gen/resources/conditional_access_policy.libsonnet index 79151e0..67d6bda 100644 --- a/2.x/_gen/resources/conditional_access_policy.libsonnet +++ b/2.x/_gen/resources/conditional_access_policy.libsonnet @@ -53,7 +53,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); included_locations: included_locations, }), }, - '#new':: d.fn(help='\n`azuread.conditional_access_policy.conditions.new` constructs a new object with attributes and blocks configured for the `conditions`\nTerraform sub block.\n\n\n\n**Args**:\n - `client_app_types` (`list`): 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':: 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 - `service_principal_risk_levels` (`list`): Set the `service_principal_risk_levels` field on the resulting object. When `null`, the `service_principal_risk_levels` field will be omitted from 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, @@ -61,6 +61,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); devices=null, locations=null, platforms=null, + service_principal_risk_levels=null, sign_in_risk_levels=null, user_risk_levels=null, users=null @@ -71,6 +72,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); devices: devices, locations: locations, platforms: platforms, + service_principal_risk_levels: service_principal_risk_levels, sign_in_risk_levels: sign_in_risk_levels, user_risk_levels: user_risk_levels, users: users, diff --git a/docs/2.x/conditional_access_policy.md b/docs/2.x/conditional_access_policy.md index 5c65bb8..82526e2 100644 --- a/docs/2.x/conditional_access_policy.md +++ b/docs/2.x/conditional_access_policy.md @@ -314,6 +314,7 @@ Terraform sub block. **Args**: - `client_app_types` (`list`): Set the `client_app_types` field on the resulting object. + - `service_principal_risk_levels` (`list`): Set the `service_principal_risk_levels` field on the resulting object. When `null`, the `service_principal_risk_levels` field will be omitted from the resulting object. - `sign_in_risk_levels` (`list`): Set the `sign_in_risk_levels` field on the resulting object. When `null`, the `sign_in_risk_levels` field will be omitted from the resulting object. - `user_risk_levels` (`list`): Set the `user_risk_levels` field on the resulting object. When `null`, the `user_risk_levels` field will be omitted from the resulting object. - `applications` (`list[obj]`): Set the `applications` field on the resulting object. When `null`, the `applications` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.conditional_access_policy.conditions.applications.new](#fn-conditionsapplicationsnew) constructor. diff --git a/docs/2.x/data/directory_role_templates.md b/docs/2.x/data/directory_role_templates.md new file mode 100644 index 0000000..cd308ee --- /dev/null +++ b/docs/2.x/data/directory_role_templates.md @@ -0,0 +1,138 @@ +--- +permalink: /data/directory_role_templates/ +--- + +# data.directory_role_templates + +`directory_role_templates` represents the `azuread_directory_role_templates` Terraform data source. + + + +This package contains functions and utilities for setting up the data source using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`fn withTimeouts()`](#fn-withtimeouts) +* [`fn withTimeoutsMixin()`](#fn-withtimeoutsmixin) +* [`obj timeouts`](#obj-timeouts) + * [`fn new()`](#fn-timeoutsnew) + +## Fields + +### fn new + +```ts +new() +``` + + +`azuread.data.directory_role_templates.new` injects a new `data_azuread_directory_role_templates` Terraform `data source` +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.data.directory_role_templates.new('some_id') + +You can get the reference to the `id` field of the created `azuread.data.directory_role_templates` using the reference: + + $._ref.data_azuread_directory_role_templates.some_id.get('id') + +This is the same as directly entering `"${ data_azuread_directory_role_templates.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**: + - `dataSrcLabel` (`string`): The name label of the block. + - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.directory_role_templates.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new data source into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`azuread.data.directory_role_templates.newAttrs` constructs a new object with attributes and blocks configured for the `directory_role_templates` +Terraform data source. + +Unlike [azuread.data.directory_role_templates.new](#fn-new), this function will not inject the `data source` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) 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**: + - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.directory_role_templates.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `directory_role_templates` data source into the root Terraform configuration. + + +### fn withTimeouts + +```ts +withTimeouts() +``` + +`azuread.obj.withTimeouts` constructs a mixin object that can be merged into the `obj` +Terraform data source 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**: + - `dataSrcLabel` (`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 data source 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**: + - `dataSrcLabel` (`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_templates.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object. + +**Returns**: + - An attribute object that represents the `timeouts` sub block. diff --git a/docs/2.x/data/index.md b/docs/2.x/data/index.md index 46c16c7..3ccf014 100644 --- a/docs/2.x/data/index.md +++ b/docs/2.x/data/index.md @@ -15,10 +15,12 @@ permalink: /data/ * [application_template](application_template.md) * [client_config](client_config.md) * [directory_object](directory_object.md) +* [directory_role_templates](directory_role_templates.md) * [directory_roles](directory_roles.md) * [domains](domains.md) * [group](group.md) * [groups](groups.md) +* [named_location](named_location.md) * [service_principal](service_principal.md) * [service_principals](service_principals.md) * [user](user.md) diff --git a/docs/2.x/data/named_location.md b/docs/2.x/data/named_location.md new file mode 100644 index 0000000..9e71fb4 --- /dev/null +++ b/docs/2.x/data/named_location.md @@ -0,0 +1,157 @@ +--- +permalink: /data/named_location/ +--- + +# data.named_location + +`named_location` represents the `azuread_named_location` Terraform data source. + + + +This package contains functions and utilities for setting up the data source using Jsonnet code. + + +## Index + +* [`fn new()`](#fn-new) +* [`fn newAttrs()`](#fn-newattrs) +* [`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.data.named_location.new` injects a new `data_azuread_named_location` Terraform `data source` +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.data.named_location.new('some_id') + +You can get the reference to the `id` field of the created `azuread.data.named_location` using the reference: + + $._ref.data_azuread_named_location.some_id.get('id') + +This is the same as directly entering `"${ data_azuread_named_location.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**: + - `dataSrcLabel` (`string`): The name label of the block. + - `display_name` (`string`): Set the `display_name` field on the resulting data source block. + - `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.named_location.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: +- A mixin object that injects the new data source into the root Terraform configuration. + + +### fn newAttrs + +```ts +newAttrs() +``` + + +`azuread.data.named_location.newAttrs` constructs a new object with attributes and blocks configured for the `named_location` +Terraform data source. + +Unlike [azuread.data.named_location.new](#fn-new), this function will not inject the `data source` +block into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the +[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) 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`): Set the `display_name` field on 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.named_location.timeouts.new](#fn-timeoutsnew) constructor. + +**Returns**: + - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `named_location` data source into the root Terraform configuration. + + +### fn withDisplayName + +```ts +withDisplayName() +``` + +`azuread.string.withDisplayName` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the display_name field. + + + +**Args**: + - `dataSrcLabel` (`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 data source 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**: + - `dataSrcLabel` (`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 data source 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**: + - `dataSrcLabel` (`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.named_location.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts` +Terraform sub block. + + + +**Args**: + - `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.