diff --git a/docs/data-sources/accounts.md b/docs/data-sources/accounts.md index 12818e269..90d281505 100644 --- a/docs/data-sources/accounts.md +++ b/docs/data-sources/accounts.md @@ -30,6 +30,7 @@ data "octopusdeploy_accounts" "example" { - `ids` (List of String) A filter to search by a list of IDs. - `partial_name` (String) A filter to search by the partial match of a name. - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) A Space ID to filter by. Will revert what is specified on the provider if not set. - `take` (Number) A filter to specify the number of items to take (or return) in the response. ### Read-Only diff --git a/docs/data-sources/azure_cloud_service_deployment_targets.md b/docs/data-sources/azure_cloud_service_deployment_targets.md index 2673546bc..fc9c0d334 100644 --- a/docs/data-sources/azure_cloud_service_deployment_targets.md +++ b/docs/data-sources/azure_cloud_service_deployment_targets.md @@ -37,6 +37,7 @@ data "octopusdeploy_azure_cloud_service_deployment_targets" "example" { - `roles` (List of String) A filter to search by a list of role IDs. - `shell_names` (List of String) A list of shell names to match in the query and/or search - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) The space ID associated with this resource. - `take` (Number) A filter to specify the number of items to take (or return) in the response. - `tenant_tags` (List of String) A filter to search by a list of tenant tags. - `tenants` (List of String) A filter to search by a list of tenant IDs. @@ -181,5 +182,3 @@ Read-Only: - `upgrade_required` (Boolean) - `upgrade_suggested` (Boolean) - `version` (String) - - diff --git a/docs/data-sources/azure_service_fabric_cluster_deployment_targets.md b/docs/data-sources/azure_service_fabric_cluster_deployment_targets.md index 06ade5d33..d046b6cd1 100644 --- a/docs/data-sources/azure_service_fabric_cluster_deployment_targets.md +++ b/docs/data-sources/azure_service_fabric_cluster_deployment_targets.md @@ -37,6 +37,7 @@ data "octopusdeploy_azure_service_fabric_cluster_deployment_targets" "example" { - `roles` (List of String) A filter to search by a list of role IDs. - `shell_names` (List of String) A list of shell names to match in the query and/or search - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) The space ID associated with this resource. - `take` (Number) A filter to specify the number of items to take (or return) in the response. - `tenant_tags` (List of String) A filter to search by a list of tenant tags. - `tenants` (List of String) A filter to search by a list of tenant IDs. @@ -184,5 +185,3 @@ Read-Only: - `upgrade_required` (Boolean) - `upgrade_suggested` (Boolean) - `version` (String) - - diff --git a/docs/data-sources/azure_web_app_deployment_targets.md b/docs/data-sources/azure_web_app_deployment_targets.md index 7198988fc..475f4a73a 100644 --- a/docs/data-sources/azure_web_app_deployment_targets.md +++ b/docs/data-sources/azure_web_app_deployment_targets.md @@ -37,6 +37,7 @@ data "octopusdeploy_azure_web_app_deployment_targets" "example" { - `roles` (List of String) A filter to search by a list of role IDs. - `shell_names` (List of String) A list of shell names to match in the query and/or search - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) The space ID associated with this resource. - `take` (Number) A filter to specify the number of items to take (or return) in the response. - `tenant_tags` (List of String) A filter to search by a list of tenant tags. - `tenants` (List of String) A filter to search by a list of tenant IDs. @@ -178,5 +179,3 @@ Read-Only: - `upgrade_required` (Boolean) - `upgrade_suggested` (Boolean) - `version` (String) - - diff --git a/docs/data-sources/certificates.md b/docs/data-sources/certificates.md index ffd5762c8..c0b5270b7 100644 --- a/docs/data-sources/certificates.md +++ b/docs/data-sources/certificates.md @@ -34,6 +34,7 @@ data "octopusdeploy_certificates" "example" { - `partial_name` (String) A filter to search by the partial match of a name. - `search` (String) A filter of terms used the search operation. - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) The space ID associated with this resource. - `take` (Number) A filter to specify the number of items to take (or return) in the response. - `tenant` (String) A filter to search by a tenant ID. @@ -66,6 +67,7 @@ Read-Only: - `self_signed` (Boolean) - `serial_number` (String) - `signature_algorithm_name` (String) +- `space_id` (String) - `subject_alternative_names` (List of String) - `subject_common_name` (String) - `subject_distinguished_name` (String) @@ -75,5 +77,3 @@ Read-Only: - `tenants` (List of String) A list of tenant IDs associated with this resource. - `thumbprint` (String) - `version` (Number) - - diff --git a/docs/data-sources/channels.md b/docs/data-sources/channels.md index 11ff233a8..804ae11d9 100644 --- a/docs/data-sources/channels.md +++ b/docs/data-sources/channels.md @@ -29,6 +29,7 @@ data "octopusdeploy_channels" "example" { - `ids` (List of String) A filter to search by a list of IDs. - `partial_name` (String) A filter to search by the partial match of a name. - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) The space ID associated with this resource. - `take` (Number) A filter to specify the number of items to take (or return) in the response. ### Read-Only @@ -68,5 +69,3 @@ Read-Only: - `deployment_action` (String) - `package_reference` (String) - - diff --git a/docs/data-sources/cloud_region_deployment_targets.md b/docs/data-sources/cloud_region_deployment_targets.md index 3be96795f..9e16196ec 100644 --- a/docs/data-sources/cloud_region_deployment_targets.md +++ b/docs/data-sources/cloud_region_deployment_targets.md @@ -38,6 +38,7 @@ data "octopusdeploy_cloud_region_deployment_targets" "example" { - `roles` (List of String) A filter to search by a list of role IDs. - `shell_names` (List of String) A list of shell names to match in the query and/or search - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) The space ID associated with this resource. - `take` (Number) A filter to specify the number of items to take (or return) in the response. - `tenant_tags` (List of String) A filter to search by a list of tenant tags. - `tenants` (List of String) A filter to search by a list of tenant IDs. @@ -74,5 +75,3 @@ Read-Only: - `tenants` (List of String) A list of tenant IDs associated with this resource. - `thumbprint` (String) - `uri` (String) - - diff --git a/docs/data-sources/deployment_targets.md b/docs/data-sources/deployment_targets.md index aabef93f7..c1534eb07 100644 --- a/docs/data-sources/deployment_targets.md +++ b/docs/data-sources/deployment_targets.md @@ -28,6 +28,7 @@ Provides information about existing deployment targets. - `roles` (List of String) A filter to search by a list of role IDs. - `shell_names` (List of String) A list of shell names to match in the query and/or search - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) The space ID associated with this resource. - `take` (Number) A filter to specify the number of items to take (or return) in the response. - `tenant_tags` (List of String) A filter to search by a list of tenant tags. - `tenants` (List of String) A filter to search by a list of tenant IDs. @@ -165,5 +166,3 @@ Read-Only: - `upgrade_required` (Boolean) - `upgrade_suggested` (Boolean) - `version` (String) - - diff --git a/docs/data-sources/environments.md b/docs/data-sources/environments.md index 3f3833c95..960c96dd4 100644 --- a/docs/data-sources/environments.md +++ b/docs/data-sources/environments.md @@ -31,6 +31,7 @@ data "octopusdeploy_environments" "example" { - `name` (String) A filter to search by name. - `partial_name` (String) A filter to search by the partial match of a name. - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) The space ID associated with this resource. - `take` (Number) A filter to specify the number of items to take (or return) in the response. ### Read-Only @@ -77,5 +78,3 @@ Read-Only: Read-Only: - `is_enabled` (Boolean) - - diff --git a/docs/data-sources/feeds.md b/docs/data-sources/feeds.md index cb73f075c..623ec5593 100644 --- a/docs/data-sources/feeds.md +++ b/docs/data-sources/feeds.md @@ -31,6 +31,7 @@ data "octopusdeploy_feeds" "example" { - `name` (String) A filter to search by name. - `partial_name` (String) A filter to search by the partial match of a name. - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) The space ID associated with this resource. - `take` (Number) A filter to specify the number of items to take (or return) in the response. ### Read-Only diff --git a/docs/data-sources/git_credentials.md b/docs/data-sources/git_credentials.md index b157b4a7b..5645109c5 100644 --- a/docs/data-sources/git_credentials.md +++ b/docs/data-sources/git_credentials.md @@ -19,6 +19,7 @@ Provides information about existing GitCredentials. - `name` (String) A filter to search by name. - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) The space ID associated with this resource. - `take` (Number) A filter to specify the number of items to take (or return) in the response. ### Read-Only @@ -38,5 +39,3 @@ Read-Only: - `space_id` (String) The space ID associated with this resource. - `type` (String) The Git credential authentication type. - `username` (String) The username for the Git credential. - - diff --git a/docs/data-sources/kubernetes_cluster_deployment_targets.md b/docs/data-sources/kubernetes_cluster_deployment_targets.md index 7633dfc48..cb7d166e0 100644 --- a/docs/data-sources/kubernetes_cluster_deployment_targets.md +++ b/docs/data-sources/kubernetes_cluster_deployment_targets.md @@ -27,6 +27,7 @@ Provides information about existing Kubernetes cluster deployment targets. - `roles` (List of String) A filter to search by a list of role IDs. - `shell_names` (List of String) A list of shell names to match in the query and/or search - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) The space ID associated with this resource. - `take` (Number) A filter to specify the number of items to take (or return) in the response. - `tenant_tags` (List of String) A filter to search by a list of tenant tags. - `tenants` (List of String) A filter to search by a list of tenant IDs. @@ -253,5 +254,3 @@ Read-Only: Read-Only: - `token_path` (String) - - diff --git a/docs/data-sources/library_variable_sets.md b/docs/data-sources/library_variable_sets.md index 57242a454..a50ca91ef 100644 --- a/docs/data-sources/library_variable_sets.md +++ b/docs/data-sources/library_variable_sets.md @@ -21,6 +21,7 @@ Provides information about existing library variable sets. - `ids` (List of String) A filter to search by a list of IDs. - `partial_name` (String) A filter to search by the partial match of a name. - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) A Space ID to filter by. Will revert what is specified on the provider if not set. - `take` (Number) A filter to specify the number of items to take (or return) in the response. ### Read-Only @@ -51,5 +52,3 @@ Read-Only: - `id` (String) - `label` (String) - `name` (String) - - diff --git a/docs/data-sources/lifecycles.md b/docs/data-sources/lifecycles.md index 52ab1930f..1acbc0b3a 100644 --- a/docs/data-sources/lifecycles.md +++ b/docs/data-sources/lifecycles.md @@ -29,6 +29,7 @@ data "octopusdeploy_lifecycles" "example" { - `ids` (List of String) A filter to search by a list of IDs. - `partial_name` (String) A filter to search by the partial match of a name. - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) The space ID associated with this resource. - `take` (Number) A filter to specify the number of items to take (or return) in the response. ### Read-Only @@ -102,5 +103,3 @@ Read-Only: - `quantity_to_keep` (Number) - `should_keep_forever` (Boolean) - `unit` (String) - - diff --git a/docs/data-sources/listening_tentacle_deployment_targets.md b/docs/data-sources/listening_tentacle_deployment_targets.md index ae94919cd..ce465ad4e 100644 --- a/docs/data-sources/listening_tentacle_deployment_targets.md +++ b/docs/data-sources/listening_tentacle_deployment_targets.md @@ -46,6 +46,7 @@ data "octopusdeploy_listening_tentacle_deployment_targets" "listening_tentacle_d - `roles` (List of String) A filter to search by a list of role IDs. - `shell_names` (List of String) A list of shell names to match in the query and/or search - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) The space ID associated with this resource. - `take` (Number) A filter to specify the number of items to take (or return) in the response. - `tenant_tags` (List of String) A filter to search by a list of tenant tags. - `tenants` (List of String) A filter to search by a list of tenant IDs. @@ -95,5 +96,3 @@ Read-Only: - `upgrade_required` (Boolean) - `upgrade_suggested` (Boolean) - `version` (String) - - diff --git a/docs/data-sources/machine.md b/docs/data-sources/machine.md index b4ce10418..839a607db 100644 --- a/docs/data-sources/machine.md +++ b/docs/data-sources/machine.md @@ -42,5 +42,3 @@ description: |- - `tenanteddeploymentparticipation` (String) - `tenantids` (List of String) - `tenanttags` (List of String) - - diff --git a/docs/data-sources/machine_policies.md b/docs/data-sources/machine_policies.md index 28342d931..f7d0adeab 100644 --- a/docs/data-sources/machine_policies.md +++ b/docs/data-sources/machine_policies.md @@ -20,6 +20,7 @@ Provides information about existing machine policies. - `ids` (List of String) A filter to search by a list of IDs. - `partial_name` (String) A filter to search by the partial match of a name. - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) The space ID associated with this resource. - `take` (Number) A filter to specify the number of items to take (or return) in the response. ### Read-Only @@ -104,5 +105,3 @@ Read-Only: - `calamari_update_behavior` (String) - `tentacle_update_account_id` (String) - `tentacle_update_behavior` (String) - - diff --git a/docs/data-sources/offline_package_drop_deployment_targets.md b/docs/data-sources/offline_package_drop_deployment_targets.md index d4404fee2..d55532393 100644 --- a/docs/data-sources/offline_package_drop_deployment_targets.md +++ b/docs/data-sources/offline_package_drop_deployment_targets.md @@ -27,6 +27,7 @@ Provides information about existing offline package drop deployment targets. - `roles` (List of String) A filter to search by a list of role IDs. - `shell_names` (List of String) A list of shell names to match in the query and/or search - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) The space ID associated with this resource. - `take` (Number) A filter to specify the number of items to take (or return) in the response. - `tenant_tags` (List of String) A filter to search by a list of tenant tags. - `tenants` (List of String) A filter to search by a list of tenant IDs. @@ -176,5 +177,3 @@ Read-Only: - `upgrade_required` (Boolean) - `upgrade_suggested` (Boolean) - `version` (String) - - diff --git a/docs/data-sources/polling_tentacle_deployment_targets.md b/docs/data-sources/polling_tentacle_deployment_targets.md index a2768b0e8..1b11bd69f 100644 --- a/docs/data-sources/polling_tentacle_deployment_targets.md +++ b/docs/data-sources/polling_tentacle_deployment_targets.md @@ -27,6 +27,7 @@ Provides information about existing polling tentacle deployment targets. - `roles` (List of String) A filter to search by a list of role IDs. - `shell_names` (List of String) A list of shell names to match in the query and/or search - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) The space ID associated with this resource. - `take` (Number) A filter to specify the number of items to take (or return) in the response. - `tenant_tags` (List of String) A filter to search by a list of tenant tags. - `tenants` (List of String) A filter to search by a list of tenant IDs. @@ -179,5 +180,3 @@ Read-Only: - `upgrade_required` (Boolean) - `upgrade_suggested` (Boolean) - `version` (String) - - diff --git a/docs/data-sources/project_groups.md b/docs/data-sources/project_groups.md index fe048ef1a..3e72b136f 100644 --- a/docs/data-sources/project_groups.md +++ b/docs/data-sources/project_groups.md @@ -29,6 +29,7 @@ data "octopusdeploy_project_groups" "example" { - `ids` (List of String) A filter to search by a list of IDs. - `partial_name` (String) A filter to search by the partial match of a name. - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) A Space ID to filter by. Will revert what is specified on the provider if not set. - `take` (Number) A filter to specify the number of items to take (or return) in the response. ### Read-Only @@ -46,5 +47,3 @@ Read-Only: - `name` (String) The name of this resource. - `retention_policy_id` (String) The ID of the retention policy associated with this project group. - `space_id` (String) The space ID associated with this project group. - - diff --git a/docs/data-sources/projects.md b/docs/data-sources/projects.md index b4d700d3b..01bd849f6 100644 --- a/docs/data-sources/projects.md +++ b/docs/data-sources/projects.md @@ -35,6 +35,7 @@ data "octopusdeploy_projects" "example" { - `name` (String) A filter to search by name. - `partial_name` (String) A filter to search by the partial match of a name. - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) A Space ID to filter by. Will revert what is specified on the provider if not set. - `take` (Number) A filter to specify the number of items to take (or return) in the response. ### Read-Only @@ -196,5 +197,3 @@ Read-Only: - `deployment_action` (String) - `package_reference` (String) - - diff --git a/docs/data-sources/script_modules b/docs/data-sources/script_modules index 43adc39d9..6625186eb 100644 --- a/docs/data-sources/script_modules +++ b/docs/data-sources/script_modules @@ -28,6 +28,7 @@ data "octopusdeploy_script_modules" "example" { - `ids` (List of String) A filter to search by a list of IDs. - `partial_name` (String) A filter to search by the partial match of a name. - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) A Space ID to filter by. Will revert what is specified on the provider if not set. - `take` (Number) A filter to specify the number of items to take (or return) in the response. ### Read-Only diff --git a/docs/data-sources/script_modules.md b/docs/data-sources/script_modules.md index 5bb1355f6..8a4ab70c5 100644 --- a/docs/data-sources/script_modules.md +++ b/docs/data-sources/script_modules.md @@ -29,6 +29,7 @@ data "octopusdeploy_script_modules" "example" { - `ids` (List of String) A filter to search by a list of IDs. - `partial_name` (String) A filter to search by the partial match of a name. - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) A Space ID to filter by. Will revert what is specified on the provider if not set. - `take` (Number) A filter to specify the number of items to take (or return) in the response. ### Read-Only @@ -55,5 +56,3 @@ Read-Only: - `body` (String) - `syntax` (String) - - diff --git a/docs/data-sources/space.md b/docs/data-sources/space.md index 36bcc4c81..70897c61f 100644 --- a/docs/data-sources/space.md +++ b/docs/data-sources/space.md @@ -28,5 +28,3 @@ Provides information about an existing space. - `slug` (String) The unique slug of this space. - `space_managers_team_members` (Set of String) A list of user IDs designated to be managers of this space. - `space_managers_teams` (Set of String) A list of team IDs designated to be managers of this space. - - diff --git a/docs/data-sources/spaces.md b/docs/data-sources/spaces.md index 36485b0a1..3cda99d0b 100644 --- a/docs/data-sources/spaces.md +++ b/docs/data-sources/spaces.md @@ -49,5 +49,3 @@ Read-Only: - `slug` (String) The unique slug of this space. - `space_managers_team_members` (Set of String) A list of user IDs designated to be managers of this space. - `space_managers_teams` (Set of String) A list of team IDs designated to be managers of this space. - - diff --git a/docs/data-sources/ssh_connection_deployment_targets.md b/docs/data-sources/ssh_connection_deployment_targets.md index f521411f6..c9918d5b2 100644 --- a/docs/data-sources/ssh_connection_deployment_targets.md +++ b/docs/data-sources/ssh_connection_deployment_targets.md @@ -27,6 +27,7 @@ Provides information about existing SSH connection deployment targets. - `roles` (List of String) A filter to search by a list of role IDs. - `shell_names` (List of String) A list of shell names to match in the query and/or search - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) The space ID associated with this resource. - `take` (Number) A filter to specify the number of items to take (or return) in the response. - `tenant_tags` (List of String) A filter to search by a list of tenant tags. - `tenants` (List of String) A filter to search by a list of tenant IDs. @@ -170,5 +171,3 @@ Read-Only: - `upgrade_required` (Boolean) - `upgrade_suggested` (Boolean) - `version` (String) - - diff --git a/docs/data-sources/tag_sets.md b/docs/data-sources/tag_sets.md index f126a66fd..8061cfb1c 100644 --- a/docs/data-sources/tag_sets.md +++ b/docs/data-sources/tag_sets.md @@ -20,6 +20,7 @@ Provides information about existing tag sets. - `ids` (List of String) A filter to search by a list of IDs. - `partial_name` (String) A filter to search by the partial match of a name. - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) The space ID associated with this resource. - `take` (Number) A filter to specify the number of items to take (or return) in the response. ### Read-Only @@ -37,5 +38,3 @@ Read-Only: - `name` (String) The name of this resource. - `sort_order` (Number) The sort order associated with this resource. - `space_id` (String) The space ID associated with this resource. - - diff --git a/docs/data-sources/teams.md b/docs/data-sources/teams.md index ba635c2e0..180ed6f56 100644 --- a/docs/data-sources/teams.md +++ b/docs/data-sources/teams.md @@ -53,5 +53,3 @@ Read-Only: - `display_id_and_name` (Boolean) - `display_name` (String) - `id` (String) - - diff --git a/docs/data-sources/tenants.md b/docs/data-sources/tenants.md index d221a4df2..92d6f3103 100644 --- a/docs/data-sources/tenants.md +++ b/docs/data-sources/tenants.md @@ -52,5 +52,3 @@ Read-Only: - `environments` (List of String) - `project_id` (String) - - diff --git a/docs/data-sources/user_roles.md b/docs/data-sources/user_roles.md index a301e78e7..0757d6ce6 100644 --- a/docs/data-sources/user_roles.md +++ b/docs/data-sources/user_roles.md @@ -29,6 +29,7 @@ data "octopusdeploy_user_roles" "example" { - `ids` (List of String) A filter to search by a list of IDs. - `partial_name` (String) A filter to search by the partial match of a name. - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) A Space ID to filter by. Will revert what is specified on the provider if not set. - `take` (Number) A filter to specify the number of items to take (or return) in the response. ### Read-Only @@ -50,5 +51,3 @@ Read-Only: - `space_permission_descriptions` (List of String) - `supported_restrictions` (List of String) - `system_permission_descriptions` (List of String) - - diff --git a/docs/data-sources/users.md b/docs/data-sources/users.md index ade0ff72f..a0be264d4 100644 --- a/docs/data-sources/users.md +++ b/docs/data-sources/users.md @@ -28,6 +28,7 @@ data "octopusdeploy_users" "example" { - `filter` (String) A filter with which to search. - `ids` (List of String) A filter to search by a list of IDs. - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) A Space ID to filter by. Will revert what is specified on the provider if not set. - `take` (Number) A filter to specify the number of items to take (or return) in the response. ### Read-Only @@ -67,5 +68,3 @@ Read-Only: - `is_identifying_claim` (Boolean) - `name` (String) - `value` (String) - - diff --git a/docs/data-sources/variables.md b/docs/data-sources/variables.md index d7c2729f7..bb25146ab 100644 --- a/docs/data-sources/variables.md +++ b/docs/data-sources/variables.md @@ -20,74 +20,62 @@ data "octopusdeploy_variables" "example" { ## Schema -### Optional - -- `ids` (List of String) A filter to search by a list of IDs. +### Required -### Read-Only +- `name` (String) The name of variable to find. +- `owner_id` (String) Owner ID for the variable to find. +- `scope` (Block List, Min: 1, Max: 1) As variable names can appear more than once under different scopes, a VariableScope must also be provided (see [below for nested schema](#nestedblock--scope)) -- `id` (String) An auto-generated identifier that includes the timestamp when this data source was last modified. -- `variables` (Block List) A list of variables that match the filter(s). (see [below for nested schema](#nestedblock--variables)) +### Optional - -### Nested Schema for `variables` +- `space_id` (String) A Space ID to filter by. Will revert what is specified on the provider if not set. -Read-Only: +### Read-Only - `description` (String) The description of this variable. -- `encrypted_value` (String) +- `id` (String) The identifier of the variable to find. - `is_editable` (Boolean) Indicates whether or not this variable is considered editable. - `is_sensitive` (Boolean) Indicates whether or not this resource is considered sensitive and should be kept secret. -- `key_fingerprint` (String) -- `name` (String) The name of this resource. -- `owner_id` (String) -- `pgp_key` (String, Sensitive) -- `project_id` (String, Deprecated) -- `prompt` (List of Object) (see [below for nested schema](#nestedatt--variables--prompt)) -- `scope` (List of Object) (see [below for nested schema](#nestedatt--variables--scope)) +- `prompt` (List of Object) (see [below for nested schema](#nestedatt--prompt)) - `sensitive_value` (String, Sensitive) - `type` (String) The type of variable represented by this resource. Valid types are `AmazonWebServicesAccount`, `AzureAccount`, `GoogleCloudAccount`, `Certificate`, `Sensitive`, `String`, or `WorkerPool`. - `value` (String) - -### Nested Schema for `variables.prompt` + +### Nested Schema for `scope` + +Optional: + +- `actions` (List of String) A list of actions that are scoped to this variable value. +- `channels` (List of String) A list of channels that are scoped to this variable value. +- `environments` (List of String) A list of environments that are scoped to this variable value. +- `machines` (List of String) A list of machines that are scoped to this variable value. +- `roles` (List of String) A list of roles that are scoped to this variable value. +- `tenant_tags` (List of String) A list of tenant tags that are scoped to this variable value. + + + +### Nested Schema for `prompt` Read-Only: - `description` (String) -- `display_settings` (List of Object) (see [below for nested schema](#nestedobjatt--variables--prompt--display_settings)) +- `display_settings` (List of Object) (see [below for nested schema](#nestedobjatt--prompt--display_settings)) - `is_required` (Boolean) - `label` (String) - -### Nested Schema for `variables.prompt.display_settings` + +### Nested Schema for `prompt.display_settings` Read-Only: - `control_type` (String) -- `select_option` (List of Object) (see [below for nested schema](#nestedobjatt--variables--prompt--display_settings--select_option)) +- `select_option` (List of Object) (see [below for nested schema](#nestedobjatt--prompt--display_settings--select_option)) - -### Nested Schema for `variables.prompt.display_settings.select_option` + +### Nested Schema for `prompt.display_settings.select_option` Read-Only: - `display_name` (String) - `value` (String) - - - - - -### Nested Schema for `variables.scope` - -Read-Only: - -- `actions` (List of String) -- `channels` (List of String) -- `environments` (List of String) -- `machines` (List of String) -- `roles` (List of String) -- `tenant_tags` (List of String) - - diff --git a/docs/data-sources/worker_pools.md b/docs/data-sources/worker_pools.md index f4945ceda..e23a062b7 100644 --- a/docs/data-sources/worker_pools.md +++ b/docs/data-sources/worker_pools.md @@ -21,6 +21,7 @@ Provides information about existing worker pools. - `name` (String) A filter to search by name. - `partial_name` (String) A filter to search by the partial match of a name. - `skip` (Number) A filter to specify the number of items to skip in the response. +- `space_id` (String) The space ID associated with this resource. - `take` (Number) A filter to specify the number of items to take (or return) in the response. ### Read-Only @@ -42,5 +43,3 @@ Read-Only: - `space_id` (String) The space ID associated with this resource. - `worker_pool_type` (String) - `worker_type` (String) - - diff --git a/docs/index.md b/docs/index.md index 4e780bfbf..4d054c49e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -130,11 +130,8 @@ resource "octopusdeploy_environment" "Env3" { ## Schema -### Required +### Optional - `address` (String) The endpoint of the Octopus REST API - `api_key` (String) The API key to use with the Octopus REST API - -### Optional - - `space_id` (String) The space ID to target \ No newline at end of file diff --git a/docs/resources/azure_service_fabric_cluster_deployment_target.md b/docs/resources/azure_service_fabric_cluster_deployment_target.md index 0666230b6..75be6bdeb 100644 --- a/docs/resources/azure_service_fabric_cluster_deployment_target.md +++ b/docs/resources/azure_service_fabric_cluster_deployment_target.md @@ -13,11 +13,9 @@ This resource manages Azure service fabric cluster deployment targets in Octopus ```terraform resource "octopusdeploy_azure_service_fabric_cluster_deployment_target" "example" { - account_id = "Accounts-123" connection_endpoint = "[connection-endpoint]" environments = ["Environments-123", "Environment-321"] name = "Azure Service Fabric Cluster Deployment Target (OK to Delete)" - storage_account_name = "[storage_account_name]" roles = ["Development Team", "System Administrators"] tenanted_deployment_participation = "Untenanted" } diff --git a/docs/resources/certificate.md b/docs/resources/certificate.md index 1f4580186..704e98cd8 100644 --- a/docs/resources/certificate.md +++ b/docs/resources/certificate.md @@ -47,6 +47,7 @@ resource "octopusdeploy_certificate" "example" { - `self_signed` (Boolean) - `serial_number` (String) - `signature_algorithm_name` (String) +- `space_id` (String) - `subject_alternative_names` (List of String) - `subject_common_name` (String) - `subject_distinguished_name` (String) diff --git a/docs/resources/deployment_process.md b/docs/resources/deployment_process.md index b255312d0..07f76d8f3 100644 --- a/docs/resources/deployment_process.md +++ b/docs/resources/deployment_process.md @@ -66,11 +66,12 @@ resource "octopusdeploy_deployment_process" "child_step_example" { start_trigger = "StartAfterPrevious" target_roles = [ "hello-world" ] run_script_action { + name = "Hello world (using PowerShell)" + sort_order = 1 can_be_used_for_project_versioning = false condition = "Success" is_disabled = false is_required = true - name = "Hello world (using PowerShell)" script_body = <<-EOT Write-Host 'Hello world, using PowerShell' #TODO: Experiment with steps of your own :) @@ -78,11 +79,12 @@ resource "octopusdeploy_deployment_process" "child_step_example" { EOT } run_script_action { + name = "Hello world (using Bash)" + sort_order = 2 can_be_used_for_project_versioning = false condition = "Success" is_disabled = false is_required = true - name = "Hello world (using Bash)" script_body = <<-EOT echo 'Hello world, using Bash' #TODO: Experiment with steps of your own :) @@ -103,11 +105,12 @@ resource "octopusdeploy_deployment_process" "child_step_rolling_deployment_examp target_roles = [ "hello-world" ] window_size = 2 run_script_action { + name = "Hello world (using PowerShell)" + sort_order = 1 can_be_used_for_project_versioning = false condition = "Success" is_disabled = false is_required = true - name = "Hello world (using PowerShell)" script_body = <<-EOT Write-Host 'Hello world, using PowerShell' #TODO: Experiment with steps of your own :) @@ -115,11 +118,12 @@ resource "octopusdeploy_deployment_process" "child_step_rolling_deployment_examp EOT } run_script_action { + name = "Hello world (using Bash)" + sort_order = 2 can_be_used_for_project_versioning = false condition = "Success" is_disabled = false is_required = true - name = "Hello world (using Bash)" script_body = <<-EOT echo 'Hello world, using Bash' #TODO: Experiment with steps of your own :) @@ -444,6 +448,8 @@ Optional: - `run_on_server` (Boolean) Whether this step runs on a worker or on the target - `sort_order` (Number) Order used by terraform to ensure correct ordering of actions. This property must be either omitted from all actions, or provided on all actions - `tenant_tags` (List of String) A list of tenant tags associated with this resource. +- `worker_pool_id` (String) The worker pool associated with this deployment action. +- `worker_pool_variable` (String) The worker pool variable associated with this deployment action. ### Nested Schema for `step.deploy_kubernetes_secret_action.action_template` @@ -773,11 +779,14 @@ Optional: - `primary_package` (Block List, Max: 1) The package assocated with this action. (see [below for nested schema](#nestedblock--step--run_kubectl_script_action--primary_package)) - `properties` (Map of String) The properties associated with this deployment action. - `run_on_server` (Boolean) Whether this step runs on a worker or on the target +- `script_body` (String) - `script_file_name` (String) The script file name in the package - `script_parameters` (String) Parameters expected by the script. Use platform specific calling convention. e.g. -Path #{VariableStoringPath} for PowerShell or -- #{VariableStoringPath} for ScriptCS - `script_source` (String) - `sort_order` (Number) Order used by terraform to ensure correct ordering of actions. This property must be either omitted from all actions, or provided on all actions - `tenant_tags` (List of String) A list of tenant tags associated with this resource. +- `worker_pool_id` (String) The worker pool associated with this deployment action. +- `worker_pool_variable` (String) The worker pool variable associated with this deployment action. ### Nested Schema for `step.run_kubectl_script_action.action_template` diff --git a/docs/resources/git_credential.md b/docs/resources/git_credential.md index e47402fa1..57f2a6b00 100644 --- a/docs/resources/git_credential.md +++ b/docs/resources/git_credential.md @@ -27,5 +27,3 @@ This resource manages Git credentials in Octopus Deploy. - `id` (String) The unique ID for this resource. - `space_id` (String) The space ID associated with this resource. - `type` (String) The Git credential authentication type. - - diff --git a/docs/resources/library_variable_set.md b/docs/resources/library_variable_set.md index 5cdf3b26a..69a2c2300 100644 --- a/docs/resources/library_variable_set.md +++ b/docs/resources/library_variable_set.md @@ -44,5 +44,3 @@ Optional: - `help_text` (String) The help presented alongside the parameter input. - `id` (String) The unique ID for this resource. - `label` (String) The label shown beside the parameter when presented in the deployment process. Example: `Server name`. - - diff --git a/docs/resources/listening_tentacle_deployment_target.md b/docs/resources/listening_tentacle_deployment_target.md index 0a00a076e..7e4efcbc7 100644 --- a/docs/resources/listening_tentacle_deployment_target.md +++ b/docs/resources/listening_tentacle_deployment_target.md @@ -15,7 +15,7 @@ This resource manages listening tentacle deployment targets in Octopus Deploy. resource "octopusdeploy_listening_tentacle_deployment_target" "example" { environments = ["Environments-123", "Environment-321"] is_disabled = true - machine_policy_id = "MachinePolicy-123" + machine_policy_id = "MachinePolicies-123" name = "Listening Tentacle Deployment Target (OK to Delete)" roles = ["Development Team", "System Administrators"] tenanted_deployment_participation = "Untenanted" diff --git a/docs/resources/machine_policy.md b/docs/resources/machine_policy.md index d3fa2a8cd..136e885d3 100644 --- a/docs/resources/machine_policy.md +++ b/docs/resources/machine_policy.md @@ -98,5 +98,3 @@ Optional: - `calamari_update_behavior` (String) - `tentacle_update_account_id` (String) - `tentacle_update_behavior` (String) - - diff --git a/docs/resources/offline_package_drop_deployment_target.md b/docs/resources/offline_package_drop_deployment_target.md index bd20fce3b..ab8dfd603 100644 --- a/docs/resources/offline_package_drop_deployment_target.md +++ b/docs/resources/offline_package_drop_deployment_target.md @@ -12,15 +12,16 @@ This resource manages offline package drop deployment targets in Octopus Deploy. ## Example Usage ```terraform -resource "octopusdeploy_listening_tentacle_deployment_target" "example" { +resource "octopusdeploy_offline_package_drop_deployment_target" "example" { environments = ["Environments-123", "Environment-321"] is_disabled = true - machine_policy_id = "MachinePolicy-123" - name = "Listening Tentacle Deployment Target (OK to Delete)" + machine_policy_id = "MachinePolicies-123" + name = "Offline Package Drop Deployment Target (OK to Delete)" roles = ["Development Team", "System Administrators"] tenanted_deployment_participation = "Untenanted" - tentacle_url = "https://example.com:1234/" thumbprint = "" + working_directory = "" + applications_directory = "" } ``` diff --git a/docs/resources/polling_tentacle_deployment_target.md b/docs/resources/polling_tentacle_deployment_target.md index b8e9fcc6a..9e80bd9e3 100644 --- a/docs/resources/polling_tentacle_deployment_target.md +++ b/docs/resources/polling_tentacle_deployment_target.md @@ -12,11 +12,11 @@ This resource manages polling tentacle deployment targets in Octopus Deploy. ## Example Usage ```terraform -resource "octopusdeploy_listening_tentacle_deployment_target" "example" { +resource "octopusdeploy_polling_tentacle_deployment_target" "example" { environments = ["Environments-123", "Environment-321"] is_disabled = true - machine_policy_id = "MachinePolicy-123" - name = "Listening Tentacle Deployment Target (OK to Delete)" + machine_policy_id = "MachinePolicies-123" + name = "Polling Tentacle Deployment Target (OK to Delete)" roles = ["Development Team", "System Administrators"] tenanted_deployment_participation = "Untenanted" tentacle_url = "https://example.com:1234/" diff --git a/docs/resources/runbook.md b/docs/resources/runbook.md index bca3a44cb..4a96a9fec 100644 --- a/docs/resources/runbook.md +++ b/docs/resources/runbook.md @@ -31,7 +31,7 @@ This resource manages runbooks in Octopus Deploy. - `id` (String) The unique ID for this resource. - `multi_tenancy_mode` (String) The tenanted deployment mode of the resource. Valid account types are `Untenanted`, `TenantedOrUntenanted`, or `Tenanted`. - `retention_policy` (Block List, Max: 1) Sets the runbook retention policy (see [below for nested schema](#nestedblock--retention_policy)) -- `space_id` (String) The space ID associated with this runbook. +- `space_id` (String) The space ID associated with this resource. ### Read-Only @@ -56,5 +56,3 @@ Optional: - `quantity_to_keep` (Number) How many runs to keep per environment. - `should_keep_forever` (Boolean) Indicates if items should never be deleted. The default value is `false`. - - diff --git a/docs/resources/runbook_process.md b/docs/resources/runbook_process.md index 7e522e4eb..29de5207c 100644 --- a/docs/resources/runbook_process.md +++ b/docs/resources/runbook_process.md @@ -326,6 +326,8 @@ Optional: - `run_on_server` (Boolean) Whether this step runs on a worker or on the target - `sort_order` (Number) Order used by terraform to ensure correct ordering of actions. This property must be either omitted from all actions, or provided on all actions - `tenant_tags` (List of String) A list of tenant tags associated with this resource. +- `worker_pool_id` (String) The worker pool associated with this deployment action. +- `worker_pool_variable` (String) The worker pool variable associated with this deployment action. ### Nested Schema for `step.deploy_kubernetes_secret_action.action_template` @@ -655,11 +657,14 @@ Optional: - `primary_package` (Block List, Max: 1) The package assocated with this action. (see [below for nested schema](#nestedblock--step--run_kubectl_script_action--primary_package)) - `properties` (Map of String) The properties associated with this deployment action. - `run_on_server` (Boolean) Whether this step runs on a worker or on the target +- `script_body` (String) - `script_file_name` (String) The script file name in the package - `script_parameters` (String) Parameters expected by the script. Use platform specific calling convention. e.g. -Path #{VariableStoringPath} for PowerShell or -- #{VariableStoringPath} for ScriptCS - `script_source` (String) - `sort_order` (Number) Order used by terraform to ensure correct ordering of actions. This property must be either omitted from all actions, or provided on all actions - `tenant_tags` (List of String) A list of tenant tags associated with this resource. +- `worker_pool_id` (String) The worker pool associated with this deployment action. +- `worker_pool_variable` (String) The worker pool variable associated with this deployment action. ### Nested Schema for `step.run_kubectl_script_action.action_template` @@ -806,5 +811,3 @@ Optional: - `id` (String) The unique ID for this resource. - `name` (String) The name of this resource. - `properties` (Map of String) A list of properties associated with this package. - - diff --git a/docs/resources/ssh_connection_deployment_target.md b/docs/resources/ssh_connection_deployment_target.md index c0d13b676..72804bed6 100644 --- a/docs/resources/ssh_connection_deployment_target.md +++ b/docs/resources/ssh_connection_deployment_target.md @@ -13,10 +13,13 @@ This resource manages SSH connection deployment targets in Octopus Deploy. ```terraform resource "octopusdeploy_ssh_connection_deployment_target" "example" { - name = "SSH Connection Deployment Target (OK to Delete)" - fingerprint = "[fingerprint]" - host = "[host]" - port = 22 + name = "SSH Connection Deployment Target (OK to Delete)" + fingerprint = "" + host = "" + port = 22 + environments = ["Environments-123", "Environment-321"] + account_id = "Accounts-1" + roles = ["Development Team", "System Administrators"] } ``` diff --git a/docs/resources/tag.md b/docs/resources/tag.md index a41cb40b1..d20232cc6 100644 --- a/docs/resources/tag.md +++ b/docs/resources/tag.md @@ -25,10 +25,9 @@ This resource manages tags in Octopus Deploy. - `description` (String) The description of this tag. - `sort_order` (Number) +- `tag_set_space_id` (String) The Space ID of the associated tag set. Required if the tag set is not in the same space as what is configured on the provider ### Read-Only - `canonical_tag_name` (String) - `id` (String) The ID of this resource. - - diff --git a/docs/resources/tenant.md b/docs/resources/tenant.md index 60a2793f8..7e2aaa006 100644 --- a/docs/resources/tenant.md +++ b/docs/resources/tenant.md @@ -35,5 +35,3 @@ Required: - `environments` (List of String) A list of environment IDs associated with this tenant through a project. - `project_id` (String) The project ID associated with this tenant. - - diff --git a/docs/resources/tenant_common_variable.md b/docs/resources/tenant_common_variable.md index f24d7beb7..c4a8220eb 100644 --- a/docs/resources/tenant_common_variable.md +++ b/docs/resources/tenant_common_variable.md @@ -23,10 +23,9 @@ This resource manages tenant common variables in Octopus Deploy. ### Optional +- `space_id` (String) - `value` (String, Sensitive) ### Read-Only - `id` (String) The ID of this resource. - - diff --git a/docs/resources/tenant_project_variable.md b/docs/resources/tenant_project_variable.md index c86d1e851..024e4e06a 100644 --- a/docs/resources/tenant_project_variable.md +++ b/docs/resources/tenant_project_variable.md @@ -24,10 +24,9 @@ This resource manages tenant project variables in Octopus Deploy. ### Optional +- `space_id` (String) - `value` (String, Sensitive) ### Read-Only - `id` (String) The ID of this resource. - - diff --git a/docs/resources/variable.md b/docs/resources/variable.md index 16b6229df..33a0cbffb 100644 --- a/docs/resources/variable.md +++ b/docs/resources/variable.md @@ -101,6 +101,7 @@ resource "octopusdeploy_variable" "prompted_variable" { - `prompt` (Block List, Max: 1) (see [below for nested schema](#nestedblock--prompt)) - `scope` (Block List, Max: 1) (see [below for nested schema](#nestedblock--scope)) - `sensitive_value` (String, Sensitive) +- `space_id` (String) The space ID associated with this resource. - `value` (String) ### Read-Only