Service class which helps to filter or edit input parameters.

export

### Hierarchy

- ProvisioningService

## Index

### Methods

- checkForPassedOptionalParms
- parseProperties
- readPropertiesFromYamlFile

## Methods

### Static checkForPassedOptionalParms

- checkForPassedOptionalParms(properties?: string, propertiesFile?: string, domainName?: string, tenantName?: string, userDataId?: string, userData?: string, accountInfo?: string, systemNickNames?: string[]): IProvisionOptionals

- - Defined in @zowe/provisioning-for-zowe-sdk/src/ProvisioningService.ts:78

  Helper method which checks if optional parameters were passed or not.

  memberof

    ProvisioningService

  #### Parameters

  - ##### Optional properties: string

    required runtime property objects.

  - ##### Optional propertiesFile: string

    path of the properties yaml file.

  - ##### Optional domainName: string

    name of the domain.

  - ##### Optional tenantName: string

    name of the tenant.

  - ##### Optional userDataId: string

    ID for the user data specified with user-data.

  - ##### Optional userData: string

    user data that is passed into the software services registry.

  - ##### Optional accountInfo: string

    account information to use in the JCL JOB statement.

  - ##### Optional systemNickNames: string[]

    nicknames of the systems upon which to provision a template.

  #### Returns IProvisionOptionals

  object with optional properties, @see {IProvisionOptionals}

### Static parseProperties

- parseProperties(propertiesText: string): IPropertiesInput[]

- - Defined in @zowe/provisioning-for-zowe-sdk/src/ProvisioningService.ts:30

  Parsers text with properties in key1=val1,key2=val2 format and returns IInputProperty[]

  memberof

    ProvisioningService

  #### Parameters

  - ##### propertiesText: string

    required runtime property objects passed as a string.

  #### Returns IPropertiesInput[]

  array of properties, @see {IPropertiesInput}

### Static readPropertiesFromYamlFile

- readPropertiesFromYamlFile(path: string): IPropertiesInput[]

- - Defined in @zowe/provisioning-for-zowe-sdk/src/ProvisioningService.ts:50

  Reads a YAML file with properties, parses it in key1=val1,key2=val2 format and returns IInputProperty[].

  memberof

    ProvisioningService

  #### Parameters

  - ##### path: string

    path of the file.

  #### Returns IPropertiesInput[]

  array of properties, @see {IPropertiesInput}

Generated using TypeDoc