Microsoft.Web staticSites 2021-01-01

  • Artikel

Bicep-Ressourcendefinition

Der staticSites-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die folgendes zum Ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Web/staticSites-Ressource zu erstellen, fügen Sie Der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.Web/staticSites@2021-01-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  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'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  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'
    }
  }
}

Eigenschaftswerte

staticSites

Name Beschreibung Wert
name Der Ressourcenname Zeichenfolge (erforderlich)
location Ressourcenspeicherort. Zeichenfolge (erforderlich)
tags Ressourcentags. Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
sku Beschreibung einer SKU für eine skalierbare Ressource. SkuDescription
kind Art der Ressource. Zeichenfolge
identity Verwaltete Dienstidentität. ManagedServiceIdentity
properties Kernressourceneigenschaften StaticSite

ManagedServiceIdentity

Name Beschreibung Wert
type Typ der verwalteten Dienstidentität. "Keine"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
userAssignedIdentities Die Liste der benutzerseitig zugewiesenen Identitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs in der Form : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} Objekt (object)

StaticSite

Name Beschreibung Wert
allowConfigFileUpdates false , wenn die Konfigurationsdatei für diese statische Web-App gesperrt ist; trueandernfalls . bool
Verzweigung Der Zielbranch im Repository. Zeichenfolge
buildProperties Erstellen Sie Eigenschaften, die für das Repository konfiguriert werden sollen. StaticSiteBuildProperties
repositoryToken Das Github-Repositorytoken eines Benutzers. Dies wird verwendet, um die Github Actions-Workflowdatei und API-Geheimnisse einzurichten. Zeichenfolge
repositoryUrl URL für das Repository der statischen Website. Zeichenfolge
stagingEnvironmentPolicy Zustand, der angibt, ob Stagingumgebungen für eine statische Web-App zulässig sind oder nicht. "Deaktiviert"
"Aktiviert"
templateProperties Vorlagenoptionen zum Generieren eines neuen Repositorys. StaticSiteTemplateOptions

StaticSiteBuildProperties

Name Beschreibung Wert
apiBuildCommand Ein benutzerdefinierter Befehl, der während der Bereitstellung der Azure Functions API-Anwendung ausgeführt werden soll. Zeichenfolge
apiLocation Der Pfad zum API-Code im Repository. Zeichenfolge
appArtifactLocation Veraltet: Der Pfad der App-Artefakte nach dem Erstellen (zugunsten von OutputLocation veraltet) Zeichenfolge
appBuildCommand Ein benutzerdefinierter Befehl, der während der Bereitstellung der Anwendung für statische Inhalte ausgeführt werden soll. Zeichenfolge
appLocation Der Pfad zum App-Code im Repository. Zeichenfolge
githubActionSecretNameOverride Überschreiben des GitHub Action-Geheimnisnamens. Zeichenfolge
outputLocation Der Ausgabepfad der App nach dem Erstellen. Zeichenfolge
skipGithubActionWorkflowGeneration Überspringen Sie die GitHub Action-Workflowgenerierung. bool

StaticSiteTemplateOptions

Name Beschreibung Wert
description Beschreibung des neu generierten Repositorys. Zeichenfolge
Isprivate Gibt an, ob es sich bei dem neu generierten Repository um ein privates Repository handelt. Der Standardwert ist false (d. h. öffentlich). bool
owner Besitzer des neu generierten Repositorys. Zeichenfolge
repositoryName Name des neu generierten Repositorys. Zeichenfolge
templateRepositoryUrl URL des Vorlagenrepositorys. Das neu generierte Repository basiert auf diesem Repository. Zeichenfolge

SkuDescription

Name Beschreibung Wert
capabilities Funktionen der SKU, z. B. Ist traffic manager aktiviert? Funktion[]
Kapazität Aktuelle Anzahl von Instanzen, die der Ressource zugewiesen sind. INT
family Familiencode der Ressourcen-SKU. Zeichenfolge
locations Speicherorte der SKU. string[]
name Name der Ressourcen-SKU. Zeichenfolge
size Größenspezifizierer der Ressourcen-SKU. Zeichenfolge
skuCapacity Mindest-, Max- und Standardskalierungswerte der SKU. SkuCapacity
Ebene Dienstebene der Ressourcen-SKU. Zeichenfolge

Funktion

Name Beschreibung Wert
name Name der SKU-Funktion. Zeichenfolge
reason Grund der SKU-Funktion. Zeichenfolge
value Wert der SKU-Funktion. Zeichenfolge

SkuCapacity

Name Beschreibung Wert
default Standardanzahl von Workern für diese App Service Plan-SKU. INT
elasticMaximum Maximale Anzahl von Elastic-Workern für diese App Service Plan-SKU. INT
maximum Maximale Anzahl von Workern für diese App Service Plan-SKU. INT
minimum Mindestanzahl von Workern für diese App Service Plan-SKU. INT
scaleType Verfügbare Skalierungskonfigurationen für einen App Service-Plan. Zeichenfolge

Ressourcendefinition mit einer ARM-Vorlage

Der ressourcentyp staticSites kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Web/staticSites-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.Web/staticSites",
  "apiVersion": "2021-01-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "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"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "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"
    }
  }
}

Eigenschaftswerte

staticSites

Name Beschreibung Wert
type Ressourcentyp "Microsoft.Web/staticSites"
apiVersion Die Ressourcen-API-Version '2021-01-01'
name Der Ressourcenname Zeichenfolge (erforderlich)
location Ressourcenspeicherort. Zeichenfolge (erforderlich)
tags Ressourcentags. Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
sku Beschreibung einer SKU für eine skalierbare Ressource. SkuDescription
kind Art der Ressource. Zeichenfolge
identity Verwaltete Dienstidentität. ManagedServiceIdentity
properties Kernressourceneigenschaften StaticSite

ManagedServiceIdentity

Name Beschreibung Wert
type Typ der verwalteten Dienstidentität. "Keine"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
userAssignedIdentities Die Liste der benutzerseitig zugewiesenen Identitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs in der Form : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} Objekt (object)

StaticSite

Name Beschreibung Wert
allowConfigFileUpdates false , wenn die Konfigurationsdatei für diese statische Web-App gesperrt ist; trueandernfalls . bool
Verzweigung Der Zielbranch im Repository. Zeichenfolge
buildProperties Erstellen Sie Eigenschaften, die für das Repository konfiguriert werden sollen. StaticSiteBuildProperties
repositoryToken Das Github-Repositorytoken eines Benutzers. Dies wird verwendet, um die Github Actions-Workflowdatei und API-Geheimnisse einzurichten. Zeichenfolge
repositoryUrl URL für das Repository der statischen Website. Zeichenfolge
stagingEnvironmentPolicy Zustand, der angibt, ob Stagingumgebungen für eine statische Web-App zulässig sind oder nicht. "Deaktiviert"
"Aktiviert"
templateProperties Vorlagenoptionen zum Generieren eines neuen Repositorys. StaticSiteTemplateOptions

StaticSiteBuildProperties

Name Beschreibung Wert
apiBuildCommand Ein benutzerdefinierter Befehl, der während der Bereitstellung der Azure Functions API-Anwendung ausgeführt werden soll. Zeichenfolge
apiLocation Der Pfad zum API-Code im Repository. Zeichenfolge
appArtifactLocation Veraltet: Der Pfad der App-Artefakte nach dem Erstellen (zugunsten von OutputLocation veraltet) Zeichenfolge
appBuildCommand Ein benutzerdefinierter Befehl, der während der Bereitstellung der Anwendung für statische Inhalte ausgeführt werden soll. Zeichenfolge
appLocation Der Pfad zum App-Code im Repository. Zeichenfolge
githubActionSecretNameOverride Der Name des Github Action-Geheimnisses wird außer Kraft gesetzt. Zeichenfolge
outputLocation Der Ausgabepfad der App nach dem Erstellen. Zeichenfolge
skipGithubActionWorkflowGeneration Überspringen Sie die Github Action-Workflowgenerierung. bool

StaticSiteTemplateOptions

Name Beschreibung Wert
description Beschreibung des neu generierten Repositorys. Zeichenfolge
Isprivate Gibt an, ob es sich bei dem neu generierten Repository um ein privates Repository handelt oder nicht. Standardwert ist false (d. h. öffentlich). bool
owner Besitzer des neu generierten Repositorys. Zeichenfolge
repositoryName Name des neu generierten Repositorys. Zeichenfolge
templateRepositoryUrl URL des Vorlagenrepositorys. Das neu generierte Repository basiert auf diesem Repository. Zeichenfolge

SkuDescription

Name Beschreibung Wert
capabilities Funktionen der SKU, z. B. ist der Datenverkehrs-Manager aktiviert? Funktion[]
Kapazität Aktuelle Anzahl von Instanzen, die der Ressource zugewiesen sind. INT
family Familiencode der Ressourcen-SKU. Zeichenfolge
locations Speicherorte der SKU. string[]
name Name der Ressourcen-SKU. Zeichenfolge
size Größenspezifizierer der Ressourcen-SKU. Zeichenfolge
skuCapacity Min., max. und Standardwerte der SKU. SkuCapacity
Ebene Dienstebene der Ressourcen-SKU. Zeichenfolge

Funktion

Name Beschreibung Wert
name Name der SKU-Funktion. Zeichenfolge
reason Grund der SKU-Funktion. Zeichenfolge
value Wert der SKU-Funktion. Zeichenfolge

SkuCapacity

Name Beschreibung Wert
default Standardanzahl von Workern für diese App Service Plan-SKU. INT
elasticMaximum Maximale Anzahl von Elastischen Workern für diese App Service Plan-SKU. INT
maximum Maximale Anzahl von Workern für diese App Service Plan-SKU. INT
minimum Mindestanzahl von Workern für diese App Service Plan-SKU. INT
scaleType Verfügbare Skalierungskonfigurationen für einen App Service-Plan. Zeichenfolge

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der staticSites-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die folgendes zum Ziel haben:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Web/staticSites-Ressource zu erstellen, fügen Sie Der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/staticSites@2021-01-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  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"
      }
    }
    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"
    }
    kind = "string"
  })
}

Eigenschaftswerte

staticSites

Name Beschreibung Wert
type Ressourcentyp "Microsoft.Web/staticSites@2021-01-01"
name Der Ressourcenname Zeichenfolge (erforderlich)
location Ressourcenspeicherort. Zeichenfolge (erforderlich)
parent_id Verwenden Sie zum Bereitstellen in einer Ressourcengruppe die ID dieser Ressourcengruppe. Zeichenfolge (erforderlich)
tags Ressourcentags. Wörterbuch der Tagnamen und -werte.
sku Beschreibung einer SKU für eine skalierbare Ressource. SkuDescription
kind Art der Ressource. Zeichenfolge
identity Verwaltete Dienstidentität. ManagedServiceIdentity
properties Kernressourceneigenschaften StaticSite

ManagedServiceIdentity

Name Beschreibung Wert
type Typ der verwalteten Dienstidentität. "SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
identity_ids Die Liste der benutzerseitig zugewiesenen Identitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} Array von Benutzeridentitäts-IDs.

StaticSite

Name Beschreibung Wert
allowConfigFileUpdates false , wenn die Konfigurationsdatei für diese statische Web-App gesperrt ist; trueandernfalls . bool
Verzweigung Der Zielbranch im Repository. Zeichenfolge
buildProperties Erstellen Von Eigenschaften, die für das Repository konfiguriert werden sollen. StaticSiteBuildProperties
repositoryToken Das GitHub-Repositorytoken eines Benutzers. Dies wird verwendet, um die Github Actions-Workflowdatei und API-Geheimnisse einzurichten. Zeichenfolge
repositoryUrl URL für das Repository der statischen Website. Zeichenfolge
stagingEnvironmentPolicy Status, der angibt, ob Stagingumgebungen für eine statische Web-App zulässig oder nicht zulässig sind. "Deaktiviert"
"Aktiviert"
templateProperties Vorlagenoptionen zum Generieren eines neuen Repositorys. StaticSiteTemplateOptions

StaticSiteBuildProperties

Name Beschreibung Wert
apiBuildCommand Ein benutzerdefinierter Befehl, der während der Bereitstellung der Azure Functions-API-Anwendung ausgeführt werden soll. Zeichenfolge
apiLocation Der Pfad zum API-Code im Repository. Zeichenfolge
appArtifactLocation Veraltet: Der Pfad der App-Artefakte nach dem Erstellen (veraltet zugunsten von OutputLocation) Zeichenfolge
appBuildCommand Ein benutzerdefinierter Befehl, der während der Bereitstellung der Anwendung für statische Inhalte ausgeführt werden soll. Zeichenfolge
appLocation Der Pfad zum App-Code im Repository. Zeichenfolge
githubActionSecretNameOverride Überschreiben des GitHub Action-Geheimnisnamens. Zeichenfolge
outputLocation Der Ausgabepfad der App nach dem Erstellen. Zeichenfolge
skipGithubActionWorkflowGeneration Überspringen Sie die GitHub Action-Workflowgenerierung. bool

StaticSiteTemplateOptions

Name Beschreibung Wert
description Beschreibung des neu generierten Repositorys. Zeichenfolge
Isprivate Gibt an, ob es sich bei dem neu generierten Repository um ein privates Repository handelt. Der Standardwert ist false (d. h. öffentlich). bool
owner Besitzer des neu generierten Repositorys. Zeichenfolge
repositoryName Name des neu generierten Repositorys. Zeichenfolge
templateRepositoryUrl URL des Vorlagenrepositorys. Das neu generierte Repository basiert auf diesem Repository. Zeichenfolge

SkuDescription

Name Beschreibung Wert
capabilities Funktionen der SKU, z. B. Ist traffic manager aktiviert? Funktion[]
Kapazität Aktuelle Anzahl von Instanzen, die der Ressource zugewiesen sind. INT
family Familiencode der Ressourcen-SKU. Zeichenfolge
locations Speicherorte der SKU. string[]
name Name der Ressourcen-SKU. Zeichenfolge
size Größenspezifizierer der Ressourcen-SKU. Zeichenfolge
skuCapacity Mindest-, Max- und Standardskalierungswerte der SKU. SkuCapacity
Ebene Dienstebene der Ressourcen-SKU. Zeichenfolge

Funktion

Name Beschreibung Wert
name Name der SKU-Funktion. Zeichenfolge
reason Grund der SKU-Funktion. Zeichenfolge
value Wert der SKU-Funktion. Zeichenfolge

SkuCapacity

Name Beschreibung Wert
default Standardanzahl von Workern für diese App Service Plan-SKU. INT
elasticMaximum Maximale Anzahl von Elastic-Workern für diese App Service Plan-SKU. INT
maximum Maximale Anzahl von Workern für diese App Service Plan-SKU. INT
minimum Mindestanzahl von Workern für diese App Service Plan-SKU. INT
scaleType Verfügbare Skalierungskonfigurationen für einen App Service-Plan. Zeichenfolge