Interface MachineRunCommand
public interface MachineRunCommand
An immutable client-side representation of MachineRunCommand.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceThe entirety of the MachineRunCommand definition.static interfaceThe MachineRunCommand definition stages.static interfaceThe template for MachineRunCommand update.static interfaceThe MachineRunCommand update stages. -
Method Summary
Modifier and TypeMethodDescriptionGets the asyncExecution property: Optional.Gets the errorBlobManagedIdentity property: User-assigned managed identity that has access to errorBlobUri storage blob.Gets the errorBlobUri property: Specifies the Azure storage blob where script error stream will be uploaded.id()Gets the id property: Fully qualified resource Id for the resource.Gets the inner com.azure.resourcemanager.hybridcompute.fluent.models.MachineRunCommandInner object.Gets the instanceView property: The machine run command instance view.location()Gets the location property: The geo-location where the resource lives.name()Gets the name property: The name of the resource.Gets the outputBlobManagedIdentity property: User-assigned managed identity that has access to outputBlobUri storage blob.Gets the outputBlobUri property: Specifies the Azure storage blob where script output stream will be uploaded.Gets the parameters property: The parameters used by the script.Gets the protectedParameters property: The parameters used by the script.Gets the provisioningState property: The provisioning state, which only appears in the response.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.Regionregion()Gets the region of the resource.Gets the name of the resource region.Gets the name of the resource group.Gets the runAsPassword property: Specifies the user account password on the machine when executing the run command.Gets the runAsUser property: Specifies the user account on the machine when executing the run command.source()Gets the source property: The source of the run command script.com.azure.core.management.SystemDataGets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.tags()Gets the tags property: Resource tags.Gets the timeoutInSeconds property: The timeout in seconds to execute the run command.type()Gets the type property: The type of the resource.update()Begins update for the MachineRunCommand 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.
-
systemData
com.azure.core.management.SystemData systemData()Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.- Returns:
- the systemData value.
-
source
MachineRunCommandScriptSource source()Gets the source property: The source of the run command script.- Returns:
- the source value.
-
parameters
List<RunCommandInputParameter> parameters()Gets the parameters property: The parameters used by the script.- Returns:
- the parameters value.
-
protectedParameters
List<RunCommandInputParameter> protectedParameters()Gets the protectedParameters property: The parameters used by the script.- Returns:
- the protectedParameters value.
-
asyncExecution
Boolean asyncExecution()Gets the asyncExecution property: Optional. If set to true, provisioning will complete as soon as script starts and will not wait for script to complete.- Returns:
- the asyncExecution value.
-
runAsUser
String runAsUser()Gets the runAsUser property: Specifies the user account on the machine when executing the run command.- Returns:
- the runAsUser value.
-
runAsPassword
String runAsPassword()Gets the runAsPassword property: Specifies the user account password on the machine when executing the run command.- Returns:
- the runAsPassword value.
-
timeoutInSeconds
Integer timeoutInSeconds()Gets the timeoutInSeconds property: The timeout in seconds to execute the run command.- Returns:
- the timeoutInSeconds value.
-
outputBlobUri
String outputBlobUri()Gets 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.
-
errorBlobUri
String errorBlobUri()Gets 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.
-
outputBlobManagedIdentity
RunCommandManagedIdentity outputBlobManagedIdentity()Gets 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.
-
errorBlobManagedIdentity
RunCommandManagedIdentity errorBlobManagedIdentity()Gets 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.
-
provisioningState
String provisioningState()Gets the provisioningState property: The provisioning state, which only appears in the response.- Returns:
- the provisioningState value.
-
instanceView
MachineRunCommandInstanceView instanceView()Gets the instanceView property: The machine run command instance view.- Returns:
- the instanceView 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
MachineRunCommandInner innerModel()Gets the inner com.azure.resourcemanager.hybridcompute.fluent.models.MachineRunCommandInner object.- Returns:
- the inner object.
-
update
MachineRunCommand.Update update()Begins update for the MachineRunCommand resource.- Returns:
- the stage of resource update.
-
refresh
MachineRunCommand 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.
-