Skip to content

Commit

Permalink
Merge pull request #1419 from hashicorp/docs/timeouts-and-api-limits
Browse files Browse the repository at this point in the history
docs: timeouts and notes on restrictive API limits
  • Loading branch information
manicminer authored Jun 26, 2024
2 parents e336102 + b1f2708 commit cc808a9
Show file tree
Hide file tree
Showing 101 changed files with 703 additions and 140 deletions.
6 changes: 6 additions & 0 deletions docs/data-sources/access_package.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,9 @@ In addition to the above arguments, the following attributes are exported:
* `id` - The ID of this resource.
* `description` - The description of the access package.
* `hidden` - Whether the access package is hidden from the requestor.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
5 changes: 5 additions & 0 deletions docs/data-sources/access_package_catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,8 @@ In additional to the arguments, the following attributes are exported:
* `externally_visible` - Whether the access packages in this catalog can be requested by users outside the tenant.
* `published` - Whether the access packages in this catalog are available for management.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
6 changes: 6 additions & 0 deletions docs/data-sources/access_package_catalog_role.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,9 @@ The following attributes are exported:
* `display_name` - The display name of the role.
* `object_id` - The object ID of the role.
* `template_id` - The object ID of the role.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
6 changes: 6 additions & 0 deletions docs/data-sources/administrative_unit.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,9 @@ The following attributes are exported:
* `members` - A list of object IDs of members who are present in this administrative unit.
* `object_id` - The object ID of the administrative unit.
* `visibility` - Whether the administrative unit _and_ its members are hidden or publicly viewable in the directory. One of: `Hiddenmembership` or `Public`.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
6 changes: 6 additions & 0 deletions docs/data-sources/application.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,3 +174,9 @@ The following attributes are exported:

* `access_token_issuance_enabled` - Whether this web application can request an access token using OAuth 2.0 implicit flow.
* `id_token_issuance_enabled` - Whether this web application can request an ID token using OAuth 2.0 implicit flow.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
6 changes: 6 additions & 0 deletions docs/data-sources/application_published_app_ids.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,9 @@ This data source does not have any arguments.
The following attributes are exported:

* `result` - A map of application names to application IDs.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
6 changes: 6 additions & 0 deletions docs/data-sources/application_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,9 @@ The following attributes are exported:
* `supported_provisioning_types` - List of provisioning modes supported by this templated application.
* `supported_single_sign_on_modes` - List of single sign on modes supported by this templated application.
* `template_id` - The ID of the templated application.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
6 changes: 6 additions & 0 deletions docs/data-sources/client_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,9 @@ The following attributes are exported:
* `client_id` - The client ID (application ID) linked to the authenticated principal, or the application used for delegated authentication.
* `object_id` - The object ID of the authenticated principal.
* `tenant_id` - The tenant ID of the authenticated principal.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
6 changes: 6 additions & 0 deletions docs/data-sources/directory_object.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,9 @@ The following attributes are exported:

*`object_id` - The object ID of the directory object.
*`type` - The shortened OData type of the directory object. Possible values include: `Group`, `User` or `ServicePrincipal`.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
6 changes: 6 additions & 0 deletions docs/data-sources/directory_role_templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,9 @@ The following attributes are exported:
* `description` - The description of the directory role template.
* `display_name` - The display name of the directory role template.
* `object_id` - The object ID of the directory role template.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
6 changes: 6 additions & 0 deletions docs/data-sources/directory_roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,9 @@ The following attributes are exported:
* `template_id` - The template ID of the directory role.
* `description` - The description of the directory role.
* `object_id` - The object ID of the directory role.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
6 changes: 6 additions & 0 deletions docs/data-sources/domains.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,9 @@ In addition to all arguments above, the following attributes are exported:
* `root` - Whether the domain is a verified root domain (not a subdomain).
* `verified` - Whether the domain has completed domain ownership verification.
* `supported_services` - A list of capabilities / services supported by the domain. Possible values include `Email`, `Sharepoint`, `EmailInternalRelayOnly`, `OfficeCommunicationsOnline`, `SharePointDefaultDomain`, `FullRedelegation`, `SharePointPublic`, `OrgIdAuthentication`, `Yammer` and `Intune`.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
6 changes: 6 additions & 0 deletions docs/data-sources/group.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,9 @@ The following attributes are exported:

* `enabled` - Whether rule processing is "On" (true) or "Paused" (false).
* `rule` - The rule that determines membership of this group.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
6 changes: 6 additions & 0 deletions docs/data-sources/group_role_management_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,9 @@ In addition to all arguments above, the following attributes are exported:
* `description` - (String) The description of this policy.
* `display_name` - (String) The display name of this policy.
* `id` - (String) The ID of this policy.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
6 changes: 6 additions & 0 deletions docs/data-sources/groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,9 @@ The following attributes are exported:

* `display_names` - The display names of the groups.
* `object_ids` - The object IDs of the groups.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
6 changes: 6 additions & 0 deletions docs/data-sources/named_location.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,9 @@ The following attributes are exported:

* `ip_ranges` - List of IP address ranges in IPv4 CIDR format (e.g. `1.2.3.4/32`) or any allowable IPv6 format from IETF RFC596.
* `trusted` - Whether the named location is trusted.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
6 changes: 6 additions & 0 deletions docs/data-sources/service_principal.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,3 +119,9 @@ The following attributes are exported:
`saml_single_sign_on` exports the following:

* `relay_state` - The relative URI the service provider would redirect to after completion of the single sign-on flow.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
5 changes: 5 additions & 0 deletions docs/data-sources/service_principals.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,3 +90,8 @@ The following attributes are exported:
* `tags` - A list of tags applied to the service principal.
* `type` - Identifies whether the service principal represents an application or a managed identity. Possible values include `Application` or `ManagedIdentity`.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
6 changes: 6 additions & 0 deletions docs/data-sources/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,9 @@ The following attributes are exported:
* `usage_location` - The usage location of the user.
* `user_principal_name` - The user principal name (UPN) of the user.
* `user_type` - The user type in the directory. Possible values are `Guest` or `Member`.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
6 changes: 6 additions & 0 deletions docs/data-sources/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,9 @@ The following attributes are exported:
* `onpremises_user_principal_name` - The on-premise user principal name of the user.
* `usage_location` - The usage location of the user.
* `user_principal_name` - The user principal name (UPN) of the user.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
9 changes: 9 additions & 0 deletions docs/resources/access_package.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,15 @@ In addition to all arguments above, the following attributes are exported:

* `id` - The ID of this resource.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
* `read` - (Defaults to 5 minutes) Used when retrieving the resource.
* `update` - (Defaults to 5 minutes) Used when updating the resource.
* `delete` - (Defaults to 5 minutes) Used when deleting the resource.

## Import

Access Packages can be imported using the `id`, e.g.
Expand Down
9 changes: 9 additions & 0 deletions docs/resources/access_package_assignment_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,15 @@ In addition to all arguments above, the following attributes are exported:

- `id` (String) The ID of this resource.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
* `read` - (Defaults to 5 minutes) Used when retrieving the resource.
* `update` - (Defaults to 5 minutes) Used when updating the resource.
* `delete` - (Defaults to 5 minutes) Used when deleting the resource.

## Import

An access package assignment policy can be imported using the ID, e.g.
Expand Down
9 changes: 9 additions & 0 deletions docs/resources/access_package_catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,15 @@ In addition to all arguments above, the following attributes are exported:

* `id` - The ID of this resource.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
* `read` - (Defaults to 5 minutes) Used when retrieving the resource.
* `update` - (Defaults to 5 minutes) Used when updating the resource.
* `delete` - (Defaults to 5 minutes) Used when deleting the resource.

## Import

An Access Package Catalog can be imported using the `id`, e.g.
Expand Down
9 changes: 9 additions & 0 deletions docs/resources/access_package_catalog_role_assignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,15 @@ In addition to all arguments above, the following attributes are exported:

*No additional attributes are exported*

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
* `read` - (Defaults to 5 minutes) Used when retrieving the resource.
* `update` - (Defaults to 5 minutes) Used when updating the resource.
* `delete` - (Defaults to 5 minutes) Used when deleting the resource.

## Import

Catalog role assignments can be imported using the ID of the assignment, e.g.
Expand Down
8 changes: 8 additions & 0 deletions docs/resources/access_package_resource_catalog_association.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@ In addition to all arguments above, the following attributes are exported:

* `id` - The ID of this resource, the ID is the concatenation of `catalog_id` and `resource_origin_id` with colon in between.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
* `read` - (Defaults to 5 minutes) Used when retrieving the resource.
* `delete` - (Defaults to 5 minutes) Used when deleting the resource.

## Import

The resource and catalog association can be imported using the catalog ID and the resource origin ID, e.g.
Expand Down
8 changes: 8 additions & 0 deletions docs/resources/access_package_resource_package_association.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,14 @@ In addition to all arguments above, the following attributes are exported:

* `id` - The ID of this resource. The ID is combined by four fields with colon in between, the four fields are `access_package_id`, this package association id, `resource_origin_id` and `access_type`.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
* `read` - (Defaults to 5 minutes) Used when retrieving the resource.
* `delete` - (Defaults to 5 minutes) Used when deleting the resource.

## Import

The resource and catalog association can be imported using the access package ID, the access package ResourceRoleScope, the resource origin ID, and the access type, e.g.
Expand Down
9 changes: 9 additions & 0 deletions docs/resources/administrative_unit.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,15 @@ In addition to all arguments above, the following attributes are exported:

* `object_id` - The object ID of the administrative unit.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
* `read` - (Defaults to 5 minutes) Used when retrieving the resource.
* `update` - (Defaults to 5 minutes) Used when updating the resource.
* `delete` - (Defaults to 5 minutes) Used when deleting the resource.

## Import

Administrative units can be imported using their object ID, e.g.
Expand Down
8 changes: 8 additions & 0 deletions docs/resources/administrative_unit_member.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,14 @@ In addition to all arguments above, the following attributes are exported:

*No additional attributes are exported*

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
* `read` - (Defaults to 5 minutes) Used when retrieving the resource.
* `delete` - (Defaults to 5 minutes) Used when deleting the resource.

## Import

Administrative unit members can be imported using the object ID of the administrative unit and the object ID of the member, e.g.
Expand Down
8 changes: 8 additions & 0 deletions docs/resources/administrative_unit_role_member.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,14 @@ In addition to all arguments above, the following attributes are exported:

*No additional attributes are exported*

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 5 minutes) Used when creating the resource.
* `read` - (Defaults to 5 minutes) Used when retrieving the resource.
* `delete` - (Defaults to 5 minutes) Used when deleting the resource.

## Import

Administrative unit role members can be imported using the object ID of the administrative unit and the unique ID of the role assignment, e.g.
Expand Down
Loading

0 comments on commit cc808a9

Please sign in to comment.