2019-12-02 14:02:51 +01:00
# ${docGenStepName}
## ${docGenDescription}
## Prerequisites
2019-12-16 21:44:15 +01:00
* Cloud Foundry API endpoint, organization, space, user and service instance are available
* Credentials have been configured in Jenkins with a dedicated Id
2019-12-02 14:02:51 +01:00
## ${docGenParameters}
## ${docGenConfiguration}
## ${docJenkinsPluginDependencies}
## Example
The following example creates a service key named "myServiceKey" for the service instance "myServiceInstance" in the provided cloud foundry organization and space. For the service key creation, the serviceKeyConfig is used.
```groovy
cloudFoundryCreateServiceKey(
2019-12-16 21:44:15 +01:00
script: this,
cloudFoundry: [
apiEndpoint: 'https://test.server.com',
credentialsId: 'cfCredentialsId',
org: 'cfOrg',
space: 'cfSpace',
serviceInstance: 'myServiceInstance',
serviceKey: 'myServiceKey',
serviceKeyConfig: '{ \"key\" : \"value\" }'
])
2019-12-02 14:02:51 +01:00
```