Interface GlobalSchedulesClient
public interface GlobalSchedulesClient
An instance of this class provides access to all the operations defined in GlobalSchedulesClient.
-
Method Summary
Modifier and TypeMethodDescriptionbeginExecute
(String resourceGroupName, String name) Execute a schedule.beginExecute
(String resourceGroupName, String name, com.azure.core.util.Context context) Execute a schedule.beginRetarget
(String resourceGroupName, String name, RetargetScheduleProperties retargetScheduleProperties) Updates a schedule's target resource Id.beginRetarget
(String resourceGroupName, String name, RetargetScheduleProperties retargetScheduleProperties, com.azure.core.util.Context context) Updates a schedule's target resource Id.createOrUpdate
(String resourceGroupName, String name, ScheduleInner schedule) Create or replace an existing schedule.com.azure.core.http.rest.Response<ScheduleInner>
createOrUpdateWithResponse
(String resourceGroupName, String name, ScheduleInner schedule, com.azure.core.util.Context context) Create or replace an existing schedule.void
Delete schedule.com.azure.core.http.rest.Response<Void>
deleteWithResponse
(String resourceGroupName, String name, com.azure.core.util.Context context) Delete schedule.void
Execute a schedule.void
Execute a schedule.getByResourceGroup
(String resourceGroupName, String name) Get schedule.com.azure.core.http.rest.Response<ScheduleInner>
getByResourceGroupWithResponse
(String resourceGroupName, String name, String expand, com.azure.core.util.Context context) Get schedule.com.azure.core.http.rest.PagedIterable<ScheduleInner>
list()
List schedules in a subscription.com.azure.core.http.rest.PagedIterable<ScheduleInner>
list
(String expand, String filter, Integer top, String orderby, com.azure.core.util.Context context) List schedules in a subscription.com.azure.core.http.rest.PagedIterable<ScheduleInner>
listByResourceGroup
(String resourceGroupName) List schedules in a resource group.com.azure.core.http.rest.PagedIterable<ScheduleInner>
listByResourceGroup
(String resourceGroupName, String expand, String filter, Integer top, String orderby, com.azure.core.util.Context context) List schedules in a resource group.void
retarget
(String resourceGroupName, String name, RetargetScheduleProperties retargetScheduleProperties) Updates a schedule's target resource Id.void
retarget
(String resourceGroupName, String name, RetargetScheduleProperties retargetScheduleProperties, com.azure.core.util.Context context) Updates a schedule's target resource Id.update
(String resourceGroupName, String name, ScheduleFragment schedule) Allows modifying tags of schedules.com.azure.core.http.rest.Response<ScheduleInner>
updateWithResponse
(String resourceGroupName, String name, ScheduleFragment schedule, com.azure.core.util.Context context) Allows modifying tags of schedules.
-
Method Details
-
list
com.azure.core.http.rest.PagedIterable<ScheduleInner> list()List schedules in a subscription.- Returns:
- the response of a list operation as paginated response with
PagedIterable
. - Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
list
com.azure.core.http.rest.PagedIterable<ScheduleInner> list(String expand, String filter, Integer top, String orderby, com.azure.core.util.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
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listByResourceGroup
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
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listByResourceGroup
com.azure.core.http.rest.PagedIterable<ScheduleInner> listByResourceGroup(String resourceGroupName, String expand, String filter, Integer top, String orderby, com.azure.core.util.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
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getByResourceGroupWithResponse
com.azure.core.http.rest.Response<ScheduleInner> getByResourceGroupWithResponse(String resourceGroupName, String name, String expand, com.azure.core.util.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
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getByResourceGroup
Get schedule.- Parameters:
resourceGroupName
- The name of the resource group.name
- The name of the schedule.- Returns:
- schedule.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
createOrUpdateWithResponse
com.azure.core.http.rest.Response<ScheduleInner> createOrUpdateWithResponse(String resourceGroupName, String name, ScheduleInner schedule, com.azure.core.util.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
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
createOrUpdate
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.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteWithResponse
com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String name, com.azure.core.util.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:
- the
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
delete
Delete schedule.- Parameters:
resourceGroupName
- The name of the resource group.name
- The name of the schedule.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
updateWithResponse
com.azure.core.http.rest.Response<ScheduleInner> updateWithResponse(String resourceGroupName, String name, ScheduleFragment schedule, com.azure.core.util.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
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
update
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.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
beginExecute
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.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
for polling of long-running operation. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
beginExecute
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginExecute(String resourceGroupName, String name, com.azure.core.util.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
for polling of long-running operation. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
execute
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.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
execute
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.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
beginRetarget
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.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
for polling of long-running operation. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
beginRetarget
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginRetarget(String resourceGroupName, String name, RetargetScheduleProperties retargetScheduleProperties, com.azure.core.util.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
for polling of long-running operation. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
retarget
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.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
retarget
void retarget(String resourceGroupName, String name, RetargetScheduleProperties retargetScheduleProperties, com.azure.core.util.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.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-