diff --git a/2.x/_gen/data/group.libsonnet b/2.x/_gen/data/group.libsonnet index 9d32c43..b28a56b 100644 --- a/2.x/_gen/data/group.libsonnet +++ b/2.x/_gen/data/group.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='group', url='', help='`group` represents the `azuread_group` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'), - '#new':: d.fn(help="\n`azuread.data.group.new` injects a new `data_azuread_group` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.group.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.group` using the reference:\n\n $._ref.data_azuread_group.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_group.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `display_name` (`string`): The display name for the group When `null`, the `display_name` field will be omitted from the resulting object.\n - `mail_enabled` (`bool`): Whether the group is mail-enabled When `null`, the `mail_enabled` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the group When `null`, the `object_id` field will be omitted from the resulting object.\n - `security_enabled` (`bool`): Whether the group is a security group When `null`, the `security_enabled` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.group.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), + '#new':: d.fn(help="\n`azuread.data.group.new` injects a new `data_azuread_group` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.group.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.group` using the reference:\n\n $._ref.data_azuread_group.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_group.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `display_name` (`string`): The display name for the group When `null`, the `display_name` field will be omitted from the resulting object.\n - `mail_enabled` (`bool`): Whether the group is mail-enabled When `null`, the `mail_enabled` field will be omitted from the resulting object.\n - `mail_nickname` (`string`): The mail alias for the group, unique in the organisation When `null`, the `mail_nickname` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the group When `null`, the `object_id` field will be omitted from the resulting object.\n - `security_enabled` (`bool`): Whether the group is a security group When `null`, the `security_enabled` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.group.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]), new( dataSrcLabel, display_name=null, mail_enabled=null, + mail_nickname=null, object_id=null, security_enabled=null, timeouts=null, @@ -17,22 +18,25 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); attrs=self.newAttrs( display_name=display_name, mail_enabled=mail_enabled, + mail_nickname=mail_nickname, object_id=object_id, security_enabled=security_enabled, timeouts=timeouts ), _meta=_meta ), - '#newAttrs':: d.fn(help='\n`azuread.data.group.newAttrs` constructs a new object with attributes and blocks configured for the `group`\nTerraform data source.\n\nUnlike [azuread.data.group.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name` (`string`): The display name for the group When `null`, the `display_name` field will be omitted from the resulting object.\n - `mail_enabled` (`bool`): Whether the group is mail-enabled When `null`, the `mail_enabled` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the group When `null`, the `object_id` field will be omitted from the resulting object.\n - `security_enabled` (`bool`): Whether the group is a security group When `null`, the `security_enabled` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.group.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `group` data source into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.data.group.newAttrs` constructs a new object with attributes and blocks configured for the `group`\nTerraform data source.\n\nUnlike [azuread.data.group.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name` (`string`): The display name for the group When `null`, the `display_name` field will be omitted from the resulting object.\n - `mail_enabled` (`bool`): Whether the group is mail-enabled When `null`, the `mail_enabled` field will be omitted from the resulting object.\n - `mail_nickname` (`string`): The mail alias for the group, unique in the organisation When `null`, the `mail_nickname` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the group When `null`, the `object_id` field will be omitted from the resulting object.\n - `security_enabled` (`bool`): Whether the group is a security group When `null`, the `security_enabled` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.group.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `group` data source into the root Terraform configuration.\n', args=[]), newAttrs( display_name=null, mail_enabled=null, + mail_nickname=null, object_id=null, security_enabled=null, timeouts=null ):: std.prune(a={ display_name: display_name, mail_enabled: mail_enabled, + mail_nickname: mail_nickname, object_id: object_id, security_enabled: security_enabled, timeouts: timeouts, @@ -65,6 +69,16 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, }, + '#withMailNickname':: d.fn(help='`azuread.string.withMailNickname` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the mail_nickname 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_nickname` field.\n', args=[]), + withMailNickname(dataSrcLabel, value): { + data+: { + azuread_group+: { + [dataSrcLabel]+: { + mail_nickname: value, + }, + }, + }, + }, '#withObjectId':: d.fn(help='`azuread.string.withObjectId` constructs a mixin object that can be merged into the `string`\nTerraform data source block to set or update the object_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 `object_id` field.\n', args=[]), withObjectId(dataSrcLabel, value): { data+: { diff --git a/2.x/_gen/provider_azuread.libsonnet b/2.x/_gen/provider_azuread.libsonnet index bbdafcd..7b9bb4a 100644 --- a/2.x/_gen/provider_azuread.libsonnet +++ b/2.x/_gen/provider_azuread.libsonnet @@ -2,13 +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='provider', url='', help='`provider` represents the `azuread` Terraform provider config.\n\n\n\nThis package contains functions and utilities for setting up the provider using Jsonnet code.\n'), - '#new':: d.fn(help='\n`azuread.provider.new` injects a new `azuread` Terraform `provider`\nblock into the root module document.\n\nOptionally, this inserts the provider into the\n[required_providers](https://developer.hashicorp.com/terraform/language/providers/requirements) `terraform` sub block if\nthe `src` and/or `version` parameters are set.\n\n**Args**:\n - `client_certificate` (`string`): Base64 encoded PKCS#12 certificate bundle to use when authenticating as a Service Principal using a Client Certificate When `null`, the `client_certificate` field will be omitted from the resulting object.\n - `client_certificate_password` (`string`): The password to decrypt the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate When `null`, the `client_certificate_password` field will be omitted from the resulting object.\n - `client_certificate_path` (`string`): The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate When `null`, the `client_certificate_path` field will be omitted from the resulting object.\n - `client_id` (`string`): The Client ID which should be used for service principal authentication When `null`, the `client_id` field will be omitted from the resulting object.\n - `client_secret` (`string`): The application password to use when authenticating as a Service Principal using a Client Secret When `null`, the `client_secret` field will be omitted from the resulting object.\n - `disable_terraform_partner_id` (`bool`): Disable the Terraform Partner ID, which is used if a custom `partner_id` isn't specified When `null`, the `disable_terraform_partner_id` field will be omitted from the resulting object.\n - `environment` (`string`): The cloud environment which should be used. Possible values are: `global` (also `public`), `usgovernmentl4` (also `usgovernment`), `usgovernmentl5` (also `dod`), and `china`. Defaults to `global` When `null`, the `environment` field will be omitted from the resulting object.\n - `metadata_host` (`string`): The Hostname which should be used for the Azure Metadata Service. When `null`, the `metadata_host` field will be omitted from the resulting object.\n - `msi_endpoint` (`string`): The path to a custom endpoint for Managed Identity - in most circumstances this should be detected automatically When `null`, the `msi_endpoint` field will be omitted from the resulting object.\n - `oidc_request_token` (`string`): The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect. When `null`, the `oidc_request_token` field will be omitted from the resulting object.\n - `oidc_request_url` (`string`): The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal using OpenID Connect. When `null`, the `oidc_request_url` field will be omitted from the resulting object.\n - `oidc_token` (`string`): The ID token for use when authenticating as a Service Principal using OpenID Connect. When `null`, the `oidc_token` field will be omitted from the resulting object.\n - `oidc_token_file_path` (`string`): The path to a file containing an ID token for use when authenticating as a Service Principal using OpenID Connect. When `null`, the `oidc_token_file_path` field will be omitted from the resulting object.\n - `partner_id` (`string`): A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution When `null`, the `partner_id` field will be omitted from the resulting object.\n - `tenant_id` (`string`): The Tenant ID which should be used. Works with all authentication methods except Managed Identity When `null`, the `tenant_id` field will be omitted from the resulting object.\n - `use_cli` (`bool`): Allow Azure CLI to be used for Authentication When `null`, the `use_cli` field will be omitted from the resulting object.\n - `use_msi` (`bool`): Allow Managed Identity to be used for Authentication When `null`, the `use_msi` field will be omitted from the resulting object.\n - `use_oidc` (`bool`): Allow OpenID Connect to be used for authentication When `null`, the `use_oidc` field will be omitted from the resulting object.\n - `alias` (`string`): The provider `alias` to set for this instance of the provider block. When `null`, the `alias`\n field will be omitted from the resulting provider block.\n - `src` (`string`): The provider `source` to set on the resulting `required_providers` block. If `src` or `version` is\n set and is not `null`, a `required_providers` block and entry for the provider will be injected into the document.\n - `version` (`string`): The provider `version` to set on the resulting `required_providers` block. If `src` or\n `version` is set and is not `null`, a `required_providers` block and entry for the provider will be injected into the\n document.\n\n\n**Returns**:\n- A mixin object that injects the new provider (and optionally, `required_providers` block) into the root Terraform configuration.\n', args=[]), + '#new':: d.fn(help='\n`azuread.provider.new` injects a new `azuread` Terraform `provider`\nblock into the root module document.\n\nOptionally, this inserts the provider into the\n[required_providers](https://developer.hashicorp.com/terraform/language/providers/requirements) `terraform` sub block if\nthe `src` and/or `version` parameters are set.\n\n**Args**:\n - `client_certificate` (`string`): Base64 encoded PKCS#12 certificate bundle to use when authenticating as a Service Principal using a Client Certificate When `null`, the `client_certificate` field will be omitted from the resulting object.\n - `client_certificate_password` (`string`): The password to decrypt the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate When `null`, the `client_certificate_password` field will be omitted from the resulting object.\n - `client_certificate_path` (`string`): The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate When `null`, the `client_certificate_path` field will be omitted from the resulting object.\n - `client_id` (`string`): The Client ID which should be used for service principal authentication When `null`, the `client_id` field will be omitted from the resulting object.\n - `client_id_file_path` (`string`): The path to a file containing the Client ID which should be used for service principal authentication When `null`, the `client_id_file_path` field will be omitted from the resulting object.\n - `client_secret` (`string`): The application password to use when authenticating as a Service Principal using a Client Secret When `null`, the `client_secret` field will be omitted from the resulting object.\n - `client_secret_file_path` (`string`): The path to a file containing the application password to use when authenticating as a Service Principal using a Client Secret When `null`, the `client_secret_file_path` field will be omitted from the resulting object.\n - `disable_terraform_partner_id` (`bool`): Disable the Terraform Partner ID, which is used if a custom `partner_id` isn't specified When `null`, the `disable_terraform_partner_id` field will be omitted from the resulting object.\n - `environment` (`string`): The cloud environment which should be used. Possible values are: `global` (also `public`), `usgovernmentl4` (also `usgovernment`), `usgovernmentl5` (also `dod`), and `china`. Defaults to `global` When `null`, the `environment` field will be omitted from the resulting object.\n - `metadata_host` (`string`): The Hostname which should be used for the Azure Metadata Service. When `null`, the `metadata_host` field will be omitted from the resulting object.\n - `msi_endpoint` (`string`): The path to a custom endpoint for Managed Identity - in most circumstances this should be detected automatically When `null`, the `msi_endpoint` field will be omitted from the resulting object.\n - `oidc_request_token` (`string`): The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect. When `null`, the `oidc_request_token` field will be omitted from the resulting object.\n - `oidc_request_url` (`string`): The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal using OpenID Connect. When `null`, the `oidc_request_url` field will be omitted from the resulting object.\n - `oidc_token` (`string`): The ID token for use when authenticating as a Service Principal using OpenID Connect. When `null`, the `oidc_token` field will be omitted from the resulting object.\n - `oidc_token_file_path` (`string`): The path to a file containing an ID token for use when authenticating as a Service Principal using OpenID Connect. When `null`, the `oidc_token_file_path` field will be omitted from the resulting object.\n - `partner_id` (`string`): A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution When `null`, the `partner_id` field will be omitted from the resulting object.\n - `tenant_id` (`string`): The Tenant ID which should be used. Works with all authentication methods except Managed Identity When `null`, the `tenant_id` field will be omitted from the resulting object.\n - `use_cli` (`bool`): Allow Azure CLI to be used for Authentication When `null`, the `use_cli` field will be omitted from the resulting object.\n - `use_msi` (`bool`): Allow Managed Identity to be used for Authentication When `null`, the `use_msi` field will be omitted from the resulting object.\n - `use_oidc` (`bool`): Allow OpenID Connect to be used for authentication When `null`, the `use_oidc` field will be omitted from the resulting object.\n - `alias` (`string`): The provider `alias` to set for this instance of the provider block. When `null`, the `alias`\n field will be omitted from the resulting provider block.\n - `src` (`string`): The provider `source` to set on the resulting `required_providers` block. If `src` or `version` is\n set and is not `null`, a `required_providers` block and entry for the provider will be injected into the document.\n - `version` (`string`): The provider `version` to set on the resulting `required_providers` block. If `src` or\n `version` is set and is not `null`, a `required_providers` block and entry for the provider will be injected into the\n document.\n\n\n**Returns**:\n- A mixin object that injects the new provider (and optionally, `required_providers` block) into the root Terraform configuration.\n', args=[]), new( client_certificate=null, client_certificate_password=null, client_certificate_path=null, client_id=null, + client_id_file_path=null, client_secret=null, + client_secret_file_path=null, disable_terraform_partner_id=null, environment=null, metadata_host=null, @@ -35,7 +37,9 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); client_certificate_password=client_certificate_password, client_certificate_path=client_certificate_path, client_id=client_id, + client_id_file_path=client_id_file_path, client_secret=client_secret, + client_secret_file_path=client_secret_file_path, disable_terraform_partner_id=disable_terraform_partner_id, environment=environment, metadata_host=metadata_host, @@ -51,13 +55,15 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); use_oidc=use_oidc ) ), - '#newAttrs':: d.fn(help='\n`azuread.provider.` constructs a new object with attributes and blocks configured for the `azuread`\nTerraform `provider`.\n\nUnlike [azuread.provider.new](#fn-azureadnew), this function will not inject the `provider`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) 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 - `client_certificate` (`string`): Base64 encoded PKCS#12 certificate bundle to use when authenticating as a Service Principal using a Client Certificate When `null`, the `client_certificate` field will be omitted from the resulting object.\n - `client_certificate_password` (`string`): The password to decrypt the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate When `null`, the `client_certificate_password` field will be omitted from the resulting object.\n - `client_certificate_path` (`string`): The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate When `null`, the `client_certificate_path` field will be omitted from the resulting object.\n - `client_id` (`string`): The Client ID which should be used for service principal authentication When `null`, the `client_id` field will be omitted from the resulting object.\n - `client_secret` (`string`): The application password to use when authenticating as a Service Principal using a Client Secret When `null`, the `client_secret` field will be omitted from the resulting object.\n - `disable_terraform_partner_id` (`bool`): Disable the Terraform Partner ID, which is used if a custom `partner_id` isn't specified When `null`, the `disable_terraform_partner_id` field will be omitted from the resulting object.\n - `environment` (`string`): The cloud environment which should be used. Possible values are: `global` (also `public`), `usgovernmentl4` (also `usgovernment`), `usgovernmentl5` (also `dod`), and `china`. Defaults to `global` When `null`, the `environment` field will be omitted from the resulting object.\n - `metadata_host` (`string`): The Hostname which should be used for the Azure Metadata Service. When `null`, the `metadata_host` field will be omitted from the resulting object.\n - `msi_endpoint` (`string`): The path to a custom endpoint for Managed Identity - in most circumstances this should be detected automatically When `null`, the `msi_endpoint` field will be omitted from the resulting object.\n - `oidc_request_token` (`string`): The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect. When `null`, the `oidc_request_token` field will be omitted from the resulting object.\n - `oidc_request_url` (`string`): The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal using OpenID Connect. When `null`, the `oidc_request_url` field will be omitted from the resulting object.\n - `oidc_token` (`string`): The ID token for use when authenticating as a Service Principal using OpenID Connect. When `null`, the `oidc_token` field will be omitted from the resulting object.\n - `oidc_token_file_path` (`string`): The path to a file containing an ID token for use when authenticating as a Service Principal using OpenID Connect. When `null`, the `oidc_token_file_path` field will be omitted from the resulting object.\n - `partner_id` (`string`): A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution When `null`, the `partner_id` field will be omitted from the resulting object.\n - `tenant_id` (`string`): The Tenant ID which should be used. Works with all authentication methods except Managed Identity When `null`, the `tenant_id` field will be omitted from the resulting object.\n - `use_cli` (`bool`): Allow Azure CLI to be used for Authentication When `null`, the `use_cli` field will be omitted from the resulting object.\n - `use_msi` (`bool`): Allow Managed Identity to be used for Authentication When `null`, the `use_msi` field will be omitted from the resulting object.\n - `use_oidc` (`bool`): Allow OpenID Connect to be used for authentication When `null`, the `use_oidc` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) to construct a new `azuread` provider\n configuration into the root Terraform configuration.\n', args=[]), + '#newAttrs':: d.fn(help='\n`azuread.provider.` constructs a new object with attributes and blocks configured for the `azuread`\nTerraform `provider`.\n\nUnlike [azuread.provider.new](#fn-azureadnew), this function will not inject the `provider`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) 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 - `client_certificate` (`string`): Base64 encoded PKCS#12 certificate bundle to use when authenticating as a Service Principal using a Client Certificate When `null`, the `client_certificate` field will be omitted from the resulting object.\n - `client_certificate_password` (`string`): The password to decrypt the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate When `null`, the `client_certificate_password` field will be omitted from the resulting object.\n - `client_certificate_path` (`string`): The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate When `null`, the `client_certificate_path` field will be omitted from the resulting object.\n - `client_id` (`string`): The Client ID which should be used for service principal authentication When `null`, the `client_id` field will be omitted from the resulting object.\n - `client_id_file_path` (`string`): The path to a file containing the Client ID which should be used for service principal authentication When `null`, the `client_id_file_path` field will be omitted from the resulting object.\n - `client_secret` (`string`): The application password to use when authenticating as a Service Principal using a Client Secret When `null`, the `client_secret` field will be omitted from the resulting object.\n - `client_secret_file_path` (`string`): The path to a file containing the application password to use when authenticating as a Service Principal using a Client Secret When `null`, the `client_secret_file_path` field will be omitted from the resulting object.\n - `disable_terraform_partner_id` (`bool`): Disable the Terraform Partner ID, which is used if a custom `partner_id` isn't specified When `null`, the `disable_terraform_partner_id` field will be omitted from the resulting object.\n - `environment` (`string`): The cloud environment which should be used. Possible values are: `global` (also `public`), `usgovernmentl4` (also `usgovernment`), `usgovernmentl5` (also `dod`), and `china`. Defaults to `global` When `null`, the `environment` field will be omitted from the resulting object.\n - `metadata_host` (`string`): The Hostname which should be used for the Azure Metadata Service. When `null`, the `metadata_host` field will be omitted from the resulting object.\n - `msi_endpoint` (`string`): The path to a custom endpoint for Managed Identity - in most circumstances this should be detected automatically When `null`, the `msi_endpoint` field will be omitted from the resulting object.\n - `oidc_request_token` (`string`): The bearer token for the request to the OIDC provider. For use when authenticating as a Service Principal using OpenID Connect. When `null`, the `oidc_request_token` field will be omitted from the resulting object.\n - `oidc_request_url` (`string`): The URL for the OIDC provider from which to request an ID token. For use when authenticating as a Service Principal using OpenID Connect. When `null`, the `oidc_request_url` field will be omitted from the resulting object.\n - `oidc_token` (`string`): The ID token for use when authenticating as a Service Principal using OpenID Connect. When `null`, the `oidc_token` field will be omitted from the resulting object.\n - `oidc_token_file_path` (`string`): The path to a file containing an ID token for use when authenticating as a Service Principal using OpenID Connect. When `null`, the `oidc_token_file_path` field will be omitted from the resulting object.\n - `partner_id` (`string`): A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution When `null`, the `partner_id` field will be omitted from the resulting object.\n - `tenant_id` (`string`): The Tenant ID which should be used. Works with all authentication methods except Managed Identity When `null`, the `tenant_id` field will be omitted from the resulting object.\n - `use_cli` (`bool`): Allow Azure CLI to be used for Authentication When `null`, the `use_cli` field will be omitted from the resulting object.\n - `use_msi` (`bool`): Allow Managed Identity to be used for Authentication When `null`, the `use_msi` field will be omitted from the resulting object.\n - `use_oidc` (`bool`): Allow OpenID Connect to be used for authentication When `null`, the `use_oidc` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that can be used with [tf.withProvider](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withprovider) to construct a new `azuread` provider\n configuration into the root Terraform configuration.\n', args=[]), newAttrs( client_certificate=null, client_certificate_password=null, client_certificate_path=null, client_id=null, + client_id_file_path=null, client_secret=null, + client_secret_file_path=null, disable_terraform_partner_id=null, environment=null, metadata_host=null, @@ -76,7 +82,9 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); client_certificate_password: client_certificate_password, client_certificate_path: client_certificate_path, client_id: client_id, + client_id_file_path: client_id_file_path, client_secret: client_secret, + client_secret_file_path: client_secret_file_path, disable_terraform_partner_id: disable_terraform_partner_id, environment: environment, metadata_host: metadata_host, diff --git a/2.x/_gen/resources/conditional_access_policy.libsonnet b/2.x/_gen/resources/conditional_access_policy.libsonnet index 67d6bda..64be8d8 100644 --- a/2.x/_gen/resources/conditional_access_policy.libsonnet +++ b/2.x/_gen/resources/conditional_access_policy.libsonnet @@ -107,10 +107,10 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'); }, }, grant_controls:: { - '#new':: d.fn(help='\n`azuread.conditional_access_policy.grant_controls.new` constructs a new object with attributes and blocks configured for the `grant_controls`\nTerraform sub block.\n\n\n\n**Args**:\n - `built_in_controls` (`list`): Set the `built_in_controls` field on the resulting object.\n - `custom_authentication_factors` (`list`): Set the `custom_authentication_factors` field on the resulting object. When `null`, the `custom_authentication_factors` field will be omitted from the resulting object.\n - `operator` (`string`): Set the `operator` field on the resulting object.\n - `terms_of_use` (`list`): Set the `terms_of_use` field on the resulting object. When `null`, the `terms_of_use` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `grant_controls` sub block.\n', args=[]), + '#new':: 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( - built_in_controls, operator, + built_in_controls=null, custom_authentication_factors=null, terms_of_use=null ):: std.prune(a={ diff --git a/docs/2.x/conditional_access_policy.md b/docs/2.x/conditional_access_policy.md index 82526e2..e707ce8 100644 --- a/docs/2.x/conditional_access_policy.md +++ b/docs/2.x/conditional_access_policy.md @@ -517,7 +517,7 @@ Terraform sub block. **Args**: - - `built_in_controls` (`list`): Set the `built_in_controls` field on 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. - `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. diff --git a/docs/2.x/data/group.md b/docs/2.x/data/group.md index 0ddb070..4ac2dc6 100644 --- a/docs/2.x/data/group.md +++ b/docs/2.x/data/group.md @@ -17,6 +17,7 @@ This package contains functions and utilities for setting up the data source usi * [`fn newAttrs()`](#fn-newattrs) * [`fn withDisplayName()`](#fn-withdisplayname) * [`fn withMailEnabled()`](#fn-withmailenabled) +* [`fn withMailNickname()`](#fn-withmailnickname) * [`fn withObjectId()`](#fn-withobjectid) * [`fn withSecurityEnabled()`](#fn-withsecurityenabled) * [`fn withTimeouts()`](#fn-withtimeouts) @@ -55,6 +56,7 @@ or `$` to refer to the root object. Instead, make an explicit outer object using - `dataSrcLabel` (`string`): The name label of the block. - `display_name` (`string`): The display name for the group When `null`, the `display_name` field will be omitted from the resulting object. - `mail_enabled` (`bool`): Whether the group is mail-enabled When `null`, the `mail_enabled` field will be omitted from the resulting object. + - `mail_nickname` (`string`): The mail alias for the group, unique in the organisation When `null`, the `mail_nickname` field will be omitted from the resulting object. - `object_id` (`string`): The object ID of the group When `null`, the `object_id` field will be omitted from the resulting object. - `security_enabled` (`bool`): Whether the group is a security group When `null`, the `security_enabled` field will be omitted from the resulting object. - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.group.timeouts.new](#fn-timeoutsnew) constructor. @@ -83,6 +85,7 @@ injecting into a complete block. **Args**: - `display_name` (`string`): The display name for the group When `null`, the `display_name` field will be omitted from the resulting object. - `mail_enabled` (`bool`): Whether the group is mail-enabled When `null`, the `mail_enabled` field will be omitted from the resulting object. + - `mail_nickname` (`string`): The mail alias for the group, unique in the organisation When `null`, the `mail_nickname` field will be omitted from the resulting object. - `object_id` (`string`): The object ID of the group When `null`, the `object_id` field will be omitted from the resulting object. - `security_enabled` (`bool`): Whether the group is a security group When `null`, the `security_enabled` field will be omitted from the resulting object. - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.group.timeouts.new](#fn-timeoutsnew) constructor. @@ -123,6 +126,22 @@ Terraform data source block to set or update the mail_enabled field. - `value` (`bool`): The value to set for the `mail_enabled` field. +### fn withMailNickname + +```ts +withMailNickname() +``` + +`azuread.string.withMailNickname` constructs a mixin object that can be merged into the `string` +Terraform data source block to set or update the mail_nickname field. + + + +**Args**: + - `dataSrcLabel` (`string`): The name label of the block to update. + - `value` (`string`): The value to set for the `mail_nickname` field. + + ### fn withObjectId ```ts diff --git a/docs/2.x/provider.md b/docs/2.x/provider.md index 3fbf4b0..e8cb601 100644 --- a/docs/2.x/provider.md +++ b/docs/2.x/provider.md @@ -37,7 +37,9 @@ the `src` and/or `version` parameters are set. - `client_certificate_password` (`string`): The password to decrypt the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate When `null`, the `client_certificate_password` field will be omitted from the resulting object. - `client_certificate_path` (`string`): The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate When `null`, the `client_certificate_path` field will be omitted from the resulting object. - `client_id` (`string`): The Client ID which should be used for service principal authentication When `null`, the `client_id` field will be omitted from the resulting object. + - `client_id_file_path` (`string`): The path to a file containing the Client ID which should be used for service principal authentication When `null`, the `client_id_file_path` field will be omitted from the resulting object. - `client_secret` (`string`): The application password to use when authenticating as a Service Principal using a Client Secret When `null`, the `client_secret` field will be omitted from the resulting object. + - `client_secret_file_path` (`string`): The path to a file containing the application password to use when authenticating as a Service Principal using a Client Secret When `null`, the `client_secret_file_path` field will be omitted from the resulting object. - `disable_terraform_partner_id` (`bool`): Disable the Terraform Partner ID, which is used if a custom `partner_id` isn't specified When `null`, the `disable_terraform_partner_id` field will be omitted from the resulting object. - `environment` (`string`): The cloud environment which should be used. Possible values are: `global` (also `public`), `usgovernmentl4` (also `usgovernment`), `usgovernmentl5` (also `dod`), and `china`. Defaults to `global` When `null`, the `environment` field will be omitted from the resulting object. - `metadata_host` (`string`): The Hostname which should be used for the Azure Metadata Service. When `null`, the `metadata_host` field will be omitted from the resulting object. @@ -86,7 +88,9 @@ injecting into a complete block. - `client_certificate_password` (`string`): The password to decrypt the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate When `null`, the `client_certificate_password` field will be omitted from the resulting object. - `client_certificate_path` (`string`): The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate When `null`, the `client_certificate_path` field will be omitted from the resulting object. - `client_id` (`string`): The Client ID which should be used for service principal authentication When `null`, the `client_id` field will be omitted from the resulting object. + - `client_id_file_path` (`string`): The path to a file containing the Client ID which should be used for service principal authentication When `null`, the `client_id_file_path` field will be omitted from the resulting object. - `client_secret` (`string`): The application password to use when authenticating as a Service Principal using a Client Secret When `null`, the `client_secret` field will be omitted from the resulting object. + - `client_secret_file_path` (`string`): The path to a file containing the application password to use when authenticating as a Service Principal using a Client Secret When `null`, the `client_secret_file_path` field will be omitted from the resulting object. - `disable_terraform_partner_id` (`bool`): Disable the Terraform Partner ID, which is used if a custom `partner_id` isn't specified When `null`, the `disable_terraform_partner_id` field will be omitted from the resulting object. - `environment` (`string`): The cloud environment which should be used. Possible values are: `global` (also `public`), `usgovernmentl4` (also `usgovernment`), `usgovernmentl5` (also `dod`), and `china`. Defaults to `global` When `null`, the `environment` field will be omitted from the resulting object. - `metadata_host` (`string`): The Hostname which should be used for the Azure Metadata Service. When `null`, the `metadata_host` field will be omitted from the resulting object.