Get-AzStorageSyncCloudEndpoint
This command lists all cloud endpoints within a given sync group.
Syntax
Get-AzStorageSyncCloudEndpoint
[-ResourceGroupName] <String>
[-StorageSyncServiceName] <String>
[-SyncGroupName] <String>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzStorageSyncCloudEndpoint
[-ParentObject] <PSSyncGroup>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzStorageSyncCloudEndpoint
[-ParentResourceId] <String>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
This command lists all cloud endpoints within a given sync group. It can be used to also list the attributes of each cloud endpoint.
Examples
Example 1
Get-AzStorageSyncCloudEndpoint -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -SyncGroupName "mySyncGroupName"
This command gets all cloud endpoints contained within the specified sync group. Specify -CloudEndpointName to return a specific one.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Name of the CloudEndpoint.
Type: | String |
Aliases: | CloudEndpointName |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ParentObject
StorageSyncService Object, normally passed through the parameter.
Type: | PSSyncGroup |
Aliases: | SyncGroup |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ParentResourceId
StorageSyncService Object, normally passed through the parameter.
Type: | String |
Aliases: | SyncGroupId |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceGroupName
Resource Group Name.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-StorageSyncServiceName
Name of the StorageSyncService.
Type: | String |
Aliases: | ParentName |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SyncGroupName
Name of the SyncGroup.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
Outputs
Azure PowerShell