Skip to content
Proud to collaborate with Microsoft for Startups

data.network.security_boundary.persist ​

Upsert a NetworkSecurityBoundary from sync (no rule contents persisted)

Create, restore, or update a NetworkSecurityBoundary.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-network
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—UUID of the organization
network_scope_uuiduuidYes—UUID of the parent NetworkScope
provider_boundary_refstringYes—Provider-side security boundary reference (sg-..., nsg ref, etc.)
namestringYes—Human-readable boundary name
descriptionstringNo—Provider-supplied description
boundary_typestringNo—Boundary type tag (security_group, nsg, firewall_group, ...)
rule_countintegerNo—Total count of provider rules attached (no rule contents)
provider_metadatadictNo—Provider-side metadata bag (no secrets)
actorstringNo—Caller initiating the persist

Output Schema ​

FieldTypeRequiredDefaultDescription
security_boundary_uuiduuidYes—UUID of the persisted boundary
createdbooleanYes—True when a new row was inserted
restoredbooleanYes—True when a soft-deleted row was restored
updatedbooleanYes—True when an existing row was mutated
persisted_atstringYes—ISO-8601 timestamp
failure_reasonstringNo—Engine-stamped human-readable failure reason
failed_at_statestringNo—Engine-stamped state when the workflow failed
failed_stepstringNo—Engine-stamped step name (DAG path)
failed_layerintegerNo—Engine-stamped layer index (DAG path)
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—completePersist boundary
completedNoYesYes—Persisted
failedNoYesNo—Persist failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

Outcomes ​

OutcomeTypeDescriptionState Data Keys
persistedSUCCESSUpsert a NetworkSecurityBoundary from sync (no rule contents persisted)—
failedFAILURENetwork workflow failedfailure_reason

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "data.network.security_boundary.persist",
  "initial_data": {
    "organization_uuid": "value",
    "network_scope_uuid": "value",
    "provider_boundary_ref": "value",
    "name": "value"
  }
}