Skip to main content

DataSegment

Properties

NameTypeDescriptionNotes
IdStringThe segment's ID.[optional]
NameStringThe segment's business name.[optional]
CreatedSystem.DateTimeThe time when the segment is created.[optional]
ModifiedSystem.DateTimeThe time when the segment is modified.[optional]
DescriptionStringThe segment's optional description.[optional]
Scopes[]ScopeList of Scopes that are assigned to the segment[optional]
MemberSelection[]RefList of Identities that are assigned to the segment[optional]
MemberFilterVisibilitycriteria[optional]
MembershipMembershiptype[optional]
EnabledBooleanThis boolean indicates whether the segment is currently active. Inactive segments have no effect.[optional] [default to $false]
PublishedBooleanThis boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified to until published[optional] [default to $false]

Examples

  • Prepare the resource
$DataSegment = Initialize-DataSegment  -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde `
-Name segment-xyz `
-Created 2020-01-01T00:00Z `
-Modified 2020-01-01T00:00Z `
-Description This segment represents xyz `
-Scopes [{"scope":"ENTITLEMENT","visibility":"SELECTION","scopeFilter":null,"scopeSelection":[{"type":"ENTITLEMENT","id":"34d73f611449463ea4fdcf02cda0c397"}]}] `
-MemberSelection [{"type":"IDENTITY","id":"29cb6c061da843ea8be4b3125f248f2a"},{"type":"IDENTITY","id":"f7b1b8a35fed4fd4ad2982014e137e19"}] `
-MemberFilter null `
-Membership null `
-Enabled true `
-Published true
  • Convert the resource to JSON
$DataSegment | ConvertTo-JSON

[Back to top]