VirtualMachineRunCommandInner Class

Package:

com.azure.resourcemanager.compute.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-compute:2.44.0

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.core.management.Resource
    • • com.azure.resourcemanager.compute.fluent.models.VirtualMachineRunCommandInner

public final class VirtualMachineRunCommandInner
extends Resource

Describes a Virtual Machine run command.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
Boolean	asyncExecution() Get the asyncExecution property: Optional.
RunCommandManagedIdentity	errorBlobManagedIdentity() Get the errorBlobManagedIdentity property: User-assigned managed identity that has access to errorBlobUri storage blob.
String	errorBlobUri() Get the errorBlobUri property: Specifies the Azure storage blob where script error stream will be uploaded.
static VirtualMachineRunCommandInner	fromJson(JsonReader jsonReader) Reads an instance of VirtualMachineRunCommandInner from the JsonReader.
String	id() Get the id property: Fully qualified resource Id for the resource.
VirtualMachineRunCommandInstanceView	instanceView() Get the instanceView property: The virtual machine run command instance view.
String	name() Get the name property: The name of the resource.
RunCommandManagedIdentity	outputBlobManagedIdentity() Get the outputBlobManagedIdentity property: User-assigned managed identity that has access to outputBlobUri storage blob.
String	outputBlobUri() Get the outputBlobUri property: Specifies the Azure storage blob where script output stream will be uploaded.
List<RunCommandInputParameter>	parameters() Get the parameters property: The parameters used by the script.
List<RunCommandInputParameter>	protectedParameters() Get the protectedParameters property: The parameters used by the script.
String	provisioningState() Get the provisioningState property: The provisioning state, which only appears in the response.
String	runAsPassword() Get the runAsPassword property: Specifies the user account password on the VM when executing the run command.
String	runAsUser() Get the runAsUser property: Specifies the user account on the VM when executing the run command.
VirtualMachineRunCommandScriptSource	source() Get the source property: The source of the run command script.
Integer	timeoutInSeconds() Get the timeoutInSeconds property: The timeout in seconds to execute the run command.
JsonWriter	toJson(JsonWriter jsonWriter)
Boolean	treatFailureAsDeploymentFailure() Get the treatFailureAsDeploymentFailure property: Optional.
String	type() Get the type property: The type of the resource.
void	validate() Validates the instance.
VirtualMachineRunCommandInner	withAsyncExecution(Boolean asyncExecution) Set the asyncExecution property: Optional.
VirtualMachineRunCommandInner	withErrorBlobManagedIdentity(RunCommandManagedIdentity errorBlobManagedIdentity) Set the errorBlobManagedIdentity property: User-assigned managed identity that has access to errorBlobUri storage blob.
VirtualMachineRunCommandInner	withErrorBlobUri(String errorBlobUri) Set the errorBlobUri property: Specifies the Azure storage blob where script error stream will be uploaded.
VirtualMachineRunCommandInner	withLocation(String location)
VirtualMachineRunCommandInner	withOutputBlobManagedIdentity(RunCommandManagedIdentity outputBlobManagedIdentity) Set the outputBlobManagedIdentity property: User-assigned managed identity that has access to outputBlobUri storage blob.
VirtualMachineRunCommandInner	withOutputBlobUri(String outputBlobUri) Set the outputBlobUri property: Specifies the Azure storage blob where script output stream will be uploaded.
VirtualMachineRunCommandInner	withParameters(List<RunCommandInputParameter> parameters) Set the parameters property: The parameters used by the script.
VirtualMachineRunCommandInner	withProtectedParameters(List<RunCommandInputParameter> protectedParameters) Set the protectedParameters property: The parameters used by the script.
VirtualMachineRunCommandInner	withRunAsPassword(String runAsPassword) Set the runAsPassword property: Specifies the user account password on the VM when executing the run command.
VirtualMachineRunCommandInner	withRunAsUser(String runAsUser) Set the runAsUser property: Specifies the user account on the VM when executing the run command.
VirtualMachineRunCommandInner	withSource(VirtualMachineRunCommandScriptSource source) Set the source property: The source of the run command script.
VirtualMachineRunCommandInner	withTags(Map<String,String> tags)
VirtualMachineRunCommandInner	withTimeoutInSeconds(Integer timeoutInSeconds) Set the timeoutInSeconds property: The timeout in seconds to execute the run command.
VirtualMachineRunCommandInner	withTreatFailureAsDeploymentFailure(Boolean treatFailureAsDeploymentFailure) Set the treatFailureAsDeploymentFailure property: Optional.

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VirtualMachineRunCommandInner

public VirtualMachineRunCommandInner()

Creates an instance of VirtualMachineRunCommandInner class.

Method Details

asyncExecution

public Boolean asyncExecution()

Get the asyncExecution property: Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.

Returns:

the asyncExecution value.

errorBlobManagedIdentity

public RunCommandManagedIdentity errorBlobManagedIdentity()

Get the errorBlobManagedIdentity property: User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.

Returns:

the errorBlobManagedIdentity value.

errorBlobUri

public String errorBlobUri()

Get the errorBlobUri property: Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter.

Returns:

the errorBlobUri value.

fromJson

public static VirtualMachineRunCommandInner fromJson(JsonReader jsonReader)

Reads an instance of VirtualMachineRunCommandInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of VirtualMachineRunCommandInner 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.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

VirtualMachineRunCommandInner.id()

Returns:

the id value.

instanceView

public VirtualMachineRunCommandInstanceView instanceView()

Get the instanceView property: The virtual machine run command instance view.

Returns:

the instanceView value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

VirtualMachineRunCommandInner.name()

Returns:

the name value.

outputBlobManagedIdentity

public RunCommandManagedIdentity outputBlobManagedIdentity()

Get the outputBlobManagedIdentity property: User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.

Returns:

the outputBlobManagedIdentity value.

outputBlobUri

public String outputBlobUri()

Get the outputBlobUri property: Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter.

Returns:

the outputBlobUri value.

parameters

public List parameters()

Get the parameters property: The parameters used by the script.

Returns:

the parameters value.

protectedParameters

public List protectedParameters()

Get the protectedParameters property: The parameters used by the script.

Returns:

the protectedParameters value.

provisioningState

public String provisioningState()

Get the provisioningState property: The provisioning state, which only appears in the response. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged\#get-execution-status-and-results.

Returns:

the provisioningState value.

runAsPassword

public String runAsPassword()

Get the runAsPassword property: Specifies the user account password on the VM when executing the run command.

Returns:

the runAsPassword value.

runAsUser

public String runAsUser()

Get the runAsUser property: Specifies the user account on the VM when executing the run command.

Returns:

the runAsUser value.

source

public VirtualMachineRunCommandScriptSource source()

Get the source property: The source of the run command script.

Returns:

the source value.

timeoutInSeconds

public Integer timeoutInSeconds()

Get the timeoutInSeconds property: The timeout in seconds to execute the run command.

Returns:

the timeoutInSeconds value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

VirtualMachineRunCommandInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

treatFailureAsDeploymentFailure

public Boolean treatFailureAsDeploymentFailure()

Get the treatFailureAsDeploymentFailure property: Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged\#get-execution-status-and-results.

Returns:

the treatFailureAsDeploymentFailure value.

type

public String type()

Get the type property: The type of the resource.

Overrides:

VirtualMachineRunCommandInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

withAsyncExecution

public VirtualMachineRunCommandInner withAsyncExecution(Boolean asyncExecution)

Set the asyncExecution property: Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.

Parameters:

asyncExecution - the asyncExecution value to set.

Returns:

the VirtualMachineRunCommandInner object itself.

withErrorBlobManagedIdentity

public VirtualMachineRunCommandInner withErrorBlobManagedIdentity(RunCommandManagedIdentity errorBlobManagedIdentity)

Set the errorBlobManagedIdentity property: User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.

Parameters:

errorBlobManagedIdentity - the errorBlobManagedIdentity value to set.

Returns:

the VirtualMachineRunCommandInner object itself.

withErrorBlobUri

public VirtualMachineRunCommandInner withErrorBlobUri(String errorBlobUri)

Set the errorBlobUri property: Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter.

Parameters:

errorBlobUri - the errorBlobUri value to set.

Returns:

the VirtualMachineRunCommandInner object itself.

withLocation

public VirtualMachineRunCommandInner withLocation(String location)

Overrides:

VirtualMachineRunCommandInner.withLocation(String location)

Parameters:

location

withOutputBlobManagedIdentity

public VirtualMachineRunCommandInner withOutputBlobManagedIdentity(RunCommandManagedIdentity outputBlobManagedIdentity)

Set the outputBlobManagedIdentity property: User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.

Parameters:

outputBlobManagedIdentity - the outputBlobManagedIdentity value to set.

Returns:

the VirtualMachineRunCommandInner object itself.

withOutputBlobUri

public VirtualMachineRunCommandInner withOutputBlobUri(String outputBlobUri)

Set the outputBlobUri property: Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter.

Parameters:

outputBlobUri - the outputBlobUri value to set.

Returns:

the VirtualMachineRunCommandInner object itself.

withParameters

public VirtualMachineRunCommandInner withParameters(List parameters)

Set the parameters property: The parameters used by the script.

Parameters:

parameters - the parameters value to set.

Returns:

the VirtualMachineRunCommandInner object itself.

withProtectedParameters

public VirtualMachineRunCommandInner withProtectedParameters(List protectedParameters)

Set the protectedParameters property: The parameters used by the script.

Parameters:

protectedParameters - the protectedParameters value to set.

Returns:

the VirtualMachineRunCommandInner object itself.

withRunAsPassword

public VirtualMachineRunCommandInner withRunAsPassword(String runAsPassword)

Set the runAsPassword property: Specifies the user account password on the VM when executing the run command.

Parameters:

runAsPassword - the runAsPassword value to set.

Returns:

the VirtualMachineRunCommandInner object itself.

withRunAsUser

public VirtualMachineRunCommandInner withRunAsUser(String runAsUser)

Set the runAsUser property: Specifies the user account on the VM when executing the run command.

Parameters:

runAsUser - the runAsUser value to set.

Returns:

the VirtualMachineRunCommandInner object itself.

withSource

public VirtualMachineRunCommandInner withSource(VirtualMachineRunCommandScriptSource source)

Set the source property: The source of the run command script.

Parameters:

source - the source value to set.

Returns:

the VirtualMachineRunCommandInner object itself.

withTags

public VirtualMachineRunCommandInner withTags(Map tags)

Overrides:

VirtualMachineRunCommandInner.withTags(Map<String,String> tags)

Parameters:

tags

withTimeoutInSeconds

public VirtualMachineRunCommandInner withTimeoutInSeconds(Integer timeoutInSeconds)

Set the timeoutInSeconds property: The timeout in seconds to execute the run command.

Parameters:

timeoutInSeconds - the timeoutInSeconds value to set.

Returns:

the VirtualMachineRunCommandInner object itself.

withTreatFailureAsDeploymentFailure

public VirtualMachineRunCommandInner withTreatFailureAsDeploymentFailure(Boolean treatFailureAsDeploymentFailure)

Set the treatFailureAsDeploymentFailure property: Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged\#get-execution-status-and-results.

Parameters:

treatFailureAsDeploymentFailure - the treatFailureAsDeploymentFailure value to set.

Returns:

the VirtualMachineRunCommandInner object itself.