Interface Runbook
public interface Runbook
An immutable client-side representation of Runbook.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
The entirety of the Runbook definition.static interface
The Runbook definition stages.static interface
The template for Runbook update.static interface
The Runbook update stages. -
Method Summary
Modifier and TypeMethodDescriptionGets the creationTime property: Gets or sets the creation time.Gets the description property: Gets or sets the description.draft()
Gets the draft property: Gets or sets the draft runbook properties.etag()
Gets the etag property: Gets or sets the etag of the resource.id()
Gets the id property: Fully qualified resource Id for the resource.Gets the inner com.azure.resourcemanager.automation.fluent.models.RunbookInner object.jobCount()
Gets the jobCount property: Gets or sets the job count of the runbook.Gets the lastModifiedBy property: Gets or sets the last modified by.Gets the lastModifiedTime property: Gets or sets the last modified time.location()
Gets the location property: The geo-location where the resource lives.Gets the logActivityTrace property: Gets or sets the option to log activity trace of the runbook.Gets the logProgress property: Gets or sets progress log option.Gets the logVerbose property: Gets or sets verbose log option.name()
Gets the name property: The name of the resource.Gets the outputTypes property: Gets or sets the runbook output types.Gets the parameters property: Gets or sets the runbook parameters.Gets the provisioningState property: Gets or sets the provisioning state of the runbook.void
publish()
Publish runbook draft.void
publish
(com.azure.core.util.Context context) Publish runbook draft.Gets the publishContentLink property: Gets or sets the published runbook content link.refresh()
Refreshes the resource to sync with Azure.refresh
(com.azure.core.util.Context context) Refreshes the resource to sync with Azure.com.azure.core.management.Region
region()
Gets the region of the resource.Gets the name of the resource region.Gets the name of the resource group.Gets the runbookType property: Gets or sets the type of the runbook.state()
Gets the state property: Gets or sets the state of the runbook.tags()
Gets the tags property: Resource tags.type()
Gets the type property: The type of the resource.update()
Begins update for the Runbook resource.
-
Method Details
-
id
String id()Gets the id property: Fully qualified resource Id for the resource.- Returns:
- the id value.
-
name
String name()Gets the name property: The name of the resource.- Returns:
- the name value.
-
type
String type()Gets the type property: The type of the resource.- Returns:
- the type value.
-
location
String location()Gets the location property: The geo-location where the resource lives.- Returns:
- the location value.
-
tags
Gets the tags property: Resource tags.- Returns:
- the tags value.
-
etag
String etag()Gets the etag property: Gets or sets the etag of the resource.- Returns:
- the etag value.
-
runbookType
RunbookTypeEnum runbookType()Gets the runbookType property: Gets or sets the type of the runbook.- Returns:
- the runbookType value.
-
publishContentLink
ContentLink publishContentLink()Gets the publishContentLink property: Gets or sets the published runbook content link.- Returns:
- the publishContentLink value.
-
state
RunbookState state()Gets the state property: Gets or sets the state of the runbook.- Returns:
- the state value.
-
logVerbose
Boolean logVerbose()Gets the logVerbose property: Gets or sets verbose log option.- Returns:
- the logVerbose value.
-
logProgress
Boolean logProgress()Gets the logProgress property: Gets or sets progress log option.- Returns:
- the logProgress value.
-
logActivityTrace
Integer logActivityTrace()Gets the logActivityTrace property: Gets or sets the option to log activity trace of the runbook.- Returns:
- the logActivityTrace value.
-
jobCount
Integer jobCount()Gets the jobCount property: Gets or sets the job count of the runbook.- Returns:
- the jobCount value.
-
parameters
Map<String,RunbookParameter> parameters()Gets the parameters property: Gets or sets the runbook parameters.- Returns:
- the parameters value.
-
outputTypes
Gets the outputTypes property: Gets or sets the runbook output types.- Returns:
- the outputTypes value.
-
draft
RunbookDraft draft()Gets the draft property: Gets or sets the draft runbook properties.- Returns:
- the draft value.
-
provisioningState
RunbookProvisioningState provisioningState()Gets the provisioningState property: Gets or sets the provisioning state of the runbook.- Returns:
- the provisioningState value.
-
lastModifiedBy
String lastModifiedBy()Gets the lastModifiedBy property: Gets or sets the last modified by.- Returns:
- the lastModifiedBy value.
-
creationTime
OffsetDateTime creationTime()Gets the creationTime property: Gets or sets the creation time.- Returns:
- the creationTime value.
-
lastModifiedTime
OffsetDateTime lastModifiedTime()Gets the lastModifiedTime property: Gets or sets the last modified time.- Returns:
- the lastModifiedTime value.
-
description
String description()Gets the description property: Gets or sets the description.- Returns:
- the description value.
-
region
com.azure.core.management.Region region()Gets the region of the resource.- Returns:
- the region of the resource.
-
regionName
String regionName()Gets the name of the resource region.- Returns:
- the name of the resource region.
-
resourceGroupName
String resourceGroupName()Gets the name of the resource group.- Returns:
- the name of the resource group.
-
innerModel
RunbookInner innerModel()Gets the inner com.azure.resourcemanager.automation.fluent.models.RunbookInner object.- Returns:
- the inner object.
-
update
Runbook.Update update()Begins update for the Runbook resource.- Returns:
- the stage of resource update.
-
refresh
Runbook refresh()Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
Refreshes the resource to sync with Azure.- Parameters:
context
- The context to associate with this operation.- Returns:
- the refreshed resource.
-
publish
void publish()Publish runbook draft.- 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.
-
publish
void publish(com.azure.core.util.Context context) Publish runbook draft.- Parameters:
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.
-