Cmd packages additions to the profile manager type configuration document. Used by the CliProfileManager. Allows profiles to be built from command arguments. See the "CliProfileManager" for more information.

export
interface

  ICommandProfileTypeConfiguration

### Hierarchy

- IProfileTypeConfiguration
  - ICommandProfileTypeConfiguration

## Index

### Properties

- authConfig
- dependencies
- schema
- type
- validationPlanModule

## Properties

### Optional authConfig

authConfig: ICommandProfileAuthConfig[]

- Defined in @zowe/imperative/src/cmd/src/doc/profiles/definition/ICommandProfileTypeConfiguration.ts:37

Configuration for authentication services to associate with this profile type.

### Optional dependencies

dependencies: IProfileDependency[]

Inherited from IProfileTypeConfiguration.dependencies

- Defined in @zowe/imperative/src/profiles/src/doc/config/IProfileTypeConfiguration.ts:51

The profile dependency specification. Indicates the required or optional profiles that a profile is depedent on. Dependencies are written as part of the profile, but you do NOT need to specify dependencies in your schema document - this is automatically generated based on your specifications.

memberof

  IProfileTypeConfiguration

deprecated

  Only applies to V1 profiles. For team config, use nested profiles instead.

### schema

schema: ICommandProfileSchema

Overrides IProfileTypeConfiguration.schema

- Defined in @zowe/imperative/src/cmd/src/doc/profiles/definition/ICommandProfileTypeConfiguration.ts:32

The JSON schema document. The schema document provides a way to enforce the contents of a profile. The schema conforms exactly to the JSON schema specification. You must supply all properties you would like validated for correctness on the schema, except for "dependencies". Dependency schema checking is generated automatically if you populate the dependencies property of this document.

### type

type: string

Inherited from IProfileTypeConfiguration.type

- Defined in @zowe/imperative/src/profiles/src/doc/config/IProfileTypeConfiguration.ts:31

The name of the profile "type" (e.g. "banana"). The type should be indicative of the profile contents (defined by the profile schema on this document). A "type" is analogous to a category.

memberof

  IProfileTypeConfiguration

### Optional validationPlanModule

validationPlanModule: string

Inherited from IProfileTypeConfiguration.validationPlanModule

- Defined in @zowe/imperative/src/profiles/src/doc/config/IProfileTypeConfiguration.ts:61

Path to a module that contains an object that matches the interface IProfileValidationPlan. This is optional, but if provided a "validate profile" command will be generated to give the user a report on the validity of their profile.

memberof

  IProfileTypeConfiguration

deprecated

  Only applies to V1 profiles. For team config, validate with JSON schema instead.

Generated using TypeDoc