github.com/jaylevin/jenkins-library@v1.230.4/documentation/docs/steps/apiKeyValueMapUpload.md (about)

     1  # ${docGenStepName}
     2  
     3  ## ${docGenDescription}
     4  
     5  With this step you can store one or more key value pairs of data stored in a group called a map or key value map.
     6  
     7  To consume the ApiKeyValueMapUpload step, proceed as follows:
     8  
     9  * Copy the SAP API management service key from the SAP BTP sub account cockpit, under instance and subscriptions → service API Management, API portal, which was created under apiportal-apiaccess plan.
    10  * Store your service key created for SAP API Management in the Jenkins server as a secret text.
    11  * Create a new Jenkins pipeline designated for the ApiKeyValueMapUpload step.
    12  * Execute the pipeline and validate the step exection results as explained in the blog [Integration Suite Piper commands](https://blogs.sap.com/2022/01/05/orking-with-integration-suite-piper-commands/)
    13  * Using the ApiKeyValueMapUpload step, you can create a new API key value map in the API portal.
    14  * The ApiKeyValueMapUpload step allows you to prevent command execution in case an API key value map already exists.
    15  * If API key value map already exists, then delete it and execute the piper step again, which will create a new API Key value Map.
    16  * ApiKeyValueMapUpload only supports create operation.
    17  
    18  ## Prerequisites
    19  
    20  ## ${docGenParameters}
    21  
    22  ## ${docGenConfiguration}
    23  
    24  ## ${docJenkinsPluginDependencies}
    25  
    26  ## Example
    27  
    28  Configuration example for a `Jenkinsfile`:
    29  
    30  ```groovy
    31  apiKeyValueMapUpload script: this
    32  ```
    33  
    34  Configuration example for a YAML file(for example `.pipeline/config.yaml`):
    35  
    36  ```yaml
    37  steps:
    38    <...>
    39    apiKeyValueMapUpload:
    40      apimApiServiceKeyCredentialsId: 'MY_API_SERVICE_KEY'
    41      key: API_KEY_NAME
    42      value: API_KEY_VALUE
    43      keyValueMapName: API_KEY_VALUE_MAP_NAME
    44  ```