Partager via

Microsoft.Web staticSites 2021-02-01

  • Article

Définition de ressource Bicep

Le type de ressource staticSites peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Web/staticSites, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.Web/staticSites@2021-02-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    allowConfigFileUpdates: bool
    branch: 'string'
    buildProperties: {
      apiBuildCommand: 'string'
      apiLocation: 'string'
      appArtifactLocation: 'string'
      appBuildCommand: 'string'
      appLocation: 'string'
      githubActionSecretNameOverride: 'string'
      outputLocation: 'string'
      skipGithubActionWorkflowGeneration: bool
    }
    repositoryToken: 'string'
    repositoryUrl: 'string'
    stagingEnvironmentPolicy: 'string'
    templateProperties: {
      description: 'string'
      isPrivate: bool
      owner: 'string'
      repositoryName: 'string'
      templateRepositoryUrl: 'string'
    }
  }
  sku: {
    capabilities: [
      {
        name: 'string'
        reason: 'string'
        value: 'string'
      }
    ]
    capacity: int
    family: 'string'
    locations: [
      'string'
    ]
    name: 'string'
    size: 'string'
    skuCapacity: {
      default: int
      elasticMaximum: int
      maximum: int
      minimum: int
      scaleType: 'string'
    }
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

Capacité

Nom Description Valeur
nom Nom de la fonctionnalité de référence SKU. corde
raison Raison de la fonctionnalité de référence SKU. corde
valeur Valeur de la fonctionnalité de référence SKU. corde

ManagedServiceIdentity

Nom Description Valeur
type Type d’identité de service managé. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités affectées par l’utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nom Description Valeur

Microsoft.Web/staticSites

Nom Description Valeur
identité Identité du service managé. ManagedServiceIdentity
gentil Type de ressource. corde
emplacement Emplacement de la ressource. chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés de ressources principales StaticSite
Sku Description d’une référence SKU pour une ressource évolutive. SkuDescription
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

ResourceTags

Nom Description Valeur

SkuCapacity

Nom Description Valeur
faire défaut Nombre de workers par défaut pour cette référence SKU de plan App Service. Int
elasticMaximum Nombre maximal de workers élastiques pour cette référence SKU de plan App Service. Int
maximum Nombre maximal de workers pour cette référence SKU de plan App Service. Int
minimum Nombre minimal de workers pour cette référence SKU de plan App Service. Int
scaleType Configurations de mise à l’échelle disponibles pour un plan App Service. corde

SkuDescription

Nom Description Valeur
Capacités Les fonctionnalités de la référence SKU, par exemple, traffic Manager sont-ils activées ? fonctionnalité[]
capacité Nombre actuel d’instances affectées à la ressource. Int
Famille Code de famille de la référence SKU de ressource. corde
Lieux Emplacements de la référence SKU. string[]
nom Nom de la référence SKU de ressource. corde
taille Spécificateur de taille de la référence SKU de ressource. corde
skuCapacity Valeurs d’échelle min, max et par défaut de la référence SKU. SkuCapacity
niveau Niveau de service de la référence SKU de ressource. corde

StaticSite

Nom Description Valeur
allowConfigFileUpdates <code>false</code> si le fichier de configuration est verrouillé pour cette application web statique ; sinon, <code>true</code>. Bool
branche Branche cible dans le référentiel. corde
buildProperties Générer des propriétés à configurer sur le référentiel. StaticSiteBuildProperties
repositoryToken Jeton de dépôt github d’un utilisateur. Il est utilisé pour configurer le fichier de flux de travail Github Actions et les secrets d’API. corde
repositoryUrl URL du référentiel du site statique. corde
stagingEnvironmentPolicy État indiquant si les environnements intermédiaires sont autorisés ou non pour une application web statique. 'Désactivé'
'Activé'
templateProperties Options de modèle pour générer un nouveau référentiel. StaticSiteTemplateOptions

StaticSiteBuildProperties

Nom Description Valeur
apiBuildCommand Commande personnalisée à exécuter pendant le déploiement de l’application API Azure Functions. corde
apiLocation Chemin d’accès au code d’API dans le référentiel. corde
appArtifactLocation Déconseillé : chemin d’accès des artefacts d’application après la génération (déconseillé en faveur de OutputLocation) corde
appBuildCommand Commande personnalisée à exécuter pendant le déploiement de l’application de contenu statique. corde
appLocation Chemin d’accès au code de l’application dans le référentiel. corde
githubActionSecretNameOverride Remplacement du nom du secret d’action Github. corde
outputLocation Chemin de sortie de l’application après la génération. corde
skipGithubActionWorkflowGeneration Ignorez la génération du flux de travail Github Action. Bool

StaticSiteTemplateOptions

Nom Description Valeur
description Description du dépôt nouvellement généré. corde
isPrivate Indique si le référentiel nouvellement généré est un dépôt privé. La valeur par défaut est false (c’est-à-dire public). Bool
propriétaire Propriétaire du référentiel nouvellement généré. corde
repositoryName Nom du dépôt nouvellement généré. corde
templateRepositoryUrl URL du référentiel de modèles. Le dépôt nouvellement généré est basé sur celui-ci. corde

UserAssignedIdentity

Nom Description Valeur

Définition de ressource de modèle ARM

Le type de ressource staticSites peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Web/staticSites, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.Web/staticSites",
  "apiVersion": "2021-02-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "allowConfigFileUpdates": "bool",
    "branch": "string",
    "buildProperties": {
      "apiBuildCommand": "string",
      "apiLocation": "string",
      "appArtifactLocation": "string",
      "appBuildCommand": "string",
      "appLocation": "string",
      "githubActionSecretNameOverride": "string",
      "outputLocation": "string",
      "skipGithubActionWorkflowGeneration": "bool"
    },
    "repositoryToken": "string",
    "repositoryUrl": "string",
    "stagingEnvironmentPolicy": "string",
    "templateProperties": {
      "description": "string",
      "isPrivate": "bool",
      "owner": "string",
      "repositoryName": "string",
      "templateRepositoryUrl": "string"
    }
  },
  "sku": {
    "capabilities": [
      {
        "name": "string",
        "reason": "string",
        "value": "string"
      }
    ],
    "capacity": "int",
    "family": "string",
    "locations": [ "string" ],
    "name": "string",
    "size": "string",
    "skuCapacity": {
      "default": "int",
      "elasticMaximum": "int",
      "maximum": "int",
      "minimum": "int",
      "scaleType": "string"
    },
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

Capacité

Nom Description Valeur
nom Nom de la fonctionnalité de référence SKU. corde
raison Raison de la fonctionnalité de référence SKU. corde
valeur Valeur de la fonctionnalité de référence SKU. corde

ManagedServiceIdentity

Nom Description Valeur
type Type d’identité de service managé. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités affectées par l’utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nom Description Valeur

Microsoft.Web/staticSites

Nom Description Valeur
apiVersion Version de l’API '2021-02-01'
identité Identité du service managé. ManagedServiceIdentity
gentil Type de ressource. corde
emplacement Emplacement de la ressource. chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés de ressources principales StaticSite
Sku Description d’une référence SKU pour une ressource évolutive. SkuDescription
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.Web/staticSites'

ResourceTags

Nom Description Valeur

SkuCapacity

Nom Description Valeur
faire défaut Nombre de workers par défaut pour cette référence SKU de plan App Service. Int
elasticMaximum Nombre maximal de workers élastiques pour cette référence SKU de plan App Service. Int
maximum Nombre maximal de workers pour cette référence SKU de plan App Service. Int
minimum Nombre minimal de workers pour cette référence SKU de plan App Service. Int
scaleType Configurations de mise à l’échelle disponibles pour un plan App Service. corde

SkuDescription

Nom Description Valeur
Capacités Les fonctionnalités de la référence SKU, par exemple, traffic Manager sont-ils activées ? fonctionnalité[]
capacité Nombre actuel d’instances affectées à la ressource. Int
Famille Code de famille de la référence SKU de ressource. corde
Lieux Emplacements de la référence SKU. string[]
nom Nom de la référence SKU de ressource. corde
taille Spécificateur de taille de la référence SKU de ressource. corde
skuCapacity Valeurs d’échelle min, max et par défaut de la référence SKU. SkuCapacity
niveau Niveau de service de la référence SKU de ressource. corde

StaticSite

Nom Description Valeur
allowConfigFileUpdates <code>false</code> si le fichier de configuration est verrouillé pour cette application web statique ; sinon, <code>true</code>. Bool
branche Branche cible dans le référentiel. corde
buildProperties Générer des propriétés à configurer sur le référentiel. StaticSiteBuildProperties
repositoryToken Jeton de dépôt github d’un utilisateur. Il est utilisé pour configurer le fichier de flux de travail Github Actions et les secrets d’API. corde
repositoryUrl URL du référentiel du site statique. corde
stagingEnvironmentPolicy État indiquant si les environnements intermédiaires sont autorisés ou non pour une application web statique. 'Désactivé'
'Activé'
templateProperties Options de modèle pour générer un nouveau référentiel. StaticSiteTemplateOptions

StaticSiteBuildProperties

Nom Description Valeur
apiBuildCommand Commande personnalisée à exécuter pendant le déploiement de l’application API Azure Functions. corde
apiLocation Chemin d’accès au code d’API dans le référentiel. corde
appArtifactLocation Déconseillé : chemin d’accès des artefacts d’application après la génération (déconseillé en faveur de OutputLocation) corde
appBuildCommand Commande personnalisée à exécuter pendant le déploiement de l’application de contenu statique. corde
appLocation Chemin d’accès au code de l’application dans le référentiel. corde
githubActionSecretNameOverride Remplacement du nom du secret d’action Github. corde
outputLocation Chemin de sortie de l’application après la génération. corde
skipGithubActionWorkflowGeneration Ignorez la génération du flux de travail Github Action. Bool

StaticSiteTemplateOptions

Nom Description Valeur
description Description du dépôt nouvellement généré. corde
isPrivate Indique si le référentiel nouvellement généré est un dépôt privé. La valeur par défaut est false (c’est-à-dire public). Bool
propriétaire Propriétaire du référentiel nouvellement généré. corde
repositoryName Nom du dépôt nouvellement généré. corde
templateRepositoryUrl URL du référentiel de modèles. Le dépôt nouvellement généré est basé sur celui-ci. corde

UserAssignedIdentity

Nom Description Valeur

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource staticSites peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Web/staticSites, ajoutez le terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/staticSites@2021-02-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "string"
  sku = {
    capabilities = [
      {
        name = "string"
        reason = "string"
        value = "string"
      }
    ]
    capacity = int
    family = "string"
    locations = [
      "string"
    ]
    name = "string"
    size = "string"
    skuCapacity = {
      default = int
      elasticMaximum = int
      maximum = int
      minimum = int
      scaleType = "string"
    }
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      allowConfigFileUpdates = bool
      branch = "string"
      buildProperties = {
        apiBuildCommand = "string"
        apiLocation = "string"
        appArtifactLocation = "string"
        appBuildCommand = "string"
        appLocation = "string"
        githubActionSecretNameOverride = "string"
        outputLocation = "string"
        skipGithubActionWorkflowGeneration = bool
      }
      repositoryToken = "string"
      repositoryUrl = "string"
      stagingEnvironmentPolicy = "string"
      templateProperties = {
        description = "string"
        isPrivate = bool
        owner = "string"
        repositoryName = "string"
        templateRepositoryUrl = "string"
      }
    }
  })
}

Valeurs de propriété

Capacité

Nom Description Valeur
nom Nom de la fonctionnalité de référence SKU. corde
raison Raison de la fonctionnalité de référence SKU. corde
valeur Valeur de la fonctionnalité de référence SKU. corde

ManagedServiceIdentity

Nom Description Valeur
type Type d’identité de service managé. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités affectées par l’utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nom Description Valeur

Microsoft.Web/staticSites

Nom Description Valeur
identité Identité du service managé. ManagedServiceIdentity
gentil Type de ressource. corde
emplacement Emplacement de la ressource. chaîne (obligatoire)
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés de ressources principales StaticSite
Sku Description d’une référence SKU pour une ressource évolutive. SkuDescription
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.Web/staticSites@2021-02-01 »

ResourceTags

Nom Description Valeur

SkuCapacity

Nom Description Valeur
faire défaut Nombre de workers par défaut pour cette référence SKU de plan App Service. Int
elasticMaximum Nombre maximal de workers élastiques pour cette référence SKU de plan App Service. Int
maximum Nombre maximal de workers pour cette référence SKU de plan App Service. Int
minimum Nombre minimal de workers pour cette référence SKU de plan App Service. Int
scaleType Configurations de mise à l’échelle disponibles pour un plan App Service. corde

SkuDescription

Nom Description Valeur
Capacités Les fonctionnalités de la référence SKU, par exemple, traffic Manager sont-ils activées ? fonctionnalité[]
capacité Nombre actuel d’instances affectées à la ressource. Int
Famille Code de famille de la référence SKU de ressource. corde
Lieux Emplacements de la référence SKU. string[]
nom Nom de la référence SKU de ressource. corde
taille Spécificateur de taille de la référence SKU de ressource. corde
skuCapacity Valeurs d’échelle min, max et par défaut de la référence SKU. SkuCapacity
niveau Niveau de service de la référence SKU de ressource. corde

StaticSite

Nom Description Valeur
allowConfigFileUpdates <code>false</code> si le fichier de configuration est verrouillé pour cette application web statique ; sinon, <code>true</code>. Bool
branche Branche cible dans le référentiel. corde
buildProperties Générer des propriétés à configurer sur le référentiel. StaticSiteBuildProperties
repositoryToken Jeton de dépôt github d’un utilisateur. Il est utilisé pour configurer le fichier de flux de travail Github Actions et les secrets d’API. corde
repositoryUrl URL du référentiel du site statique. corde
stagingEnvironmentPolicy État indiquant si les environnements intermédiaires sont autorisés ou non pour une application web statique. 'Désactivé'
'Activé'
templateProperties Options de modèle pour générer un nouveau référentiel. StaticSiteTemplateOptions

StaticSiteBuildProperties

Nom Description Valeur
apiBuildCommand Commande personnalisée à exécuter pendant le déploiement de l’application API Azure Functions. corde
apiLocation Chemin d’accès au code d’API dans le référentiel. corde
appArtifactLocation Déconseillé : chemin d’accès des artefacts d’application après la génération (déconseillé en faveur de OutputLocation) corde
appBuildCommand Commande personnalisée à exécuter pendant le déploiement de l’application de contenu statique. corde
appLocation Chemin d’accès au code de l’application dans le référentiel. corde
githubActionSecretNameOverride Remplacement du nom du secret d’action Github. corde
outputLocation Chemin de sortie de l’application après la génération. corde
skipGithubActionWorkflowGeneration Ignorez la génération du flux de travail Github Action. Bool

StaticSiteTemplateOptions

Nom Description Valeur
description Description du dépôt nouvellement généré. corde
isPrivate Indique si le référentiel nouvellement généré est un dépôt privé. La valeur par défaut est false (c’est-à-dire public). Bool
propriétaire Propriétaire du référentiel nouvellement généré. corde
repositoryName Nom du dépôt nouvellement généré. corde
templateRepositoryUrl URL du référentiel de modèles. Le dépôt nouvellement généré est basé sur celui-ci. corde

UserAssignedIdentity

Nom Description Valeur