Skip to content

policy-set

Manage governance policy sets and policy rules

Authentication scope: fabric

List policy sets in a workspace

Terminal window
fabio policy-set list --workspace <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--no-recursive bool No Only list policy sets directly in the root folder
--root-folder-id string No Filter to a specific root folder ID

Examples

Terminal window
fabio policy-set list --workspace $WS
Terminal window
fabio policy-set list --workspace $WS --root-folder-id $FOLDER --no-recursive

Read-only · Returns list

Show a policy set

Terminal window
fabio policy-set show --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Policy set ID

Examples

Terminal window
fabio policy-set show --workspace $WS --id $POLICY_SET

Read-only · Returns object

Create a policy set

Terminal window
fabio policy-set create --workspace <value> --name <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--name string Yes Display name
--description string No Description (maximum 256 characters)
--folder-id string No Folder ID (defaults to the workspace root)
--scope enum No Policy scope for a creation-payload request One of: Tenant, Capacity.
--definition string No Full policy-set definition envelope as inline JSON
--definition-file string No Path to a full policy-set definition envelope

Examples

Terminal window
fabio policy-set create --workspace $WS --name "Capacity governance" --scope Capacity --dry-run
Terminal window
fabio policy-set create --workspace $WS --name "Tenant governance" --definition-file policy-set-definition.json --dry-run

Mutates state · Returns object

Update policy-set properties

Terminal window
fabio policy-set update --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Policy set ID
--name string No New display name
--description string No New description

Examples

Terminal window
fabio policy-set update --workspace $WS --id $POLICY_SET --description "Updated governance policy" --dry-run

Mutates state · Returns object

Delete a policy set

Terminal window
fabio policy-set delete --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Policy set ID

Examples

Terminal window
fabio policy-set delete --workspace $WS --id $POLICY_SET --dry-run

Mutates state · Destructive · Returns void

Get a policy-set definition

Terminal window
fabio policy-set get-definition --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Policy set ID
--format enum No Definition format (currently Beta) One of: Beta.
--decode bool No Decode base64 definition parts

Examples

Terminal window
fabio policy-set get-definition --workspace $WS --id $POLICY_SET --format Beta --decode

Read-only · Long-running operation · Returns object

Replace a policy-set definition

Terminal window
fabio policy-set update-definition --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Policy set ID
--file string No Path to a raw policySet.json part or full definition envelope
--content string No Inline raw policySet.json content or full definition envelope
--update-metadata bool No Update item metadata from a supplied .platform definition part

Examples

Terminal window
fabio policy-set update-definition --workspace $WS --id $POLICY_SET --file policySet.json --dry-run
Terminal window
fabio policy-set update-definition --workspace $WS --id $POLICY_SET --file definition.json --update-metadata --dry-run

Mutates state · Destructive · Long-running operation · Returns object

List policy rules (beta)

Terminal window
fabio policy-set list-rules --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Policy set ID

Examples

Terminal window
fabio policy-set list-rules --workspace $WS --id $POLICY_SET

Read-only · Returns list

Show a policy rule (beta)

Terminal window
fabio policy-set show-rule --workspace <value> --id <value> --rule-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Policy set ID
--rule-id string Yes Policy rule ID

Examples

Terminal window
fabio policy-set show-rule --workspace $WS --id $POLICY_SET --rule-id $RULE

Read-only · Returns object

Create a policy rule (beta)

Terminal window
fabio policy-set create-rule --workspace <value> --id <value> --name <value> --policy <value> --conditions <value> --effects <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Policy set ID
--name string Yes Rule display name
--description string No Rule description
--policy enum Yes Policy governed by the rule One of: ItemCreation, WorkspaceSettingsEditing.
--conditions string Yes Conditions JSON array
--effects string Yes Effects JSON array

Examples

Terminal window
fabio policy-set create-rule --workspace $WS --id $POLICY_SET --name "Approved items" --policy ItemCreation --conditions '[{"type":"Dynamic","targetProperty":"item.type","predicate":{"operator":"AnyOf","values":["Lakehouse","Warehouse"]}}]' --effects '[{"type":"Allow"}]' --dry-run

Mutates state · Returns object

Update a policy rule (beta)

Terminal window
fabio policy-set update-rule --workspace <value> --id <value> --rule-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Policy set ID
--rule-id string Yes Policy rule ID
--name string No New display name
--description string No New description
--conditions string No Replacement conditions JSON array

Examples

Terminal window
fabio policy-set update-rule --workspace $WS --id $POLICY_SET --rule-id $RULE --name "Updated rule" --dry-run

Mutates state · Returns object

Delete a policy rule (beta)

Terminal window
fabio policy-set delete-rule --workspace <value> --id <value> --rule-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Policy set ID
--rule-id string Yes Policy rule ID

Examples

Terminal window
fabio policy-set delete-rule --workspace $WS --id $POLICY_SET --rule-id $RULE --dry-run

Mutates state · Destructive · Returns void

Replace every rule for one policy (beta)

Terminal window
fabio policy-set replace-rules-by-policy --workspace <value> --id <value> --policy <value> --policy-rules <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Policy set ID
--policy enum Yes Policy whose rules will be replaced One of: ItemCreation, WorkspaceSettingsEditing.
--policy-rules string Yes Complete replacement policyRules JSON array

Examples

Terminal window
fabio policy-set replace-rules-by-policy --workspace $WS --id $POLICY_SET --policy ItemCreation --policy-rules '[{"displayName":"Approved items","conditions":[{"type":"Static","value":true}],"effects":[{"type":"Allow"}]}]' --dry-run

Mutates state · Destructive · Returns object

Activate a capacity-scoped policy set

Terminal window
fabio policy-set activate --workspace <value> --id <value> --capacity-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Policy set ID
--capacity-id string Yes Capacity ID on which to activate the policy set
--allow-replace bool No Replace the currently active policy set on this capacity

Examples

Terminal window
fabio policy-set activate --workspace $WS --id $POLICY_SET --capacity-id $CAPACITY_ID --dry-run
Terminal window
fabio policy-set activate --workspace $WS --id $POLICY_SET --capacity-id $CAPACITY_ID --allow-replace --dry-run

Mutates state · Returns object

Deactivate a capacity-scoped policy set

Terminal window
fabio policy-set deactivate --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Policy set ID

Examples

Terminal window
fabio policy-set deactivate --workspace $WS --id $POLICY_SET --dry-run

Mutates state · Returns object

Show the active policy set on a capacity

Terminal window
fabio policy-set get-active-for-capacity --capacity-id <value>
Flag Type Required Description
--capacity-id string Yes Capacity ID

Examples

Terminal window
fabio policy-set get-active-for-capacity --capacity-id $CAPACITY_ID

Read-only · Returns object