web.azure.com/v1api20220301
APIVersion
Value | Description |
---|---|
“2022-03-01” |
ServerFarm
Generator information: - Generated from: /web/resource-manager/Microsoft.Web/stable/2022-03-01/AppServicePlans.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
Used by: ServerFarmList.
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ObjectMeta | ||
spec | ServerFarm_Spec Optional |
|
status | ServerFarm_STATUS Optional |
ServerFarm_Spec
Property | Description | Type |
---|---|---|
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
elasticScaleEnabled | ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku | bool Optional |
extendedLocation | Extended Location. | ExtendedLocation Optional |
freeOfferExpirationTime | The time when the server farm free offer expires. | string Optional |
hostingEnvironmentProfile | Specification for the App Service Environment to use for the App Service plan. | HostingEnvironmentProfile Optional |
hyperV | If Hyper-V container app service plan true , false otherwise. |
bool Optional |
isSpot | If true , this App Service Plan owns spot instances. |
bool Optional |
isXenon | Obsolete: If Hyper-V container app service plan true , false otherwise. |
bool Optional |
kind | Kind of resource. | string Optional |
kubeEnvironmentProfile | Specification for the Kubernetes Environment to use for the App Service plan. | KubeEnvironmentProfile Optional |
location | Resource Location. | string Required |
maximumElasticWorkerCount | Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan | int Optional |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ServerFarmOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
perSiteScaling | If true , apps assigned to this App Service plan can be scaled independently. If false , apps assigned to this App Service plan will scale to all instances of the plan. |
bool Optional |
reserved | If Linux app service plan true , false otherwise. |
bool Optional |
sku | Description of a SKU for a scalable resource. | SkuDescription Optional |
spotExpirationTime | The time when the server farm expires. Valid only if it is a spot server farm. | string Optional |
tags | Resource tags. | map[string]string Optional |
targetWorkerCount | Scaling worker count. | int Optional |
targetWorkerSizeId | Scaling worker size ID. | int Optional |
workerTierName | Target worker tier assigned to the App Service plan. | string Optional |
zoneRedundant | If true , this App Service Plan will perform availability zone balancing. If false , this App Service Plan will not perform availability zone balancing. |
bool Optional |
ServerFarm_STATUS
Property | Description | Type |
---|---|---|
conditions | The observed state of the resource | conditions.Condition[] Optional |
elasticScaleEnabled | ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku | bool Optional |
extendedLocation | Extended Location. | ExtendedLocation_STATUS Optional |
freeOfferExpirationTime | The time when the server farm free offer expires. | string Optional |
geoRegion | Geographical location for the App Service plan. | string Optional |
hostingEnvironmentProfile | Specification for the App Service Environment to use for the App Service plan. | HostingEnvironmentProfile_STATUS Optional |
hyperV | If Hyper-V container app service plan true , false otherwise. |
bool Optional |
id | Resource Id. | string Optional |
isSpot | If true , this App Service Plan owns spot instances. |
bool Optional |
isXenon | Obsolete: If Hyper-V container app service plan true , false otherwise. |
bool Optional |
kind | Kind of resource. | string Optional |
kubeEnvironmentProfile | Specification for the Kubernetes Environment to use for the App Service plan. | KubeEnvironmentProfile_STATUS Optional |
location | Resource Location. | string Optional |
maximumElasticWorkerCount | Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan | int Optional |
maximumNumberOfWorkers | Maximum number of instances that can be assigned to this App Service plan. | int Optional |
name | Resource Name. | string Optional |
numberOfSites | Number of apps assigned to this App Service plan. | int Optional |
numberOfWorkers | The number of instances that are assigned to this App Service plan. | int Optional |
perSiteScaling | If true , apps assigned to this App Service plan can be scaled independently. If false , apps assigned to this App Service plan will scale to all instances of the plan. |
bool Optional |
provisioningState | Provisioning state of the App Service Plan. | Serverfarm_Properties_ProvisioningState_STATUS Optional |
reserved | If Linux app service plan true , false otherwise. |
bool Optional |
resourceGroup | Resource group of the App Service plan. | string Optional |
sku | Description of a SKU for a scalable resource. | SkuDescription_STATUS Optional |
spotExpirationTime | The time when the server farm expires. Valid only if it is a spot server farm. | string Optional |
status | App Service plan status. | Serverfarm_Properties_Status_STATUS Optional |
subscription | App Service plan subscription. | string Optional |
tags | Resource tags. | map[string]string Optional |
targetWorkerCount | Scaling worker count. | int Optional |
targetWorkerSizeId | Scaling worker size ID. | int Optional |
type | Resource type. | string Optional |
workerTierName | Target worker tier assigned to the App Service plan. | string Optional |
zoneRedundant | If true , this App Service Plan will perform availability zone balancing. If false , this App Service Plan will not perform availability zone balancing. |
bool Optional |
ServerFarmList
Generator information: - Generated from: /web/resource-manager/Microsoft.Web/stable/2022-03-01/AppServicePlans.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ListMeta | ||
items | ServerFarm[] Optional |
Site
Generator information: - Generated from: /web/resource-manager/Microsoft.Web/stable/2022-03-01/WebApps.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
Used by: SiteList.
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ObjectMeta | ||
spec | Site_Spec Optional |
|
status | Site_STATUS Optional |
Site_Spec
Property | Description | Type |
---|---|---|
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
clientAffinityEnabled | true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true . |
bool Optional |
clientCertEnabled | true to enable client certificate authentication (TLS mutual authentication); otherwise, false . Default is false . |
bool Optional |
clientCertExclusionPaths | client certificate authentication comma-separated exclusion paths | string Optional |
clientCertMode | This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. | Site_Properties_ClientCertMode_Spec Optional |
cloningInfo | If specified during app creation, the app is cloned from a source app. | CloningInfo Optional |
containerSize | Size of the function container. | int Optional |
customDomainVerificationId | Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. | string Optional |
dailyMemoryTimeQuota | Maximum allowed daily memory-time quota (applicable on dynamic apps only). | int Optional |
enabled | true if the app is enabled; otherwise, false . Setting this value to false disables the app (takes the app offline). |
bool Optional |
extendedLocation | Extended Location. | ExtendedLocation Optional |
hostingEnvironmentProfile | App Service Environment to use for the app. | HostingEnvironmentProfile Optional |
hostNamesDisabled | true to disable the public hostnames of the app; otherwise, false . If true , the app is only accessible via API management process. |
bool Optional |
hostNameSslStates | Hostname SSL states are used to manage the SSL bindings for app’s hostnames. | HostNameSslState[] Optional |
httpsOnly | HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests | bool Optional |
hyperV | Hyper-V sandbox. | bool Optional |
identity | Managed service identity. | ManagedServiceIdentity Optional |
isXenon | Obsolete: Hyper-V sandbox. | bool Optional |
keyVaultReferenceIdentity | Identity to use for Key Vault Reference authentication. | string Optional |
kind | Kind of resource. | string Optional |
location | Resource Location. | string Required |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | SiteOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
publicNetworkAccess | Property to allow or block all public traffic. Allowed Values: ‘Enabled’, ‘Disabled’ or an empty string. | string Optional |
redundancyMode | Site redundancy mode | Site_Properties_RedundancyMode_Spec Optional |
reserved | true if reserved; otherwise, false . |
bool Optional |
scmSiteAlsoStopped | true to stop SCM (KUDU) site when the app is stopped; otherwise, false . The default is false . |
bool Optional |
serverFarmReference | Resource ID of the associated App Service plan, formatted as: “/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”. | genruntime.ResourceReference Optional |
siteConfig | Configuration of the app. | SiteConfig Optional |
storageAccountRequired | Checks if Customer provided storage account is required | bool Optional |
tags | Resource tags. | map[string]string Optional |
virtualNetworkSubnetReference | Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} | genruntime.ResourceReference Optional |
vnetContentShareEnabled | To enable accessing content over virtual network | bool Optional |
vnetImagePullEnabled | To enable pulling image over Virtual Network | bool Optional |
vnetRouteAllEnabled | Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. | bool Optional |
Site_STATUS
Property | Description | Type |
---|---|---|
availabilityState | Management information availability state for the app. | Site_Properties_AvailabilityState_STATUS Optional |
clientAffinityEnabled | true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true . |
bool Optional |
clientCertEnabled | true to enable client certificate authentication (TLS mutual authentication); otherwise, false . Default is false . |
bool Optional |
clientCertExclusionPaths | client certificate authentication comma-separated exclusion paths | string Optional |
clientCertMode | This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. | Site_Properties_ClientCertMode_STATUS Optional |
cloningInfo | If specified during app creation, the app is cloned from a source app. | CloningInfo_STATUS Optional |
conditions | The observed state of the resource | conditions.Condition[] Optional |
containerSize | Size of the function container. | int Optional |
customDomainVerificationId | Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. | string Optional |
dailyMemoryTimeQuota | Maximum allowed daily memory-time quota (applicable on dynamic apps only). | int Optional |
defaultHostName | Default hostname of the app. Read-only. | string Optional |
enabled | true if the app is enabled; otherwise, false . Setting this value to false disables the app (takes the app offline). |
bool Optional |
enabledHostNames | Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. | string[] Optional |
extendedLocation | Extended Location. | ExtendedLocation_STATUS Optional |
hostingEnvironmentProfile | App Service Environment to use for the app. | HostingEnvironmentProfile_STATUS Optional |
hostNames | Hostnames associated with the app. | string[] Optional |
hostNamesDisabled | true to disable the public hostnames of the app; otherwise, false . If true , the app is only accessible via API management process. |
bool Optional |
hostNameSslStates | Hostname SSL states are used to manage the SSL bindings for app’s hostnames. | HostNameSslState_STATUS[] Optional |
httpsOnly | HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests | bool Optional |
hyperV | Hyper-V sandbox. | bool Optional |
id | Resource Id. | string Optional |
identity | Managed service identity. | ManagedServiceIdentity_STATUS Optional |
inProgressOperationId | Specifies an operation id if this site has a pending operation. | string Optional |
isDefaultContainer | true if the app is a default container; otherwise, false . |
bool Optional |
isXenon | Obsolete: Hyper-V sandbox. | bool Optional |
keyVaultReferenceIdentity | Identity to use for Key Vault Reference authentication. | string Optional |
kind | Kind of resource. | string Optional |
lastModifiedTimeUtc | Last time the app was modified, in UTC. Read-only. | string Optional |
location | Resource Location. | string Optional |
maxNumberOfWorkers | Maximum number of workers. This only applies to Functions container. | int Optional |
name | Resource Name. | string Optional |
outboundIpAddresses | List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. | string Optional |
possibleOutboundIpAddresses | List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. | string Optional |
publicNetworkAccess | Property to allow or block all public traffic. Allowed Values: ‘Enabled’, ‘Disabled’ or an empty string. | string Optional |
redundancyMode | Site redundancy mode | Site_Properties_RedundancyMode_STATUS Optional |
repositorySiteName | Name of the repository site. | string Optional |
reserved | true if reserved; otherwise, false . |
bool Optional |
resourceGroup | Name of the resource group the app belongs to. Read-only. | string Optional |
scmSiteAlsoStopped | true to stop SCM (KUDU) site when the app is stopped; otherwise, false . The default is false . |
bool Optional |
serverFarmId | Resource ID of the associated App Service plan, formatted as: “/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”. | string Optional |
siteConfig | Configuration of the app. | SiteConfig_STATUS Optional |
slotSwapStatus | Status of the last deployment slot swap operation. | SlotSwapStatus_STATUS Optional |
state | Current state of the app. | string Optional |
storageAccountRequired | Checks if Customer provided storage account is required | bool Optional |
suspendedTill | App suspended till in case memory-time quota is exceeded. | string Optional |
tags | Resource tags. | map[string]string Optional |
targetSwapSlot | Specifies which deployment slot this app will swap into. Read-only. | string Optional |
trafficManagerHostNames | Azure Traffic Manager hostnames associated with the app. Read-only. | string[] Optional |
type | Resource type. | string Optional |
usageState | State indicating whether the app has exceeded its quota usage. Read-only. | Site_Properties_UsageState_STATUS Optional |
virtualNetworkSubnetId | Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} | string Optional |
vnetContentShareEnabled | To enable accessing content over virtual network | bool Optional |
vnetImagePullEnabled | To enable pulling image over Virtual Network | bool Optional |
vnetRouteAllEnabled | Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. | bool Optional |
SiteList
Generator information: - Generated from: /web/resource-manager/Microsoft.Web/stable/2022-03-01/WebApps.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ListMeta | ||
items | Site[] Optional |
SitesSourcecontrol
Generator information: - Generated from: /web/resource-manager/Microsoft.Web/stable/2022-03-01/WebApps.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
Used by: SitesSourcecontrolList.
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ObjectMeta | ||
spec | SitesSourcecontrol_Spec Optional |
|
status | SitesSourcecontrol_STATUS Optional |
SitesSourcecontrol_Spec
Property | Description | Type |
---|---|---|
branch | Name of branch to use for deployment. | string Optional |
deploymentRollbackEnabled | true to enable deployment rollback; otherwise, false . |
bool Optional |
gitHubActionConfiguration | If GitHub Action is selected, than the associated configuration. | GitHubActionConfiguration Optional |
isGitHubAction | true if this is deployed via GitHub action. |
bool Optional |
isManualIntegration | true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). |
bool Optional |
isMercurial | true for a Mercurial repository; false for a Git repository. |
bool Optional |
kind | Kind of resource. | string Optional |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | SitesSourcecontrolOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a web.azure.com/Site resource | genruntime.KnownResourceReference Required |
repoUrl | Repository or source control URL. | string Optional |
SitesSourcecontrol_STATUS
Property | Description | Type |
---|---|---|
branch | Name of branch to use for deployment. | string Optional |
conditions | The observed state of the resource | conditions.Condition[] Optional |
deploymentRollbackEnabled | true to enable deployment rollback; otherwise, false . |
bool Optional |
gitHubActionConfiguration | If GitHub Action is selected, than the associated configuration. | GitHubActionConfiguration_STATUS Optional |
id | Resource Id. | string Optional |
isGitHubAction | true if this is deployed via GitHub action. |
bool Optional |
isManualIntegration | true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). |
bool Optional |
isMercurial | true for a Mercurial repository; false for a Git repository. |
bool Optional |
kind | Kind of resource. | string Optional |
name | Resource Name. | string Optional |
repoUrl | Repository or source control URL. | string Optional |
type | Resource type. | string Optional |
SitesSourcecontrolList
Generator information: - Generated from: /web/resource-manager/Microsoft.Web/stable/2022-03-01/WebApps.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
Property | Description | Type |
---|---|---|
metav1.TypeMeta | ||
metav1.ListMeta | ||
items | SitesSourcecontrol[] Optional |
ServerFarm_Spec
Used by: ServerFarm.
Property | Description | Type |
---|---|---|
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
elasticScaleEnabled | ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku | bool Optional |
extendedLocation | Extended Location. | ExtendedLocation Optional |
freeOfferExpirationTime | The time when the server farm free offer expires. | string Optional |
hostingEnvironmentProfile | Specification for the App Service Environment to use for the App Service plan. | HostingEnvironmentProfile Optional |
hyperV | If Hyper-V container app service plan true , false otherwise. |
bool Optional |
isSpot | If true , this App Service Plan owns spot instances. |
bool Optional |
isXenon | Obsolete: If Hyper-V container app service plan true , false otherwise. |
bool Optional |
kind | Kind of resource. | string Optional |
kubeEnvironmentProfile | Specification for the Kubernetes Environment to use for the App Service plan. | KubeEnvironmentProfile Optional |
location | Resource Location. | string Required |
maximumElasticWorkerCount | Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan | int Optional |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ServerFarmOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
perSiteScaling | If true , apps assigned to this App Service plan can be scaled independently. If false , apps assigned to this App Service plan will scale to all instances of the plan. |
bool Optional |
reserved | If Linux app service plan true , false otherwise. |
bool Optional |
sku | Description of a SKU for a scalable resource. | SkuDescription Optional |
spotExpirationTime | The time when the server farm expires. Valid only if it is a spot server farm. | string Optional |
tags | Resource tags. | map[string]string Optional |
targetWorkerCount | Scaling worker count. | int Optional |
targetWorkerSizeId | Scaling worker size ID. | int Optional |
workerTierName | Target worker tier assigned to the App Service plan. | string Optional |
zoneRedundant | If true , this App Service Plan will perform availability zone balancing. If false , this App Service Plan will not perform availability zone balancing. |
bool Optional |
ServerFarm_STATUS
Used by: ServerFarm.
Property | Description | Type |
---|---|---|
conditions | The observed state of the resource | conditions.Condition[] Optional |
elasticScaleEnabled | ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku | bool Optional |
extendedLocation | Extended Location. | ExtendedLocation_STATUS Optional |
freeOfferExpirationTime | The time when the server farm free offer expires. | string Optional |
geoRegion | Geographical location for the App Service plan. | string Optional |
hostingEnvironmentProfile | Specification for the App Service Environment to use for the App Service plan. | HostingEnvironmentProfile_STATUS Optional |
hyperV | If Hyper-V container app service plan true , false otherwise. |
bool Optional |
id | Resource Id. | string Optional |
isSpot | If true , this App Service Plan owns spot instances. |
bool Optional |
isXenon | Obsolete: If Hyper-V container app service plan true , false otherwise. |
bool Optional |
kind | Kind of resource. | string Optional |
kubeEnvironmentProfile | Specification for the Kubernetes Environment to use for the App Service plan. | KubeEnvironmentProfile_STATUS Optional |
location | Resource Location. | string Optional |
maximumElasticWorkerCount | Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan | int Optional |
maximumNumberOfWorkers | Maximum number of instances that can be assigned to this App Service plan. | int Optional |
name | Resource Name. | string Optional |
numberOfSites | Number of apps assigned to this App Service plan. | int Optional |
numberOfWorkers | The number of instances that are assigned to this App Service plan. | int Optional |
perSiteScaling | If true , apps assigned to this App Service plan can be scaled independently. If false , apps assigned to this App Service plan will scale to all instances of the plan. |
bool Optional |
provisioningState | Provisioning state of the App Service Plan. | Serverfarm_Properties_ProvisioningState_STATUS Optional |
reserved | If Linux app service plan true , false otherwise. |
bool Optional |
resourceGroup | Resource group of the App Service plan. | string Optional |
sku | Description of a SKU for a scalable resource. | SkuDescription_STATUS Optional |
spotExpirationTime | The time when the server farm expires. Valid only if it is a spot server farm. | string Optional |
status | App Service plan status. | Serverfarm_Properties_Status_STATUS Optional |
subscription | App Service plan subscription. | string Optional |
tags | Resource tags. | map[string]string Optional |
targetWorkerCount | Scaling worker count. | int Optional |
targetWorkerSizeId | Scaling worker size ID. | int Optional |
type | Resource type. | string Optional |
workerTierName | Target worker tier assigned to the App Service plan. | string Optional |
zoneRedundant | If true , this App Service Plan will perform availability zone balancing. If false , this App Service Plan will not perform availability zone balancing. |
bool Optional |
Site_Spec
Used by: Site.
Property | Description | Type |
---|---|---|
azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
clientAffinityEnabled | true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true . |
bool Optional |
clientCertEnabled | true to enable client certificate authentication (TLS mutual authentication); otherwise, false . Default is false . |
bool Optional |
clientCertExclusionPaths | client certificate authentication comma-separated exclusion paths | string Optional |
clientCertMode | This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. | Site_Properties_ClientCertMode_Spec Optional |
cloningInfo | If specified during app creation, the app is cloned from a source app. | CloningInfo Optional |
containerSize | Size of the function container. | int Optional |
customDomainVerificationId | Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. | string Optional |
dailyMemoryTimeQuota | Maximum allowed daily memory-time quota (applicable on dynamic apps only). | int Optional |
enabled | true if the app is enabled; otherwise, false . Setting this value to false disables the app (takes the app offline). |
bool Optional |
extendedLocation | Extended Location. | ExtendedLocation Optional |
hostingEnvironmentProfile | App Service Environment to use for the app. | HostingEnvironmentProfile Optional |
hostNamesDisabled | true to disable the public hostnames of the app; otherwise, false . If true , the app is only accessible via API management process. |
bool Optional |
hostNameSslStates | Hostname SSL states are used to manage the SSL bindings for app’s hostnames. | HostNameSslState[] Optional |
httpsOnly | HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests | bool Optional |
hyperV | Hyper-V sandbox. | bool Optional |
identity | Managed service identity. | ManagedServiceIdentity Optional |
isXenon | Obsolete: Hyper-V sandbox. | bool Optional |
keyVaultReferenceIdentity | Identity to use for Key Vault Reference authentication. | string Optional |
kind | Kind of resource. | string Optional |
location | Resource Location. | string Required |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | SiteOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
publicNetworkAccess | Property to allow or block all public traffic. Allowed Values: ‘Enabled’, ‘Disabled’ or an empty string. | string Optional |
redundancyMode | Site redundancy mode | Site_Properties_RedundancyMode_Spec Optional |
reserved | true if reserved; otherwise, false . |
bool Optional |
scmSiteAlsoStopped | true to stop SCM (KUDU) site when the app is stopped; otherwise, false . The default is false . |
bool Optional |
serverFarmReference | Resource ID of the associated App Service plan, formatted as: “/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”. | genruntime.ResourceReference Optional |
siteConfig | Configuration of the app. | SiteConfig Optional |
storageAccountRequired | Checks if Customer provided storage account is required | bool Optional |
tags | Resource tags. | map[string]string Optional |
virtualNetworkSubnetReference | Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} | genruntime.ResourceReference Optional |
vnetContentShareEnabled | To enable accessing content over virtual network | bool Optional |
vnetImagePullEnabled | To enable pulling image over Virtual Network | bool Optional |
vnetRouteAllEnabled | Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. | bool Optional |
Site_STATUS
A web app, a mobile app backend, or an API app.
Used by: Site.
Property | Description | Type |
---|---|---|
availabilityState | Management information availability state for the app. | Site_Properties_AvailabilityState_STATUS Optional |
clientAffinityEnabled | true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true . |
bool Optional |
clientCertEnabled | true to enable client certificate authentication (TLS mutual authentication); otherwise, false . Default is false . |
bool Optional |
clientCertExclusionPaths | client certificate authentication comma-separated exclusion paths | string Optional |
clientCertMode | This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. | Site_Properties_ClientCertMode_STATUS Optional |
cloningInfo | If specified during app creation, the app is cloned from a source app. | CloningInfo_STATUS Optional |
conditions | The observed state of the resource | conditions.Condition[] Optional |
containerSize | Size of the function container. | int Optional |
customDomainVerificationId | Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. | string Optional |
dailyMemoryTimeQuota | Maximum allowed daily memory-time quota (applicable on dynamic apps only). | int Optional |
defaultHostName | Default hostname of the app. Read-only. | string Optional |
enabled | true if the app is enabled; otherwise, false . Setting this value to false disables the app (takes the app offline). |
bool Optional |
enabledHostNames | Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. | string[] Optional |
extendedLocation | Extended Location. | ExtendedLocation_STATUS Optional |
hostingEnvironmentProfile | App Service Environment to use for the app. | HostingEnvironmentProfile_STATUS Optional |
hostNames | Hostnames associated with the app. | string[] Optional |
hostNamesDisabled | true to disable the public hostnames of the app; otherwise, false . If true , the app is only accessible via API management process. |
bool Optional |
hostNameSslStates | Hostname SSL states are used to manage the SSL bindings for app’s hostnames. | HostNameSslState_STATUS[] Optional |
httpsOnly | HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests | bool Optional |
hyperV | Hyper-V sandbox. | bool Optional |
id | Resource Id. | string Optional |
identity | Managed service identity. | ManagedServiceIdentity_STATUS Optional |
inProgressOperationId | Specifies an operation id if this site has a pending operation. | string Optional |
isDefaultContainer | true if the app is a default container; otherwise, false . |
bool Optional |
isXenon | Obsolete: Hyper-V sandbox. | bool Optional |
keyVaultReferenceIdentity | Identity to use for Key Vault Reference authentication. | string Optional |
kind | Kind of resource. | string Optional |
lastModifiedTimeUtc | Last time the app was modified, in UTC. Read-only. | string Optional |
location | Resource Location. | string Optional |
maxNumberOfWorkers | Maximum number of workers. This only applies to Functions container. | int Optional |
name | Resource Name. | string Optional |
outboundIpAddresses | List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. | string Optional |
possibleOutboundIpAddresses | List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. | string Optional |
publicNetworkAccess | Property to allow or block all public traffic. Allowed Values: ‘Enabled’, ‘Disabled’ or an empty string. | string Optional |
redundancyMode | Site redundancy mode | Site_Properties_RedundancyMode_STATUS Optional |
repositorySiteName | Name of the repository site. | string Optional |
reserved | true if reserved; otherwise, false . |
bool Optional |
resourceGroup | Name of the resource group the app belongs to. Read-only. | string Optional |
scmSiteAlsoStopped | true to stop SCM (KUDU) site when the app is stopped; otherwise, false . The default is false . |
bool Optional |
serverFarmId | Resource ID of the associated App Service plan, formatted as: “/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”. | string Optional |
siteConfig | Configuration of the app. | SiteConfig_STATUS Optional |
slotSwapStatus | Status of the last deployment slot swap operation. | SlotSwapStatus_STATUS Optional |
state | Current state of the app. | string Optional |
storageAccountRequired | Checks if Customer provided storage account is required | bool Optional |
suspendedTill | App suspended till in case memory-time quota is exceeded. | string Optional |
tags | Resource tags. | map[string]string Optional |
targetSwapSlot | Specifies which deployment slot this app will swap into. Read-only. | string Optional |
trafficManagerHostNames | Azure Traffic Manager hostnames associated with the app. Read-only. | string[] Optional |
type | Resource type. | string Optional |
usageState | State indicating whether the app has exceeded its quota usage. Read-only. | Site_Properties_UsageState_STATUS Optional |
virtualNetworkSubnetId | Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} | string Optional |
vnetContentShareEnabled | To enable accessing content over virtual network | bool Optional |
vnetImagePullEnabled | To enable pulling image over Virtual Network | bool Optional |
vnetRouteAllEnabled | Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. | bool Optional |
SitesSourcecontrol_Spec
Used by: SitesSourcecontrol.
Property | Description | Type |
---|---|---|
branch | Name of branch to use for deployment. | string Optional |
deploymentRollbackEnabled | true to enable deployment rollback; otherwise, false . |
bool Optional |
gitHubActionConfiguration | If GitHub Action is selected, than the associated configuration. | GitHubActionConfiguration Optional |
isGitHubAction | true if this is deployed via GitHub action. |
bool Optional |
isManualIntegration | true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). |
bool Optional |
isMercurial | true for a Mercurial repository; false for a Git repository. |
bool Optional |
kind | Kind of resource. | string Optional |
operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | SitesSourcecontrolOperatorSpec Optional |
owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a web.azure.com/Site resource | genruntime.KnownResourceReference Required |
repoUrl | Repository or source control URL. | string Optional |
SitesSourcecontrol_STATUS
Used by: SitesSourcecontrol.
Property | Description | Type |
---|---|---|
branch | Name of branch to use for deployment. | string Optional |
conditions | The observed state of the resource | conditions.Condition[] Optional |
deploymentRollbackEnabled | true to enable deployment rollback; otherwise, false . |
bool Optional |
gitHubActionConfiguration | If GitHub Action is selected, than the associated configuration. | GitHubActionConfiguration_STATUS Optional |
id | Resource Id. | string Optional |
isGitHubAction | true if this is deployed via GitHub action. |
bool Optional |
isManualIntegration | true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). |
bool Optional |
isMercurial | true for a Mercurial repository; false for a Git repository. |
bool Optional |
kind | Kind of resource. | string Optional |
name | Resource Name. | string Optional |
repoUrl | Repository or source control URL. | string Optional |
type | Resource type. | string Optional |
CloningInfo
Information needed for cloning operation.
Used by: Site_Spec.
Property | Description | Type |
---|---|---|
appSettingsOverrides | Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. | map[string]string Optional |
cloneCustomHostNames | true to clone custom hostnames from source app; otherwise, false . |
bool Optional |
cloneSourceControl | true to clone source control from source app; otherwise, false . |
bool Optional |
configureLoadBalancing | true to configure load balancing for source and destination app. |
bool Optional |
correlationId | Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. | string Optional |
hostingEnvironment | App Service Environment. | string Optional |
overwrite | true to overwrite destination app; otherwise, false . |
bool Optional |
sourceWebAppLocation | Location of source app ex: West US or North Europe | string Optional |
sourceWebAppReference | ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. | genruntime.ResourceReference Required |
trafficManagerProfileName | Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. | string Optional |
trafficManagerProfileReference | ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. | genruntime.ResourceReference Optional |
CloningInfo_STATUS
Information needed for cloning operation.
Used by: Site_STATUS.
Property | Description | Type |
---|---|---|
appSettingsOverrides | Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. | map[string]string Optional |
cloneCustomHostNames | true to clone custom hostnames from source app; otherwise, false . |
bool Optional |
cloneSourceControl | true to clone source control from source app; otherwise, false . |
bool Optional |
configureLoadBalancing | true to configure load balancing for source and destination app. |
bool Optional |
correlationId | Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. | string Optional |
hostingEnvironment | App Service Environment. | string Optional |
overwrite | true to overwrite destination app; otherwise, false . |
bool Optional |
sourceWebAppId | ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. | string Optional |
sourceWebAppLocation | Location of source app ex: West US or North Europe | string Optional |
trafficManagerProfileId | ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. | string Optional |
trafficManagerProfileName | Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. | string Optional |
ExtendedLocation
Extended Location.
Used by: ServerFarm_Spec, and Site_Spec.
Property | Description | Type |
---|---|---|
name | Name of extended location. | string Optional |
ExtendedLocation_STATUS
Extended Location.
Used by: ServerFarm_STATUS, and Site_STATUS.
Property | Description | Type |
---|---|---|
name | Name of extended location. | string Optional |
type | Type of extended location. | string Optional |
GitHubActionConfiguration
The GitHub action configuration.
Used by: SitesSourcecontrol_Spec.
Property | Description | Type |
---|---|---|
codeConfiguration | GitHub Action code configuration. | GitHubActionCodeConfiguration Optional |
containerConfiguration | GitHub Action container configuration. | GitHubActionContainerConfiguration Optional |
generateWorkflowFile | Workflow option to determine whether the workflow file should be generated and written to the repository. | bool Optional |
isLinux | This will help determine the workflow configuration to select. | bool Optional |
GitHubActionConfiguration_STATUS
The GitHub action configuration.
Used by: SitesSourcecontrol_STATUS.
Property | Description | Type |
---|---|---|
codeConfiguration | GitHub Action code configuration. | GitHubActionCodeConfiguration_STATUS Optional |
containerConfiguration | GitHub Action container configuration. | GitHubActionContainerConfiguration_STATUS Optional |
generateWorkflowFile | Workflow option to determine whether the workflow file should be generated and written to the repository. | bool Optional |
isLinux | This will help determine the workflow configuration to select. | bool Optional |
HostingEnvironmentProfile
Specification for an App Service Environment to use for this resource.
Used by: ServerFarm_Spec, and Site_Spec.
Property | Description | Type |
---|---|---|
reference | Resource ID of the App Service Environment. | genruntime.ResourceReference Optional |
HostingEnvironmentProfile_STATUS
Specification for an App Service Environment to use for this resource.
Used by: ServerFarm_STATUS, and Site_STATUS.
Property | Description | Type |
---|---|---|
id | Resource ID of the App Service Environment. | string Optional |
name | Name of the App Service Environment. | string Optional |
type | Resource type of the App Service Environment. | string Optional |
HostNameSslState
SSL-enabled hostname.
Used by: Site_Spec.
Property | Description | Type |
---|---|---|
hostType | Indicates whether the hostname is a standard or repository hostname. | HostNameSslState_HostType Optional |
name | Hostname. | string Optional |
sslState | SSL type. | HostNameSslState_SslState Optional |
thumbprint | SSL certificate thumbprint. | string Optional |
toUpdate | Set to true to update existing hostname. |
bool Optional |
virtualIP | Virtual IP address assigned to the hostname if IP based SSL is enabled. | string Optional |
HostNameSslState_STATUS
SSL-enabled hostname.
Used by: Site_STATUS.
Property | Description | Type |
---|---|---|
hostType | Indicates whether the hostname is a standard or repository hostname. | HostNameSslState_HostType_STATUS Optional |
name | Hostname. | string Optional |
sslState | SSL type. | HostNameSslState_SslState_STATUS Optional |
thumbprint | SSL certificate thumbprint. | string Optional |
toUpdate | Set to true to update existing hostname. |
bool Optional |
virtualIP | Virtual IP address assigned to the hostname if IP based SSL is enabled. | string Optional |
KubeEnvironmentProfile
Specification for a Kubernetes Environment to use for this resource.
Used by: ServerFarm_Spec.
Property | Description | Type |
---|---|---|
reference | Resource ID of the Kubernetes Environment. | genruntime.ResourceReference Optional |
KubeEnvironmentProfile_STATUS
Specification for a Kubernetes Environment to use for this resource.
Used by: ServerFarm_STATUS.
Property | Description | Type |
---|---|---|
id | Resource ID of the Kubernetes Environment. | string Optional |
name | Name of the Kubernetes Environment. | string Optional |
type | Resource type of the Kubernetes Environment. | string Optional |
ManagedServiceIdentity
Managed service identity.
Used by: Site_Spec.
Property | Description | Type |
---|---|---|
type | Type of managed service identity. | ManagedServiceIdentity_Type Optional |
userAssignedIdentities | The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} | UserAssignedIdentityDetails[] Optional |
ManagedServiceIdentity_STATUS
Managed service identity.
Used by: Site_STATUS.
Property | Description | Type |
---|---|---|
principalId | Principal Id of managed service identity. | string Optional |
tenantId | Tenant of managed service identity. | string Optional |
type | Type of managed service identity. | ManagedServiceIdentity_Type_STATUS Optional |
userAssignedIdentities | The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} | map[string]UserAssignedIdentity_STATUS Optional |
Serverfarm_Properties_ProvisioningState_STATUS
Used by: ServerFarm_STATUS.
Value | Description |
---|---|
“Canceled” | |
“Deleting” | |
“Failed” | |
“InProgress” | |
“Succeeded” |
Serverfarm_Properties_Status_STATUS
Used by: ServerFarm_STATUS.
Value | Description |
---|---|
“Creating” | |
“Pending” | |
“Ready” |
ServerFarmOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: ServerFarm_Spec.
Property | Description | Type |
---|---|---|
configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
Site_Properties_AvailabilityState_STATUS
Used by: Site_STATUS.
Value | Description |
---|---|
“DisasterRecoveryMode” | |
“Limited” | |
“Normal” |
Site_Properties_ClientCertMode_Spec
Used by: Site_Spec.
Value | Description |
---|---|
“Optional” | |
“OptionalInteractiveUser” | |
“Required” |
Site_Properties_ClientCertMode_STATUS
Used by: Site_STATUS.
Value | Description |
---|---|
“Optional” | |
“OptionalInteractiveUser” | |
“Required” |
Site_Properties_RedundancyMode_Spec
Used by: Site_Spec.
Value | Description |
---|---|
“ActiveActive” | |
“Failover” | |
“GeoRedundant” | |
“Manual” | |
“None” |
Site_Properties_RedundancyMode_STATUS
Used by: Site_STATUS.
Value | Description |
---|---|
“ActiveActive” | |
“Failover” | |
“GeoRedundant” | |
“Manual” | |
“None” |
Site_Properties_UsageState_STATUS
Used by: Site_STATUS.
Value | Description |
---|---|
“Exceeded” | |
“Normal” |
SiteConfig
Configuration of an App Service app.
Used by: Site_Spec.
Property | Description | Type |
---|---|---|
acrUseManagedIdentityCreds | Flag to use Managed Identity Creds for ACR pull | bool Optional |
acrUserManagedIdentityID | If using user managed identity, the user managed identity ClientId | string Optional |
alwaysOn | true if Always On is enabled; otherwise, false . |
bool Optional |
apiDefinition | Information about the formal API definition for the app. | ApiDefinitionInfo Optional |
apiManagementConfig | Azure API management settings linked to the app. | ApiManagementConfig Optional |
appCommandLine | App command line to launch. | string Optional |
appSettings | Application settings. | NameValuePair[] Optional |
autoHealEnabled | true if Auto Heal is enabled; otherwise, false . |
bool Optional |
autoHealRules | Auto Heal rules. | AutoHealRules Optional |
autoSwapSlotName | Auto-swap slot name. | string Optional |
azureStorageAccounts | List of Azure Storage Accounts. | map[string]AzureStorageInfoValue Optional |
connectionStrings | Connection strings. | ConnStringInfo[] Optional |
cors | Cross-Origin Resource Sharing (CORS) settings. | CorsSettings Optional |
defaultDocuments | Default documents. | string[] Optional |
detailedErrorLoggingEnabled | true if detailed error logging is enabled; otherwise, false . |
bool Optional |
documentRoot | Document root. | string Optional |
experiments | This is work around for polymorphic types. | Experiments Optional |
ftpsState | State of FTP / FTPS service | SiteConfig_FtpsState Optional |
functionAppScaleLimit | Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans | int Optional |
functionsRuntimeScaleMonitoringEnabled | Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status. | bool Optional |
handlerMappings | Handler mappings. | HandlerMapping[] Optional |
healthCheckPath | Health check path | string Optional |
http20Enabled | Http20Enabled: configures a web site to allow clients to connect over http2.0 | bool Optional |
httpLoggingEnabled | true if HTTP logging is enabled; otherwise, false . |
bool Optional |
ipSecurityRestrictions | IP security restrictions for main. | IpSecurityRestriction[] Optional |
javaContainer | Java container. | string Optional |
javaContainerVersion | Java container version. | string Optional |
javaVersion | Java version. | string Optional |
keyVaultReferenceIdentity | Identity to use for Key Vault Reference authentication. | string Optional |
limits | Site limits. | SiteLimits Optional |
linuxFxVersion | Linux App Framework and version | string Optional |
loadBalancing | Site load balancing. | SiteConfig_LoadBalancing Optional |
localMySqlEnabled | true to enable local MySQL; otherwise, false . |
bool Optional |
logsDirectorySizeLimit | HTTP logs directory size limit. | int Optional |
managedPipelineMode | Managed pipeline mode. | SiteConfig_ManagedPipelineMode Optional |
managedServiceIdentityId | Managed Service Identity Id | int Optional |
minimumElasticInstanceCount | Number of minimum instance count for a site This setting only applies to the Elastic Plans | int Optional |
minTlsVersion | MinTlsVersion: configures the minimum version of TLS required for SSL requests | SiteConfig_MinTlsVersion Optional |
netFrameworkVersion | .NET Framework version. | string Optional |
nodeVersion | Version of Node.js. | string Optional |
numberOfWorkers | Number of workers. | int Optional |
phpVersion | Version of PHP. | string Optional |
powerShellVersion | Version of PowerShell. | string Optional |
preWarmedInstanceCount | Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans | int Optional |
publicNetworkAccess | Property to allow or block all public traffic. | string Optional |
publishingUsername | Publishing user name. | string Optional |
push | Push endpoint settings. | PushSettings Optional |
pythonVersion | Version of Python. | string Optional |
remoteDebuggingEnabled | true if remote debugging is enabled; otherwise, false . |
bool Optional |
remoteDebuggingVersion | Remote debugging version. | string Optional |
requestTracingEnabled | true if request tracing is enabled; otherwise, false . |
bool Optional |
requestTracingExpirationTime | Request tracing expiration time. | string Optional |
scmIpSecurityRestrictions | IP security restrictions for scm. | IpSecurityRestriction[] Optional |
scmIpSecurityRestrictionsUseMain | IP security restrictions for scm to use main. | bool Optional |
scmMinTlsVersion | ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site | SiteConfig_ScmMinTlsVersion Optional |
scmType | SCM type. | SiteConfig_ScmType Optional |
tracingOptions | Tracing options. | string Optional |
use32BitWorkerProcess | true to use 32-bit worker process; otherwise, false . |
bool Optional |
virtualApplications | Virtual applications. | VirtualApplication[] Optional |
vnetName | Virtual Network name. | string Optional |
vnetPrivatePortsCount | The number of private ports assigned to this app. These will be assigned dynamically on runtime. | int Optional |
vnetRouteAllEnabled | Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. | bool Optional |
websiteTimeZone | Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones | string Optional |
webSocketsEnabled | true if WebSocket is enabled; otherwise, false . |
bool Optional |
windowsFxVersion | Xenon App Framework and version | string Optional |
xManagedServiceIdentityId | Explicit Managed Service Identity Id | int Optional |
SiteConfig_STATUS
Configuration of an App Service app.
Used by: Site_STATUS.
Property | Description | Type |
---|---|---|
acrUseManagedIdentityCreds | Flag to use Managed Identity Creds for ACR pull | bool Optional |
acrUserManagedIdentityID | If using user managed identity, the user managed identity ClientId | string Optional |
alwaysOn | true if Always On is enabled; otherwise, false . |
bool Optional |
apiDefinition | Information about the formal API definition for the app. | ApiDefinitionInfo_STATUS Optional |
apiManagementConfig | Azure API management settings linked to the app. | ApiManagementConfig_STATUS Optional |
appCommandLine | App command line to launch. | string Optional |
appSettings | Application settings. | NameValuePair_STATUS[] Optional |
autoHealEnabled | true if Auto Heal is enabled; otherwise, false . |
bool Optional |
autoHealRules | Auto Heal rules. | AutoHealRules_STATUS Optional |
autoSwapSlotName | Auto-swap slot name. | string Optional |
azureStorageAccounts | List of Azure Storage Accounts. | map[string]AzureStorageInfoValue_STATUS Optional |
connectionStrings | Connection strings. | ConnStringInfo_STATUS[] Optional |
cors | Cross-Origin Resource Sharing (CORS) settings. | CorsSettings_STATUS Optional |
defaultDocuments | Default documents. | string[] Optional |
detailedErrorLoggingEnabled | true if detailed error logging is enabled; otherwise, false . |
bool Optional |
documentRoot | Document root. | string Optional |
experiments | This is work around for polymorphic types. | Experiments_STATUS Optional |
ftpsState | State of FTP / FTPS service | SiteConfig_FtpsState_STATUS Optional |
functionAppScaleLimit | Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans | int Optional |
functionsRuntimeScaleMonitoringEnabled | Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status. | bool Optional |
handlerMappings | Handler mappings. | HandlerMapping_STATUS[] Optional |
healthCheckPath | Health check path | string Optional |
http20Enabled | Http20Enabled: configures a web site to allow clients to connect over http2.0 | bool Optional |
httpLoggingEnabled | true if HTTP logging is enabled; otherwise, false . |
bool Optional |
ipSecurityRestrictions | IP security restrictions for main. | IpSecurityRestriction_STATUS[] Optional |
javaContainer | Java container. | string Optional |
javaContainerVersion | Java container version. | string Optional |
javaVersion | Java version. | string Optional |
keyVaultReferenceIdentity | Identity to use for Key Vault Reference authentication. | string Optional |
limits | Site limits. | SiteLimits_STATUS Optional |
linuxFxVersion | Linux App Framework and version | string Optional |
loadBalancing | Site load balancing. | SiteConfig_LoadBalancing_STATUS Optional |
localMySqlEnabled | true to enable local MySQL; otherwise, false . |
bool Optional |
logsDirectorySizeLimit | HTTP logs directory size limit. | int Optional |
machineKey | Site MachineKey. | SiteMachineKey_STATUS Optional |
managedPipelineMode | Managed pipeline mode. | SiteConfig_ManagedPipelineMode_STATUS Optional |
managedServiceIdentityId | Managed Service Identity Id | int Optional |
minimumElasticInstanceCount | Number of minimum instance count for a site This setting only applies to the Elastic Plans | int Optional |
minTlsVersion | MinTlsVersion: configures the minimum version of TLS required for SSL requests | SiteConfig_MinTlsVersion_STATUS Optional |
netFrameworkVersion | .NET Framework version. | string Optional |
nodeVersion | Version of Node.js. | string Optional |
numberOfWorkers | Number of workers. | int Optional |
phpVersion | Version of PHP. | string Optional |
powerShellVersion | Version of PowerShell. | string Optional |
preWarmedInstanceCount | Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans | int Optional |
publicNetworkAccess | Property to allow or block all public traffic. | string Optional |
publishingUsername | Publishing user name. | string Optional |
push | Push endpoint settings. | PushSettings_STATUS Optional |
pythonVersion | Version of Python. | string Optional |
remoteDebuggingEnabled | true if remote debugging is enabled; otherwise, false . |
bool Optional |
remoteDebuggingVersion | Remote debugging version. | string Optional |
requestTracingEnabled | true if request tracing is enabled; otherwise, false . |
bool Optional |
requestTracingExpirationTime | Request tracing expiration time. | string Optional |
scmIpSecurityRestrictions | IP security restrictions for scm. | IpSecurityRestriction_STATUS[] Optional |
scmIpSecurityRestrictionsUseMain | IP security restrictions for scm to use main. | bool Optional |
scmMinTlsVersion | ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site | SiteConfig_ScmMinTlsVersion_STATUS Optional |
scmType | SCM type. | SiteConfig_ScmType_STATUS Optional |
tracingOptions | Tracing options. | string Optional |
use32BitWorkerProcess | true to use 32-bit worker process; otherwise, false . |
bool Optional |
virtualApplications | Virtual applications. | VirtualApplication_STATUS[] Optional |
vnetName | Virtual Network name. | string Optional |
vnetPrivatePortsCount | The number of private ports assigned to this app. These will be assigned dynamically on runtime. | int Optional |
vnetRouteAllEnabled | Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. | bool Optional |
websiteTimeZone | Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones | string Optional |
webSocketsEnabled | true if WebSocket is enabled; otherwise, false . |
bool Optional |
windowsFxVersion | Xenon App Framework and version | string Optional |
xManagedServiceIdentityId | Explicit Managed Service Identity Id | int Optional |
SiteOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Site_Spec.
Property | Description | Type |
---|---|---|
configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
SitesSourcecontrolOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: SitesSourcecontrol_Spec.
Property | Description | Type |
---|---|---|
configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
SkuDescription
Description of a SKU for a scalable resource.
Used by: ServerFarm_Spec.
Property | Description | Type |
---|---|---|
capabilities | Capabilities of the SKU, e.g., is traffic manager enabled? | Capability[] Optional |
capacity | Current number of instances assigned to the resource. | int Optional |
family | Family code of the resource SKU. | string Optional |
locations | Locations of the SKU. | string[] Optional |
name | Name of the resource SKU. | string Optional |
size | Size specifier of the resource SKU. | string Optional |
skuCapacity | Min, max, and default scale values of the SKU. | SkuCapacity Optional |
tier | Service tier of the resource SKU. | string Optional |
SkuDescription_STATUS
Description of a SKU for a scalable resource.
Used by: ServerFarm_STATUS.
Property | Description | Type |
---|---|---|
capabilities | Capabilities of the SKU, e.g., is traffic manager enabled? | Capability_STATUS[] Optional |
capacity | Current number of instances assigned to the resource. | int Optional |
family | Family code of the resource SKU. | string Optional |
locations | Locations of the SKU. | string[] Optional |
name | Name of the resource SKU. | string Optional |
size | Size specifier of the resource SKU. | string Optional |
skuCapacity | Min, max, and default scale values of the SKU. | SkuCapacity_STATUS Optional |
tier | Service tier of the resource SKU. | string Optional |
SlotSwapStatus_STATUS
The status of the last successful slot swap operation.
Used by: Site_STATUS.
Property | Description | Type |
---|---|---|
destinationSlotName | The destination slot of the last swap operation. | string Optional |
sourceSlotName | The source slot of the last swap operation. | string Optional |
timestampUtc | The time the last successful slot swap completed. | string Optional |
ApiDefinitionInfo
Information about the formal API definition for the app.
Used by: SiteConfig.
Property | Description | Type |
---|---|---|
url | The URL of the API definition. | string Optional |
ApiDefinitionInfo_STATUS
Information about the formal API definition for the app.
Used by: SiteConfig_STATUS.
Property | Description | Type |
---|---|---|
url | The URL of the API definition. | string Optional |
ApiManagementConfig
Azure API management (APIM) configuration linked to the app.
Used by: SiteConfig.
Property | Description | Type |
---|---|---|
reference | APIM-Api Identifier. | genruntime.ResourceReference Optional |
ApiManagementConfig_STATUS
Azure API management (APIM) configuration linked to the app.
Used by: SiteConfig_STATUS.
Property | Description | Type |
---|---|---|
id | APIM-Api Identifier. | string Optional |
AutoHealRules
Rules that can be defined for auto-heal.
Used by: SiteConfig.
Property | Description | Type |
---|---|---|
actions | Actions to be executed when a rule is triggered. | AutoHealActions Optional |
triggers | Conditions that describe when to execute the auto-heal actions. | AutoHealTriggers Optional |
AutoHealRules_STATUS
Rules that can be defined for auto-heal.
Used by: SiteConfig_STATUS.
Property | Description | Type |
---|---|---|
actions | Actions to be executed when a rule is triggered. | AutoHealActions_STATUS Optional |
triggers | Conditions that describe when to execute the auto-heal actions. | AutoHealTriggers_STATUS Optional |
AzureStorageInfoValue
Azure Files or Blob Storage access information value for dictionary storage.
Used by: SiteConfig.
Property | Description | Type |
---|---|---|
accessKey | Access key for the storage account. | genruntime.SecretReference Optional |
accountName | Name of the storage account. | string Optional |
mountPath | Path to mount the storage within the site’s runtime environment. | string Optional |
shareName | Name of the file share (container name, for Blob storage). | string Optional |
type | Type of storage. | AzureStorageInfoValue_Type Optional |
AzureStorageInfoValue_STATUS
Azure Files or Blob Storage access information value for dictionary storage.
Used by: SiteConfig_STATUS.
Property | Description | Type |
---|---|---|
accountName | Name of the storage account. | string Optional |
mountPath | Path to mount the storage within the site’s runtime environment. | string Optional |
shareName | Name of the file share (container name, for Blob storage). | string Optional |
state | State of the storage account. | AzureStorageInfoValue_State_STATUS Optional |
type | Type of storage. | AzureStorageInfoValue_Type_STATUS Optional |
Capability
Describes the capabilities/features allowed for a specific SKU.
Used by: SkuDescription.
Property | Description | Type |
---|---|---|
name | Name of the SKU capability. | string Optional |
reason | Reason of the SKU capability. | string Optional |
value | Value of the SKU capability. | string Optional |
Capability_STATUS
Describes the capabilities/features allowed for a specific SKU.
Used by: SkuDescription_STATUS.
Property | Description | Type |
---|---|---|
name | Name of the SKU capability. | string Optional |
reason | Reason of the SKU capability. | string Optional |
value | Value of the SKU capability. | string Optional |
ConnStringInfo
Database connection string information.
Used by: SiteConfig.
Property | Description | Type |
---|---|---|
connectionString | Connection string value. | string Optional |
name | Name of connection string. | string Optional |
type | Type of database. | ConnStringInfo_Type Optional |
ConnStringInfo_STATUS
Database connection string information.
Used by: SiteConfig_STATUS.
Property | Description | Type |
---|---|---|
connectionString | Connection string value. | string Optional |
name | Name of connection string. | string Optional |
type | Type of database. | ConnStringInfo_Type_STATUS Optional |
CorsSettings
Cross-Origin Resource Sharing (CORS) settings for the app.
Used by: SiteConfig.
Property | Description | Type |
---|---|---|
allowedOrigins | Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use “*” to allow all. | string[] Optional |
supportCredentials | Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. | bool Optional |
CorsSettings_STATUS
Cross-Origin Resource Sharing (CORS) settings for the app.
Used by: SiteConfig_STATUS.
Property | Description | Type |
---|---|---|
allowedOrigins | Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use “*” to allow all. | string[] Optional |
supportCredentials | Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. | bool Optional |
Experiments
Routing rules in production experiments.
Used by: SiteConfig.
Property | Description | Type |
---|---|---|
rampUpRules | List of ramp-up rules. | RampUpRule[] Optional |
Experiments_STATUS
Routing rules in production experiments.
Used by: SiteConfig_STATUS.
Property | Description | Type |
---|---|---|
rampUpRules | List of ramp-up rules. | RampUpRule_STATUS[] Optional |
GitHubActionCodeConfiguration
The GitHub action code configuration.
Used by: GitHubActionConfiguration.
Property | Description | Type |
---|---|---|
runtimeStack | Runtime stack is used to determine the workflow file content for code base apps. | string Optional |
runtimeVersion | Runtime version is used to determine what build version to set in the workflow file. | string Optional |
GitHubActionCodeConfiguration_STATUS
The GitHub action code configuration.
Used by: GitHubActionConfiguration_STATUS.
Property | Description | Type |
---|---|---|
runtimeStack | Runtime stack is used to determine the workflow file content for code base apps. | string Optional |
runtimeVersion | Runtime version is used to determine what build version to set in the workflow file. | string Optional |
GitHubActionContainerConfiguration
The GitHub action container configuration.
Used by: GitHubActionConfiguration.
Property | Description | Type |
---|---|---|
imageName | The image name for the build. | string Optional |
password | The password used to upload the image to the container registry. | genruntime.SecretReference Optional |
serverUrl | The server URL for the container registry where the build will be hosted. | string Optional |
username | The username used to upload the image to the container registry. | string Optional |
GitHubActionContainerConfiguration_STATUS
The GitHub action container configuration.
Used by: GitHubActionConfiguration_STATUS.
Property | Description | Type |
---|---|---|
imageName | The image name for the build. | string Optional |
serverUrl | The server URL for the container registry where the build will be hosted. | string Optional |
username | The username used to upload the image to the container registry. | string Optional |
HandlerMapping
The IIS handler mappings used to define which handler processes HTTP requests with certain extension. For example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.
Used by: SiteConfig.
Property | Description | Type |
---|---|---|
arguments | Command-line arguments to be passed to the script processor. | string Optional |
extension | Requests with this extension will be handled using the specified FastCGI application. | string Optional |
scriptProcessor | The absolute path to the FastCGI application. | string Optional |
HandlerMapping_STATUS
The IIS handler mappings used to define which handler processes HTTP requests with certain extension. For example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.
Used by: SiteConfig_STATUS.
Property | Description | Type |
---|---|---|
arguments | Command-line arguments to be passed to the script processor. | string Optional |
extension | Requests with this extension will be handled using the specified FastCGI application. | string Optional |
scriptProcessor | The absolute path to the FastCGI application. | string Optional |
HostNameSslState_HostType
Used by: HostNameSslState.
Value | Description |
---|---|
“Repository” | |
“Standard” |
HostNameSslState_HostType_STATUS
Used by: HostNameSslState_STATUS.
Value | Description |
---|---|
“Repository” | |
“Standard” |
HostNameSslState_SslState
Used by: HostNameSslState.
Value | Description |
---|---|
“Disabled” | |
“IpBasedEnabled” | |
“SniEnabled” |
HostNameSslState_SslState_STATUS
Used by: HostNameSslState_STATUS.
Value | Description |
---|---|
“Disabled” | |
“IpBasedEnabled” | |
“SniEnabled” |
IpSecurityRestriction
IP security restriction on an app.
Used by: SiteConfig, and SiteConfig.
Property | Description | Type |
---|---|---|
action | Allow or Deny access for this IP range. | string Optional |
description | IP restriction rule description. | string Optional |
headers | IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don’t match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. | map[string]string[] Optional |
ipAddress | IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. | string Optional |
name | IP restriction rule name. | string Optional |
priority | Priority of IP restriction rule. | int Optional |
subnetMask | Subnet mask for the range of IP addresses the restriction is valid for. | string Optional |
subnetTrafficTag | (internal) Subnet traffic tag | int Optional |
tag | Defines what this IP filter will be used for. This is to support IP filtering on proxies. | IpSecurityRestriction_Tag Optional |
vnetSubnetResourceReference | Virtual network resource id | genruntime.ResourceReference Optional |
vnetTrafficTag | (internal) Vnet traffic tag | int Optional |
IpSecurityRestriction_STATUS
IP security restriction on an app.
Used by: SiteConfig_STATUS, and SiteConfig_STATUS.
Property | Description | Type |
---|---|---|
action | Allow or Deny access for this IP range. | string Optional |
description | IP restriction rule description. | string Optional |
headers | IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don’t match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. | map[string]string[] Optional |
ipAddress | IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. | string Optional |
name | IP restriction rule name. | string Optional |
priority | Priority of IP restriction rule. | int Optional |
subnetMask | Subnet mask for the range of IP addresses the restriction is valid for. | string Optional |
subnetTrafficTag | (internal) Subnet traffic tag | int Optional |
tag | Defines what this IP filter will be used for. This is to support IP filtering on proxies. | IpSecurityRestriction_Tag_STATUS Optional |
vnetSubnetResourceId | Virtual network resource id | string Optional |
vnetTrafficTag | (internal) Vnet traffic tag | int Optional |
ManagedServiceIdentity_Type
Used by: ManagedServiceIdentity.
Value | Description |
---|---|
“None” | |
“SystemAssigned” | |
“SystemAssigned, UserAssigned” | |
“UserAssigned” |
ManagedServiceIdentity_Type_STATUS
Used by: ManagedServiceIdentity_STATUS.
Value | Description |
---|---|
“None” | |
“SystemAssigned” | |
“SystemAssigned, UserAssigned” | |
“UserAssigned” |
NameValuePair
Name value pair.
Used by: SiteConfig.
Property | Description | Type |
---|---|---|
name | Pair name. | string Optional |
value | Pair value. | string Optional |
NameValuePair_STATUS
Name value pair.
Used by: SiteConfig_STATUS.
Property | Description | Type |
---|---|---|
name | Pair name. | string Optional |
value | Pair value. | string Optional |
PushSettings
Push settings for the App.
Used by: SiteConfig.
Property | Description | Type |
---|---|---|
dynamicTagsJson | Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. | string Optional |
isPushEnabled | Gets or sets a flag indicating whether the Push endpoint is enabled. | bool Required |
kind | Kind of resource. | string Optional |
tagsRequiringAuth | Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: ‘_’, ‘@’, ‘#’, ‘.’, ‘:’, ‘-’. Validation should be performed at the PushRequestHandler. | string Optional |
tagWhitelistJson | Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint. | string Optional |
PushSettings_STATUS
Push settings for the App.
Used by: SiteConfig_STATUS.
Property | Description | Type |
---|---|---|
dynamicTagsJson | Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. | string Optional |
id | Resource Id. | string Optional |
isPushEnabled | Gets or sets a flag indicating whether the Push endpoint is enabled. | bool Optional |
kind | Kind of resource. | string Optional |
name | Resource Name. | string Optional |
tagsRequiringAuth | Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: ‘_’, ‘@’, ‘#’, ‘.’, ‘:’, ‘-’. Validation should be performed at the PushRequestHandler. | string Optional |
tagWhitelistJson | Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint. | string Optional |
type | Resource type. | string Optional |
SiteConfig_FtpsState
Used by: SiteConfig.
Value | Description |
---|---|
“AllAllowed” | |
“Disabled” | |
“FtpsOnly” |
SiteConfig_FtpsState_STATUS
Used by: SiteConfig_STATUS.
Value | Description |
---|---|
“AllAllowed” | |
“Disabled” | |
“FtpsOnly” |
SiteConfig_LoadBalancing
Used by: SiteConfig.
Value | Description |
---|---|
“LeastRequests” | |
“LeastResponseTime” | |
“PerSiteRoundRobin” | |
“RequestHash” | |
“WeightedRoundRobin” | |
“WeightedTotalTraffic” |
SiteConfig_LoadBalancing_STATUS
Used by: SiteConfig_STATUS.
Value | Description |
---|---|
“LeastRequests” | |
“LeastResponseTime” | |
“PerSiteRoundRobin” | |
“RequestHash” | |
“WeightedRoundRobin” | |
“WeightedTotalTraffic” |
SiteConfig_ManagedPipelineMode
Used by: SiteConfig.
Value | Description |
---|---|
“Classic” | |
“Integrated” |
SiteConfig_ManagedPipelineMode_STATUS
Used by: SiteConfig_STATUS.
Value | Description |
---|---|
“Classic” | |
“Integrated” |
SiteConfig_MinTlsVersion
Used by: SiteConfig.
Value | Description |
---|---|
“1.0” | |
“1.1” | |
“1.2” |
SiteConfig_MinTlsVersion_STATUS
Used by: SiteConfig_STATUS.
Value | Description |
---|---|
“1.0” | |
“1.1” | |
“1.2” |
SiteConfig_ScmMinTlsVersion
Used by: SiteConfig.
Value | Description |
---|---|
“1.0” | |
“1.1” | |
“1.2” |
SiteConfig_ScmMinTlsVersion_STATUS
Used by: SiteConfig_STATUS.
Value | Description |
---|---|
“1.0” | |
“1.1” | |
“1.2” |
SiteConfig_ScmType
Used by: SiteConfig.
Value | Description |
---|---|
“BitbucketGit” | |
“BitbucketHg” | |
“CodePlexGit” | |
“CodePlexHg” | |
“Dropbox” | |
“ExternalGit” | |
“ExternalHg” | |
“GitHub” | |
“LocalGit” | |
“None” | |
“OneDrive” | |
“Tfs” | |
“VSO” | |
“VSTSRM” |
SiteConfig_ScmType_STATUS
Used by: SiteConfig_STATUS.
Value | Description |
---|---|
“BitbucketGit” | |
“BitbucketHg” | |
“CodePlexGit” | |
“CodePlexHg” | |
“Dropbox” | |
“ExternalGit” | |
“ExternalHg” | |
“GitHub” | |
“LocalGit” | |
“None” | |
“OneDrive” | |
“Tfs” | |
“VSO” | |
“VSTSRM” |
SiteLimits
Metric limits set on an app.
Used by: SiteConfig.
Property | Description | Type |
---|---|---|
maxDiskSizeInMb | Maximum allowed disk size usage in MB. | int Optional |
maxMemoryInMb | Maximum allowed memory usage in MB. | int Optional |
maxPercentageCpu | Maximum allowed CPU usage percentage. | float64 Optional |
SiteLimits_STATUS
Metric limits set on an app.
Used by: SiteConfig_STATUS.
Property | Description | Type |
---|---|---|
maxDiskSizeInMb | Maximum allowed disk size usage in MB. | int Optional |
maxMemoryInMb | Maximum allowed memory usage in MB. | int Optional |
maxPercentageCpu | Maximum allowed CPU usage percentage. | float64 Optional |
SiteMachineKey_STATUS
MachineKey of an app.
Used by: SiteConfig_STATUS.
Property | Description | Type |
---|---|---|
decryption | Algorithm used for decryption. | string Optional |
decryptionKey | Decryption key. | string Optional |
validation | MachineKey validation. | string Optional |
validationKey | Validation key. | string Optional |
SkuCapacity
Description of the App Service plan scale options.
Used by: SkuDescription.
Property | Description | Type |
---|---|---|
default | Default number of workers for this App Service plan SKU. | int Optional |
elasticMaximum | Maximum number of Elastic workers for this App Service plan SKU. | int Optional |
maximum | Maximum number of workers for this App Service plan SKU. | int Optional |
minimum | Minimum number of workers for this App Service plan SKU. | int Optional |
scaleType | Available scale configurations for an App Service plan. | string Optional |
SkuCapacity_STATUS
Description of the App Service plan scale options.
Used by: SkuDescription_STATUS.
Property | Description | Type |
---|---|---|
default | Default number of workers for this App Service plan SKU. | int Optional |
elasticMaximum | Maximum number of Elastic workers for this App Service plan SKU. | int Optional |
maximum | Maximum number of workers for this App Service plan SKU. | int Optional |
minimum | Minimum number of workers for this App Service plan SKU. | int Optional |
scaleType | Available scale configurations for an App Service plan. | string Optional |
UserAssignedIdentity_STATUS
User Assigned identity.
Used by: ManagedServiceIdentity_STATUS.
Property | Description | Type |
---|---|---|
clientId | Client Id of user assigned identity | string Optional |
principalId | Principal Id of user assigned identity | string Optional |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: ManagedServiceIdentity.
Property | Description | Type |
---|---|---|
reference | genruntime.ResourceReference Optional |
VirtualApplication
Virtual application in an app.
Used by: SiteConfig.
Property | Description | Type |
---|---|---|
physicalPath | Physical path. | string Optional |
preloadEnabled | true if preloading is enabled; otherwise, false . |
bool Optional |
virtualDirectories | Virtual directories for virtual application. | VirtualDirectory[] Optional |
virtualPath | Virtual path. | string Optional |
VirtualApplication_STATUS
Virtual application in an app.
Used by: SiteConfig_STATUS.
Property | Description | Type |
---|---|---|
physicalPath | Physical path. | string Optional |
preloadEnabled | true if preloading is enabled; otherwise, false . |
bool Optional |
virtualDirectories | Virtual directories for virtual application. | VirtualDirectory_STATUS[] Optional |
virtualPath | Virtual path. | string Optional |
AutoHealActions
Actions which to take by the auto-heal module when a rule is triggered.
Used by: AutoHealRules.
Property | Description | Type |
---|---|---|
actionType | Predefined action to be taken. | AutoHealActions_ActionType Optional |
customAction | Custom action to be taken. | AutoHealCustomAction Optional |
minProcessExecutionTime | Minimum time the process must execute before taking the action | string Optional |
AutoHealActions_STATUS
Actions which to take by the auto-heal module when a rule is triggered.
Used by: AutoHealRules_STATUS.
Property | Description | Type |
---|---|---|
actionType | Predefined action to be taken. | AutoHealActions_ActionType_STATUS Optional |
customAction | Custom action to be taken. | AutoHealCustomAction_STATUS Optional |
minProcessExecutionTime | Minimum time the process must execute before taking the action | string Optional |
AutoHealTriggers
Triggers for auto-heal.
Used by: AutoHealRules.
Property | Description | Type |
---|---|---|
privateBytesInKB | A rule based on private bytes. | int Optional |
requests | A rule based on total requests. | RequestsBasedTrigger Optional |
slowRequests | A rule based on request execution time. | SlowRequestsBasedTrigger Optional |
slowRequestsWithPath | A rule based on multiple Slow Requests Rule with path | SlowRequestsBasedTrigger[] Optional |
statusCodes | A rule based on status codes. | StatusCodesBasedTrigger[] Optional |
statusCodesRange | A rule based on status codes ranges. | StatusCodesRangeBasedTrigger[] Optional |
AutoHealTriggers_STATUS
Triggers for auto-heal.
Used by: AutoHealRules_STATUS.
Property | Description | Type |
---|---|---|
privateBytesInKB | A rule based on private bytes. | int Optional |
requests | A rule based on total requests. | RequestsBasedTrigger_STATUS Optional |
slowRequests | A rule based on request execution time. | SlowRequestsBasedTrigger_STATUS Optional |
slowRequestsWithPath | A rule based on multiple Slow Requests Rule with path | SlowRequestsBasedTrigger_STATUS[] Optional |
statusCodes | A rule based on status codes. | StatusCodesBasedTrigger_STATUS[] Optional |
statusCodesRange | A rule based on status codes ranges. | StatusCodesRangeBasedTrigger_STATUS[] Optional |
AzureStorageInfoValue_State_STATUS
Used by: AzureStorageInfoValue_STATUS.
Value | Description |
---|---|
“InvalidCredentials” | |
“InvalidShare” | |
“NotValidated” | |
“Ok” |
AzureStorageInfoValue_Type
Used by: AzureStorageInfoValue.
Value | Description |
---|---|
“AzureBlob” | |
“AzureFiles” |
AzureStorageInfoValue_Type_STATUS
Used by: AzureStorageInfoValue_STATUS.
Value | Description |
---|---|
“AzureBlob” | |
“AzureFiles” |
ConnStringInfo_Type
Used by: ConnStringInfo.
Value | Description |
---|---|
“ApiHub” | |
“Custom” | |
“DocDb” | |
“EventHub” | |
“MySql” | |
“NotificationHub” | |
“PostgreSQL” | |
“RedisCache” | |
“SQLAzure” | |
“SQLServer” | |
“ServiceBus” |
ConnStringInfo_Type_STATUS
Used by: ConnStringInfo_STATUS.
Value | Description |
---|---|
“ApiHub” | |
“Custom” | |
“DocDb” | |
“EventHub” | |
“MySql” | |
“NotificationHub” | |
“PostgreSQL” | |
“RedisCache” | |
“SQLAzure” | |
“SQLServer” | |
“ServiceBus” |
IpSecurityRestriction_Tag
Used by: IpSecurityRestriction.
Value | Description |
---|---|
“Default” | |
“ServiceTag” | |
“XffProxy” |
IpSecurityRestriction_Tag_STATUS
Used by: IpSecurityRestriction_STATUS.
Value | Description |
---|---|
“Default” | |
“ServiceTag” | |
“XffProxy” |
RampUpRule
Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.
Used by: Experiments.
Property | Description | Type |
---|---|---|
actionHostName | Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. | string Optional |
changeDecisionCallbackUrl | Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/ | string Optional |
changeIntervalInMinutes | Specifies interval in minutes to reevaluate ReroutePercentage. | int Optional |
changeStep | In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage . Site metrics are checked every N minutes specified in ChangeIntervalInMinutes .\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl . |
float64 Optional |
maxReroutePercentage | Specifies upper boundary below which ReroutePercentage will stay. | float64 Optional |
minReroutePercentage | Specifies lower boundary above which ReroutePercentage will stay. | float64 Optional |
name | Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. | string Optional |
reroutePercentage | Percentage of the traffic which will be redirected to ActionHostName . |
float64 Optional |
RampUpRule_STATUS
Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.
Used by: Experiments_STATUS.
Property | Description | Type |
---|---|---|
actionHostName | Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. | string Optional |
changeDecisionCallbackUrl | Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/ | string Optional |
changeIntervalInMinutes | Specifies interval in minutes to reevaluate ReroutePercentage. | int Optional |
changeStep | In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage . Site metrics are checked every N minutes specified in ChangeIntervalInMinutes .\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl . |
float64 Optional |
maxReroutePercentage | Specifies upper boundary below which ReroutePercentage will stay. | float64 Optional |
minReroutePercentage | Specifies lower boundary above which ReroutePercentage will stay. | float64 Optional |
name | Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. | string Optional |
reroutePercentage | Percentage of the traffic which will be redirected to ActionHostName . |
float64 Optional |
VirtualDirectory
Directory for virtual application.
Used by: VirtualApplication.
Property | Description | Type |
---|---|---|
physicalPath | Physical path. | string Optional |
virtualPath | Path to virtual application. | string Optional |
VirtualDirectory_STATUS
Directory for virtual application.
Used by: VirtualApplication_STATUS.
Property | Description | Type |
---|---|---|
physicalPath | Physical path. | string Optional |
virtualPath | Path to virtual application. | string Optional |
AutoHealActions_ActionType
Used by: AutoHealActions.
Value | Description |
---|---|
“CustomAction” | |
“LogEvent” | |
“Recycle” |
AutoHealActions_ActionType_STATUS
Used by: AutoHealActions_STATUS.
Value | Description |
---|---|
“CustomAction” | |
“LogEvent” | |
“Recycle” |
AutoHealCustomAction
Custom action to be executed when an auto heal rule is triggered.
Used by: AutoHealActions.
Property | Description | Type |
---|---|---|
exe | Executable to be run. | string Optional |
parameters | Parameters for the executable. | string Optional |
AutoHealCustomAction_STATUS
Custom action to be executed when an auto heal rule is triggered.
Used by: AutoHealActions_STATUS.
Property | Description | Type |
---|---|---|
exe | Executable to be run. | string Optional |
parameters | Parameters for the executable. | string Optional |
RequestsBasedTrigger
Trigger based on total requests.
Used by: AutoHealTriggers.
Property | Description | Type |
---|---|---|
count | Request Count. | int Optional |
timeInterval | Time interval. | string Optional |
RequestsBasedTrigger_STATUS
Trigger based on total requests.
Used by: AutoHealTriggers_STATUS.
Property | Description | Type |
---|---|---|
count | Request Count. | int Optional |
timeInterval | Time interval. | string Optional |
SlowRequestsBasedTrigger
Trigger based on request execution time.
Used by: AutoHealTriggers, and AutoHealTriggers.
Property | Description | Type |
---|---|---|
count | Request Count. | int Optional |
path | Request Path. | string Optional |
timeInterval | Time interval. | string Optional |
timeTaken | Time taken. | string Optional |
SlowRequestsBasedTrigger_STATUS
Trigger based on request execution time.
Used by: AutoHealTriggers_STATUS, and AutoHealTriggers_STATUS.
Property | Description | Type |
---|---|---|
count | Request Count. | int Optional |
path | Request Path. | string Optional |
timeInterval | Time interval. | string Optional |
timeTaken | Time taken. | string Optional |
StatusCodesBasedTrigger
Trigger based on status code.
Used by: AutoHealTriggers.
Property | Description | Type |
---|---|---|
count | Request Count. | int Optional |
path | Request Path | string Optional |
status | HTTP status code. | int Optional |
subStatus | Request Sub Status. | int Optional |
timeInterval | Time interval. | string Optional |
win32Status | Win32 error code. | int Optional |
StatusCodesBasedTrigger_STATUS
Trigger based on status code.
Used by: AutoHealTriggers_STATUS.
Property | Description | Type |
---|---|---|
count | Request Count. | int Optional |
path | Request Path | string Optional |
status | HTTP status code. | int Optional |
subStatus | Request Sub Status. | int Optional |
timeInterval | Time interval. | string Optional |
win32Status | Win32 error code. | int Optional |
StatusCodesRangeBasedTrigger
Trigger based on range of status codes.
Used by: AutoHealTriggers.
Property | Description | Type |
---|---|---|
count | Request Count. | int Optional |
path | string Optional |
|
statusCodes | HTTP status code. | string Optional |
timeInterval | Time interval. | string Optional |
StatusCodesRangeBasedTrigger_STATUS
Trigger based on range of status codes.
Used by: AutoHealTriggers_STATUS.
Property | Description | Type |
---|---|---|
count | Request Count. | int Optional |
path | string Optional |
|
statusCodes | HTTP status code. | string Optional |
timeInterval | Time interval. | string Optional |