Get-AccessStates

Summary

Retrieves a collection of access state objects.

Get-AccessStates
    -Top
    -Skip
    -Filter
    -OrderBy

Returns a collection object with the following properties:

Property	Type	Notes
Collection	Collection of access state objects	The collection of entries retrieved after `top`, `skip`, `filter`, and `order by` parameters were applied.
Top	Int32	The `top` parameter value that was used. Useful while paging data.
Skip	Int32	The `skip` parameter value that was used. Useful while paging data.
TotalCount	Int32	The total count of records available after any filtering was applied. Useful while paging data.

Parameters

Parameter	Type	Required?	Notes
Top	Int32	No, Defaults to `40`	Total number of entries to retrieve. Max is `1000`.
Skip	Int32	No, Defaults to `0`	How many entries should be skipped within the collection. Used for paging the results.
Filter	String	No	An OData 4 string that can be used for filtering the collection.
OrderBy	String	No	An OData 4 string that can be used for sorting the collection by specific fields.

Examples

Get a collection of access states

# Retrieve the collection
$collectionWrapper = Get-AccessStates

Write-Output "There are $($collectionWrapper.TotalCount) access state(s) in the workspace"

$collectionWrapper.Collection |
    Select-Object AccessStateId, Name |
    Out-String -Width 300 |
    Write-Output

Execution results:

There are 6 access state(s) in the workspace

AccessStateId Name
------------- ----
            1 Everyone
            2 All Organization Admins
            3 All Organization Users
            4 Select Portal Users
            5 Allow List
            6 Deny List