CloudEndpoints Interface

public interface CloudEndpoints

Resource collection API of CloudEndpoints.

Method Summary

Modifier and Type Method and Description
abstract CloudEndpointAfsShareMetadataCertificatePublicKeys afsShareMetadataCertificatePublicKeys(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName)

Get the AFS file share metadata signing certificate public keys.

abstract Response<CloudEndpointAfsShareMetadataCertificatePublicKeys> afsShareMetadataCertificatePublicKeysWithResponse(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, Context context)

Get the AFS file share metadata signing certificate public keys.

abstract Blank define(String name)

Begins definition for a new CloudEndpoint resource.

abstract void delete(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName)

Delete a given CloudEndpoint.

abstract void delete(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, Context context)

Delete a given CloudEndpoint.

abstract void deleteById(String id)

Delete a given CloudEndpoint.

abstract void deleteByIdWithResponse(String id, Context context)

Delete a given CloudEndpoint.

abstract CloudEndpoint get(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName)

Get a given CloudEndpoint.

abstract CloudEndpoint getById(String id)

Get a given CloudEndpoint.

abstract Response<CloudEndpoint> getByIdWithResponse(String id, Context context)

Get a given CloudEndpoint.

abstract Response<CloudEndpoint> getWithResponse(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, Context context)

Get a given CloudEndpoint.

abstract PagedIterable<CloudEndpoint> listBySyncGroup(String resourceGroupName, String storageSyncServiceName, String syncGroupName)

Get a CloudEndpoint List.

abstract PagedIterable<CloudEndpoint> listBySyncGroup(String resourceGroupName, String storageSyncServiceName, String syncGroupName, Context context)

Get a CloudEndpoint List.

abstract PostBackupResponse postBackup(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, BackupRequest parameters)

Post Backup a given CloudEndpoint.

abstract PostBackupResponse postBackup(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, BackupRequest parameters, Context context)

Post Backup a given CloudEndpoint.

abstract void postRestore(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, PostRestoreRequest parameters)

Post Restore a given CloudEndpoint.

abstract void postRestore(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, PostRestoreRequest parameters, Context context)

Post Restore a given CloudEndpoint.

abstract void preBackup(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, BackupRequest parameters)

Pre Backup a given CloudEndpoint.

abstract void preBackup(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, BackupRequest parameters, Context context)

Pre Backup a given CloudEndpoint.

abstract void preRestore(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, PreRestoreRequest parameters)

Pre Restore a given CloudEndpoint.

abstract void preRestore(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, PreRestoreRequest parameters, Context context)

Pre Restore a given CloudEndpoint.

abstract void restoreHeartbeat(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName)

Restore Heartbeat a given CloudEndpoint.

abstract CloudEndpointsRestoreHeartbeatResponse restoreHeartbeatWithResponse(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, Context context)

Restore Heartbeat a given CloudEndpoint.

abstract void triggerChangeDetection(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, TriggerChangeDetectionParameters parameters)

Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud Endpoint.

abstract void triggerChangeDetection(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, TriggerChangeDetectionParameters parameters, Context context)

Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud Endpoint.

Method Details

afsShareMetadataCertificatePublicKeys

public abstract CloudEndpointAfsShareMetadataCertificatePublicKeys afsShareMetadataCertificatePublicKeys(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName)

Get the AFS file share metadata signing certificate public keys.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.
cloudEndpointName - Name of Cloud Endpoint object.

Returns:

the AFS file share metadata signing certificate public keys.

afsShareMetadataCertificatePublicKeysWithResponse

public abstract Response<CloudEndpointAfsShareMetadataCertificatePublicKeys> afsShareMetadataCertificatePublicKeysWithResponse(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, Context context)

Get the AFS file share metadata signing certificate public keys.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.
cloudEndpointName - Name of Cloud Endpoint object.
context - The context to associate with this operation.

Returns:

the AFS file share metadata signing certificate public keys.

define

public abstract CloudEndpoint.DefinitionStages.Blank define(String name)

Begins definition for a new CloudEndpoint resource.

Parameters:

name - resource name.

Returns:

the first stage of the new CloudEndpoint definition.

delete

public abstract void delete(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName)

Delete a given CloudEndpoint.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.
cloudEndpointName - Name of Cloud Endpoint object.

delete

public abstract void delete(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, Context context)

Delete a given CloudEndpoint.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.
cloudEndpointName - Name of Cloud Endpoint object.
context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Delete a given CloudEndpoint.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Delete a given CloudEndpoint.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

get

public abstract CloudEndpoint get(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName)

Get a given CloudEndpoint.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.
cloudEndpointName - Name of Cloud Endpoint object.

Returns:

a given CloudEndpoint.

getById

public abstract CloudEndpoint getById(String id)

Get a given CloudEndpoint.

Parameters:

id - the resource ID.

Returns:

a given CloudEndpoint.

getByIdWithResponse

public abstract Response<CloudEndpoint> getByIdWithResponse(String id, Context context)

Get a given CloudEndpoint.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

a given CloudEndpoint.

getWithResponse

public abstract Response<CloudEndpoint> getWithResponse(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, Context context)

Get a given CloudEndpoint.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.
cloudEndpointName - Name of Cloud Endpoint object.
context - The context to associate with this operation.

Returns:

a given CloudEndpoint.

listBySyncGroup

public abstract PagedIterable<CloudEndpoint> listBySyncGroup(String resourceGroupName, String storageSyncServiceName, String syncGroupName)

Get a CloudEndpoint List.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.

Returns:

a CloudEndpoint List as paginated response with PagedIterable<T>.

listBySyncGroup

public abstract PagedIterable<CloudEndpoint> listBySyncGroup(String resourceGroupName, String storageSyncServiceName, String syncGroupName, Context context)

Get a CloudEndpoint List.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.
context - The context to associate with this operation.

Returns:

a CloudEndpoint List as paginated response with PagedIterable<T>.

postBackup

public abstract PostBackupResponse postBackup(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, BackupRequest parameters)

Post Backup a given CloudEndpoint.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.
cloudEndpointName - Name of Cloud Endpoint object.
parameters - Body of Backup request.

Returns:

post Backup Response.

postBackup

public abstract PostBackupResponse postBackup(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, BackupRequest parameters, Context context)

Post Backup a given CloudEndpoint.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.
cloudEndpointName - Name of Cloud Endpoint object.
parameters - Body of Backup request.
context - The context to associate with this operation.

Returns:

post Backup Response.

postRestore

public abstract void postRestore(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, PostRestoreRequest parameters)

Post Restore a given CloudEndpoint.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.
cloudEndpointName - Name of Cloud Endpoint object.
parameters - Body of Cloud Endpoint object.

postRestore

public abstract void postRestore(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, PostRestoreRequest parameters, Context context)

Post Restore a given CloudEndpoint.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.
cloudEndpointName - Name of Cloud Endpoint object.
parameters - Body of Cloud Endpoint object.
context - The context to associate with this operation.

preBackup

public abstract void preBackup(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, BackupRequest parameters)

Pre Backup a given CloudEndpoint.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.
cloudEndpointName - Name of Cloud Endpoint object.
parameters - Body of Backup request.

preBackup

public abstract void preBackup(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, BackupRequest parameters, Context context)

Pre Backup a given CloudEndpoint.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.
cloudEndpointName - Name of Cloud Endpoint object.
parameters - Body of Backup request.
context - The context to associate with this operation.

preRestore

public abstract void preRestore(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, PreRestoreRequest parameters)

Pre Restore a given CloudEndpoint.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.
cloudEndpointName - Name of Cloud Endpoint object.
parameters - Body of Cloud Endpoint object.

preRestore

public abstract void preRestore(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, PreRestoreRequest parameters, Context context)

Pre Restore a given CloudEndpoint.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.
cloudEndpointName - Name of Cloud Endpoint object.
parameters - Body of Cloud Endpoint object.
context - The context to associate with this operation.

restoreHeartbeat

public abstract void restoreHeartbeat(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName)

Restore Heartbeat a given CloudEndpoint.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.
cloudEndpointName - Name of Cloud Endpoint object.

restoreHeartbeatWithResponse

public abstract CloudEndpointsRestoreHeartbeatResponse restoreHeartbeatWithResponse(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, Context context)

Restore Heartbeat a given CloudEndpoint.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.
cloudEndpointName - Name of Cloud Endpoint object.
context - The context to associate with this operation.

Returns:

the response.

triggerChangeDetection

public abstract void triggerChangeDetection(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, TriggerChangeDetectionParameters parameters)

Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud Endpoint.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.
cloudEndpointName - Name of Cloud Endpoint object.
parameters - Trigger Change Detection Action parameters.

triggerChangeDetection

public abstract void triggerChangeDetection(String resourceGroupName, String storageSyncServiceName, String syncGroupName, String cloudEndpointName, TriggerChangeDetectionParameters parameters, Context context)

Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud Endpoint.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
storageSyncServiceName - Name of Storage Sync Service resource.
syncGroupName - Name of Sync Group resource.
cloudEndpointName - Name of Cloud Endpoint object.
parameters - Trigger Change Detection Action parameters.
context - The context to associate with this operation.

Applies to