Type Alias PolicySet

type PolicySet = {
    createPolicySet(
        policySetData: PolicySetSkeleton,
        policySetName?: string,
    ): Promise<PolicySetSkeleton>;
    createPolicySetExportTemplate(): PolicySetExportInterface;
    deletePolicySet(policySetName: string): Promise<PolicySetSkeleton>;
    exportPolicySet(
        policySetName: string,
        options?: PolicySetExportOptions,
    ): Promise<PolicySetExportInterface>;
    exportPolicySets(
        options?: PolicySetExportOptions,
    ): Promise<PolicySetExportInterface>;
    importFirstPolicySet(
        importData: PolicySetExportInterface,
        options?: PolicySetImportOptions,
    ): Promise<PolicySetSkeleton>;
    importPolicySet(
        policySetName: string,
        importData: PolicySetExportInterface,
        options?: PolicySetImportOptions,
    ): Promise<PolicySetSkeleton>;
    importPolicySets(
        importData: PolicySetExportInterface,
        options?: PolicySetImportOptions,
    ): Promise<PolicySetSkeleton[]>;
    readPolicySet(policySetName: string): Promise<PolicySetSkeleton>;
    readPolicySets(): Promise<PolicySetSkeleton[]>;
    updatePolicySet(
        policySetData: PolicySetSkeleton,
        policySetName?: string,
    ): Promise<PolicySetSkeleton>;
}

Index

Methods

createPolicySet createPolicySetExportTemplate deletePolicySet exportPolicySet exportPolicySets importFirstPolicySet importPolicySet importPolicySets readPolicySet readPolicySets updatePolicySet

Methods

createPolicySet

createPolicySet(
policySetData: PolicySetSkeleton,
policySetName?: string,
): Promise<PolicySetSkeleton>
Parameters
- policySetData: PolicySetSkeleton
- OptionalpolicySetName: string
Returns Promise<PolicySetSkeleton>
- Defined in ops/PolicySetOps.ts:56

createPolicySetExportTemplate

createPolicySetExportTemplate(): PolicySetExportInterface
Create policy export template

Returns PolicySetExportInterface
policy export interface
- Defined in ops/PolicySetOps.ts:44

deletePolicySet

deletePolicySet(policySetName: string): Promise<PolicySetSkeleton>
Parameters
- policySetName: string
Returns Promise<PolicySetSkeleton>
- Defined in ops/PolicySetOps.ts:70

exportPolicySet

exportPolicySet(
policySetName: string,
options?: PolicySetExportOptions,
): Promise<PolicySetExportInterface>
Export policy set
Parameters
- policySetName: string
  policy set name
- Optionaloptions: PolicySetExportOptions
  export options
Returns Promise<PolicySetExportInterface>
a promise that resolves to an PolicySetExportInterface object
- Defined in ops/PolicySetOps.ts:77

exportPolicySets

exportPolicySets(
options?: PolicySetExportOptions,
): Promise<PolicySetExportInterface>
Export policy sets
Parameters
- Optionaloptions: PolicySetExportOptions
  export options
Returns Promise<PolicySetExportInterface>
a promise that resolves to an PolicySetExportInterface object
- Defined in ops/PolicySetOps.ts:86

importFirstPolicySet

importFirstPolicySet(
importData: PolicySetExportInterface,
options?: PolicySetImportOptions,
): Promise<PolicySetSkeleton>
Import first policy set
Parameters
- importData: PolicySetExportInterface
  import data
- Optionaloptions: PolicySetImportOptions
  import options
Returns Promise<PolicySetSkeleton>
the imported policy set, or null if no update was made
- Defined in ops/PolicySetOps.ts:107

importPolicySet

importPolicySet(
    policySetName: string,
    importData: PolicySetExportInterface,
    options?: PolicySetImportOptions,
): Promise<PolicySetSkeleton>
Import policy set
Parameters
- policySetName: string
  policy set name
- importData: PolicySetExportInterface
  import data
- Optionaloptions: PolicySetImportOptions
  import options
Returns Promise<PolicySetSkeleton>
the imported policy set, or null if no update was made
- Defined in ops/PolicySetOps.ts:96

importPolicySets

importPolicySets(
importData: PolicySetExportInterface,
options?: PolicySetImportOptions,
): Promise<PolicySetSkeleton[]>
Import policy sets
Parameters
- importData: PolicySetExportInterface
  import data
- Optionaloptions: PolicySetImportOptions
  import options
Returns Promise<PolicySetSkeleton[]>
The imported policy sets
- Defined in ops/PolicySetOps.ts:117

readPolicySet

readPolicySet(policySetName: string): Promise<PolicySetSkeleton>
Read policy set
Parameters
- policySetName: string
  policy set name
Returns Promise<PolicySetSkeleton>
a promise that resolves to a policy set object
- Defined in ops/PolicySetOps.ts:55

readPolicySets

readPolicySets(): Promise<PolicySetSkeleton[]>
Read all policy sets

Returns Promise<PolicySetSkeleton[]>
a promise that resolves to an array of policy set objects
- Defined in ops/PolicySetOps.ts:49

updatePolicySet

updatePolicySet(
policySetData: PolicySetSkeleton,
policySetName?: string,
): Promise<PolicySetSkeleton>
Update policy set
Parameters
- policySetData: PolicySetSkeleton
- OptionalpolicySetName: string
  optional policy set name
Returns Promise<PolicySetSkeleton>
the updated policy set, or null if no update was made
- Defined in ops/PolicySetOps.ts:66

Type Alias PolicySet

Index

Methods

Methods

createPolicySet

Parameters

Returns Promise<PolicySetSkeleton>

createPolicySetExportTemplate

Returns PolicySetExportInterface

deletePolicySet

Parameters

Returns Promise<PolicySetSkeleton>

exportPolicySet

Parameters

Returns Promise<PolicySetExportInterface>

exportPolicySets

Parameters

Returns Promise<PolicySetExportInterface>

importFirstPolicySet

Parameters

Returns Promise<PolicySetSkeleton>

importPolicySet

Parameters

Returns Promise<PolicySetSkeleton>

importPolicySets

Parameters

Returns Promise<PolicySetSkeleton[]>

readPolicySet

Parameters

Returns Promise<PolicySetSkeleton>

readPolicySets

Returns Promise<PolicySetSkeleton[]>

updatePolicySet

Parameters

Returns Promise<PolicySetSkeleton>

Settings

On This Page