Delen via


App Service Environments - Create Or Update

Beschrijving voor het maken of bijwerken van een App Service-omgeving.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}?api-version=2024-11-01

URI-parameters

Name In Vereist Type Description
name
path True

string

Naam van de App Service-omgeving.

resourceGroupName
path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+[^\.]$

Naam van de resourcegroep waartoe de resource behoort.

subscriptionId
path True

string

Uw Azure-abonnements-id. Dit is een tekenreeks met GUID-indeling (bijvoorbeeld 00000000-0000-0000-0000-000000000000000).

api-version
query True

string

API-versie

Aanvraagbody

Name Vereist Type Description
location True

string

Resourcelocatie.

properties.virtualNetwork True

VirtualNetworkProfile

Beschrijving van het virtuele netwerk.

kind

string

Soort resource. Als de resource een app is, kunt u verwijzen naar https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference voor meer informatie over ondersteunde waarden voor soort.

properties.clusterSettings

NameValuePair[]

Aangepaste instellingen voor het wijzigen van het gedrag van de App Service-omgeving.

properties.customDnsSuffixConfiguration

CustomDnsSuffixConfiguration

Volledige weergave van de configuratie van het aangepaste domeinachtervoegsel voor ASEv3.

properties.dedicatedHostCount

integer (int32)

Aantal toegewezen hosts

properties.dnsSuffix

string

DNS-achtervoegsel van de App Service-omgeving.

properties.frontEndScaleFactor

integer (int32)

Schaalfactor voor front-ends.

properties.internalLoadBalancingMode

LoadBalancingMode

Hiermee geeft u op welke eindpunten intern moeten worden gebruikt in het virtuele netwerk voor de App Service-omgeving.

properties.ipsslAddressCount

integer (int32)

Het aantal IP SSL-adressen dat is gereserveerd voor de App Service-omgeving.

properties.multiSize

string

Front-end VM-grootte, bijvoorbeeld 'Gemiddeld', 'Groot'.

properties.networkingConfiguration

AseV3NetworkingConfiguration

Volledige weergave van de netwerkconfiguratie voor een ASE.

properties.upgradePreference

UpgradePreference

Upgradevoorkeur

properties.userWhitelistedIpRanges

string[]

Gebruiker heeft IP-bereiken toegevoegd aan whitelist op ASE-db

properties.zoneRedundant

boolean

Of deze App Service-omgeving zone-redundant is.

tags

object

Resourcetags.

Antwoorden

Name Type Description
200 OK

AppServiceEnvironmentResource

OK

201 Created

AppServiceEnvironmentResource

Gecreëerd

202 Accepted

AppServiceEnvironmentResource

De bewerking wordt uitgevoerd.

Kopteksten

location: string

Other Status Codes

DefaultErrorResponse

Foutreactie van App Service.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

Create or update an App Service Environment.

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase?api-version=2024-11-01

{
  "kind": "Asev3",
  "location": "South Central US",
  "properties": {
    "virtualNetwork": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/delegated"
    }
  }
}

Voorbeeldrespons

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase",
  "name": "test-ase",
  "type": "Microsoft.Web/hostingEnvironments",
  "kind": "ASEV3",
  "location": "South Central US",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "status": "Ready",
    "virtualNetwork": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated",
      "name": "delegated",
      "type": "Microsoft.Network/virtualNetworks/subnets",
      "subnet": ""
    },
    "internalLoadBalancingMode": "None",
    "multiSize": "Standard_D2d_v4",
    "multiRoleCount": null,
    "ipsslAddressCount": 0,
    "dnsSuffix": "test-ase.p.azurewebsites.net",
    "maximumNumberOfMachines": 250,
    "frontEndScaleFactor": 15,
    "suspended": false,
    "clusterSettings": null,
    "userWhitelistedIpRanges": null,
    "hasLinuxWorkers": true,
    "dedicatedHostCount": 0,
    "zoneRedundant": false,
    "networkingConfiguration": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking",
      "properties": {
        "windowsOutboundIpAddresses": [
          "20.88.241.56",
          "20.88.241.9"
        ],
        "linuxOutboundIpAddresses": [
          "20.88.241.56",
          "20.88.241.9"
        ],
        "externalInboundIpAddresses": [
          "52.153.248.36"
        ],
        "internalInboundIpAddresses": [],
        "allowNewPrivateEndpointConnections": false,
        "ftpEnabled": false,
        "remoteDebugEnabled": false,
        "inboundIpAddressOverride": null
      }
    }
  }
}
{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase",
  "name": "test-ase",
  "type": "Microsoft.Web/hostingEnvironments",
  "kind": "ASEV3",
  "location": "South Central US",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "status": "Ready",
    "virtualNetwork": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated",
      "name": "delegated",
      "type": "Microsoft.Network/virtualNetworks/subnets",
      "subnet": ""
    },
    "internalLoadBalancingMode": "None",
    "multiSize": "Standard_D2d_v4",
    "multiRoleCount": null,
    "ipsslAddressCount": 0,
    "dnsSuffix": "test-ase.p.azurewebsites.net",
    "maximumNumberOfMachines": 250,
    "frontEndScaleFactor": 15,
    "suspended": false,
    "clusterSettings": null,
    "userWhitelistedIpRanges": null,
    "hasLinuxWorkers": true,
    "dedicatedHostCount": 0,
    "zoneRedundant": false,
    "networkingConfiguration": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking",
      "properties": {
        "windowsOutboundIpAddresses": [
          "20.88.241.56",
          "20.88.241.9"
        ],
        "linuxOutboundIpAddresses": [
          "20.88.241.56",
          "20.88.241.9"
        ],
        "externalInboundIpAddresses": [
          "52.153.248.36"
        ],
        "internalInboundIpAddresses": [],
        "allowNewPrivateEndpointConnections": false,
        "ftpEnabled": false,
        "remoteDebugEnabled": false,
        "inboundIpAddressOverride": null
      }
    }
  }
}
{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase",
  "name": "test-ase",
  "type": "Microsoft.Web/hostingEnvironments",
  "kind": "ASEV3",
  "location": "South Central US",
  "tags": {},
  "properties": {
    "provisioningState": "Succeeded",
    "status": "Ready",
    "virtualNetwork": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated",
      "name": "delegated",
      "type": "Microsoft.Network/virtualNetworks/subnets",
      "subnet": ""
    },
    "internalLoadBalancingMode": "None",
    "multiSize": "Standard_D2d_v4",
    "multiRoleCount": null,
    "ipsslAddressCount": 0,
    "dnsSuffix": "test-ase.p.azurewebsites.net",
    "maximumNumberOfMachines": 250,
    "frontEndScaleFactor": 15,
    "suspended": false,
    "clusterSettings": null,
    "userWhitelistedIpRanges": null,
    "hasLinuxWorkers": true,
    "dedicatedHostCount": 0,
    "zoneRedundant": false,
    "networkingConfiguration": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking",
      "properties": {
        "windowsOutboundIpAddresses": [
          "20.88.241.56",
          "20.88.241.9"
        ],
        "linuxOutboundIpAddresses": [
          "20.88.241.56",
          "20.88.241.9"
        ],
        "externalInboundIpAddresses": [
          "52.153.248.36"
        ],
        "internalInboundIpAddresses": [],
        "allowNewPrivateEndpointConnections": false,
        "ftpEnabled": false,
        "remoteDebugEnabled": false,
        "inboundIpAddressOverride": null
      }
    }
  }
}

Definities

Name Description
AppServiceEnvironmentResource

ARM-resource voor App Service Environment.

AseV3NetworkingConfiguration

Volledige weergave van de netwerkconfiguratie voor een ASE.

CustomDnsSuffixConfiguration

Volledige weergave van de configuratie van het aangepaste domeinachtervoegsel voor ASEv3.

CustomDnsSuffixProvisioningState
DefaultErrorResponse

Foutreactie van App Service.

Details
Error

Foutmodel.

HostingEnvironmentStatus

Huidige status van de App Service-omgeving.

LoadBalancingMode

Hiermee geeft u op welke eindpunten intern moeten worden gebruikt in het virtuele netwerk voor de App Service-omgeving.

NameValuePair

Naam van waardepaar.

ProvisioningState

Inrichtingsstatus van de App Service-omgeving.

UpgradeAvailability

Of er een upgrade beschikbaar is voor deze App Service-omgeving.

UpgradePreference

Upgradevoorkeur

VirtualNetworkProfile

Specificatie voor het gebruik van een virtueel netwerk.

AppServiceEnvironmentResource

ARM-resource voor App Service Environment.

Name Type Default value Description
id

string

Resource-id.

kind

string

Soort resource. Als de resource een app is, kunt u verwijzen naar https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference voor meer informatie over ondersteunde waarden voor soort.

location

string

Resourcelocatie.

name

string

Resourcenaam.

properties.clusterSettings

NameValuePair[]

Aangepaste instellingen voor het wijzigen van het gedrag van de App Service-omgeving.

properties.customDnsSuffixConfiguration

CustomDnsSuffixConfiguration

Volledige weergave van de configuratie van het aangepaste domeinachtervoegsel voor ASEv3.

properties.dedicatedHostCount

integer (int32)

Aantal toegewezen hosts

properties.dnsSuffix

string

DNS-achtervoegsel van de App Service-omgeving.

properties.frontEndScaleFactor

integer (int32)

Schaalfactor voor front-ends.

properties.hasLinuxWorkers

boolean

Vlag die aangeeft of een ASE Linux-werkrollen heeft of niet

properties.internalLoadBalancingMode

LoadBalancingMode

Hiermee geeft u op welke eindpunten intern moeten worden gebruikt in het virtuele netwerk voor de App Service-omgeving.

properties.ipsslAddressCount

integer (int32)

Het aantal IP SSL-adressen dat is gereserveerd voor de App Service-omgeving.

properties.maximumNumberOfMachines

integer (int32)

Maximum aantal VM's in de App Service-omgeving.

properties.multiRoleCount

integer (int32)

Aantal front-endexemplaren.

properties.multiSize

string

Front-end VM-grootte, bijvoorbeeld 'Gemiddeld', 'Groot'.

properties.networkingConfiguration

AseV3NetworkingConfiguration

Volledige weergave van de netwerkconfiguratie voor een ASE.

properties.provisioningState

ProvisioningState

Inrichtingsstatus van de App Service-omgeving.

properties.status

HostingEnvironmentStatus

Huidige status van de App Service-omgeving.

properties.suspended

boolean

true als de App Service-omgeving is onderbroken; anders, false. De omgeving kan worden onderbroken, bijvoorbeeld wanneer het beheereindpunt niet meer beschikbaar is (waarschijnlijk omdat de NSG het binnenkomende verkeer heeft geblokkeerd).

properties.upgradeAvailability

UpgradeAvailability

Of er een upgrade beschikbaar is voor deze App Service-omgeving.

properties.upgradePreference

UpgradePreference

None

Upgradevoorkeur

properties.userWhitelistedIpRanges

string[]

Gebruiker heeft IP-bereiken toegevoegd aan whitelist op ASE-db

properties.virtualNetwork

VirtualNetworkProfile

Beschrijving van het virtuele netwerk.

properties.zoneRedundant

boolean

Of deze App Service-omgeving zone-redundant is.

tags

object

Resourcetags.

type

string

Type bron

AseV3NetworkingConfiguration

Volledige weergave van de netwerkconfiguratie voor een ASE.

Name Type Description
id

string

Resource-id.

kind

string

Soort resource.

name

string

Resourcenaam.

properties.allowNewPrivateEndpointConnections

boolean

Eigenschap voor het in- en uitschakelen van het maken van een nieuwe privé-eindpuntverbinding op ASE

properties.externalInboundIpAddresses

string[]

properties.ftpEnabled

boolean

Eigenschap voor het in- en uitschakelen van FTP op ASEV3

properties.inboundIpAddressOverride

string

Klant heeft het binnenkomende IP-adres opgegeven. Alleen kunnen worden ingesteld op Ase create.

properties.internalInboundIpAddresses

string[]

properties.linuxOutboundIpAddresses

string[]

properties.remoteDebugEnabled

boolean

Eigenschap voor het in- en uitschakelen van externe foutopsporing op ASEV3

properties.windowsOutboundIpAddresses

string[]

type

string

Type bron

CustomDnsSuffixConfiguration

Volledige weergave van de configuratie van het aangepaste domeinachtervoegsel voor ASEv3.

Name Type Description
id

string

Resource-id.

kind

string

Soort resource.

name

string

Resourcenaam.

properties.certificateUrl

string

De URL die verwijst naar het Azure Key Vault-certificaatgeheim dat moet worden gebruikt als het standaard SSL/TLS-certificaat voor sites met het achtervoegsel van het aangepaste domein.

properties.dnsSuffix

string

Het standaardachtervoegsel voor aangepaste domeinen dat moet worden gebruikt voor alle sites die zijn geïmplementeerd op de ASE.

properties.keyVaultReferenceIdentity

string

De door de gebruiker toegewezen identiteit die moet worden gebruikt voor het omzetten van de sleutelkluiscertificaatverwijzing. Indien niet opgegeven, wordt de door het systeem toegewezen ASE-identiteit gebruikt, indien beschikbaar.

properties.provisioningDetails

string

properties.provisioningState

CustomDnsSuffixProvisioningState

type

string

Type bron

CustomDnsSuffixProvisioningState

Waarde Description
Degraded
Failed
InProgress
Succeeded

DefaultErrorResponse

Foutreactie van App Service.

Name Type Description
error

Error

Foutmodel.

Details

Name Type Description
code

string

Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.

message

string

Gedetailleerde foutbeschrijving en foutopsporingsgegevens.

target

string

Gedetailleerde foutbeschrijving en foutopsporingsgegevens.

Error

Foutmodel.

Name Type Description
code

string

Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.

details

Details[]

Gedetailleerde fouten.

innererror

string

Meer informatie over foutopsporing.

message

string

Gedetailleerde foutbeschrijving en foutopsporingsgegevens.

target

string

Gedetailleerde foutbeschrijving en foutopsporingsgegevens.

HostingEnvironmentStatus

Huidige status van de App Service-omgeving.

Waarde Description
Deleting
Preparing
Ready
Scaling

LoadBalancingMode

Hiermee geeft u op welke eindpunten intern moeten worden gebruikt in het virtuele netwerk voor de App Service-omgeving.

Waarde Description
None
Publishing
Web
Web, Publishing

NameValuePair

Naam van waardepaar.

Name Type Description
name

string

Paarnaam.

value

string

Paarwaarde.

ProvisioningState

Inrichtingsstatus van de App Service-omgeving.

Waarde Description
Canceled
Deleting
Failed
InProgress
Succeeded

UpgradeAvailability

Of er een upgrade beschikbaar is voor deze App Service-omgeving.

Waarde Description
None

Er is momenteel geen upgrade beschikbaar voor deze App Service-omgeving

Ready

Een upgrade is gereed om handmatig te worden gestart in deze App Service-omgeving

UpgradePreference

Upgradevoorkeur

Waarde Description
Early

Deze App Service-omgeving wordt bijgewerkt voordat anderen in dezelfde regio upgradevoorkeur 'Laat' hebben

Late

Deze App Service-omgeving wordt bijgewerkt nadat anderen in dezelfde regio upgradevoorkeur 'Vroeg' hebben

Manual

Alleen ASEv3. Zodra een upgrade beschikbaar is, wacht deze App Service-omgeving 10 dagen totdat de upgrade handmatig is gestart. Na 10 dagen wordt de upgrade automatisch gestart

None

Geen voorkeur voor wanneer deze App Service-omgeving wordt bijgewerkt

VirtualNetworkProfile

Specificatie voor het gebruik van een virtueel netwerk.

Name Type Description
id

string

Resource-id van het virtuele netwerk.

name

string

Naam van het virtuele netwerk (alleen-lezen).

subnet

string

Subnet binnen het virtuele netwerk.

type

string

Resourcetype van het virtuele netwerk (alleen-lezen).