Interface RunbooksClient
public interface RunbooksClient
An instance of this class provides access to all the operations defined in RunbooksClient.
-
Method Summary
Modifier and TypeMethodDescriptionbeginPublish
(String resourceGroupName, String automationAccountName, String runbookName) Publish runbook draft.beginPublish
(String resourceGroupName, String automationAccountName, String runbookName, com.azure.core.util.Context context) Publish runbook draft.createOrUpdate
(String resourceGroupName, String automationAccountName, String runbookName, RunbookCreateOrUpdateParametersInner parameters) Create the runbook identified by runbook name.com.azure.core.http.rest.Response<RunbookInner>
createOrUpdateWithResponse
(String resourceGroupName, String automationAccountName, String runbookName, RunbookCreateOrUpdateParametersInner parameters, com.azure.core.util.Context context) Create the runbook identified by runbook name.void
Delete the runbook by name.com.azure.core.http.rest.Response<Void>
deleteWithResponse
(String resourceGroupName, String automationAccountName, String runbookName, com.azure.core.util.Context context) Delete the runbook by name.Retrieve the runbook identified by runbook name.getContent
(String resourceGroupName, String automationAccountName, String runbookName) Retrieve the content of runbook identified by runbook name.com.azure.core.http.rest.Response<Flux<ByteBuffer>>
getContentWithResponse
(String resourceGroupName, String automationAccountName, String runbookName, com.azure.core.util.Context context) Retrieve the content of runbook identified by runbook name.com.azure.core.http.rest.Response<RunbookInner>
getWithResponse
(String resourceGroupName, String automationAccountName, String runbookName, com.azure.core.util.Context context) Retrieve the runbook identified by runbook name.com.azure.core.http.rest.PagedIterable<RunbookInner>
listByAutomationAccount
(String resourceGroupName, String automationAccountName) Retrieve a list of runbooks.com.azure.core.http.rest.PagedIterable<RunbookInner>
listByAutomationAccount
(String resourceGroupName, String automationAccountName, com.azure.core.util.Context context) Retrieve a list of runbooks.void
Publish runbook draft.void
publish
(String resourceGroupName, String automationAccountName, String runbookName, com.azure.core.util.Context context) Publish runbook draft.update
(String resourceGroupName, String automationAccountName, String runbookName, RunbookUpdateParameters parameters) Update the runbook identified by runbook name.com.azure.core.http.rest.Response<RunbookInner>
updateWithResponse
(String resourceGroupName, String automationAccountName, String runbookName, RunbookUpdateParameters parameters, com.azure.core.util.Context context) Update the runbook identified by runbook name.
-
Method Details
-
beginPublish
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginPublish(String resourceGroupName, String automationAccountName, String runbookName) Publish runbook draft.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.runbookName
- The parameters supplied to the publish runbook 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.
-
beginPublish
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginPublish(String resourceGroupName, String automationAccountName, String runbookName, com.azure.core.util.Context context) Publish runbook draft.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.runbookName
- The parameters supplied to the publish runbook operation.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.
-
publish
Publish runbook draft.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.runbookName
- The parameters supplied to the publish runbook 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.
-
publish
void publish(String resourceGroupName, String automationAccountName, String runbookName, com.azure.core.util.Context context) Publish runbook draft.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.runbookName
- The parameters supplied to the publish runbook operation.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.
-
getContent
Flux<ByteBuffer> getContent(String resourceGroupName, String automationAccountName, String runbookName) Retrieve the content of runbook identified by runbook name.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.runbookName
- The runbook name.- 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.
-
getContentWithResponse
com.azure.core.http.rest.Response<Flux<ByteBuffer>> getContentWithResponse(String resourceGroupName, String automationAccountName, String runbookName, com.azure.core.util.Context context) Retrieve the content of runbook identified by runbook name.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.runbookName
- The runbook name.context
- The context to associate with this operation.- Returns:
- the response body 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.
-
get
Retrieve the runbook identified by runbook name.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.runbookName
- The runbook name.- Returns:
- definition of the runbook type.
- 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.
-
getWithResponse
com.azure.core.http.rest.Response<RunbookInner> getWithResponse(String resourceGroupName, String automationAccountName, String runbookName, com.azure.core.util.Context context) Retrieve the runbook identified by runbook name.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.runbookName
- The runbook name.context
- The context to associate with this operation.- Returns:
- definition of the runbook type 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
RunbookInner createOrUpdate(String resourceGroupName, String automationAccountName, String runbookName, RunbookCreateOrUpdateParametersInner parameters) Create the runbook identified by runbook name.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.runbookName
- The runbook name.parameters
- The create or update parameters for runbook. Provide either content link for a published runbook or draft, not both.- Returns:
- definition of the runbook type.
- 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<RunbookInner> createOrUpdateWithResponse(String resourceGroupName, String automationAccountName, String runbookName, RunbookCreateOrUpdateParametersInner parameters, com.azure.core.util.Context context) Create the runbook identified by runbook name.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.runbookName
- The runbook name.parameters
- The create or update parameters for runbook. Provide either content link for a published runbook or draft, not both.context
- The context to associate with this operation.- Returns:
- definition of the runbook type 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
RunbookInner update(String resourceGroupName, String automationAccountName, String runbookName, RunbookUpdateParameters parameters) Update the runbook identified by runbook name.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.runbookName
- The runbook name.parameters
- The update parameters for runbook.- Returns:
- definition of the runbook type.
- 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<RunbookInner> updateWithResponse(String resourceGroupName, String automationAccountName, String runbookName, RunbookUpdateParameters parameters, com.azure.core.util.Context context) Update the runbook identified by runbook name.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.runbookName
- The runbook name.parameters
- The update parameters for runbook.context
- The context to associate with this operation.- Returns:
- definition of the runbook type 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.
-
delete
Delete the runbook by name.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.runbookName
- The runbook name.- 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 automationAccountName, String runbookName, com.azure.core.util.Context context) Delete the runbook by name.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.runbookName
- The runbook name.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.
-
listByAutomationAccount
com.azure.core.http.rest.PagedIterable<RunbookInner> listByAutomationAccount(String resourceGroupName, String automationAccountName) Retrieve a list of runbooks.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.- Returns:
- the response model for the list runbook 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.
-
listByAutomationAccount
com.azure.core.http.rest.PagedIterable<RunbookInner> listByAutomationAccount(String resourceGroupName, String automationAccountName, com.azure.core.util.Context context) Retrieve a list of runbooks.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.context
- The context to associate with this operation.- Returns:
- the response model for the list runbook 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.
-