Exercício – Criar e usar um módulo

9 minutos

Você foi encarregado de adicionar uma CDN (rede de distribuição de conteúdo) ao site da sua empresa para o lançamento de um vombate de brinquedo. No entanto, outras equipes em sua empresa falaram para você que não precisam de uma CDN. Neste exercício, você criará módulos para o site e a CDN, bem como adicionará os módulos a um modelo.

Durante o processo, você vai:

Adicione um módulo para seu aplicativo.
Crie um modelo do Bicep que usa o módulo.
Adicione outro módulo para a CDN.
Adicione o módulo da CDN ao seu modelo, tornando-o opcional.
Implantar o modelo no Azure.
Examine o histórico de implantação.

Observação

Este exercício é opcional. Se você quiser concluir este exercício, precisará criar uma assinatura do Azure antes de começar. Se você não tiver uma conta do Azure ou não quiser criar uma no momento, leia as instruções para entender as informações que estão sendo apresentadas.

Este exercício usa a extensão Bicep para Visual Studio Code. É necessário que você instale essa extensão no Visual Studio Code.

Observação

Você precisa usar um grupo de recursos para concluir as etapas neste exercício. Você pode usar um grupo de recursos que já criou ou pode criar um novo grupo de recursos especificamente para este exercício. Se você optar por criar um novo grupo de recursos, isso facilitará a limpeza de todos os recursos criados durante a conclusão do exercício. Se você não tiver um grupo de recursos existente ou quiser criar um novo especificamente para este exercício, siga as etapas em Usar o portal do Azure e o Azure Resource Manager para gerenciar grupos de recursos para criar um grupo de recursos usando o portal do Azure ou siga as etapas em Gerenciar grupos de recursos do Azure usando a CLI do Azure para criar um grupo de recursos usando a CLI do Azure.

Observação

Ao longo deste exercício, substitua myResourceGroupName nos exemplos pelo nome de um grupo de recursos existente ou pelo nome do grupo de recursos que você criou para este exercício.

Criar um arquivo do Bicep em branco

Abra o Visual Studio Code.
Crie um arquivo chamado main.bicep.
Salve o arquivo vazio para que Visual Studio Code carregue as ferramentas Bicep.

Você pode selecionar Arquivo>Salvar Como ou Ctrl + S no Windows (⌘ + S no macOS). Certifique-se de lembrar onde salvou o arquivo. Por exemplo, você pode criar uma pasta modelos para salvá-lo.

Criar um módulo para o aplicativo

Crie uma pasta chamada módulos na mesma pasta em que você criou o arquivo main.bicep. Na pasta módulos, crie um arquivo chamado app.bicep. Salve o arquivo.

Adicione o seguinte conteúdo ao arquivo app.bicep:

@description('The Azure region into which the resources should be deployed.')
param location string

@description('The name of the App Service app.')
param appServiceAppName string

@description('The name of the App Service plan.')
param appServicePlanName string

@description('The name of the App Service plan SKU.')
param appServicePlanSkuName string

resource appServicePlan 'Microsoft.Web/serverfarms@2024-04-01' = {
  name: appServicePlanName
  location: location
  sku: {
    name: appServicePlanSkuName
  }
}

resource appServiceApp 'Microsoft.Web/sites@2024-04-01' = {
  name: appServiceAppName
  location: location
  properties: {
    serverFarmId: appServicePlan.id
    httpsOnly: true
  }
}

@description('The default host name of the App Service app.')
output appServiceAppHostName string = appServiceApp.properties.defaultHostName

Esse arquivo implanta um Plano do Serviço de Aplicativo do Azure e um aplicativo. Observe que o módulo é bastante genérico. Ele não inclui suposições sobre os nomes dos recursos ou o SKU do Plano do Serviço de Aplicativo. Isso facilita a reutilização do módulo para implantações diferentes.

Salve as alterações no arquivo.

Adicionar o módulo ao modelo do Bicep

Aqui, você adiciona o módulo do aplicativo ao modelo do Bicep como um ponto de partida.

Abra o arquivo main.bicep.

Adicione os seguintes parâmetros e variável ao arquivo:

@description('The Azure region into which the resources should be deployed.')
param location string = 'westus3'

@description('The name of the App Service app.')
param appServiceAppName string = 'toy-${uniqueString(resourceGroup().id)}'

@description('The name of the App Service plan SKU.')
param appServicePlanSkuName string = 'F1'

var appServicePlanName = 'toy-product-launch-plan'

Como esse é o modelo que você pretende implantar para seus sites de brinquedos, ele é um pouco mais específico. O nome do Plano do Serviço de Aplicativo é definido como uma variável. O parâmetro do SKU tem um valor padrão que faz sentido para o site de lançamento do brinquedo.

Abaixo dos parâmetros, crie uma linha em branco. Agora, digite a primeira linha da definição do módulo do aplicativo:
```
module app 'modules/app.bicep' = {
```
Conforme você digita, observe que a extensão do Bicep para Visual Studio Code ajuda a fazer scaffold da declaração do módulo. Quando você digita o caminho para o módulo e o caractere de igual (=), um menu pop-up é exibido com várias opções.
Selecione Propriedades necessárias no menu pop-up:

Conclua a declaração do módulo:

module app 'modules/app.bicep' = {
  name: 'toy-launch-app'
  params: {
    appServiceAppName: appServiceAppName
    appServicePlanName: appServicePlanName
    appServicePlanSkuName: appServicePlanSkuName
    location: location
  }
}

Na parte inferior do arquivo, defina uma saída:

@description('The host name to use to access the website.')
output websiteHostName string = app.outputs.appServiceAppHostName

Salve as alterações no arquivo.

Criar um módulo para a rede de distribuição de conteúdo

Na pasta módulos, crie um arquivo chamado cdn.bicep. Salve o arquivo.

Adicione o seguinte conteúdo ao arquivo cdn.bicep:

@description('The host name (address) of the origin server.')
param originHostName string

@description('The name of the CDN profile.')
param profileName string = 'cdn-${uniqueString(resourceGroup().id)}'

@description('The name of the CDN endpoint')
param endpointName string = 'endpoint-${uniqueString(resourceGroup().id)}'

@description('Indicates whether the CDN endpoint requires HTTPS connections.')
param httpsOnly bool

var originName = 'my-origin'

resource cdnProfile 'Microsoft.Cdn/profiles@2024-09-01' = {
  name: profileName
  location: 'global'
  sku: {
    name: 'Standard_Microsoft'
  }
}

resource endpoint 'Microsoft.Cdn/profiles/endpoints@2024-09-01' = {
  parent: cdnProfile
  name: endpointName
  location: 'global'
  properties: {
    originHostHeader: originHostName
    isHttpAllowed: !httpsOnly
    isHttpsAllowed: true
    queryStringCachingBehavior: 'IgnoreQueryString'
    contentTypesToCompress: [
      'text/plain'
      'text/html'
      'text/css'
      'application/x-javascript'
      'text/javascript'
    ]
    isCompressionEnabled: true
    origins: [
      {
        name: originName
        properties: {
          hostName: originHostName
        }
      }
    ]
  }
}

@description('The host name of the CDN endpoint.')
output endpointHostName string = endpoint.properties.hostName

Esse arquivo implanta dois recursos: um perfil de CDN e um ponto de extremidade de CDN.

Salve as alterações no arquivo.

Adicionar os módulos ao modelo principal do Bicep

Abra o arquivo main.bicep.

Abaixo do parâmetro appServicePlanSkuName, adicione os seguintes parâmetros:

@description('Indicates whether a CDN should be deployed.')
param deployCdn bool = true

Abaixo da definição do módulo app, defina o módulo cdn:
```
module cdn 'modules/cdn.bicep' = if (deployCdn) {
  name: 'toy-launch-cdn'
  params: {
    httpsOnly: true
    originHostName: app.outputs.appServiceAppHostName
  }
}
```
Observe que o módulo tem uma condição para que seja implantado somente quando o valor do parâmetro deployCdn for definido como true. Além disso, observe que o parâmetro do módulo originHostName é definido como o valor da saída appServiceAppHostName do módulo app.
Atualize a saída do nome do host para que ela selecione o nome de host correto. Quando uma CDN é implantada, você deseja que o nome do host seja o do ponto de extremidade da CDN.
```
output websiteHostName string = deployCdn ? cdn.outputs.endpointHostName : app.outputs.appServiceAppHostName
```
Salve as alterações no arquivo.

Verificar o arquivo Bicep

Depois de concluir todas as alterações anteriores, o arquivo main.bicep deverá ser semelhante a este exemplo:

@description('The Azure region into which the resources should be deployed.')
param location string = 'westus3'

@description('The name of the App Service app.')
param appServiceAppName string = 'toy-${uniqueString(resourceGroup().id)}'

@description('The name of the App Service plan SKU.')
param appServicePlanSkuName string = 'F1'

@description('Indicates whether a CDN should be deployed.')
param deployCdn bool = true

var appServicePlanName = 'toy-product-launch-plan'

module app 'modules/app.bicep' = {
  name: 'toy-launch-app'
  params: {
    appServiceAppName: appServiceAppName
    appServicePlanName: appServicePlanName
    appServicePlanSkuName: appServicePlanSkuName
    location: location
  }
}

module cdn 'modules/cdn.bicep' = if (deployCdn) {
  name: 'toy-launch-cdn'
  params: {
    httpsOnly: true
    originHostName: app.outputs.appServiceAppHostName
  }
}

@description('The host name to use to access the website.')
output websiteHostName string = deployCdn ? cdn.outputs.endpointHostName : app.outputs.appServiceAppHostName

Caso contrário, copie o exemplo ou ajuste o modelo para que ele corresponda ao exemplo.

Implantar o modelo Bicep no Azure

Para implantar esse modelo no Azure, será necessário entrar em sua conta do Azure do terminal do Visual Studio Code. Verifique se você instalou as ferramentas da CLI do Azure .

No menu Terminal, selecione Novo Terminal. A janela do terminal geralmente é aberta na metade inferior da tela.
Se a janela do terminal exibir bash no lado direito, significa que o shell correto já está aberto. Alternativamente, se você vir um ícone do shell bash à direita, você poderá selecioná-lo para iniciar o shell.

Se aparecer um shell diferente do bash, selecione a seta da lista de seleção do shell e selecione Git Bash.
No terminal, vá até o diretório no qual você salvou o modelo. Por exemplo, se você salvou o modelo na pasta modelos, use este comando:
```
cd templates
```

Instalar o Bicep

Veja se você tem a versão mais recente do Bicep executando o seguinte comando:

az bicep install && az bicep upgrade

No terminal do Visual Studio Code, entre no Azure executando o seguinte comando:
```
az login
```
No navegador que é aberto, entre em sua conta do Azure.

O terminal do Visual Studio Code exibe uma lista das assinaturas associadas a essa conta.
Na lista, localize a assinatura que você deseja usar para este exercício.

Se você perdeu a lista do login, pode usar o trecho de código a seguir para listar suas assinaturas novamente.
```
az account list --output table
```
Defina a assinatura padrão para todos os comandos da CLI do Azure executados nesta sessão.
```
az account set --subscription "Your Subscription Name or ID"
```

Implantar o modelo no Azure

Execute o código a seguir no terminal do Visual Studio Code para implantar o modelo Bicep no Azure. Esse processo pode levar um minuto ou dois para ser concluído e você terá uma implantação bem-sucedida.

az deployment group create --name main --template-file main.bicep

O status Running... aparece no terminal.

Para implantar esse modelo no Azure, entre na sua conta do Azure por meio do terminal do Visual Studio Code. Verifique se você instalou o Azure PowerShell.

No menu Terminal, selecione Novo Terminal. A janela do terminal geralmente é aberta na metade inferior da tela.
Se a janela do terminal exibir pwsh ou powershell no lado direito, significa que o shell correto já está aberto. Como alternativa, se você vir um ícone do shell do PowerShell à direita, você poderá selecioná-lo para iniciar o shell.

Se um shell diferente de pwsh ou powershell aparecer, selecione a seta suspensa do shell e, em seguida, selecione PowerShell.
No terminal, vá até o diretório no qual você salvou o modelo. Por exemplo, se você salvou o modelo na pasta modelos, use este comando:
```
Set-Location -Path templates
```

Instalar a CLI do Bicep

Para usar o Bicep no Azure PowerShell, instale a CLI do Bicep.

No terminal do Visual Studio Code, entre no Azure executando o seguinte comando:
```
Connect-AzAccount
```
No navegador que é aberto, entre em sua conta do Azure.
Obtenha a ID da assinatura que você deseja usar para este exercício executando o seguinte comando:
```
Get-AzSubscription
```
A ID da assinatura será a segunda coluna. Copie a segunda coluna. Parece algo como aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e4e4e.
Defina a assinatura padrão para todos os comandos do Azure PowerShell executados nesta sessão.
```
Set-AzContext -SubscriptionId {Your subscription ID}
```

Implantar o modelo no Azure

Implante o modelo no Azure usando o comando do Azure PowerShell a seguir no terminal. Isso pode levar um minuto ou dois para ser concluído e você terá uma implantação bem-sucedida.

New-AzResourceGroupDeployment -Name main -TemplateFile main.bicep

Examinar o histórico de implantação

Entre no portal do Azure e verifique se você está usando a assinatura apropriada:
1. Selecione seu avatar no canto superior direito da página.
2. Selecione Mudar diretório. Na lista, escolha o diretório apropriado.
No painel do lado esquerdo, selecione Grupos de recursos.
Selecione myResourceGroupName.
No menu à esquerda, selecione Implantações em Configurações.

Três implantações são listadas.
Selecione a implantação principal e expanda Detalhes da implantação.

Observe que ambos os módulos estão listados e que seus tipos são exibidos como Microsoft.Resources/deployments. Os módulos são listados duas vezes porque suas saídas também são referenciadas dentro do modelo.
Selecione as implantações toy-launch-cdn e toy-launch-app e examine os recursos implantados em cada um. Observe que eles correspondem aos recursos definidos no respectivo módulo.

Testar o site

Selecione a implantação toy-launch-app.
Selecione Saídas.
Selecione o botão de cópia para a saída appServiceAppHostName.
Em uma nova guia do navegador, tente ir para o endereço que você copiou na etapa anterior. O endereço deve começar com https://.

A página inicial do Serviço de Aplicativo é exibida, mostrando que você implantou com êxito o aplicativo.
Vá para a implantação principal e selecione Saídas.
Copie o valor da saída websiteHostName. Observe que esse nome de host é diferente, pois é um nome de host da Rede de Distribuição de Conteúdo do Azure.
Em uma nova guia do navegador, tente ir para o nome do host que você copiou na etapa anterior. Adicione https:// ao início do endereço.

Os pontos de extremidade da CDN levam alguns minutos para se tornar ativos. Se você vir um erro Página não encontrada, aguarde alguns minutos e tente colar o link novamente. Além disso, certifique-se de que você adicionou https:// ao início da URL para que você esteja usando HTTPS.

Quando o ponto de extremidade da CDN estiver ativo, você obterá a mesma página inicial do Serviço de Aplicativo. Desta vez, ele foi servido por meio do serviço de Rede de Distribuição de Conteúdo do Azure, o que ajuda a melhorar o desempenho do site.

Comentários

Esta página foi útil?

Exercício – Criar e usar um módulo

Criar um arquivo do Bicep em branco

Criar um módulo para o aplicativo

Adicionar o módulo ao modelo do Bicep

Criar um módulo para a rede de distribuição de conteúdo

Adicionar os módulos ao modelo principal do Bicep

Verificar o arquivo Bicep

Implantar o modelo Bicep no Azure

Instalar o Bicep

Entrar no Azure usando a CLI do Azure

Implantar o modelo no Azure

Instalar a CLI do Bicep

Entrar no Azure usando o Azure PowerShell

Implantar o modelo no Azure

Examinar o histórico de implantação

Testar o site

Comentários