Deployment Scripts - Update

Serviço:: Resource Management

Versão da API:: 2020-10-01

Atualiza marcas de script de implantação com valores especificados.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}?api-version=2020-10-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
scriptName	path	True	string minLength: 1 maxLength: 90	Nome do script de implantação.
subscriptionId	path	True	string	ID de assinatura que faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Corpo da solicitação

Nome	Tipo	Description
tags	object	Marcas de recurso a serem atualizadas.

Respostas

Nome	Tipo	Description
200 OK	DeploymentScript: AzurePowerShellScript AzureCliScript	OK -- As marcas de script de implantação são atualizadas.
Other Status Codes	DeploymentScriptsError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

DeploymentScriptsUpdate

Solicitação de exemplo

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/script-rg/providers/Microsoft.Resources/deploymentScripts/MyDeploymentScript?api-version=2020-10-01

{
  "tags": {}
}

Resposta de exemplo

Código de status:: 200

{
  "properties": {
    "provisioningState": "Succeeded",
    "azPowerShellVersion": "1.7.0",
    "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name",
    "arguments": "-Location 'westus' -Name \"*rg2\"",
    "supportingScriptUris": [
      "https://uri1.to.supporting.script",
      "https://uri2.to.supporting.script"
    ],
    "retentionInterval": "P7D",
    "timeout": "PT1H",
    "cleanupPreference": "Always",
    "status": {
      "containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer",
      "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage",
      "startTime": "2018-11-13T15:19:45-08:00",
      "endTime": "2018-11-13T15:19:45-08:00",
      "expirationTime": "2018-11-13T15:19:45-08:00"
    },
    "outputs": {
      "output1": "value1"
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-01T01:01:01.1075056Z"
  },
  "kind": "AzurePowerShell",
  "location": "westus",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {}
    }
  },
  "tags": {}
}

Definições

Nome	Description
AzureCliScript	Modelo de objeto para o script da CLI do Azure.
AzurePowerShellScript	Modelo de objeto para o script do Azure PowerShell.
cleanupOptions	A preferência de limpeza quando a execução do script fica em um estado terminal. A configuração padrão é 'Always'.
ContainerConfiguration	Configurações para personalizar a instância de contêiner da ACI.
createdByType	O tipo de identidade que criou o recurso.
DeploymentScriptsError	Resposta de erro de scripts de implantação.
DeploymentScriptUpdateParameter	Parâmetros de script de implantação a serem atualizados.
EnvironmentVariable	A variável de ambiente a ser passada para o script na instância do contêiner.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorResponse	Resposta de erro
ManagedServiceIdentity	Objeto genérico de identidade gerenciada.
ManagedServiceIdentityType	Tipo da identidade gerenciada.
ScriptProvisioningState	Estado da execução do script. Isso só aparece na resposta.
ScriptStatus	Resultados genéricos de modelagem de objeto da execução do script.
StorageAccountConfiguration	Configurações para usar uma conta de armazenamento existente. Os tipos de conta de armazenamento válidos são: Armazenamento, StorageV2 e FileStorage
systemData	Metadados relativos à criação e última modificação do recurso.
UserAssignedIdentity	Identidade gerenciada atribuída pelo usuário.

AzureCliScript

Objeto

Modelo de objeto para o script da CLI do Azure.

Nome	Tipo	Valor padrão	Description
id	string		ID da cadeia de caracteres usada para localizar qualquer recurso no Azure.
identity	ManagedServiceIdentity		Propriedade opcional. Identidade gerenciada a ser usada para esse script de implantação. Atualmente, há suporte apenas para MSI atribuída pelo usuário.
kind	string: AzureCLI		Tipo do script.
location	string		O local da ACI e da conta de armazenamento para o script de implantação.
name	string		Nome desse recurso.
properties.arguments	string		Argumentos de linha de comando para passar para o script. Os argumentos são separados por espaços. ex: -Name azul* -Location 'Oeste dos EUA 2'
properties.azCliVersion	string		Versão do módulo da CLI do Azure a ser usada.
properties.cleanupPreference	cleanupOptions	Always	A preferência de limpeza quando a execução do script fica em um estado terminal. A configuração padrão é 'Always'.
properties.containerSettings	ContainerConfiguration		Configurações de contêiner.
properties.environmentVariables	EnvironmentVariable[]		As variáveis de ambiente a serem passadas para o script.
properties.forceUpdateTag	string		Obtém ou define como o script de implantação deve ser forçado a ser executado mesmo que o recurso de script não tenha sido alterado. Pode ser o carimbo de data/hora atual ou um GUID.
properties.outputs	object		Lista de saídas de script.
properties.primaryScriptUri	string		Uri para o script. Esse é o ponto de entrada para o script externo.
properties.provisioningState	ScriptProvisioningState		Estado da execução do script. Isso só aparece na resposta.
properties.retentionInterval	string (duration)		Intervalo para o qual o serviço retém o recurso de script depois de atingir um estado terminal. O recurso será excluído quando essa duração expirar. A duração é baseada no padrão ISO 8601 (por exemplo, P1D significa um dia).
properties.scriptContent	string		Corpo do script.
properties.status	ScriptStatus		Contém os resultados da execução do script.
properties.storageAccountSettings	StorageAccountConfiguration		Configurações da Conta de Armazenamento.
properties.supportingScriptUris	string[]		Suporte a arquivos para o script externo.
properties.timeout	string (duration)	P1D	Tempo máximo de execução de script permitido especificado no formato ISO 8601. O valor padrão é P1D
systemData	systemData		Os metadados do sistema relacionados a esse recurso.
tags	object		Marcas de recurso.
type	string		Tipo desse recurso.

AzurePowerShellScript

Objeto

Modelo de objeto para o script do Azure PowerShell.

Nome	Tipo	Valor padrão	Description
id	string		ID da cadeia de caracteres usada para localizar qualquer recurso no Azure.
identity	ManagedServiceIdentity		Propriedade opcional. Identidade gerenciada a ser usada para esse script de implantação. Atualmente, há suporte apenas para MSI atribuída pelo usuário.
kind	string: AzurePowerShell		Tipo do script.
location	string		O local da ACI e da conta de armazenamento para o script de implantação.
name	string		Nome desse recurso.
properties.arguments	string		Argumentos de linha de comando para passar para o script. Os argumentos são separados por espaços. ex: -Name azul* -Location 'Oeste dos EUA 2'
properties.azPowerShellVersion	string		Versão do módulo do Azure PowerShell a ser usada.
properties.cleanupPreference	cleanupOptions	Always	A preferência de limpeza quando a execução do script fica em um estado terminal. A configuração padrão é 'Always'.
properties.containerSettings	ContainerConfiguration		Configurações de contêiner.
properties.environmentVariables	EnvironmentVariable[]		As variáveis de ambiente a serem passadas para o script.
properties.forceUpdateTag	string		Obtém ou define como o script de implantação deve ser forçado a ser executado mesmo que o recurso de script não tenha sido alterado. Pode ser o carimbo de data/hora atual ou um GUID.
properties.outputs	object		Lista de saídas de script.
properties.primaryScriptUri	string		Uri para o script. Esse é o ponto de entrada para o script externo.
properties.provisioningState	ScriptProvisioningState		Estado da execução do script. Isso só aparece na resposta.
properties.retentionInterval	string (duration)		Intervalo para o qual o serviço retém o recurso de script depois de atingir um estado terminal. O recurso será excluído quando essa duração expirar. A duração é baseada no padrão ISO 8601 (por exemplo, P1D significa um dia).
properties.scriptContent	string		Corpo do script.
properties.status	ScriptStatus		Contém os resultados da execução do script.
properties.storageAccountSettings	StorageAccountConfiguration		Configurações da Conta de Armazenamento.
properties.supportingScriptUris	string[]		Suporte a arquivos para o script externo.
properties.timeout	string (duration)	P1D	Tempo máximo de execução de script permitido especificado no formato ISO 8601. O valor padrão é P1D
systemData	systemData		Os metadados do sistema relacionados a esse recurso.
tags	object		Marcas de recurso.
type	string		Tipo desse recurso.

cleanupOptions

Enumeração

A preferência de limpeza quando a execução do script fica em um estado terminal. A configuração padrão é 'Always'.

Valor	Description
Always
OnExpiration
OnSuccess

ContainerConfiguration

Objeto

Configurações para personalizar a instância de contêiner da ACI.

Nome	Tipo	Description
containerGroupName	string minLength: 1 maxLength: 63	Nome do grupo de contêineres, se não especificado, o nome será gerado automaticamente. Não especificar um 'containerGroupName' indica que o sistema gerará um nome exclusivo que pode acabar sinalizando um Azure Policy como não compatível. Use 'containerGroupName' quando você tiver um Azure Policy que espere uma convenção de nomenclatura específica ou quando quiser controlar totalmente o nome. A propriedade 'containerGroupName' deve ter entre 1 e 63 caracteres, deve conter apenas letras minúsculas, números e traços e não pode iniciar ou terminar com um traço e traços consecutivos não são permitidos. Para especificar um 'containerGroupName', adicione o seguinte objeto às propriedades: { "containerSettings": { "containerGroupName": "contoso-container" } }. Se você não quiser especificar um 'containerGroupName', não adicione a propriedade 'containerSettings'.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DeploymentScriptsError

Objeto

Resposta de erro de scripts de implantação.

Nome	Tipo	Description
error	ErrorResponse	Resposta de erro Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)

DeploymentScriptUpdateParameter

Objeto

Parâmetros de script de implantação a serem atualizados.

Nome	Tipo	Description
id	string	ID da cadeia de caracteres usada para localizar qualquer recurso no Azure.
name	string	Nome desse recurso.
tags	object	Marcas de recurso a serem atualizadas.
type	string	Tipo desse recurso.

EnvironmentVariable

Objeto

A variável de ambiente a ser passada para o script na instância do contêiner.

Nome	Tipo	Description
name	string	O nome da variável de ambiente.
secureValue	string	O valor da variável de ambiente seguro.
value	string	O valor da variável de ambiente.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorResponse[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ManagedServiceIdentity

Objeto

Objeto genérico de identidade gerenciada.

Nome	Tipo	Description
tenantId	string	ID do Azure Active Directory.
type	ManagedServiceIdentityType	Tipo da identidade gerenciada.
userAssignedIdentities	<string, UserAssignedIdentity>	A lista de identidades gerenciadas atribuídas pelo usuário associadas ao recurso. A chave é a ID de recurso do Azure da identidade gerenciada.

ManagedServiceIdentityType

Enumeração

Tipo da identidade gerenciada.

Valor	Description
UserAssigned

ScriptProvisioningState

Enumeração

Estado da execução do script. Isso só aparece na resposta.

Valor	Description
Canceled
Creating
Failed
ProvisioningResources
Running
Succeeded

ScriptStatus

Objeto

Resultados genéricos de modelagem de objeto da execução do script.

Nome	Tipo	Description
containerInstanceId	string	ID de recurso da ACI.
endTime	string (date-time)	Hora de término da execução do script.
error	ErrorResponse	Resposta de erro Erro retransmitido da execução do script.
expirationTime	string (date-time)	Hora em que o recurso de script de implantação expirará.
startTime	string (date-time)	Hora de início da execução do script.
storageAccountId	string	ID do recurso da conta de armazenamento.

StorageAccountConfiguration

Objeto

Configurações para usar uma conta de armazenamento existente. Os tipos de conta de armazenamento válidos são: Armazenamento, StorageV2 e FileStorage

Nome	Tipo	Description
storageAccountKey	string	A chave de acesso da conta de armazenamento.
storageAccountName	string	O nome da conta de armazenamento.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentity

Objeto

Identidade gerenciada atribuída pelo usuário.

Nome	Tipo	Description
clientId	string	ID do aplicativo cliente associada a essa identidade.
principalId	string	ID da entidade de segurança do Azure Active Directory associada a essa identidade.

Compartilhar via

Deployment Scripts - Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

DeploymentScriptsUpdate

Solicitação de exemplo

Resposta de exemplo

Definições

AzureCliScript

AzurePowerShellScript

cleanupOptions

ContainerConfiguration

createdByType

DeploymentScriptsError

DeploymentScriptUpdateParameter

EnvironmentVariable

ErrorAdditionalInfo

ErrorResponse

ManagedServiceIdentity

ManagedServiceIdentityType

ScriptProvisioningState

ScriptStatus

StorageAccountConfiguration

systemData

UserAssignedIdentity