Get-CacheRegion
Get-CacheRegion
Returns a list of all regions in the cache cluster. It can also return only regions within a named cache, as specified by the CacheName parameter. Regions can only be created or removed by the cache client.
Syntax
Parameter Set: AllRegions
Get-CacheRegion [[-CacheName] <String> ] [-MaxRegions <Int32> ] [ <CommonParameters>]
Parameters
-CacheName<String>
The name of the cache.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
-MaxRegions<Int32>
The maximum number of regions to return. By default, all regions are returned.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
Int32.MaxValue |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
-MaxRegionsPerHost<Int32>
The maximum number of regions to return for each cache host. By default, all regions for each cache host are returned.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
Int32.MaxValue |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters
Outputs
The output type is the type of the objects that the cmdlet emits.
- List<Microsoft.Data.Caching.AdminApi.RegionInfo>