Frodo Library - v5.0.0-47
    Preparing search index...

    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,
            resultCallback?: ResultCallback<PolicySetSkeleton>,
        ): Promise<PolicySetExportInterface>;
        importFirstPolicySet(
            importData: PolicySetExportInterface,
            options?: PolicySetImportOptions,
        ): Promise<PolicySetSkeleton>;
        importPolicySet(
            policySetName: string,
            importData: PolicySetExportInterface,
            options?: PolicySetImportOptions,
        ): Promise<PolicySetSkeleton>;
        importPolicySets(
            importData: PolicySetExportInterface,
            options?: PolicySetImportOptions,
            resultCallback?: ResultCallback<PolicySetSkeleton>,
        ): Promise<PolicySetSkeleton[]>;
        readPolicySet(policySetName: string): Promise<PolicySetSkeleton>;
        readPolicySets(): Promise<PolicySetSkeleton[]>;
        updatePolicySet(
            policySetData: PolicySetSkeleton,
            policySetName?: string,
        ): Promise<PolicySetSkeleton>;
    }
    Index
    • Export policy sets

      Parameters

      • Optionaloptions: PolicySetExportOptions

        export options

      • OptionalresultCallback: ResultCallback<PolicySetSkeleton>

        Optional callback to process individual results. When given, the outcome of every policy set is passed to it as it happens: a policy set that was exported completely as the policy set, a policy set whose prerequisites or dependencies could not be exported as an error that names the policy set and carries the cause. Such a policy set is left out of the export and does not stop the others, and the function does not throw for it. Without it, the failures are collected and thrown as one error after every policy set was tried. Failing to read the policy sets always throws.

      Returns Promise<PolicySetExportInterface>

      a promise that resolves to an PolicySetExportInterface object

    • Import policy sets

      Parameters

      • importData: PolicySetExportInterface

        import data

      • Optionaloptions: PolicySetImportOptions

        import options

      • OptionalresultCallback: ResultCallback<PolicySetSkeleton>

        Optional callback to process individual results. When given, the outcome of every policy set is passed to it once, as it happens: a policy set that was imported completely as the policy set (a policy set that needed no update as it is in the import data), a policy set that could not be imported, or whose prerequisites or dependencies could not be imported, as one error that names the policy set and carries the causes. Such a policy set is not part of the result and does not stop the others, and the function does not throw for it. Without it, the failures are collected and thrown as one error after every policy set was tried.

      Returns Promise<PolicySetSkeleton[]>

      The imported policy sets