ibm_cloud_resource_controller
IbmCloudResourceController - the Ruby gem for the IBM Cloud Resource Controller API
Manage lifecycle of your Cloud resources using Resource Controller APIs. Resources are provisioned globally in an account scope. Supports asynchronous provisioning of resources. Enables consumption of a global resource through a Cloud Foundry space in any region.
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 2.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
Installation
Build a gem
To build the Ruby code into a gem:
gem build ibm_cloud_resource_controller.gemspec
Then either install the gem locally:
gem install ./ibm_cloud_resource_controller-1.0.0.gem
(for development, run gem install --dev ./ibm_cloud_resource_controller-1.0.0.gem
to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'ibm_cloud_resource_controller', '~> 1.0.0'
Install from Git
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
gem 'ibm_cloud_resource_controller', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
Include the Ruby code directly
Include the Ruby code directly using -I
as follows:
ruby -Ilib script.rb
Getting Started
Please follow the installation procedure and then run the following code:
# Load the gem
require 'ibm_cloud_resource_controller'
# Setup authorization
IbmCloudResourceController.configure do |config|
# Configure API key authorization: IAM
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = IbmCloudResourceController::ResourceAliasesApi.new
resource_alias_post = IbmCloudResourceController::ResourceAliasPost.new # ResourceAliasPost |
begin
#Create a new resource alias
result = api_instance.create_resource_alias(resource_alias_post)
p result
rescue IbmCloudResourceController::ApiError => e
puts "Exception when calling ResourceAliasesApi->create_resource_alias: #{e}"
end
Documentation for API Endpoints
All URIs are relative to https://resource-controller.cloud.ibm.com
Class | Method | HTTP request | Description |
---|---|---|---|
IbmCloudResourceController::ResourceAliasesApi | create_resource_alias | POST /v2/resource_aliases | Create a new resource alias |
IbmCloudResourceController::ResourceAliasesApi | delete_resource_alias | DELETE /v2/resource_aliases/id | Delete a resource alias |
IbmCloudResourceController::ResourceAliasesApi | get_resource_alias | GET /v2/resource_aliases/id | Get a resource alias |
IbmCloudResourceController::ResourceAliasesApi | list_resource_aliases | GET /v2/resource_aliases | Get a list of all resource aliases |
IbmCloudResourceController::ResourceAliasesApi | update_resource_alias | PATCH /v2/resource_aliases/id | Update a resource alias |
IbmCloudResourceController::ResourceBindingsApi | create_resource_binding | POST /v2/resource_bindings | Create a new resource binding |
IbmCloudResourceController::ResourceBindingsApi | delete_resource_binding | DELETE /v2/resource_bindings/id | Delete a resource binding |
IbmCloudResourceController::ResourceBindingsApi | get_resource_binding | GET /v2/resource_bindings/id | Get a resource binding |
IbmCloudResourceController::ResourceBindingsApi | list_resource_bindings | GET /v2/resource_bindings | Get a list of all resource bindings |
IbmCloudResourceController::ResourceBindingsApi | update_resource_binding | PATCH /v2/resource_bindings/id | Update a resource binding |
IbmCloudResourceController::ResourceInstancesApi | create_resource_instance | POST /v2/resource_instances | Create (provision) a new resource instance |
IbmCloudResourceController::ResourceInstancesApi | delete_resource_instance | DELETE /v2/resource_instances/id | Delete a resource instance |
IbmCloudResourceController::ResourceInstancesApi | get_resource_instance | GET /v2/resource_instances/id | Get a resource instance |
IbmCloudResourceController::ResourceInstancesApi | list_resource_instances | GET /v2/resource_instances | Get a list of all resource instances |
IbmCloudResourceController::ResourceInstancesApi | lock_resource_instance | POST /v2/resource_instances/id/lock | Lock a resource instance |
IbmCloudResourceController::ResourceInstancesApi | unlock_resource_instance | DELETE /v2/resource_instances/id/lock | Unlock a resource instance |
IbmCloudResourceController::ResourceInstancesApi | update_resource_instance | PATCH /v2/resource_instances/id | Update a resource instance |
IbmCloudResourceController::ResourceKeysApi | create_resource_key | POST /v2/resource_keys | Create a new resource key |
IbmCloudResourceController::ResourceKeysApi | delete_resource_key | DELETE /v2/resource_keys/id | Delete a resource key by ID |
IbmCloudResourceController::ResourceKeysApi | get_resource_key | GET /v2/resource_keys/id | Get resource key by ID |
IbmCloudResourceController::ResourceKeysApi | list_resource_keys | GET /v2/resource_keys | Get a list of all of the resource keys. |
IbmCloudResourceController::ResourceKeysApi | update_resource_key | PATCH /v2/resource_keys/id | Update a resource key |
IbmCloudResourceController::ResourceReclamationsApi | list_reclamations | GET /v1/reclamations | Get a list of all reclamations |
IbmCloudResourceController::ResourceReclamationsApi | run_reclamation_action | POST /v1/reclamations/id/actions/action_name | Perform a reclamation action |
Documentation for Models
- IbmCloudResourceController::Credentials
- IbmCloudResourceController::ErrorReport
- IbmCloudResourceController::PlanHistoryItem
- IbmCloudResourceController::Reclamation
- IbmCloudResourceController::ReclamationActionsPost
- IbmCloudResourceController::ReclamationsList
- IbmCloudResourceController::ResourceAlias
- IbmCloudResourceController::ResourceAliasPatch
- IbmCloudResourceController::ResourceAliasPost
- IbmCloudResourceController::ResourceAliasesList
- IbmCloudResourceController::ResourceBinding
- IbmCloudResourceController::ResourceBindingPatch
- IbmCloudResourceController::ResourceBindingPost
- IbmCloudResourceController::ResourceBindingPostParameters
- IbmCloudResourceController::ResourceBindingsList
- IbmCloudResourceController::ResourceInstance
- IbmCloudResourceController::ResourceInstancePatch
- IbmCloudResourceController::ResourceInstancePost
- IbmCloudResourceController::ResourceInstancesList
- IbmCloudResourceController::ResourceKey
- IbmCloudResourceController::ResourceKeyPatch
- IbmCloudResourceController::ResourceKeyPost
- IbmCloudResourceController::ResourceKeysList
Documentation for Authorization
IAM
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header