generated from SAP/repository-template
-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: generated documentation for resource
- Loading branch information
1 parent
6e273d7
commit de46333
Showing
1 changed file
with
76 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
--- | ||
page_title: "btp_subaccount_subscription Resource - terraform-provider-btp" | ||
subcategory: "" | ||
description: |- | ||
Subscribes to a multitenant application from a subaccount. | ||
Custom or partner-developed applications are currently not supported. | ||
Tip: | ||
You must be assigned to the subaccount admin role. | ||
--- | ||
|
||
# btp_subaccount_subscription (Resource) | ||
|
||
Subscribes to a multitenant application from a subaccount. | ||
Custom or partner-developed applications are currently not supported. | ||
|
||
__Tip:__ | ||
You must be assigned to the subaccount admin role. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "btp_subaccount_subscription" "workzone" { | ||
subaccount_id = "6aa64c2f-38c1-49a9-b2e8-cf9fea769b7f" | ||
app_name = "SAPLaunchpad" | ||
plan_name = "free" | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `app_name` (String) The unique registration name of the deployed multitenant application as defined by the app developer. | ||
- `plan_name` (String) The plan name of the application to which the consumer has subscribed. | ||
- `subaccount_id` (String) The ID of the subaccount. | ||
|
||
### Optional | ||
|
||
- `parameters` (String) The parameters of the subscription as a valid JSON object. | ||
|
||
### Read-Only | ||
|
||
- `additional_plan_features` (Set of String) The list of features specific to this plan. | ||
- `app_id` (String) The ID returned by XSUAA after the app provider has performed a bind of the multitenant application to an XSUAA service instance. | ||
- `authentication_provider` (String) The authentication provider of the multitenant application. * XSUAA is the SAP Authorization and Trust Management service that defines scopes and permissions for users as tenants at the global account level. * IAS is Identity Authentication Service that defines scopes and permissions for users in zones (common data isolation systems across systems, SaaS tenants, and services). | ||
- `category` (String) The technical name of the category defined by the app developer to which the multitenant application is grouped in customer-facing UIs. | ||
- `commercial_app_name` (String) The commercial name of the deployed multitenant application as defined by the app developer. | ||
- `created_date` (String) The date and time when the resource was created in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format. | ||
- `customer_developed` (Boolean) Shows whether the application was developed by a customer. If not, then the application is developed by the cloud operator, such as SAP. | ||
- `description` (String) The description of the multitenant application for customer-facing UIs. | ||
- `display_name` (String) The display name of the application for customer-facing UIs. | ||
- `formation_solution_name` (String) The name of the formations solution associated with the multitenant application. | ||
- `globalaccount_id` (String) The ID of the associated global account. | ||
- `id` (String) The technical ID generated by XSUAA for a multitenant application when a consumer subscribes to the application. | ||
- `labels` (Map of Set of String) The set of words or phrases assigned to the multitenant application subscription. | ||
- `last_modified` (String) The date and time when the resource was last modified in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format. | ||
- `platform_entity_id` (String) The ID of the landscape-specific environment. | ||
- `quota` (Number) The total amount the subscribed subaccount is entitled to consume. | ||
- `state` (String) The subscription state of the subaccount regarding the multitenant application. | ||
- `subscribed_subaccount_id` (String) The ID of the subaccount, which is subscribed to the multitenant application. | ||
- `subscribed_tenant_id` (String) The ID of the tenant, which is subscribed to a multitenant application. | ||
- `subscription_url` (String) The URL for app users to launch the subscribed application. | ||
- `supports_parameters_updates` (Boolean) Specifies whether a consumer, whose subaccount is subscribed to the application, can change its subscriptions parameters. | ||
- `supports_plan_updates` (Boolean) Specifies whether a consumer, whose subaccount is subscribed to the application, can change the subscription to a different plan that is available for this application and subaccount. | ||
- `tenant_id` (String) The tenant ID of the application provider. | ||
|
||
## Import | ||
|
||
Import is supported using the following syntax: | ||
|
||
```terraform | ||
# terraform import btp_subaccount_subscription.<resource_name> <subaccount_id>,<app_name>,<plan_name> | ||
terraform import btp_subaccount_subscription.workzone 6aa64c2f-38c1-49a9-b2e8-cf9fea769b7f,SAPLaunchpad,free | ||
``` |