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 minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

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

Respostas

Nome	Tipo	Description
200 OK	DeploymentScript: AzureCliScript AzurePowerShellScript	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do 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

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": {}
}

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.deploymentscripts import DeploymentScriptsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-deploymentscripts
# USAGE
    python deployment_scripts_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DeploymentScriptsClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.deployment_scripts.update(
        resource_group_name="script-rg",
        script_name="MyDeploymentScript",
    )
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deploymentScripts/stable/2020-10-01/examples/DeploymentScripts_Update.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/script-rg/providers/Microsoft.Resources/deploymentScripts/MyDeploymentScript",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {}
    }
  },
  "kind": "AzurePowerShell",
  "location": "westus",
  "properties": {
    "arguments": "-Location 'westus' -Name \"*rg2\"",
    "azPowerShellVersion": "1.7.0",
    "cleanupPreference": "Always",
    "outputs": {
      "output1": "value1"
    },
    "provisioningState": "Succeeded",
    "retentionInterval": "P7D",
    "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name",
    "status": {
      "containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer",
      "endTime": "2018-11-13T15:19:45-08:00",
      "expirationTime": "2018-11-13T15:19:45-08:00",
      "startTime": "2018-11-13T15:19:45-08:00",
      "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage"
    },
    "supportingScriptUris": [
      "https://uri1.to.supporting.script",
      "https://uri2.to.supporting.script"
    ],
    "timeout": "PT1H"
  },
  "systemData": {
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "createdBy": "string",
    "createdByType": "Application",
    "lastModifiedAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application"
  },
  "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.
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.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ManagedServiceIdentity	Descreve as identidades gerenciadas para um recurso Azure.
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.
ScriptType	Tipo 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 de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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		A localização geográfica onde o recurso reside
name	string		O nome do 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			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		Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags	object		Marcas de recurso.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

AzurePowerShellScript

Objeto

Modelo de objeto para o script do Azure PowerShell.

Nome	Tipo	Valor padrão	Description
id	string		ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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		A localização geográfica onde o recurso reside
name	string		O nome do 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			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		Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags	object		Marcas de recurso.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

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	Sempre limpe os recursos criados pela execução do script.
OnSuccess	Limpe os recursos criados pela execução do script somente se a execução for bem-sucedida.
OnExpiration	Limpe os recursos criados pela execução do script apenas após expiração.

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
User
Application
ManagedIdentity
Key

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.

ErrorDetail

Objeto

O detalhe do erro.

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

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ManagedServiceIdentity

Objeto

Descreve as identidades gerenciadas para um recurso Azure.

Nome	Tipo	Description
tenantId	string	A ID do locatário da identidade gerenciada.
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	Identidade atribuída pelo usuário.

ScriptProvisioningState

Enumeração

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

Valor	Description
Creating	O roteiro está sendo criado.
ProvisioningResources	O script está fornecendo recursos.
Running	O script está rodando.
Succeeded	A execução do script é sucedida.
Failed	A execução do script falhou.
Canceled	O roteiro foi cancelado.

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	ErrorDetail	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.

ScriptType

Enumeração

Tipo do script.

Valor	Description
AzurePowerShell	Azure PowerShell script.
AzureCLI	Azure CLI script.

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.