github.com/xgoffin/jenkins-library@v1.154.0/documentation/docs/steps/cloudFoundryDeleteService.md (about)

     1  # ${docGenStepName}
     2  
     3  ## ${docGenDescription}
     4  
     5  ## Prerequisites
     6  
     7  This step is for deleting an existing service on Cloud Foundry.
     8  You need to provide the Cloud Foundry API Endpoint, the Organisation as well as the Space and the respective Service Instance Name you want to delete.
     9  Furthermore you will need to provide the Cloud Foundry Login Credentials, which must be stored in the Jenkins Configuration.
    10  Additionally you can set the cfDeleteServiceKeys flag for deleting all Service Keys that belong to the respective Service.
    11  
    12  ## ${docGenParameters}
    13  
    14  ## ${docGenConfiguration}
    15  
    16  ## ${docJenkinsPluginDependencies}
    17  
    18  ## Example
    19  
    20  In this example, the Cloud Foundry Configuration is directly provided with the respective Credentials for the used User/Account.
    21  
    22  ```groovy
    23  cloudFoundryDeleteService(
    24      cfApiEndpoint: 'https://test.server.com',
    25      cfOrg: 'cforg',
    26      cfSpace: 'cfspace',
    27      cfServiceInstance: 'cfserviceInstance',
    28      cfCredentialsId: 'cfcredentialsId',
    29      cfDeleteServiceKeys: true,
    30  )
    31  ```