DeploymentStackProperties Class

Package:

com.azure.resourcemanager.resources.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-resources:2.48.0

• java.lang.Object
• • com.azure.resourcemanager.resources.fluent.models.DeploymentStackProperties

Implements

JsonSerializable<DeploymentStackProperties>

public final class DeploymentStackProperties
implements JsonSerializable<DeploymentStackProperties>

Deployment stack properties.

Constructor Summary

Constructor	Description
DeploymentStackProperties()	Creates an instance of DeploymentStackProperties class.

Method Summary

Modifier and Type	Method and Description
ActionOnUnmanage	actionOnUnmanage() Get the actionOnUnmanage property: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted.
Boolean	bypassStackOutOfSyncError() Get the bypassStackOutOfSyncError property: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.
String	correlationId() Get the correlationId property: The correlation id of the last Deployment stack upsert or delete operation.
DeploymentStacksDebugSetting	debugSetting() Get the debugSetting property: The debug setting of the deployment.
List<ResourceReference>	deletedResources() Get the deletedResources property: An array of resources that were deleted during the most recent Deployment stack update.
DenySettings	denySettings() Get the denySettings property: Defines how resources deployed by the stack are locked.
String	deploymentId() Get the deploymentId property: The resourceId of the deployment resource created by the deployment stack.
String	deploymentScope() Get the deploymentScope property: The scope at which the initial deployment should be created.
String	description() Get the description property: Deployment stack description.
List<ResourceReference>	detachedResources() Get the detachedResources property: An array of resources that were detached during the most recent Deployment stack update.
String	duration() Get the duration property: The duration of the last successful Deployment stack update.
ManagementError	error() Get the error property: The error detail.
List<ResourceReferenceExtended>	failedResources() Get the failedResources property: An array of resources that failed to reach goal state during the most recent update.
static DeploymentStackProperties	fromJson(JsonReader jsonReader) Reads an instance of DeploymentStackProperties from the JsonReader.
Object	outputs() Get the outputs property: The outputs of the deployment resource created by the deployment stack.
Map<String,DeploymentParameter>	parameters() Get the parameters property: Name and value pairs that define the deployment parameters for the template.
DeploymentStacksParametersLink	parametersLink() Get the parametersLink property: The URI of parameters file.
DeploymentStackProvisioningState	provisioningState() Get the provisioningState property: State of the deployment stack.
List<ManagedResourceReference>	resources() Get the resources property: An array of resources currently managed by the deployment stack.
Object	template() Get the template property: The template content.
DeploymentStacksTemplateLink	templateLink() Get the templateLink property: The URI of the template.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
DeploymentStackProperties	withActionOnUnmanage(ActionOnUnmanage actionOnUnmanage) Set the actionOnUnmanage property: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted.
DeploymentStackProperties	withBypassStackOutOfSyncError(Boolean bypassStackOutOfSyncError) Set the bypassStackOutOfSyncError property: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.
DeploymentStackProperties	withDebugSetting(DeploymentStacksDebugSetting debugSetting) Set the debugSetting property: The debug setting of the deployment.
DeploymentStackProperties	withDenySettings(DenySettings denySettings) Set the denySettings property: Defines how resources deployed by the stack are locked.
DeploymentStackProperties	withDeploymentScope(String deploymentScope) Set the deploymentScope property: The scope at which the initial deployment should be created.
DeploymentStackProperties	withDescription(String description) Set the description property: Deployment stack description.
DeploymentStackProperties	withError(ManagementError error) Set the error property: The error detail.
DeploymentStackProperties	withParameters(Map<String,DeploymentParameter> parameters) Set the parameters property: Name and value pairs that define the deployment parameters for the template.
DeploymentStackProperties	withParametersLink(DeploymentStacksParametersLink parametersLink) Set the parametersLink property: The URI of parameters file.
DeploymentStackProperties	withTemplate(Object template) Set the template property: The template content.
DeploymentStackProperties	withTemplateLink(DeploymentStacksTemplateLink templateLink) Set the templateLink property: The URI of the template.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DeploymentStackProperties

public DeploymentStackProperties()

Creates an instance of DeploymentStackProperties class.

Method Details

actionOnUnmanage

public ActionOnUnmanage actionOnUnmanage()

Get the actionOnUnmanage property: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted.

Returns:

the actionOnUnmanage value.

bypassStackOutOfSyncError

public Boolean bypassStackOutOfSyncError()

Get the bypassStackOutOfSyncError property: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.

Returns:

the bypassStackOutOfSyncError value.

correlationId

public String correlationId()

Get the correlationId property: The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing.

Returns:

the correlationId value.

debugSetting

public DeploymentStacksDebugSetting debugSetting()

Get the debugSetting property: The debug setting of the deployment.

Returns:

the debugSetting value.

deletedResources

public List deletedResources()

Get the deletedResources property: An array of resources that were deleted during the most recent Deployment stack update. Deleted means that the resource was removed from the template and relevant deletion operations were specified.

Returns:

the deletedResources value.

denySettings

public DenySettings denySettings()

Get the denySettings property: Defines how resources deployed by the stack are locked.

Returns:

the denySettings value.

deploymentId

public String deploymentId()

Get the deploymentId property: The resourceId of the deployment resource created by the deployment stack.

Returns:

the deploymentId value.

deploymentScope

public String deploymentScope()

Get the deploymentScope property: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}').

Returns:

the deploymentScope value.

description

public String description()

Get the description property: Deployment stack description. Max length of 4096 characters.

Returns:

the description value.

detachedResources

public List detachedResources()

Get the detachedResources property: An array of resources that were detached during the most recent Deployment stack update. Detached means that the resource was removed from the template, but no relevant deletion operations were specified. So, the resource still exists while no longer being associated with the stack.

Returns:

the detachedResources value.

duration

public String duration()

Get the duration property: The duration of the last successful Deployment stack update.

Returns:

the duration value.

error

public ManagementError error()

Get the error property: The error detail.

Returns:

the error value.

failedResources

public List failedResources()

Get the failedResources property: An array of resources that failed to reach goal state during the most recent update. Each resourceId is accompanied by an error message.

Returns:

the failedResources value.

fromJson

public static DeploymentStackProperties fromJson(JsonReader jsonReader)

Reads an instance of DeploymentStackProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DeploymentStackProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

outputs

public Object outputs()

Get the outputs property: The outputs of the deployment resource created by the deployment stack.

Returns:

the outputs value.

parameters

public Map parameters()

Get the parameters property: Name and value pairs that define the deployment parameters for the template. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both.

Returns:

the parameters value.

parametersLink

public DeploymentStacksParametersLink parametersLink()

Get the parametersLink property: The URI of parameters file. Use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both.

Returns:

the parametersLink value.

provisioningState

public DeploymentStackProvisioningState provisioningState()

Get the provisioningState property: State of the deployment stack.

Returns:

the provisioningState value.

resources

public List resources()

Get the resources property: An array of resources currently managed by the deployment stack.

Returns:

the resources value.

template

public Object template()

Get the template property: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both.

Returns:

the template value.

templateLink

public DeploymentStacksTemplateLink templateLink()

Get the templateLink property: The URI of the template. Use either the templateLink property or the template property, but not both.

Returns:

the templateLink value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withActionOnUnmanage

public DeploymentStackProperties withActionOnUnmanage(ActionOnUnmanage actionOnUnmanage)

Set the actionOnUnmanage property: Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted.

Parameters:

actionOnUnmanage - the actionOnUnmanage value to set.

Returns:

the DeploymentStackProperties object itself.

withBypassStackOutOfSyncError

public DeploymentStackProperties withBypassStackOutOfSyncError(Boolean bypassStackOutOfSyncError)

Set the bypassStackOutOfSyncError property: Flag to bypass service errors that indicate the stack resource list is not correctly synchronized.

Parameters:

bypassStackOutOfSyncError - the bypassStackOutOfSyncError value to set.

Returns:

the DeploymentStackProperties object itself.

withDebugSetting

public DeploymentStackProperties withDebugSetting(DeploymentStacksDebugSetting debugSetting)

Set the debugSetting property: The debug setting of the deployment.

Parameters:

debugSetting - the debugSetting value to set.

Returns:

the DeploymentStackProperties object itself.

withDenySettings

public DeploymentStackProperties withDenySettings(DenySettings denySettings)

Set the denySettings property: Defines how resources deployed by the stack are locked.

Parameters:

denySettings - the denySettings value to set.

Returns:

the DeploymentStackProperties object itself.

withDeploymentScope

public DeploymentStackProperties withDeploymentScope(String deploymentScope)

Set the deploymentScope property: The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}').

Parameters:

deploymentScope - the deploymentScope value to set.

Returns:

the DeploymentStackProperties object itself.

withDescription

public DeploymentStackProperties withDescription(String description)

Set the description property: Deployment stack description. Max length of 4096 characters.

Parameters:

description - the description value to set.

Returns:

the DeploymentStackProperties object itself.

withError

public DeploymentStackProperties withError(ManagementError error)

Set the error property: The error detail.

Parameters:

error - the error value to set.

Returns:

the DeploymentStackProperties object itself.

withParameters

public DeploymentStackProperties withParameters(Map parameters)

Set the parameters property: Name and value pairs that define the deployment parameters for the template. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both.

Parameters:

parameters - the parameters value to set.

Returns:

the DeploymentStackProperties object itself.

withParametersLink

public DeploymentStackProperties withParametersLink(DeploymentStacksParametersLink parametersLink)

Set the parametersLink property: The URI of parameters file. Use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both.

Parameters:

parametersLink - the parametersLink value to set.

Returns:

the DeploymentStackProperties object itself.

withTemplate

public DeploymentStackProperties withTemplate(Object template)

Set the template property: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both.

Parameters:

template - the template value to set.

Returns:

the DeploymentStackProperties object itself.

withTemplateLink

public DeploymentStackProperties withTemplateLink(DeploymentStacksTemplateLink templateLink)

Set the templateLink property: The URI of the template. Use either the templateLink property or the template property, but not both.

Parameters:

templateLink - the templateLink value to set.

Returns:

the DeploymentStackProperties object itself.

Azure SDK for Java

Latest