Script Executions - Create Or Update
Creación de un scriptExecution
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions/{scriptExecutionName}?api-version=2024-09-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
private
|
path | True |
string pattern: ^[-\w\._]+$ |
Nombre de la nube privada |
resource
|
path | True |
string minLength: 1maxLength: 90 |
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas. |
script
|
path | True |
string pattern: ^[-\w\._]+$ |
Nombre del cmdlet de script. |
subscription
|
path | True |
string (uuid) |
Identificador de la suscripción de destino. El valor debe ser un UUID. |
api-version
|
query | True |
string minLength: 1 |
Versión de la API que se va a usar para esta operación. |
Cuerpo de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
properties.timeout | True |
string |
Límite de tiempo para la ejecución |
properties.failureReason |
string |
Mensaje de error si el script pudo ejecutarse, pero si el propio script tenía errores o PowerShell produjo una excepción |
|
properties.hiddenParameters | ScriptExecutionParameter[]: |
Parámetros que estarán ocultos o no visibles para ARM, como contraseñas y credenciales |
|
properties.namedOutputs |
object |
Diccionario definido por el usuario. |
|
properties.output |
string[] |
Flujo de salida estándar de la ejecución de PowerShell |
|
properties.parameters | ScriptExecutionParameter[]: |
Parámetros que aceptará el script |
|
properties.retention |
string |
Período de vida para el recurso. Si no se proporciona, estará disponible durante 60 días. |
|
properties.scriptCmdletId |
string |
Referencia al recurso del cmdlet de script si el usuario ejecuta un script de AVS |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Operación de actualización de recurso "ScriptExecution" correcta |
|
201 Created |
Operación de creación de recurso "ScriptExecution" correcta Encabezados Retry-After: integer |
|
Other Status Codes |
Una respuesta de error inesperada. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
user_impersonation | suplantar la cuenta de usuario |
Ejemplos
ScriptExecutions_CreateOrUpdate
Solicitud de ejemplo
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"
}
]
}
}
Respuesta de muestra
{
"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"
}
{
"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"
}
Definiciones
Nombre | Description |
---|---|
created |
Tipo de identidad que creó el recurso. |
Error |
Información adicional sobre el error de administración de recursos. |
Error |
Detalle del error. |
Error |
Respuesta de error |
PSCredential |
un objeto de credencial de PowerShell |
Script |
Una instancia de un script ejecutado por un usuario: personalizado o AVS |
Script |
tipo de parámetro de ejecución de script |
Script |
Estado de aprovisionamiento de ejecución de scripts |
Script |
un parámetro de ejecución de valor de texto sin formato |
Script |
un parámetro de ejecución de valor de texto sin formato |
system |
Metadatos relativos a la creación y última modificación del recurso. |
createdByType
Tipo de identidad que creó el recurso.
Valor | Description |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
ErrorAdditionalInfo
Información adicional sobre el error de administración de recursos.
Nombre | Tipo | Description |
---|---|---|
info |
object |
Información adicional. |
type |
string |
Tipo de información adicional. |
ErrorDetail
Detalle del error.
Nombre | Tipo | Description |
---|---|---|
additionalInfo |
Información adicional del error. |
|
code |
string |
Código de error. |
details |
Detalles del error. |
|
message |
string |
El mensaje de error. |
target |
string |
Destino del error. |
ErrorResponse
Respuesta de error
Nombre | Tipo | Description |
---|---|---|
error |
Objeto de error. |
PSCredentialExecutionParameter
un objeto de credencial de PowerShell
Nombre | Tipo | Description |
---|---|---|
name |
string |
Nombre del parámetro |
password |
string (password) |
contraseña para el inicio de sesión |
type |
string:
Credential |
tipo de parámetro de ejecución de script |
username |
string |
nombre de usuario para el inicio de sesión |
ScriptExecution
Una instancia de un script ejecutado por un usuario: personalizado o AVS
Nombre | Tipo | Description |
---|---|---|
id |
string (arm-id) |
Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
string |
Nombre del recurso |
properties.errors |
string[] |
Flujo de salida de error estándar de la ejecución de PowerShell |
properties.failureReason |
string |
Mensaje de error si el script pudo ejecutarse, pero si el propio script tenía errores o PowerShell produjo una excepción |
properties.finishedAt |
string (date-time) |
Hora en que finalizó la ejecución del script |
properties.hiddenParameters | ScriptExecutionParameter[]: |
Parámetros que estarán ocultos o no visibles para ARM, como contraseñas y credenciales |
properties.information |
string[] |
Flujo de información estándar desde la ejecución de PowerShell |
properties.namedOutputs |
object |
Diccionario definido por el usuario. |
properties.output |
string[] |
Flujo de salida estándar de la ejecución de PowerShell |
properties.parameters | ScriptExecutionParameter[]: |
Parámetros que aceptará el script |
properties.provisioningState |
Estado del recurso de ejecución de script |
|
properties.retention |
string |
Período de vida para el recurso. Si no se proporciona, estará disponible durante 60 días. |
properties.scriptCmdletId |
string |
Referencia al recurso del cmdlet de script si el usuario ejecuta un script de AVS |
properties.startedAt |
string (date-time) |
Hora en que se inició la ejecución del script |
properties.submittedAt |
string (date-time) |
Hora en que se envió la ejecución del script |
properties.timeout |
string |
Límite de tiempo para la ejecución |
properties.warnings |
string[] |
Secuencia de salida de advertencia estándar desde la ejecución de PowerShell |
systemData |
Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy. |
|
type |
string |
Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
ScriptExecutionParameterType
tipo de parámetro de ejecución de script
Valor | Description |
---|---|
Credential | |
SecureValue | |
Value |
ScriptExecutionProvisioningState
Estado de aprovisionamiento de ejecución de scripts
Valor | Description |
---|---|
Canceled |
Se canceló la creación de recursos. |
Cancelled |
se cancela |
Cancelling |
está cancelando |
Deleting |
está eliminando |
Failed |
Error en la creación de recursos. |
Pending |
está pendiente |
Running |
se está ejecutando |
Succeeded |
Se ha creado el recurso. |
ScriptSecureStringExecutionParameter
un parámetro de ejecución de valor de texto sin formato
Nombre | Tipo | Description |
---|---|---|
name |
string |
Nombre del parámetro |
secureValue |
string (password) |
Valor seguro para el parámetro pasado, no que se almacenará en los registros. |
type |
string:
Secure |
tipo de parámetro de ejecución de script |
ScriptStringExecutionParameter
un parámetro de ejecución de valor de texto sin formato
Nombre | Tipo | Description |
---|---|---|
name |
string |
Nombre del parámetro |
type |
string:
Value |
tipo de parámetro de ejecución de script |
value |
string |
Valor del parámetro pasado |
systemData
Metadatos relativos a la creación y última modificación del recurso.
Nombre | Tipo | Description |
---|---|---|
createdAt |
string (date-time) |
Marca de tiempo de creación de recursos (UTC). |
createdBy |
string |
Identidad que creó el recurso. |
createdByType |
Tipo de identidad que creó el recurso. |
|
lastModifiedAt |
string (date-time) |
Marca de tiempo de la última modificación del recurso (UTC) |
lastModifiedBy |
string |
Identidad que modificó por última vez el recurso. |
lastModifiedByType |
Tipo de identidad que modificó por última vez el recurso. |