Script Executions - Create Or Update

Service:: AVS

Version d'API:: 2024-09-01

Créer un ScriptExecution

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions/{scriptExecutionName}?api-version=2024-09-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
privateCloudName	path	True	string pattern: ^[-\w\._]+$	Nom du cloud privé
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
scriptExecutionName	path	True	string pattern: ^[-\w\._]+$	Nom de l’applet de commande de script.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
properties.timeout	True	string	Limite de temps pour l’exécution
properties.failureReason		string	Message d’erreur si le script a pu s’exécuter, mais si le script lui-même avait des erreurs ou que PowerShell a levé une exception
properties.hiddenParameters		ScriptExecutionParameter[]: PSCredentialExecutionParameter[] ScriptSecureStringExecutionParameter[] ScriptStringExecutionParameter[]	Paramètres qui seront masqués/non visibles par ARM, tels que les mots de passe et les informations d’identification
properties.namedOutputs		object	Dictionnaire défini par l’utilisateur.
properties.output		string[]	Flux de sortie standard à partir de l’exécution de PowerShell
properties.parameters		ScriptExecutionParameter[]: PSCredentialExecutionParameter[] ScriptSecureStringExecutionParameter[] ScriptStringExecutionParameter[]	Paramètres acceptés par le script
properties.retention		string	Durée de vie de la ressource. S’il n’est pas fourni, sera disponible pendant 60 jours
properties.scriptCmdletId		string	Référence à la ressource d’applet de commande de script si l’utilisateur exécute un script AVS

Réponses

Nom	Type	Description
200 OK	ScriptExecution	Opération de mise à jour « ScriptExecution » réussie
201 Created	ScriptExecution	Opération de création de la ressource « ScriptExecution » réussie En-têtes Retry-After: integer
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Nom

Type

Description

200 OK

ScriptExecution

Opération de mise à jour « ScriptExecution » réussie

201 Created

ScriptExecution

Opération de création de la ressource « ScriptExecution » réussie

En-têtes

Retry-After: integer

Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

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

ScriptExecutions_CreateOrUpdate

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptExecutions/addSsoServer?api-version=2024-09-01

{
  "properties": {
    "scriptCmdletId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptPackages/AVS.PowerCommands@1.0.0/scriptCmdlets/New-SsoExternalIdentitySource",
    "timeout": "P0Y0M0DT0H60M60S",
    "retention": "P0Y0M60DT0H60M60S",
    "parameters": [
      {
        "name": "DomainName",
        "type": "Value",
        "value": "placeholderDomain.local"
      },
      {
        "name": "BaseUserDN",
        "type": "Value",
        "value": "DC=placeholder, DC=placeholder"
      }
    ],
    "hiddenParameters": [
      {
        "name": "Password",
        "type": "SecureValue",
        "secureValue": "PlaceholderPassword"
      }
    ]
  }
}

Exemple de réponse

Code d’état:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptExecutions/addSsoServer",
  "name": "addSsoServer",
  "properties": {
    "scriptCmdletId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptPackages/AVS.PowerCommands@1.0.0/scriptCmdlets/New-SsoExternalIdentitySource",
    "timeout": "P0Y0M0DT0H60M60S",
    "retention": "P0Y0M60DT0H60M60S",
    "provisioningState": "Succeeded",
    "failureReason": "vCenter failed to connect to the external server",
    "parameters": [
      {
        "name": "DomainName",
        "type": "Value",
        "value": "placeholderDomain.local"
      },
      {
        "name": "BaseUserDN",
        "type": "Value",
        "value": "DC=placeholder, DC=placeholder"
      }
    ],
    "output": [
      "IdentitySource: placeholder.dc",
      "BaseDN='dc=placeholder, dc=local"
    ]
  },
  "type": "Microsoft.AVS/privateClouds/scriptExecutions"
}

Code d’état:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptExecutions/addSsoServer",
  "name": "addSsoServer",
  "properties": {
    "scriptCmdletId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptPackages/AVS.PowerCommands@1.0.0/scriptCmdlets/New-SsoExternalIdentitySource",
    "timeout": "P0Y0M0DT0H60M60S",
    "retention": "P0Y0M60DT0H60M60S",
    "provisioningState": "Running",
    "parameters": [
      {
        "name": "DomainName",
        "type": "Value",
        "value": "placeholderDomain.local"
      },
      {
        "name": "BaseUserDN",
        "type": "Value",
        "value": "DC=placeholder, DC=placeholder"
      }
    ]
  },
  "type": "Microsoft.AVS/privateClouds/scriptExecutions"
}

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
PSCredentialExecutionParameter	un objet d’informations d’identification PowerShell
ScriptExecution	Instance d’un script exécuté par un utilisateur - personnalisé ou AVS
ScriptExecutionParameterType	type de paramètre d’exécution de script
ScriptExecutionProvisioningState	État d’approvisionnement d’exécution de script
ScriptSecureStringExecutionParameter	un paramètre d’exécution de valeur de texte brut
ScriptStringExecutionParameter	un paramètre d’exécution de valeur de texte brut
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

Objet

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

Objet

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

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

PSCredentialExecutionParameter

Objet

un objet d’informations d’identification PowerShell

Nom	Type	Description
name	string	Nom du paramètre
password	string (password)	mot de passe pour la connexion
type	string: Credential	type de paramètre d’exécution de script
username	string	nom d’utilisateur pour la connexion

ScriptExecution

Objet

Instance d’un script exécuté par un utilisateur - personnalisé ou AVS

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.errors	string[]	Flux de sortie d’erreur standard à partir de l’exécution de PowerShell
properties.failureReason	string	Message d’erreur si le script a pu s’exécuter, mais si le script lui-même avait des erreurs ou que PowerShell a levé une exception
properties.finishedAt	string (date-time)	Heure de fin de l’exécution du script
properties.hiddenParameters	ScriptExecutionParameter[]: PSCredentialExecutionParameter[] ScriptSecureStringExecutionParameter[] ScriptStringExecutionParameter[]	Paramètres qui seront masqués/non visibles par ARM, tels que les mots de passe et les informations d’identification
properties.information	string[]	Flux d’informations standard à partir de l’exécution de PowerShell
properties.namedOutputs	object	Dictionnaire défini par l’utilisateur.
properties.output	string[]	Flux de sortie standard à partir de l’exécution de PowerShell
properties.parameters	ScriptExecutionParameter[]: PSCredentialExecutionParameter[] ScriptSecureStringExecutionParameter[] ScriptStringExecutionParameter[]	Paramètres acceptés par le script
properties.provisioningState	ScriptExecutionProvisioningState	État de la ressource d’exécution de script
properties.retention	string	Durée de vie de la ressource. S’il n’est pas fourni, sera disponible pendant 60 jours
properties.scriptCmdletId	string	Référence à la ressource d’applet de commande de script si l’utilisateur exécute un script AVS
properties.startedAt	string (date-time)	Heure de démarrage de l’exécution du script
properties.submittedAt	string (date-time)	Heure à laquelle l’exécution du script a été envoyée
properties.timeout	string	Limite de temps pour l’exécution
properties.warnings	string[]	Avertissement standard du flux de sortie à partir de l’exécution de PowerShell
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ScriptExecutionParameterType

Énumération

type de paramètre d’exécution de script

Valeur	Description
Value
SecureValue
Credential

ScriptExecutionProvisioningState

Énumération

État d’approvisionnement d’exécution de script

Valeur	Description
Succeeded	La ressource a été créée.
Failed	Échec de la création de ressources.
Canceled	La création de ressources a été annulée.
Pending	est en attente
Running	est en cours d’exécution
Cancelling	annule
Cancelled	est annulé
Deleting	est en cours de suppression

ScriptSecureStringExecutionParameter

Objet

un paramètre d’exécution de valeur de texte brut

Nom	Type	Description
name	string	Nom du paramètre
secureValue	string (password)	Valeur sécurisée pour le paramètre passé, qui ne doit pas être stockée dans les journaux
type	string: SecureValue	type de paramètre d’exécution de script

ScriptStringExecutionParameter

Objet

un paramètre d’exécution de valeur de texte brut

Nom	Type	Description
name	string	Nom du paramètre
type	string: Value	type de paramètre d’exécution de script
value	string	Valeur du paramètre passé

systemData

Objet

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.

Partager via

Script Executions - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

ScriptExecutions_CreateOrUpdate

Exemple de requête

Exemple de réponse

Définitions

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PSCredentialExecutionParameter

ScriptExecution

ScriptExecutionParameterType

ScriptExecutionProvisioningState

ScriptSecureStringExecutionParameter

ScriptStringExecutionParameter

systemData