Microsoft.Resources deploymentScripts 2023-08-01

Definição de recursos do bíceps

O tipo de recurso deploymentScripts pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Resources/deploymentScripts, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.Resources/deploymentScripts@2023-08-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  tags: {
    {customized property}: 'string'
  }
  kind: 'string'
  // For remaining properties, see Microsoft.Resources/deploymentScripts objects
}

Objetos Microsoft.Resources/deploymentScripts

Defina a propriedade kind para especificar o tipo de objeto.

Para AzureCLI , use:

{
  kind: 'AzureCLI'
  properties: {
    arguments: 'string'
    azCliVersion: 'string'
    cleanupPreference: 'string'
    containerSettings: {
      containerGroupName: 'string'
      subnetIds: [
        {
          id: 'string'
          name: 'string'
        }
      ]
    }
    environmentVariables: [
      {
        name: 'string'
        secureValue: 'string'
        value: 'string'
      }
    ]
    forceUpdateTag: 'string'
    primaryScriptUri: 'string'
    retentionInterval: 'string'
    scriptContent: 'string'
    storageAccountSettings: {
      storageAccountKey: 'string'
      storageAccountName: 'string'
    }
    supportingScriptUris: [
      'string'
    ]
    timeout: 'string'
  }
}

Para AzurePowerShell, use:

{
  kind: 'AzurePowerShell'
  properties: {
    arguments: 'string'
    azPowerShellVersion: 'string'
    cleanupPreference: 'string'
    containerSettings: {
      containerGroupName: 'string'
      subnetIds: [
        {
          id: 'string'
          name: 'string'
        }
      ]
    }
    environmentVariables: [
      {
        name: 'string'
        secureValue: 'string'
        value: 'string'
      }
    ]
    forceUpdateTag: 'string'
    primaryScriptUri: 'string'
    retentionInterval: 'string'
    scriptContent: 'string'
    storageAccountSettings: {
      storageAccountKey: 'string'
      storageAccountName: 'string'
    }
    supportingScriptUris: [
      'string'
    ]
    timeout: 'string'
  }
}

Valores de propriedade

Microsoft.Resources/deploymentScripts

AzureCliScript

AzureCliScriptProperties

AzurePowerShellScript

AzurePowerShellScriptProperties

ContainerConfiguration

ContainerGroupSubnetId

DeploymentScriptTags

EnvironmentVariable

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

StorageAccountConfiguration

IdentidadeAtribuídaPeloUtilizador

Exemplos de uso

Módulos verificados do Azure

Os seguintes de Módulos Verificados do Azure podem ser usados para implantar esse tipo de recurso.

Exemplos de início rápido do Azure

Os seguintes modelos de início rápido do Azure contêm exemplos de Bicep para implantar esse tipo de recurso.

Definição de recurso de modelo ARM

O tipo de recurso deploymentScripts pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Resources/deploymentScripts, adicione o seguinte JSON ao seu modelo.

{
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "name": "string",
  "tags": {
    "{customized property}": "string"
  },
  "kind": "string"
  // For remaining properties, see Microsoft.Resources/deploymentScripts objects
}

Objetos Microsoft.Resources/deploymentScripts

Defina a propriedade kind para especificar o tipo de objeto.

Para AzureCLI , use:

{
  "kind": "AzureCLI",
  "properties": {
    "arguments": "string",
    "azCliVersion": "string",
    "cleanupPreference": "string",
    "containerSettings": {
      "containerGroupName": "string",
      "subnetIds": [
        {
          "id": "string",
          "name": "string"
        }
      ]
    },
    "environmentVariables": [
      {
        "name": "string",
        "secureValue": "string",
        "value": "string"
      }
    ],
    "forceUpdateTag": "string",
    "primaryScriptUri": "string",
    "retentionInterval": "string",
    "scriptContent": "string",
    "storageAccountSettings": {
      "storageAccountKey": "string",
      "storageAccountName": "string"
    },
    "supportingScriptUris": [ "string" ],
    "timeout": "string"
  }
}

Para AzurePowerShell, use:

{
  "kind": "AzurePowerShell",
  "properties": {
    "arguments": "string",
    "azPowerShellVersion": "string",
    "cleanupPreference": "string",
    "containerSettings": {
      "containerGroupName": "string",
      "subnetIds": [
        {
          "id": "string",
          "name": "string"
        }
      ]
    },
    "environmentVariables": [
      {
        "name": "string",
        "secureValue": "string",
        "value": "string"
      }
    ],
    "forceUpdateTag": "string",
    "primaryScriptUri": "string",
    "retentionInterval": "string",
    "scriptContent": "string",
    "storageAccountSettings": {
      "storageAccountKey": "string",
      "storageAccountName": "string"
    },
    "supportingScriptUris": [ "string" ],
    "timeout": "string"
  }
}

Valores de propriedade

Microsoft.Resources/deploymentScripts

AzureCliScript

AzureCliScriptProperties

AzurePowerShellScript

AzurePowerShellScriptProperties

ContainerConfiguration

ContainerGroupSubnetId

DeploymentScriptTags

EnvironmentVariable

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

StorageAccountConfiguration

IdentidadeAtribuídaPeloUtilizador

Exemplos de uso

Modelos de início rápido do Azure

Os seguintes modelos de início rápido do Azure implantam esse tipo de recurso.

Modelo	Descrição
o Serviço de Contêiner do Azure (AKS) com o Helm	Implantar um cluster gerenciado com o Serviço de Contêiner do Azure (AKS) com o Helm
Construtor de Imagens do Azure com de Linha de Base do Windows do Azure	Cria um ambiente do Azure Image Builder e cria uma imagem do Windows Server com as atualizações mais recentes do Windows e a linha de base do Windows do Azure aplicadas.
Crie imagens de contêiner com o ACR Tasks	Este modelo usa DeploymentScript para orquestrar o ACR para criar sua imagem de contêiner a partir do repositório de código.
Configurar o serviço Caixa de Desenvolvimento	Este modelo criaria todos os recursos de administração da Caixa de Desenvolvimento de acordo com o guia de início rápido da Caixa de Desenvolvimento (/azure/dev-box/quickstart-create-dev-box). Você pode visualizar todos os recursos criados ou ir diretamente para DevPortal.microsoft.com para criar sua primeira Caixa de Desenvolvimento.
Copiar um arquivo de um uri para um contêiner de armazenamento de blob	Este módulo baixa um arquivo de um uri e o copia para um contêiner de blob storageAccount do Azure. O storageAccount já deve existir e o arquivo de origem já deve estar preparado para o uri.
Criar um blob para o início rápido da ferramenta de início rápido de cópia de data factory	Este modelo cria um armazenamento de blob e carrega um arquivo para o início rápido da ferramenta de cópia de dados
Criar um script de implantação com entradas & saídas complexas	Este modelo demonstra as práticas recomendadas para passar e ler entradas, saídas e logs complexos para um script de implantação Az CLI
Criar um script de implantação com entradas & saídas complexas	Este modelo demonstra as práticas recomendadas para passar e ler entradas, saídas e logs complexos para um Script de Implantação do Az PowerShell
Criar um site WordPress	Este modelo cria um site WordPress na instância de contêiner
Crie AKS com Prometheus e Grafana com link privae	Isso criará um Azure grafana, AKS e instalará o Prometheus, um kit de ferramentas de monitoramento e alerta de código aberto, em um cluster do Serviço Kubernetes do Azure (AKS). Em seguida, você usa o ponto de extremidade privado gerenciado do Azure Managed Grafana para se conectar a esse servidor Prometheus e exibir os dados do Prometheus em um painel do Grafana
Criar um de trabalho do Azure Machine Learning Sweep	Este modelo cria um trabalho de varredura do Azure Machine Learning para ajuste de hiperparâmetros.
Criar um Gerenciador de Rede Virtual do Azure e exemplos de VNETs	Este modelo implanta um Gerenciador de Rede Virtual do Azure e redes virtuais de exemplo no grupo de recursos nomeado. Ele suporta várias topologias de conectividade e tipos de associação de grupo de rede.
Criar um servidor SFTP sob demanda com de armazenamento persistente	Este modelo demonstra um servidor SFTP sob demanda usando uma Instância de Contêiner do Azure (ACI).
Criar gateway de aplicativo com certificados	Este modelo mostra como gerar certificados autoassinados do Cofre da Chave e, em seguida, fazer referência do Application Gateway.
Crie chaves ssh e armazene no KeyVault	Este modelo usa o recurso deploymentScript para gerar chaves ssh e armazena a chave privada no keyVault.
cria um aplicativo de contêiner e um ambiente com de registro	Crie um Ambiente de Aplicativo de Contêiner com um Aplicativo de Contêiner básico a partir de um Registro de Contêiner do Azure. Ele também implanta um espaço de trabalho do Log Analytics para armazenar logs.
Cria um aplicativo de microsserviços Dapr usando o Container Apps	Crie um aplicativo de microsserviços Dapr usando Aplicativos de Contêiner.
Cria um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner	Crie um aplicativo de barramento de serviço pub-sub Dapr usando Aplicativos de Contêiner.
Implantar um aplicativo de microsserviço simples do Azure Spring Apps	Este modelo implanta um aplicativo de microsserviço simples do Azure Spring Apps para ser executado no Azure.
implanta um site estático	Implanta um site estático com uma conta de armazenamento de backup
hub FinOps	Este modelo cria uma nova instância de hub FinOps, incluindo Data Explorer, armazenamento Data Lake e Data Factory.
Porta da frente Standard/Premium com origem estática no site	Este modelo cria um site estático Front Door Standard/Premium e um site estático do Armazenamento do Azure e configura o Front Door para enviar tráfego para o site estático.
Function App no Linux Plano de Consumo com Remote Build	Este modelo provisiona um aplicativo de função em um plano de consumo do Linux e executa a compilação remota durante a implantação do código. O aplicativo é executado sob demanda e você é cobrado por execução, sem compromisso permanente de recursos.
Importar imagens de contêiner para o ACR	Este modelo aproveita o módulo Importar ACR do registro bicep para importar imagens de contêiner público para um Registro de Contêiner do Azure.
Importar Blobs VHD de um URL de Arquivo ZIP	A implantação de máquinas virtuais com base em imagens de disco especializadas requer a importação de arquivos VHD para uma conta de armazenamento. No caso de haver vários arquivos VHD compactados em um único ZIP e você tiver a URL para buscar o arquivo ZIP, este modelo ARM facilitará o trabalho: Baixar, extrair e importar para um contêiner de Blob de conta de armazenamento existente.
min.io Gateway do Azure	Implantação totalmente privada min.io Gateway do Azure para fornecer uma API de armazenamento compatível com o S3 apoiada por armazenamento de blob
mais é possível com o Azure Data Factory - Um clique para experimentar o Azure Data Factory	Este modelo cria um pipeline de fábrica de dados para uma atividade de cópia do Blob do Azure para outro Blob do Azure
Agente Protegido em Rede com de Identidade Gerenciada pelo Usuário	Este conjunto de modelos demonstra como configurar o Azure AI Agent Service com isolamento de rede virtual usando a autenticação de Identidade Gerenciada pelo Usuário para a conexão AI Service/AOAI e links de rede privada para conectar o agente aos seus dados seguros.
Configuração do agente padrão	Este conjunto de modelos demonstra como configurar o Azure AI Agent Service com a configuração padrão, ou seja, com a autenticação de identidade gerenciada para conexões de projeto/hub e acesso público à Internet habilitado. Os agentes usam recursos de pesquisa e armazenamento de propriedade do cliente e de locatário único. Com essa configuração, você tem total controle e visibilidade sobre esses recursos, mas incorrerá em custos com base no seu uso.
Ambiente de teste para o Azure Firewall Premium	Este modelo cria uma Política de Firewall Premium e de Firewall do Azure com recursos premium, como IDPS (Intrusion Inspection Detection), inspeção TLS e filtragem de Categoria da Web
Usar um script de implantação para criar objetos do Azure AD	Este exemplo usa um script de implantação para criar objetos no Azure Ative Directory.

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso deploymentScripts pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Resources/deploymentScripts, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  name = "string"
  tags = {
    {customized property} = "string"
  }
  kind = "string"
  // For remaining properties, see Microsoft.Resources/deploymentScripts objects
}

Objetos Microsoft.Resources/deploymentScripts

Defina a propriedade kind para especificar o tipo de objeto.

Para AzureCLI , use:

{
  kind = "AzureCLI"
  properties = {
    arguments = "string"
    azCliVersion = "string"
    cleanupPreference = "string"
    containerSettings = {
      containerGroupName = "string"
      subnetIds = [
        {
          id = "string"
          name = "string"
        }
      ]
    }
    environmentVariables = [
      {
        name = "string"
        secureValue = "string"
        value = "string"
      }
    ]
    forceUpdateTag = "string"
    primaryScriptUri = "string"
    retentionInterval = "string"
    scriptContent = "string"
    storageAccountSettings = {
      storageAccountKey = "string"
      storageAccountName = "string"
    }
    supportingScriptUris = [
      "string"
    ]
    timeout = "string"
  }
}

Para AzurePowerShell, use:

{
  kind = "AzurePowerShell"
  properties = {
    arguments = "string"
    azPowerShellVersion = "string"
    cleanupPreference = "string"
    containerSettings = {
      containerGroupName = "string"
      subnetIds = [
        {
          id = "string"
          name = "string"
        }
      ]
    }
    environmentVariables = [
      {
        name = "string"
        secureValue = "string"
        value = "string"
      }
    ]
    forceUpdateTag = "string"
    primaryScriptUri = "string"
    retentionInterval = "string"
    scriptContent = "string"
    storageAccountSettings = {
      storageAccountKey = "string"
      storageAccountName = "string"
    }
    supportingScriptUris = [
      "string"
    ]
    timeout = "string"
  }
}

Valores de propriedade

Microsoft.Resources/deploymentScripts

AzureCliScript

AzureCliScriptProperties

AzurePowerShellScript

AzurePowerShellScriptProperties

ContainerConfiguration

ContainerGroupSubnetId

DeploymentScriptTags

EnvironmentVariable

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

StorageAccountConfiguration

IdentidadeAtribuídaPeloUtilizador

Exemplos de uso

Amostras Terraform

Um exemplo básico de implantação do Resource Deployment Script.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "deploymentScript" {
  type      = "Microsoft.Resources/deploymentScripts@2020-10-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "AzurePowerShell"
    properties = {
      azPowerShellVersion  = "8.3"
      cleanupPreference    = "Always"
      environmentVariables = null
      retentionInterval    = "P1D"
      scriptContent        = "\t\t$output = 'Hello'\n\t\tWrite-Output $output\n\t\t$DeploymentScriptOutputs = @{}\n\t\t$DeploymentScriptOutputs['text'] = $output\n"
      supportingScriptUris = null
      timeout              = "P1D"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}