Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kavya498 committed Oct 26, 2022
1 parent feb0c4f commit 0eaf08f
Show file tree
Hide file tree
Showing 804 changed files with 19,515 additions and 3,532 deletions.
2 changes: 1 addition & 1 deletion docs/ibm_account_info.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Requirements
------------
The below requirements are needed on the host that executes this module.

- IBM-Cloud terraform-provider-ibm v1.39.1
- IBM-Cloud terraform-provider-ibm v1.46.0
- Terraform v0.12.20


Expand Down
22 changes: 11 additions & 11 deletions docs/ibm_api_gateway_endpoint.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Requirements
------------
The below requirements are needed on the host that executes this module.

- IBM-Cloud terraform-provider-ibm v1.39.1
- IBM-Cloud terraform-provider-ibm v1.46.0
- Terraform v0.12.20


Expand All @@ -35,28 +35,28 @@ Parameters
(Required for new resource) Api Gateway Service Instance Crn


name (True, str, None)
(Required for new resource) Endpoint name
open_api_doc_name (True, str, None)
(Required for new resource) Json File path


routes (False, list, None)
Invokable routes for an endpoint


managed (False, bool, False)
Managed indicates if endpoint is online or offline.


provider_id (False, str, user-defined)
Provider ID of an endpoint allowable values user-defined and whisk


type (False, str, unshare)
Action type of Endpoint ALoowable values are share, unshare, manage, unmanage
name (True, str, None)
(Required for new resource) Endpoint name


open_api_doc_name (True, str, None)
(Required for new resource) Json File path
managed (False, bool, False)
Managed indicates if endpoint is online or offline.


type (False, str, unshare)
Action type of Endpoint ALoowable values are share, unshare, manage, unmanage


id (False, str, None)
Expand Down
10 changes: 5 additions & 5 deletions docs/ibm_api_gateway_endpoint_subscription.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,18 @@ Requirements
------------
The below requirements are needed on the host that executes this module.

- IBM-Cloud terraform-provider-ibm v1.39.1
- IBM-Cloud terraform-provider-ibm v1.46.0
- Terraform v0.12.20



Parameters
----------

type (True, str, None)
(Required for new resource) Subscription type. Allowable values are external, internal


client_secret (False, str, None)
Client Sercret of a Subscription

Expand All @@ -51,10 +55,6 @@ Parameters
(Required for new resource) Subscription name


type (True, str, None)
(Required for new resource) Subscription type. Allowable values are external, internal


id (False, str, None)
(Required when updating or destroying existing resource) IBM Cloud Resource ID.

Expand Down
2 changes: 1 addition & 1 deletion docs/ibm_api_gateway_info.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Requirements
------------
The below requirements are needed on the host that executes this module.

- IBM-Cloud terraform-provider-ibm v1.39.1
- IBM-Cloud terraform-provider-ibm v1.46.0
- Terraform v0.12.20


Expand Down
93 changes: 93 additions & 0 deletions docs/ibm_app_config_collection.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@

ibm_app_config_collection -- Configure IBM Cloud 'ibm_app_config_collection' resource
=====================================================================================

.. contents::
:local:
:depth: 1


Synopsis
--------

Create, update or destroy an IBM Cloud 'ibm_app_config_collection' resource

This module supports idempotency


ForMoreInfoRefer
----------------
refer - https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/app_config_collection

Requirements
------------
The below requirements are needed on the host that executes this module.

- IBM-Cloud terraform-provider-ibm v1.46.0
- Terraform v0.12.20



Parameters
----------

guid (True, str, None)
(Required for new resource) GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.


name (True, str, None)
(Required for new resource) Collection name.


collection_id (True, str, None)
(Required for new resource) Collection Id.


description (False, str, None)
Collection description


tags (False, str, None)
Tags associated with the collection


id (False, str, None)
(Required when updating or destroying existing resource) IBM Cloud Resource ID.


state (False, any, available)
State of resource


iaas_classic_username (False, any, None)
(Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'.


iaas_classic_api_key (False, any, None)
(Required when generation = 1) The IBM Cloud Classic Infrastructure API key. This can also be provided via the environment variable 'IAAS_CLASSIC_API_KEY'.


region (False, any, us-south)
The IBM Cloud region where you want to create your resources. If this value is not specified, us-south is used by default. This can also be provided via the environment variable 'IC_REGION'.


ibmcloud_api_key (True, any, None)
The IBM Cloud API key to authenticate with the IBM Cloud platform. This can also be provided via the environment variable 'IC_API_KEY'.













Authors
~~~~~~~

- Jay Carman (@jaywcarman)

79 changes: 79 additions & 0 deletions docs/ibm_app_config_collection_info.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@

ibm_app_config_collection_info -- Retrieve IBM Cloud 'ibm_app_config_collection' resource
=========================================================================================

.. contents::
:local:
:depth: 1


Synopsis
--------

Retrieve an IBM Cloud 'ibm_app_config_collection' resource


ForMoreInfoRefer
----------------
refer - https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/data-sources/app_config_collection

Requirements
------------
The below requirements are needed on the host that executes this module.

- IBM-Cloud terraform-provider-ibm v1.46.0
- Terraform v0.12.20



Parameters
----------

guid (True, str, None)
GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.


collection_id (True, str, None)
Collection Id of the collection.


include (False, list, None)
Include feature, property details in the response.


expand (False, bool, None)
If set to true, returns expanded view of the resource details.


iaas_classic_username (False, any, None)
(Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'.


iaas_classic_api_key (False, any, None)
(Required when generation = 1) The IBM Cloud Classic Infrastructure API key. This can also be provided via the environment variable 'IAAS_CLASSIC_API_KEY'.


region (False, any, us-south)
The IBM Cloud region where you want to create your resources. If this value is not specified, us-south is used by default. This can also be provided via the environment variable 'IC_REGION'.


ibmcloud_api_key (True, any, None)
The IBM Cloud API key to authenticate with the IBM Cloud platform. This can also be provided via the environment variable 'IC_API_KEY'.













Authors
~~~~~~~

- Jay Carman (@jaywcarman)

83 changes: 83 additions & 0 deletions docs/ibm_app_config_collections_info.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@

ibm_app_config_collections_info -- Retrieve IBM Cloud 'ibm_app_config_collections' resource
===========================================================================================

.. contents::
:local:
:depth: 1


Synopsis
--------

Retrieve an IBM Cloud 'ibm_app_config_collections' resource


ForMoreInfoRefer
----------------
refer - https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/data-sources/app_config_collections

Requirements
------------
The below requirements are needed on the host that executes this module.

- IBM-Cloud terraform-provider-ibm v1.46.0
- Terraform v0.12.20



Parameters
----------

offset (False, int, None)
Skipped number of records.


include (False, list, None)
Include feature, property details in the response.


expand (False, bool, None)
If set to true, returns expanded view of the resource details.


guid (True, str, None)
GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.


limit (False, int, None)
The number of records to retrieve.


iaas_classic_username (False, any, None)
(Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'.


iaas_classic_api_key (False, any, None)
(Required when generation = 1) The IBM Cloud Classic Infrastructure API key. This can also be provided via the environment variable 'IAAS_CLASSIC_API_KEY'.


region (False, any, us-south)
The IBM Cloud region where you want to create your resources. If this value is not specified, us-south is used by default. This can also be provided via the environment variable 'IC_REGION'.


ibmcloud_api_key (True, any, None)
The IBM Cloud API key to authenticate with the IBM Cloud platform. This can also be provided via the environment variable 'IC_API_KEY'.













Authors
~~~~~~~

- Jay Carman (@jaywcarman)

18 changes: 9 additions & 9 deletions docs/ibm_app_config_environment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,22 +23,14 @@ Requirements
------------
The below requirements are needed on the host that executes this module.

- IBM-Cloud terraform-provider-ibm v1.39.1
- IBM-Cloud terraform-provider-ibm v1.46.0
- Terraform v0.12.20



Parameters
----------

environment_id (True, str, None)
(Required for new resource) Environment Id.


description (False, str, None)
Environment description


guid (True, str, None)
(Required for new resource) GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard.

Expand All @@ -47,10 +39,18 @@ Parameters
(Required for new resource) Environment name.


environment_id (True, str, None)
(Required for new resource) Environment Id.


tags (False, str, None)
Tags associated with the environment


description (False, str, None)
Environment description


color_code (False, str, None)
Color code to distinguish the environment.

Expand Down
Loading

0 comments on commit 0eaf08f

Please sign in to comment.