GlobalSchedulesClient Interface

public interface GlobalSchedulesClient

An instance of this class provides access to all the operations defined in GlobalSchedulesClient.

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<Void>,Void> beginExecute(String resourceGroupName, String name)

Execute a schedule.

abstract SyncPoller<PollResult<Void>,Void> beginExecute(String resourceGroupName, String name, Context context)

Execute a schedule.

abstract SyncPoller<PollResult<Void>,Void> beginRetarget(String resourceGroupName, String name, RetargetScheduleProperties retargetScheduleProperties)

Updates a schedule's target resource Id.

abstract SyncPoller<PollResult<Void>,Void> beginRetarget(String resourceGroupName, String name, RetargetScheduleProperties retargetScheduleProperties, Context context)

Updates a schedule's target resource Id.

abstract ScheduleInner createOrUpdate(String resourceGroupName, String name, ScheduleInner schedule)

Create or replace an existing schedule.

abstract Response<ScheduleInner> createOrUpdateWithResponse(String resourceGroupName, String name, ScheduleInner schedule, Context context)

Create or replace an existing schedule.

abstract void delete(String resourceGroupName, String name)

Delete schedule.

abstract Response<Void> deleteWithResponse(String resourceGroupName, String name, Context context)

Delete schedule.

abstract void execute(String resourceGroupName, String name)

Execute a schedule.

abstract void execute(String resourceGroupName, String name, Context context)

Execute a schedule.

abstract ScheduleInner getByResourceGroup(String resourceGroupName, String name)

Get schedule.

abstract Response<ScheduleInner> getByResourceGroupWithResponse(String resourceGroupName, String name, String expand, Context context)

Get schedule.

abstract PagedIterable<ScheduleInner> list()

List schedules in a subscription.

abstract PagedIterable<ScheduleInner> list(String expand, String filter, Integer top, String orderby, Context context)

List schedules in a subscription.

abstract PagedIterable<ScheduleInner> listByResourceGroup(String resourceGroupName)

List schedules in a resource group.

abstract PagedIterable<ScheduleInner> listByResourceGroup(String resourceGroupName, String expand, String filter, Integer top, String orderby, Context context)

List schedules in a resource group.

abstract void retarget(String resourceGroupName, String name, RetargetScheduleProperties retargetScheduleProperties)

Updates a schedule's target resource Id.

abstract void retarget(String resourceGroupName, String name, RetargetScheduleProperties retargetScheduleProperties, Context context)

Updates a schedule's target resource Id.

abstract ScheduleInner update(String resourceGroupName, String name, ScheduleFragment schedule)

Allows modifying tags of schedules.

abstract Response<ScheduleInner> updateWithResponse(String resourceGroupName, String name, ScheduleFragment schedule, Context context)

Allows modifying tags of schedules.

Method Details

beginExecute

public abstract SyncPoller<PollResult<Void>,Void> beginExecute(String resourceGroupName, String name)

Execute a schedule. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the schedule.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginExecute

public abstract SyncPoller<PollResult<Void>,Void> beginExecute(String resourceGroupName, String name, Context context)

Execute a schedule. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the schedule.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginRetarget

public abstract SyncPoller<PollResult<Void>,Void> beginRetarget(String resourceGroupName, String name, RetargetScheduleProperties retargetScheduleProperties)

Updates a schedule's target resource Id. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the schedule.
retargetScheduleProperties - Properties for retargeting a virtual machine schedule.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginRetarget

public abstract SyncPoller<PollResult<Void>,Void> beginRetarget(String resourceGroupName, String name, RetargetScheduleProperties retargetScheduleProperties, Context context)

Updates a schedule's target resource Id. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the schedule.
retargetScheduleProperties - Properties for retargeting a virtual machine schedule.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

createOrUpdate

public abstract ScheduleInner createOrUpdate(String resourceGroupName, String name, ScheduleInner schedule)

Create or replace an existing schedule.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the schedule.
schedule - A schedule.

Returns:

a schedule.

createOrUpdateWithResponse

public abstract Response<ScheduleInner> createOrUpdateWithResponse(String resourceGroupName, String name, ScheduleInner schedule, Context context)

Create or replace an existing schedule.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the schedule.
schedule - A schedule.
context - The context to associate with this operation.

Returns:

a schedule along with Response<T>.

delete

public abstract void delete(String resourceGroupName, String name)

Delete schedule.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the schedule.

deleteWithResponse

public abstract Response<Void> deleteWithResponse(String resourceGroupName, String name, Context context)

Delete schedule.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the schedule.
context - The context to associate with this operation.

Returns:

execute

public abstract void execute(String resourceGroupName, String name)

Execute a schedule. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the schedule.

execute

public abstract void execute(String resourceGroupName, String name, Context context)

Execute a schedule. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the schedule.
context - The context to associate with this operation.

getByResourceGroup

public abstract ScheduleInner getByResourceGroup(String resourceGroupName, String name)

Get schedule.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the schedule.

Returns:

schedule.

getByResourceGroupWithResponse

public abstract Response<ScheduleInner> getByResourceGroupWithResponse(String resourceGroupName, String name, String expand, Context context)

Get schedule.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the schedule.
expand - Specify the $expand query. Example: 'properties($select=status)'.
context - The context to associate with this operation.

Returns:

schedule along with Response<T>.

list

public abstract PagedIterable<ScheduleInner> list()

List schedules in a subscription.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<ScheduleInner> list(String expand, String filter, Integer top, String orderby, Context context)

List schedules in a subscription.

Parameters:

expand - Specify the $expand query. Example: 'properties($select=status)'.
filter - The filter to apply to the operation. Example: '$filter=contains(name,'myName').
top - The maximum number of resources to return from the operation. Example: '$top=10'.
orderby - The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.
context - The context to associate with this operation.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<ScheduleInner> listByResourceGroup(String resourceGroupName)

List schedules in a resource group.

Parameters:

resourceGroupName - The name of the resource group.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<ScheduleInner> listByResourceGroup(String resourceGroupName, String expand, String filter, Integer top, String orderby, Context context)

List schedules in a resource group.

Parameters:

resourceGroupName - The name of the resource group.
expand - Specify the $expand query. Example: 'properties($select=status)'.
filter - The filter to apply to the operation. Example: '$filter=contains(name,'myName').
top - The maximum number of resources to return from the operation. Example: '$top=10'.
orderby - The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.
context - The context to associate with this operation.

Returns:

the response of a list operation as paginated response with PagedIterable<T>.

retarget

public abstract void retarget(String resourceGroupName, String name, RetargetScheduleProperties retargetScheduleProperties)

Updates a schedule's target resource Id. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the schedule.
retargetScheduleProperties - Properties for retargeting a virtual machine schedule.

retarget

public abstract void retarget(String resourceGroupName, String name, RetargetScheduleProperties retargetScheduleProperties, Context context)

Updates a schedule's target resource Id. This operation can take a while to complete.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the schedule.
retargetScheduleProperties - Properties for retargeting a virtual machine schedule.
context - The context to associate with this operation.

update

public abstract ScheduleInner update(String resourceGroupName, String name, ScheduleFragment schedule)

Allows modifying tags of schedules. All other properties will be ignored.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the schedule.
schedule - A schedule.

Returns:

a schedule.

updateWithResponse

public abstract Response<ScheduleInner> updateWithResponse(String resourceGroupName, String name, ScheduleFragment schedule, Context context)

Allows modifying tags of schedules. All other properties will be ignored.

Parameters:

resourceGroupName - The name of the resource group.
name - The name of the schedule.
schedule - A schedule.
context - The context to associate with this operation.

Returns:

a schedule along with Response<T>.

Applies to