Partager via

Machine Run Commands - Get

Service:
Hybrid Compute
Version d'API:
2025-01-13

Opération d’obtention d’une commande d’exécution.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands/{runCommandName}?api-version=2025-01-13

Paramètres URI

Nom Dans Obligatoire Type Description
machineName
 path True

string

pattern: [a-zA-Z0-9-_\.]+

Nom de la machine hybride.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nom du groupe de ressources. Le nom ne respecte pas la casse.
runCommandName
 path True

string

pattern: [a-zA-Z0-9-_\.]+

Nom de la commande d’exécution.
subscriptionId
 path True

string

minLength: 1

ID de l’abonnement cible.
api-version
 query True

string

minLength: 1

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

MachineRunCommand

D’ACCORD
Other Status Codes

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

Get a Run Command

Exemple de requête

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine/runCommands/myRunCommand?api-version=2025-01-13

Exemple de réponse

Code d’état:
200 
{
  "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/runcommands/myRunCommand",
  "name": "myRunCommand",
  "type": "Microsoft.HybridCompute/machines/runcommands",
  "location": "eastus2",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "source": {
      "script": "Write-Host Hello World!"
    },
    "parameters": [
      {
        "name": "param1",
        "value": "value1"
      },
      {
        "name": "param2",
        "value": "value2"
      }
    ],
    "protectedParameters": [],
    "asyncExecution": false,
    "runAsUser": "user1",
    "timeoutInSeconds": 3600,
    "provisioningState": "Succeeded",
    "instanceView": {
      "executionState": "Succeeded",
      "executionMessage": "",
      "exitCode": 0,
      "output": "Hello World",
      "error": "",
      "startTime": "2023-06-15T20:48:41.4641785+00:00",
      "endTime": "2023-06-15T20:48:41.4641785+00:00"
    }
  }
}

Définitions

Nom Description
createdByType

Type d’identité qui a créé la ressource.
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail

Détail de l’erreur.
ErrorResponse

Réponse d’erreur
ExecutionState

État de l’exécution du script.
ExtensionsResourceStatus

État de l’affichage de l’instance.
ExtensionsStatusLevelTypes

Code de niveau.
MachineRunCommand

Décrit une commande d’exécution
MachineRunCommandInstanceView

Vue d’instance d’une commande d’exécution de machine.
MachineRunCommandScriptSource

Décrit les sources de script pour la commande d’exécution. Utilisez un seul script, scriptUri, commandId.
RunCommandInputParameter

Décrit les propriétés d’un paramètre de commande d’exécution.
RunCommandManagedIdentity

Contient clientId ou objectId (utilisez un seul, et non les deux) d’une identité managée affectée par l’utilisateur qui a accès à l’objet blob de stockage utilisé dans La commande d’exécution. Utilisez un objet RunCommandManagedIdentity vide en cas d’identité affectée par le système. Vérifiez que l’objet blob de stockage Azure existe en cas de scriptUri et que l’identité managée a été accordée au conteneur de l’objet blob avec l’attribution de rôle « Lecteur de données blob de stockage » avec l’objet blob scriptUri et « Contributeur aux données blob de stockage » pour les objets blob Append (outputBlobUri, errorBlobUri). En cas d’identité affectée par l’utilisateur, veillez à l’ajouter sous l’identité de la machine virtuelle. Pour plus d’informations sur l’identité managée et la commande Exécuter, reportez-vous https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged.
systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.
type

string

Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d’erreur.
details

ErrorDetail[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

ExecutionState

Énumération

État de l’exécution du script.

Valeur Description
Unknown
Pending
Running
Failed
Succeeded
TimedOut
Canceled

ExtensionsResourceStatus

Object

État de l’affichage de l’instance.

Nom Type Description
code

string

Code d’état.
displayStatus

string

Étiquette localisable courte pour l’état.
level

ExtensionsStatusLevelTypes

Code de niveau.
message

string

Message d’état détaillé, y compris pour les alertes et les messages d’erreur.
time

string (date-time)

Heure de l’état.

ExtensionsStatusLevelTypes

Énumération

Code de niveau.

Valeur Description
Info
Warning
Error

MachineRunCommand

Object

Décrit une commande d’exécution

Nom Type Valeur par défaut Description
id

string

ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

Emplacement géographique où réside la ressource
name

string

Nom de la ressource
properties.asyncExecution

boolean

False

Optionnel. Si la valeur est true, l’approvisionnement se termine dès que le script démarre et n’attend pas la fin du script.
properties.errorBlobManagedIdentity

RunCommandManagedIdentity

Identité managée affectée par l’utilisateur qui a accès à l’objet blob de stockage errorBlobUri. Utilisez un objet vide en cas d’identité affectée par le système. Vérifiez que l’identité managée a reçu l’accès au conteneur de l’objet blob avec l’attribution de rôle « Contributeur aux données blob de stockage ». En cas d’identité affectée par l’utilisateur, veillez à l’ajouter sous l’identité de la machine virtuelle. Pour plus d’informations sur l’identité managée et exécuter la commande, consultez https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged
properties.errorBlobUri

string

Spécifie l’objet blob de stockage Azure dans lequel le flux d’erreurs de script sera chargé. Utilisez un URI SAP avec lecture, ajout, création, accès en écriture OU utiliser l’identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre errorBlobManagedIdentity.
properties.instanceView

MachineRunCommandInstanceView

Vue de l’instance de commande d’exécution de la machine.
properties.outputBlobManagedIdentity

RunCommandManagedIdentity

Identité managée affectée par l’utilisateur qui a accès à l’objet blob de stockage outputBlobUri. Utilisez un objet vide en cas d’identité affectée par le système. Vérifiez que l’identité managée a reçu l’accès au conteneur de l’objet blob avec l’attribution de rôle « Contributeur aux données blob de stockage ». En cas d’identité affectée par l’utilisateur, veillez à l’ajouter sous l’identité de la machine virtuelle. Pour plus d’informations sur l’identité managée et exécuter la commande, consultez https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged
properties.outputBlobUri

string

Spécifie l’objet blob de stockage Azure dans lequel le flux de sortie de script sera chargé. Utilisez un URI SAP avec lecture, ajout, création, accès en écriture OU utiliser l’identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre outputBlobManagedIdentity.
properties.parameters

RunCommandInputParameter[]

Paramètres utilisés par le script.
properties.protectedParameters

RunCommandInputParameter[]

Paramètres utilisés par le script.
properties.provisioningState

string

État d’approvisionnement, qui apparaît uniquement dans la réponse.
properties.runAsPassword

string

Spécifie le mot de passe du compte d’utilisateur sur l’ordinateur lors de l’exécution de la commande d’exécution.
properties.runAsUser

string

Spécifie le compte d’utilisateur sur l’ordinateur lors de l’exécution de la commande d’exécution.
properties.source

MachineRunCommandScriptSource

Source du script de commande d’exécution.
properties.timeoutInSeconds

integer (int32)

Délai d’expiration en secondes pour exécuter la commande d’exécution.
systemData

systemData

Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags

object

Balises de ressource.
type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

MachineRunCommandInstanceView

Object

Vue d’instance d’une commande d’exécution de machine.

Nom Type Description
endTime

string (date-time)

Heure de fin du script.
error

string

Flux d’erreurs de script.
executionMessage

string

Communiquez les erreurs de configuration de script ou les messages d’exécution.
executionState

ExecutionState

État de l’exécution du script.
exitCode

integer (int32)

Quittez le code retourné par l’exécution du script.
output

string

Flux de sortie de script.
startTime

string (date-time)

Heure de début du script.
statuses

ExtensionsResourceStatus[]

Informations d’état.

MachineRunCommandScriptSource

Object

Décrit les sources de script pour la commande d’exécution. Utilisez un seul script, scriptUri, commandId.

Nom Type Description
commandId

string

Spécifie l’ID de commande du script intégré prédéfini.
script

string

Spécifie le contenu du script à exécuter sur l’ordinateur.
scriptUri

string

Spécifie l’emplacement de téléchargement du script. Il peut s’agir de l’URI SAP d’un objet blob de stockage Azure avec accès en lecture ou URI public.
scriptUriManagedIdentity

RunCommandManagedIdentity

Identité managée affectée par l’utilisateur qui a accès à scriptUri en cas d’objet blob de stockage Azure. Utilisez un objet vide en cas d’identité affectée par le système. Vérifiez que l’objet blob de stockage Azure existe et que l’identité managée a été attribuée au conteneur de l’objet blob avec l’attribution de rôle « Lecteur de données blob du stockage ». En cas d’identité affectée par l’utilisateur, veillez à l’ajouter sous l’identité de la machine virtuelle. Pour plus d’informations sur l’identité managée et la commande Exécuter, reportez-vous https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged.

RunCommandInputParameter

Object

Décrit les propriétés d’un paramètre de commande d’exécution.

Nom Type Description
name

string

Nom du paramètre de commande d’exécution.
value

string

Valeur du paramètre de commande d’exécution.

RunCommandManagedIdentity

Object

Contient clientId ou objectId (utilisez un seul, et non les deux) d’une identité managée affectée par l’utilisateur qui a accès à l’objet blob de stockage utilisé dans La commande d’exécution. Utilisez un objet RunCommandManagedIdentity vide en cas d’identité affectée par le système. Vérifiez que l’objet blob de stockage Azure existe en cas de scriptUri et que l’identité managée a été accordée au conteneur de l’objet blob avec l’attribution de rôle « Lecteur de données blob de stockage » avec l’objet blob scriptUri et « Contributeur aux données blob de stockage » pour les objets blob Append (outputBlobUri, errorBlobUri). En cas d’identité affectée par l’utilisateur, veillez à l’ajouter sous l’identité de la machine virtuelle. Pour plus d’informations sur l’identité managée et la commande Exécuter, reportez-vous https://aka.ms/ManagedIdentity et https://aka.ms/RunCommandManaged.

Nom Type Description
clientId

string

ID client (valeur GUID) de l’identité managée affectée par l’utilisateur. ObjectId ne doit pas être utilisé si cela est fourni.
objectId

string

ID d’objet (valeur GUID) de l’identité managée affectée par l’utilisateur. ClientId ne doit pas être utilisé si cela est fourni.

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string (date-time)

Horodatage de la création de ressources (UTC).
createdBy

string

Identité qui a créé la ressource.
createdByType

createdByType

Type d’identité qui a créé la ressource.
lastModifiedAt

string (date-time)

Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.