web.azure.com/v1api20220301

web.azure.com/v1api20220301

Package v1api20220301 contains API Schema definitions for the web v1api20220301 API group

Resource Types:

    APIVersion (string alias)

    Value Description

    "2022-03-01"

    ApiDefinitionInfo

    (Appears on:SiteConfig)

    Information about the formal API definition for the app.

    Field Description
    url
    string

    Url: The URL of the API definition.

    ApiDefinitionInfo_ARM

    (Appears on:SiteConfig_ARM)

    Information about the formal API definition for the app.

    Field Description
    url
    string

    Url: The URL of the API definition.

    ApiDefinitionInfo_STATUS

    (Appears on:SiteConfig_STATUS)

    Information about the formal API definition for the app.

    Field Description
    url
    string

    Url: The URL of the API definition.

    ApiDefinitionInfo_STATUS_ARM

    (Appears on:SiteConfig_STATUS_ARM)

    Information about the formal API definition for the app.

    Field Description
    url
    string

    Url: The URL of the API definition.

    ApiManagementConfig

    (Appears on:SiteConfig)

    Azure API management (APIM) configuration linked to the app.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: APIM-Api Identifier.

    ApiManagementConfig_ARM

    (Appears on:SiteConfig_ARM)

    Azure API management (APIM) configuration linked to the app.

    Field Description
    id
    string

    ApiManagementConfig_STATUS

    (Appears on:SiteConfig_STATUS)

    Azure API management (APIM) configuration linked to the app.

    Field Description
    id
    string

    Id: APIM-Api Identifier.

    ApiManagementConfig_STATUS_ARM

    (Appears on:SiteConfig_STATUS_ARM)

    Azure API management (APIM) configuration linked to the app.

    Field Description
    id
    string

    Id: APIM-Api Identifier.

    AutoHealActions

    (Appears on:AutoHealRules)

    Actions which to take by the auto-heal module when a rule is triggered.

    Field Description
    actionType
    AutoHealActions_ActionType

    ActionType: Predefined action to be taken.

    customAction
    AutoHealCustomAction

    CustomAction: Custom action to be taken.

    minProcessExecutionTime
    string

    MinProcessExecutionTime: Minimum time the process must execute before taking the action

    AutoHealActions_ARM

    (Appears on:AutoHealRules_ARM)

    Actions which to take by the auto-heal module when a rule is triggered.

    Field Description
    actionType
    AutoHealActions_ActionType

    ActionType: Predefined action to be taken.

    customAction
    AutoHealCustomAction_ARM

    CustomAction: Custom action to be taken.

    minProcessExecutionTime
    string

    MinProcessExecutionTime: Minimum time the process must execute before taking the action

    AutoHealActions_ActionType (string alias)

    (Appears on:AutoHealActions, AutoHealActions_ARM)

    Value Description

    "CustomAction"

    "LogEvent"

    "Recycle"

    AutoHealActions_ActionType_STATUS (string alias)

    (Appears on:AutoHealActions_STATUS, AutoHealActions_STATUS_ARM)

    Value Description

    "CustomAction"

    "LogEvent"

    "Recycle"

    AutoHealActions_STATUS

    (Appears on:AutoHealRules_STATUS)

    Actions which to take by the auto-heal module when a rule is triggered.

    Field Description
    actionType
    AutoHealActions_ActionType_STATUS

    ActionType: Predefined action to be taken.

    customAction
    AutoHealCustomAction_STATUS

    CustomAction: Custom action to be taken.

    minProcessExecutionTime
    string

    MinProcessExecutionTime: Minimum time the process must execute before taking the action

    AutoHealActions_STATUS_ARM

    (Appears on:AutoHealRules_STATUS_ARM)

    Actions which to take by the auto-heal module when a rule is triggered.

    Field Description
    actionType
    AutoHealActions_ActionType_STATUS

    ActionType: Predefined action to be taken.

    customAction
    AutoHealCustomAction_STATUS_ARM

    CustomAction: Custom action to be taken.

    minProcessExecutionTime
    string

    MinProcessExecutionTime: Minimum time the process must execute before taking the action

    AutoHealCustomAction

    (Appears on:AutoHealActions)

    Custom action to be executed when an auto heal rule is triggered.

    Field Description
    exe
    string

    Exe: Executable to be run.

    parameters
    string

    Parameters: Parameters for the executable.

    AutoHealCustomAction_ARM

    (Appears on:AutoHealActions_ARM)

    Custom action to be executed when an auto heal rule is triggered.

    Field Description
    exe
    string

    Exe: Executable to be run.

    parameters
    string

    Parameters: Parameters for the executable.

    AutoHealCustomAction_STATUS

    (Appears on:AutoHealActions_STATUS)

    Custom action to be executed when an auto heal rule is triggered.

    Field Description
    exe
    string

    Exe: Executable to be run.

    parameters
    string

    Parameters: Parameters for the executable.

    AutoHealCustomAction_STATUS_ARM

    (Appears on:AutoHealActions_STATUS_ARM)

    Custom action to be executed when an auto heal rule is triggered.

    Field Description
    exe
    string

    Exe: Executable to be run.

    parameters
    string

    Parameters: Parameters for the executable.

    AutoHealRules

    (Appears on:SiteConfig)

    Rules that can be defined for auto-heal.

    Field Description
    actions
    AutoHealActions

    Actions: Actions to be executed when a rule is triggered.

    triggers
    AutoHealTriggers

    Triggers: Conditions that describe when to execute the auto-heal actions.

    AutoHealRules_ARM

    (Appears on:SiteConfig_ARM)

    Rules that can be defined for auto-heal.

    Field Description
    actions
    AutoHealActions_ARM

    Actions: Actions to be executed when a rule is triggered.

    triggers
    AutoHealTriggers_ARM

    Triggers: Conditions that describe when to execute the auto-heal actions.

    AutoHealRules_STATUS

    (Appears on:SiteConfig_STATUS)

    Rules that can be defined for auto-heal.

    Field Description
    actions
    AutoHealActions_STATUS

    Actions: Actions to be executed when a rule is triggered.

    triggers
    AutoHealTriggers_STATUS

    Triggers: Conditions that describe when to execute the auto-heal actions.

    AutoHealRules_STATUS_ARM

    (Appears on:SiteConfig_STATUS_ARM)

    Rules that can be defined for auto-heal.

    Field Description
    actions
    AutoHealActions_STATUS_ARM

    Actions: Actions to be executed when a rule is triggered.

    triggers
    AutoHealTriggers_STATUS_ARM

    Triggers: Conditions that describe when to execute the auto-heal actions.

    AutoHealTriggers

    (Appears on:AutoHealRules)

    Triggers for auto-heal.

    Field Description
    privateBytesInKB
    int

    PrivateBytesInKB: A rule based on private bytes.

    requests
    RequestsBasedTrigger

    Requests: A rule based on total requests.

    slowRequests
    SlowRequestsBasedTrigger

    SlowRequests: A rule based on request execution time.

    slowRequestsWithPath
    []SlowRequestsBasedTrigger

    SlowRequestsWithPath: A rule based on multiple Slow Requests Rule with path

    statusCodes
    []StatusCodesBasedTrigger

    StatusCodes: A rule based on status codes.

    statusCodesRange
    []StatusCodesRangeBasedTrigger

    StatusCodesRange: A rule based on status codes ranges.

    AutoHealTriggers_ARM

    (Appears on:AutoHealRules_ARM)

    Triggers for auto-heal.

    Field Description
    privateBytesInKB
    int

    PrivateBytesInKB: A rule based on private bytes.

    requests
    RequestsBasedTrigger_ARM

    Requests: A rule based on total requests.

    slowRequests
    SlowRequestsBasedTrigger_ARM

    SlowRequests: A rule based on request execution time.

    slowRequestsWithPath
    []SlowRequestsBasedTrigger_ARM

    SlowRequestsWithPath: A rule based on multiple Slow Requests Rule with path

    statusCodes
    []StatusCodesBasedTrigger_ARM

    StatusCodes: A rule based on status codes.

    statusCodesRange
    []StatusCodesRangeBasedTrigger_ARM

    StatusCodesRange: A rule based on status codes ranges.

    AutoHealTriggers_STATUS

    (Appears on:AutoHealRules_STATUS)

    Triggers for auto-heal.

    Field Description
    privateBytesInKB
    int

    PrivateBytesInKB: A rule based on private bytes.

    requests
    RequestsBasedTrigger_STATUS

    Requests: A rule based on total requests.

    slowRequests
    SlowRequestsBasedTrigger_STATUS

    SlowRequests: A rule based on request execution time.

    slowRequestsWithPath
    []SlowRequestsBasedTrigger_STATUS

    SlowRequestsWithPath: A rule based on multiple Slow Requests Rule with path

    statusCodes
    []StatusCodesBasedTrigger_STATUS

    StatusCodes: A rule based on status codes.

    statusCodesRange
    []StatusCodesRangeBasedTrigger_STATUS

    StatusCodesRange: A rule based on status codes ranges.

    AutoHealTriggers_STATUS_ARM

    (Appears on:AutoHealRules_STATUS_ARM)

    Triggers for auto-heal.

    Field Description
    privateBytesInKB
    int

    PrivateBytesInKB: A rule based on private bytes.

    requests
    RequestsBasedTrigger_STATUS_ARM

    Requests: A rule based on total requests.

    slowRequests
    SlowRequestsBasedTrigger_STATUS_ARM

    SlowRequests: A rule based on request execution time.

    slowRequestsWithPath
    []SlowRequestsBasedTrigger_STATUS_ARM

    SlowRequestsWithPath: A rule based on multiple Slow Requests Rule with path

    statusCodes
    []StatusCodesBasedTrigger_STATUS_ARM

    StatusCodes: A rule based on status codes.

    statusCodesRange
    []StatusCodesRangeBasedTrigger_STATUS_ARM

    StatusCodesRange: A rule based on status codes ranges.

    AzureStorageInfoValue

    (Appears on:SiteConfig)

    Azure Files or Blob Storage access information value for dictionary storage.

    Field Description
    accessKey
    genruntime.SecretReference

    AccessKey: Access key for the storage account.

    accountName
    string

    AccountName: Name of the storage account.

    mountPath
    string

    MountPath: Path to mount the storage within the site’s runtime environment.

    shareName
    string

    ShareName: Name of the file share (container name, for Blob storage).

    type
    AzureStorageInfoValue_Type

    Type: Type of storage.

    AzureStorageInfoValue_ARM

    (Appears on:SiteConfig_ARM)

    Azure Files or Blob Storage access information value for dictionary storage.

    Field Description
    accessKey
    string

    AccessKey: Access key for the storage account.

    accountName
    string

    AccountName: Name of the storage account.

    mountPath
    string

    MountPath: Path to mount the storage within the site’s runtime environment.

    shareName
    string

    ShareName: Name of the file share (container name, for Blob storage).

    type
    AzureStorageInfoValue_Type

    Type: Type of storage.

    AzureStorageInfoValue_STATUS

    (Appears on:SiteConfig_STATUS)

    Azure Files or Blob Storage access information value for dictionary storage.

    Field Description
    accountName
    string

    AccountName: Name of the storage account.

    mountPath
    string

    MountPath: Path to mount the storage within the site’s runtime environment.

    shareName
    string

    ShareName: Name of the file share (container name, for Blob storage).

    state
    AzureStorageInfoValue_State_STATUS

    State: State of the storage account.

    type
    AzureStorageInfoValue_Type_STATUS

    Type: Type of storage.

    AzureStorageInfoValue_STATUS_ARM

    (Appears on:SiteConfig_STATUS_ARM)

    Azure Files or Blob Storage access information value for dictionary storage.

    Field Description
    accountName
    string

    AccountName: Name of the storage account.

    mountPath
    string

    MountPath: Path to mount the storage within the site’s runtime environment.

    shareName
    string

    ShareName: Name of the file share (container name, for Blob storage).

    state
    AzureStorageInfoValue_State_STATUS

    State: State of the storage account.

    type
    AzureStorageInfoValue_Type_STATUS

    Type: Type of storage.

    AzureStorageInfoValue_State_STATUS (string alias)

    (Appears on:AzureStorageInfoValue_STATUS, AzureStorageInfoValue_STATUS_ARM)

    Value Description

    "InvalidCredentials"

    "InvalidShare"

    "NotValidated"

    "Ok"

    AzureStorageInfoValue_Type (string alias)

    (Appears on:AzureStorageInfoValue, AzureStorageInfoValue_ARM)

    Value Description

    "AzureBlob"

    "AzureFiles"

    AzureStorageInfoValue_Type_STATUS (string alias)

    (Appears on:AzureStorageInfoValue_STATUS, AzureStorageInfoValue_STATUS_ARM)

    Value Description

    "AzureBlob"

    "AzureFiles"

    Capability

    (Appears on:SkuDescription)

    Describes the capabilities/features allowed for a specific SKU.

    Field Description
    name
    string

    Name: Name of the SKU capability.

    reason
    string

    Reason: Reason of the SKU capability.

    value
    string

    Value: Value of the SKU capability.

    Capability_ARM

    (Appears on:SkuDescription_ARM)

    Describes the capabilities/features allowed for a specific SKU.

    Field Description
    name
    string

    Name: Name of the SKU capability.

    reason
    string

    Reason: Reason of the SKU capability.

    value
    string

    Value: Value of the SKU capability.

    Capability_STATUS

    (Appears on:SkuDescription_STATUS)

    Describes the capabilities/features allowed for a specific SKU.

    Field Description
    name
    string

    Name: Name of the SKU capability.

    reason
    string

    Reason: Reason of the SKU capability.

    value
    string

    Value: Value of the SKU capability.

    Capability_STATUS_ARM

    (Appears on:SkuDescription_STATUS_ARM)

    Describes the capabilities/features allowed for a specific SKU.

    Field Description
    name
    string

    Name: Name of the SKU capability.

    reason
    string

    Reason: Reason of the SKU capability.

    value
    string

    Value: Value of the SKU capability.

    CloningInfo

    (Appears on:Site_Spec)

    Information needed for cloning operation.

    Field Description
    appSettingsOverrides
    map[string]string

    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.

    cloneCustomHostNames
    bool

    CloneCustomHostNames: true to clone custom hostnames from source app; otherwise, false.

    cloneSourceControl
    bool

    CloneSourceControl: true to clone source control from source app; otherwise, false.

    configureLoadBalancing
    bool

    ConfigureLoadBalancing: true to configure load balancing for source and destination app.

    correlationId
    string

    CorrelationId: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot.

    hostingEnvironment
    string

    HostingEnvironment: App Service Environment.

    overwrite
    bool

    Overwrite: true to overwrite destination app; otherwise, false.

    sourceWebAppLocation
    string

    SourceWebAppLocation: Location of source app ex: West US or North Europe

    sourceWebAppReference
    genruntime.ResourceReference

    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.

    trafficManagerProfileName
    string

    TrafficManagerProfileName: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.

    trafficManagerProfileReference
    genruntime.ResourceReference

    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}.

    CloningInfo_ARM

    (Appears on:Site_Properties_Spec_ARM)

    Information needed for cloning operation.

    Field Description
    appSettingsOverrides
    map[string]string

    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.

    cloneCustomHostNames
    bool

    CloneCustomHostNames: true to clone custom hostnames from source app; otherwise, false.

    cloneSourceControl
    bool

    CloneSourceControl: true to clone source control from source app; otherwise, false.

    configureLoadBalancing
    bool

    ConfigureLoadBalancing: true to configure load balancing for source and destination app.

    correlationId
    string

    CorrelationId: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot.

    hostingEnvironment
    string

    HostingEnvironment: App Service Environment.

    overwrite
    bool

    Overwrite: true to overwrite destination app; otherwise, false.

    sourceWebAppId
    string
    sourceWebAppLocation
    string

    SourceWebAppLocation: Location of source app ex: West US or North Europe

    trafficManagerProfileId
    string
    trafficManagerProfileName
    string

    TrafficManagerProfileName: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.

    CloningInfo_STATUS

    (Appears on:Site_STATUS)

    Information needed for cloning operation.

    Field Description
    appSettingsOverrides
    map[string]string

    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.

    cloneCustomHostNames
    bool

    CloneCustomHostNames: true to clone custom hostnames from source app; otherwise, false.

    cloneSourceControl
    bool

    CloneSourceControl: true to clone source control from source app; otherwise, false.

    configureLoadBalancing
    bool

    ConfigureLoadBalancing: true to configure load balancing for source and destination app.

    correlationId
    string

    CorrelationId: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot.

    hostingEnvironment
    string

    HostingEnvironment: App Service Environment.

    overwrite
    bool

    Overwrite: true to overwrite destination app; otherwise, false.

    sourceWebAppId
    string

    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.

    sourceWebAppLocation
    string

    SourceWebAppLocation: Location of source app ex: West US or North Europe

    trafficManagerProfileId
    string

    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}.

    trafficManagerProfileName
    string

    TrafficManagerProfileName: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.

    CloningInfo_STATUS_ARM

    (Appears on:Site_Properties_STATUS_ARM)

    Information needed for cloning operation.

    Field Description
    appSettingsOverrides
    map[string]string

    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.

    cloneCustomHostNames
    bool

    CloneCustomHostNames: true to clone custom hostnames from source app; otherwise, false.

    cloneSourceControl
    bool

    CloneSourceControl: true to clone source control from source app; otherwise, false.

    configureLoadBalancing
    bool

    ConfigureLoadBalancing: true to configure load balancing for source and destination app.

    correlationId
    string

    CorrelationId: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot.

    hostingEnvironment
    string

    HostingEnvironment: App Service Environment.

    overwrite
    bool

    Overwrite: true to overwrite destination app; otherwise, false.

    sourceWebAppId
    string

    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.

    sourceWebAppLocation
    string

    SourceWebAppLocation: Location of source app ex: West US or North Europe

    trafficManagerProfileId
    string

    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}.

    trafficManagerProfileName
    string

    TrafficManagerProfileName: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.

    ConnStringInfo

    (Appears on:SiteConfig)

    Database connection string information.

    Field Description
    connectionString
    string

    ConnectionString: Connection string value.

    name
    string

    Name: Name of connection string.

    type
    ConnStringInfo_Type

    Type: Type of database.

    ConnStringInfo_ARM

    (Appears on:SiteConfig_ARM)

    Database connection string information.

    Field Description
    connectionString
    string

    ConnectionString: Connection string value.

    name
    string

    Name: Name of connection string.

    type
    ConnStringInfo_Type

    Type: Type of database.

    ConnStringInfo_STATUS

    (Appears on:SiteConfig_STATUS)

    Database connection string information.

    Field Description
    connectionString
    string

    ConnectionString: Connection string value.

    name
    string

    Name: Name of connection string.

    type
    ConnStringInfo_Type_STATUS

    Type: Type of database.

    ConnStringInfo_STATUS_ARM

    (Appears on:SiteConfig_STATUS_ARM)

    Database connection string information.

    Field Description
    connectionString
    string

    ConnectionString: Connection string value.

    name
    string

    Name: Name of connection string.

    type
    ConnStringInfo_Type_STATUS

    Type: Type of database.

    ConnStringInfo_Type (string alias)

    (Appears on:ConnStringInfo, ConnStringInfo_ARM)

    Value Description

    "ApiHub"

    "Custom"

    "DocDb"

    "EventHub"

    "MySql"

    "NotificationHub"

    "PostgreSQL"

    "RedisCache"

    "SQLAzure"

    "SQLServer"

    "ServiceBus"

    ConnStringInfo_Type_STATUS (string alias)

    (Appears on:ConnStringInfo_STATUS, ConnStringInfo_STATUS_ARM)

    Value Description

    "ApiHub"

    "Custom"

    "DocDb"

    "EventHub"

    "MySql"

    "NotificationHub"

    "PostgreSQL"

    "RedisCache"

    "SQLAzure"

    "SQLServer"

    "ServiceBus"

    CorsSettings

    (Appears on:SiteConfig)

    Cross-Origin Resource Sharing (CORS) settings for the app.

    Field Description
    allowedOrigins
    []string

    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.

    supportCredentials
    bool

    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.

    CorsSettings_ARM

    (Appears on:SiteConfig_ARM)

    Cross-Origin Resource Sharing (CORS) settings for the app.

    Field Description
    allowedOrigins
    []string

    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.

    supportCredentials
    bool

    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.

    CorsSettings_STATUS

    (Appears on:SiteConfig_STATUS)

    Cross-Origin Resource Sharing (CORS) settings for the app.

    Field Description
    allowedOrigins
    []string

    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.

    supportCredentials
    bool

    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.

    CorsSettings_STATUS_ARM

    (Appears on:SiteConfig_STATUS_ARM)

    Cross-Origin Resource Sharing (CORS) settings for the app.

    Field Description
    allowedOrigins
    []string

    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.

    supportCredentials
    bool

    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.

    Experiments

    (Appears on:SiteConfig)

    Routing rules in production experiments.

    Field Description
    rampUpRules
    []RampUpRule

    RampUpRules: List of ramp-up rules.

    Experiments_ARM

    (Appears on:SiteConfig_ARM)

    Routing rules in production experiments.

    Field Description
    rampUpRules
    []RampUpRule_ARM

    RampUpRules: List of ramp-up rules.

    Experiments_STATUS

    (Appears on:SiteConfig_STATUS)

    Routing rules in production experiments.

    Field Description
    rampUpRules
    []RampUpRule_STATUS

    RampUpRules: List of ramp-up rules.

    Experiments_STATUS_ARM

    (Appears on:SiteConfig_STATUS_ARM)

    Routing rules in production experiments.

    Field Description
    rampUpRules
    []RampUpRule_STATUS_ARM

    RampUpRules: List of ramp-up rules.

    ExtendedLocation

    (Appears on:Serverfarm_Spec, Site_Spec)

    Extended Location.

    Field Description
    name
    string

    Name: Name of extended location.

    ExtendedLocation_ARM

    (Appears on:Serverfarm_Spec_ARM, Site_Spec_ARM)

    Extended Location.

    Field Description
    name
    string

    Name: Name of extended location.

    ExtendedLocation_STATUS

    (Appears on:Serverfarm_STATUS, Site_STATUS)

    Extended Location.

    Field Description
    name
    string

    Name: Name of extended location.

    type
    string

    Type: Type of extended location.

    ExtendedLocation_STATUS_ARM

    (Appears on:Serverfarm_STATUS_ARM, Site_STATUS_ARM)

    Extended Location.

    Field Description
    name
    string

    Name: Name of extended location.

    type
    string

    Type: Type of extended location.

    HandlerMapping

    (Appears on:SiteConfig)

    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.

    Field Description
    arguments
    string

    Arguments: Command-line arguments to be passed to the script processor.

    extension
    string

    Extension: Requests with this extension will be handled using the specified FastCGI application.

    scriptProcessor
    string

    ScriptProcessor: The absolute path to the FastCGI application.

    HandlerMapping_ARM

    (Appears on:SiteConfig_ARM)

    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.

    Field Description
    arguments
    string

    Arguments: Command-line arguments to be passed to the script processor.

    extension
    string

    Extension: Requests with this extension will be handled using the specified FastCGI application.

    scriptProcessor
    string

    ScriptProcessor: The absolute path to the FastCGI application.

    HandlerMapping_STATUS

    (Appears on:SiteConfig_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.

    Field Description
    arguments
    string

    Arguments: Command-line arguments to be passed to the script processor.

    extension
    string

    Extension: Requests with this extension will be handled using the specified FastCGI application.

    scriptProcessor
    string

    ScriptProcessor: The absolute path to the FastCGI application.

    HandlerMapping_STATUS_ARM

    (Appears on:SiteConfig_STATUS_ARM)

    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.

    Field Description
    arguments
    string

    Arguments: Command-line arguments to be passed to the script processor.

    extension
    string

    Extension: Requests with this extension will be handled using the specified FastCGI application.

    scriptProcessor
    string

    ScriptProcessor: The absolute path to the FastCGI application.

    HostNameSslState

    (Appears on:Site_Spec)

    SSL-enabled hostname.

    Field Description
    hostType
    HostNameSslState_HostType

    HostType: Indicates whether the hostname is a standard or repository hostname.

    name
    string

    Name: Hostname.

    sslState
    HostNameSslState_SslState

    SslState: SSL type.

    thumbprint
    string

    Thumbprint: SSL certificate thumbprint.

    toUpdate
    bool

    ToUpdate: Set to true to update existing hostname.

    virtualIP
    string

    VirtualIP: Virtual IP address assigned to the hostname if IP based SSL is enabled.

    HostNameSslState_ARM

    (Appears on:Site_Properties_Spec_ARM)

    SSL-enabled hostname.

    Field Description
    hostType
    HostNameSslState_HostType

    HostType: Indicates whether the hostname is a standard or repository hostname.

    name
    string

    Name: Hostname.

    sslState
    HostNameSslState_SslState

    SslState: SSL type.

    thumbprint
    string

    Thumbprint: SSL certificate thumbprint.

    toUpdate
    bool

    ToUpdate: Set to true to update existing hostname.

    virtualIP
    string

    VirtualIP: Virtual IP address assigned to the hostname if IP based SSL is enabled.

    HostNameSslState_HostType (string alias)

    (Appears on:HostNameSslState, HostNameSslState_ARM)

    Value Description

    "Repository"

    "Standard"

    HostNameSslState_HostType_STATUS (string alias)

    (Appears on:HostNameSslState_STATUS, HostNameSslState_STATUS_ARM)

    Value Description

    "Repository"

    "Standard"

    HostNameSslState_STATUS

    (Appears on:Site_STATUS)

    SSL-enabled hostname.

    Field Description
    hostType
    HostNameSslState_HostType_STATUS

    HostType: Indicates whether the hostname is a standard or repository hostname.

    name
    string

    Name: Hostname.

    sslState
    HostNameSslState_SslState_STATUS

    SslState: SSL type.

    thumbprint
    string

    Thumbprint: SSL certificate thumbprint.

    toUpdate
    bool

    ToUpdate: Set to true to update existing hostname.

    virtualIP
    string

    VirtualIP: Virtual IP address assigned to the hostname if IP based SSL is enabled.

    HostNameSslState_STATUS_ARM

    (Appears on:Site_Properties_STATUS_ARM)

    SSL-enabled hostname.

    Field Description
    hostType
    HostNameSslState_HostType_STATUS

    HostType: Indicates whether the hostname is a standard or repository hostname.

    name
    string

    Name: Hostname.

    sslState
    HostNameSslState_SslState_STATUS

    SslState: SSL type.

    thumbprint
    string

    Thumbprint: SSL certificate thumbprint.

    toUpdate
    bool

    ToUpdate: Set to true to update existing hostname.

    virtualIP
    string

    VirtualIP: Virtual IP address assigned to the hostname if IP based SSL is enabled.

    HostNameSslState_SslState (string alias)

    (Appears on:HostNameSslState, HostNameSslState_ARM)

    Value Description

    "Disabled"

    "IpBasedEnabled"

    "SniEnabled"

    HostNameSslState_SslState_STATUS (string alias)

    (Appears on:HostNameSslState_STATUS, HostNameSslState_STATUS_ARM)

    Value Description

    "Disabled"

    "IpBasedEnabled"

    "SniEnabled"

    HostingEnvironmentProfile

    (Appears on:Serverfarm_Spec, Site_Spec)

    Specification for an App Service Environment to use for this resource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID of the App Service Environment.

    HostingEnvironmentProfile_ARM

    (Appears on:Serverfarm_Properties_Spec_ARM, Site_Properties_Spec_ARM)

    Specification for an App Service Environment to use for this resource.

    Field Description
    id
    string

    HostingEnvironmentProfile_STATUS

    (Appears on:Serverfarm_STATUS, Site_STATUS)

    Specification for an App Service Environment to use for this resource.

    Field Description
    id
    string

    Id: Resource ID of the App Service Environment.

    name
    string

    Name: Name of the App Service Environment.

    type
    string

    Type: Resource type of the App Service Environment.

    HostingEnvironmentProfile_STATUS_ARM

    (Appears on:Serverfarm_Properties_STATUS_ARM, Site_Properties_STATUS_ARM)

    Specification for an App Service Environment to use for this resource.

    Field Description
    id
    string

    Id: Resource ID of the App Service Environment.

    name
    string

    Name: Name of the App Service Environment.

    type
    string

    Type: Resource type of the App Service Environment.

    IpSecurityRestriction

    (Appears on:SiteConfig)

    IP security restriction on an app.

    Field Description
    action
    string

    Action: Allow or Deny access for this IP range.

    description
    string

    Description: IP restriction rule description.

    headers
    map[string][]string

    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.

    ipAddress
    string

    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.

    name
    string

    Name: IP restriction rule name.

    priority
    int

    Priority: Priority of IP restriction rule.

    subnetMask
    string

    SubnetMask: Subnet mask for the range of IP addresses the restriction is valid for.

    subnetTrafficTag
    int

    SubnetTrafficTag: (internal) Subnet traffic tag

    tag
    IpSecurityRestriction_Tag

    Tag: Defines what this IP filter will be used for. This is to support IP filtering on proxies.

    vnetSubnetResourceReference
    genruntime.ResourceReference

    VnetSubnetResourceReference: Virtual network resource id

    vnetTrafficTag
    int

    VnetTrafficTag: (internal) Vnet traffic tag

    IpSecurityRestriction_ARM

    (Appears on:SiteConfig_ARM)

    IP security restriction on an app.

    Field Description
    action
    string

    Action: Allow or Deny access for this IP range.

    description
    string

    Description: IP restriction rule description.

    headers
    map[string][]string

    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.

    ipAddress
    string

    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.

    name
    string

    Name: IP restriction rule name.

    priority
    int

    Priority: Priority of IP restriction rule.

    subnetMask
    string

    SubnetMask: Subnet mask for the range of IP addresses the restriction is valid for.

    subnetTrafficTag
    int

    SubnetTrafficTag: (internal) Subnet traffic tag

    tag
    IpSecurityRestriction_Tag

    Tag: Defines what this IP filter will be used for. This is to support IP filtering on proxies.

    vnetSubnetResourceId
    string
    vnetTrafficTag
    int

    VnetTrafficTag: (internal) Vnet traffic tag

    IpSecurityRestriction_STATUS

    (Appears on:SiteConfig_STATUS)

    IP security restriction on an app.

    Field Description
    action
    string

    Action: Allow or Deny access for this IP range.

    description
    string

    Description: IP restriction rule description.

    headers
    map[string][]string

    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.

    ipAddress
    string

    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.

    name
    string

    Name: IP restriction rule name.

    priority
    int

    Priority: Priority of IP restriction rule.

    subnetMask
    string

    SubnetMask: Subnet mask for the range of IP addresses the restriction is valid for.

    subnetTrafficTag
    int

    SubnetTrafficTag: (internal) Subnet traffic tag

    tag
    IpSecurityRestriction_Tag_STATUS

    Tag: Defines what this IP filter will be used for. This is to support IP filtering on proxies.

    vnetSubnetResourceId
    string

    VnetSubnetResourceId: Virtual network resource id

    vnetTrafficTag
    int

    VnetTrafficTag: (internal) Vnet traffic tag

    IpSecurityRestriction_STATUS_ARM

    (Appears on:SiteConfig_STATUS_ARM)

    IP security restriction on an app.

    Field Description
    action
    string

    Action: Allow or Deny access for this IP range.

    description
    string

    Description: IP restriction rule description.

    headers
    map[string][]string

    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.

    ipAddress
    string

    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.

    name
    string

    Name: IP restriction rule name.

    priority
    int

    Priority: Priority of IP restriction rule.

    subnetMask
    string

    SubnetMask: Subnet mask for the range of IP addresses the restriction is valid for.

    subnetTrafficTag
    int

    SubnetTrafficTag: (internal) Subnet traffic tag

    tag
    IpSecurityRestriction_Tag_STATUS

    Tag: Defines what this IP filter will be used for. This is to support IP filtering on proxies.

    vnetSubnetResourceId
    string

    VnetSubnetResourceId: Virtual network resource id

    vnetTrafficTag
    int

    VnetTrafficTag: (internal) Vnet traffic tag

    IpSecurityRestriction_Tag (string alias)

    (Appears on:IpSecurityRestriction, IpSecurityRestriction_ARM)

    Value Description

    "Default"

    "ServiceTag"

    "XffProxy"

    IpSecurityRestriction_Tag_STATUS (string alias)

    (Appears on:IpSecurityRestriction_STATUS, IpSecurityRestriction_STATUS_ARM)

    Value Description

    "Default"

    "ServiceTag"

    "XffProxy"

    KubeEnvironmentProfile

    (Appears on:Serverfarm_Spec)

    Specification for a Kubernetes Environment to use for this resource.

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Resource ID of the Kubernetes Environment.

    KubeEnvironmentProfile_ARM

    (Appears on:Serverfarm_Properties_Spec_ARM)

    Specification for a Kubernetes Environment to use for this resource.

    Field Description
    id
    string

    KubeEnvironmentProfile_STATUS

    (Appears on:Serverfarm_STATUS)

    Specification for a Kubernetes Environment to use for this resource.

    Field Description
    id
    string

    Id: Resource ID of the Kubernetes Environment.

    name
    string

    Name: Name of the Kubernetes Environment.

    type
    string

    Type: Resource type of the Kubernetes Environment.

    KubeEnvironmentProfile_STATUS_ARM

    (Appears on:Serverfarm_Properties_STATUS_ARM)

    Specification for a Kubernetes Environment to use for this resource.

    Field Description
    id
    string

    Id: Resource ID of the Kubernetes Environment.

    name
    string

    Name: Name of the Kubernetes Environment.

    type
    string

    Type: Resource type of the Kubernetes Environment.

    ManagedServiceIdentity

    (Appears on:Site_Spec)

    Managed service identity.

    Field Description
    type
    ManagedServiceIdentity_Type

    Type: Type of managed service identity.

    userAssignedIdentities
    []UserAssignedIdentityDetails

    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}

    ManagedServiceIdentity_ARM

    (Appears on:Site_Spec_ARM)

    Managed service identity.

    Field Description
    type
    ManagedServiceIdentity_Type

    Type: Type of managed service identity.

    userAssignedIdentities
    map[string]./api/web/v1api20220301.UserAssignedIdentityDetails_ARM

    ManagedServiceIdentity_STATUS

    (Appears on:Site_STATUS)

    Managed service identity.

    Field Description
    principalId
    string

    PrincipalId: Principal Id of managed service identity.

    tenantId
    string

    TenantId: Tenant of managed service identity.

    type
    ManagedServiceIdentity_Type_STATUS

    Type: Type of managed service identity.

    userAssignedIdentities
    map[string]./api/web/v1api20220301.UserAssignedIdentity_STATUS

    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}

    ManagedServiceIdentity_STATUS_ARM

    (Appears on:Site_STATUS_ARM)

    Managed service identity.

    Field Description
    principalId
    string

    PrincipalId: Principal Id of managed service identity.

    tenantId
    string

    TenantId: Tenant of managed service identity.

    type
    ManagedServiceIdentity_Type_STATUS

    Type: Type of managed service identity.

    userAssignedIdentities
    map[string]./api/web/v1api20220301.UserAssignedIdentity_STATUS_ARM

    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}

    ManagedServiceIdentity_Type (string alias)

    (Appears on:ManagedServiceIdentity, ManagedServiceIdentity_ARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned, UserAssigned"

    "UserAssigned"

    ManagedServiceIdentity_Type_STATUS (string alias)

    (Appears on:ManagedServiceIdentity_STATUS, ManagedServiceIdentity_STATUS_ARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned, UserAssigned"

    "UserAssigned"

    NameValuePair

    (Appears on:SiteConfig)

    Name value pair.

    Field Description
    name
    string

    Name: Pair name.

    value
    string

    Value: Pair value.

    NameValuePair_ARM

    (Appears on:SiteConfig_ARM)

    Name value pair.

    Field Description
    name
    string

    Name: Pair name.

    value
    string

    Value: Pair value.

    NameValuePair_STATUS

    (Appears on:SiteConfig_STATUS)

    Name value pair.

    Field Description
    name
    string

    Name: Pair name.

    value
    string

    Value: Pair value.

    NameValuePair_STATUS_ARM

    (Appears on:SiteConfig_STATUS_ARM)

    Name value pair.

    Field Description
    name
    string

    Name: Pair name.

    value
    string

    Value: Pair value.

    PushSettings

    (Appears on:SiteConfig)

    Push settings for the App.

    Field Description
    dynamicTagsJson
    string

    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.

    isPushEnabled
    bool

    IsPushEnabled: Gets or sets a flag indicating whether the Push endpoint is enabled.

    kind
    string

    Kind: Kind of resource.

    tagWhitelistJson
    string

    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.

    tagsRequiringAuth
    string

    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.

    PushSettings_ARM

    (Appears on:SiteConfig_ARM)

    Push settings for the App.

    Field Description
    kind
    string

    Kind: Kind of resource.

    properties
    PushSettings_Properties_ARM

    Properties: PushSettings resource specific properties

    PushSettings_Properties_ARM

    (Appears on:PushSettings_ARM)

    Field Description
    dynamicTagsJson
    string

    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.

    isPushEnabled
    bool

    IsPushEnabled: Gets or sets a flag indicating whether the Push endpoint is enabled.

    tagWhitelistJson
    string

    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.

    tagsRequiringAuth
    string

    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.

    PushSettings_Properties_STATUS_ARM

    (Appears on:PushSettings_STATUS_ARM)

    Field Description
    dynamicTagsJson
    string

    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.

    isPushEnabled
    bool

    IsPushEnabled: Gets or sets a flag indicating whether the Push endpoint is enabled.

    tagWhitelistJson
    string

    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.

    tagsRequiringAuth
    string

    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.

    PushSettings_STATUS

    (Appears on:SiteConfig_STATUS)

    Push settings for the App.

    Field Description
    dynamicTagsJson
    string

    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.

    id
    string

    Id: Resource Id.

    isPushEnabled
    bool

    IsPushEnabled: Gets or sets a flag indicating whether the Push endpoint is enabled.

    kind
    string

    Kind: Kind of resource.

    name
    string

    Name: Resource Name.

    tagWhitelistJson
    string

    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.

    tagsRequiringAuth
    string

    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.

    type
    string

    Type: Resource type.

    PushSettings_STATUS_ARM

    (Appears on:SiteConfig_STATUS_ARM)

    Push settings for the App.

    Field Description
    id
    string

    Id: Resource Id.

    kind
    string

    Kind: Kind of resource.

    name
    string

    Name: Resource Name.

    properties
    PushSettings_Properties_STATUS_ARM

    Properties: PushSettings resource specific properties

    type
    string

    Type: Resource type.

    RampUpRule

    (Appears on:Experiments)

    Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.

    Field Description
    actionHostName
    string

    ActionHostName: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.

    changeDecisionCallbackUrl
    string

    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/

    changeIntervalInMinutes
    int

    ChangeIntervalInMinutes: Specifies interval in minutes to reevaluate ReroutePercentage.

    changeStep
    float64

    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.

    maxReroutePercentage
    float64

    MaxReroutePercentage: Specifies upper boundary below which ReroutePercentage will stay.

    minReroutePercentage
    float64

    MinReroutePercentage: Specifies lower boundary above which ReroutePercentage will stay.

    name
    string

    Name: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.

    reroutePercentage
    float64

    ReroutePercentage: Percentage of the traffic which will be redirected to ActionHostName.

    RampUpRule_ARM

    (Appears on:Experiments_ARM)

    Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.

    Field Description
    actionHostName
    string

    ActionHostName: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.

    changeDecisionCallbackUrl
    string

    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/

    changeIntervalInMinutes
    int

    ChangeIntervalInMinutes: Specifies interval in minutes to reevaluate ReroutePercentage.

    changeStep
    float64

    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.

    maxReroutePercentage
    float64

    MaxReroutePercentage: Specifies upper boundary below which ReroutePercentage will stay.

    minReroutePercentage
    float64

    MinReroutePercentage: Specifies lower boundary above which ReroutePercentage will stay.

    name
    string

    Name: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.

    reroutePercentage
    float64

    ReroutePercentage: Percentage of the traffic which will be redirected to ActionHostName.

    RampUpRule_STATUS

    (Appears on:Experiments_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.

    Field Description
    actionHostName
    string

    ActionHostName: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.

    changeDecisionCallbackUrl
    string

    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/

    changeIntervalInMinutes
    int

    ChangeIntervalInMinutes: Specifies interval in minutes to reevaluate ReroutePercentage.

    changeStep
    float64

    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.

    maxReroutePercentage
    float64

    MaxReroutePercentage: Specifies upper boundary below which ReroutePercentage will stay.

    minReroutePercentage
    float64

    MinReroutePercentage: Specifies lower boundary above which ReroutePercentage will stay.

    name
    string

    Name: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.

    reroutePercentage
    float64

    ReroutePercentage: Percentage of the traffic which will be redirected to ActionHostName.

    RampUpRule_STATUS_ARM

    (Appears on:Experiments_STATUS_ARM)

    Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.

    Field Description
    actionHostName
    string

    ActionHostName: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.

    changeDecisionCallbackUrl
    string

    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/

    changeIntervalInMinutes
    int

    ChangeIntervalInMinutes: Specifies interval in minutes to reevaluate ReroutePercentage.

    changeStep
    float64

    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.

    maxReroutePercentage
    float64

    MaxReroutePercentage: Specifies upper boundary below which ReroutePercentage will stay.

    minReroutePercentage
    float64

    MinReroutePercentage: Specifies lower boundary above which ReroutePercentage will stay.

    name
    string

    Name: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.

    reroutePercentage
    float64

    ReroutePercentage: Percentage of the traffic which will be redirected to ActionHostName.

    RequestsBasedTrigger

    (Appears on:AutoHealTriggers)

    Trigger based on total requests.

    Field Description
    count
    int

    Count: Request Count.

    timeInterval
    string

    TimeInterval: Time interval.

    RequestsBasedTrigger_ARM

    (Appears on:AutoHealTriggers_ARM)

    Trigger based on total requests.

    Field Description
    count
    int

    Count: Request Count.

    timeInterval
    string

    TimeInterval: Time interval.

    RequestsBasedTrigger_STATUS

    (Appears on:AutoHealTriggers_STATUS)

    Trigger based on total requests.

    Field Description
    count
    int

    Count: Request Count.

    timeInterval
    string

    TimeInterval: Time interval.

    RequestsBasedTrigger_STATUS_ARM

    (Appears on:AutoHealTriggers_STATUS_ARM)

    Trigger based on total requests.

    Field Description
    count
    int

    Count: Request Count.

    timeInterval
    string

    TimeInterval: Time interval.

    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}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Serverfarm_Spec


    azureName
    string

    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.

    elasticScaleEnabled
    bool

    ElasticScaleEnabled: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku

    extendedLocation
    ExtendedLocation

    ExtendedLocation: Extended Location.

    freeOfferExpirationTime
    string

    FreeOfferExpirationTime: The time when the server farm free offer expires.

    hostingEnvironmentProfile
    HostingEnvironmentProfile

    HostingEnvironmentProfile: Specification for the App Service Environment to use for the App Service plan.

    hyperV
    bool

    HyperV: If Hyper-V container app service plan true, false otherwise.

    isSpot
    bool

    IsSpot: If true, this App Service Plan owns spot instances.

    isXenon
    bool

    IsXenon: Obsolete: If Hyper-V container app service plan true, false otherwise.

    kind
    string

    Kind: Kind of resource.

    kubeEnvironmentProfile
    KubeEnvironmentProfile

    KubeEnvironmentProfile: Specification for the Kubernetes Environment to use for the App Service plan.

    location
    string

    Location: Resource Location.

    maximumElasticWorkerCount
    int

    MaximumElasticWorkerCount: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan

    owner
    genruntime.KnownResourceReference

    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

    perSiteScaling
    bool

    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.

    reserved
    bool

    Reserved: If Linux app service plan true, false otherwise.

    sku
    SkuDescription

    Sku: Description of a SKU for a scalable resource.

    spotExpirationTime
    string

    SpotExpirationTime: The time when the server farm expires. Valid only if it is a spot server farm.

    tags
    map[string]string

    Tags: Resource tags.

    targetWorkerCount
    int

    TargetWorkerCount: Scaling worker count.

    targetWorkerSizeId
    int

    TargetWorkerSizeId: Scaling worker size ID.

    workerTierName
    string

    WorkerTierName: Target worker tier assigned to the App Service plan.

    zoneRedundant
    bool

    ZoneRedundant: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.

    status
    Serverfarm_STATUS

    Serverfarm_Properties_ProvisioningState_STATUS (string alias)

    (Appears on:Serverfarm_Properties_STATUS_ARM, Serverfarm_STATUS)

    Value Description

    "Canceled"

    "Deleting"

    "Failed"

    "InProgress"

    "Succeeded"

    Serverfarm_Properties_STATUS_ARM

    (Appears on:Serverfarm_STATUS_ARM)

    Field Description
    elasticScaleEnabled
    bool

    ElasticScaleEnabled: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku

    freeOfferExpirationTime
    string

    FreeOfferExpirationTime: The time when the server farm free offer expires.

    geoRegion
    string

    GeoRegion: Geographical location for the App Service plan.

    hostingEnvironmentProfile
    HostingEnvironmentProfile_STATUS_ARM

    HostingEnvironmentProfile: Specification for the App Service Environment to use for the App Service plan.

    hyperV
    bool

    HyperV: If Hyper-V container app service plan true, false otherwise.

    isSpot
    bool

    IsSpot: If true, this App Service Plan owns spot instances.

    isXenon
    bool

    IsXenon: Obsolete: If Hyper-V container app service plan true, false otherwise.

    kubeEnvironmentProfile
    KubeEnvironmentProfile_STATUS_ARM

    KubeEnvironmentProfile: Specification for the Kubernetes Environment to use for the App Service plan.

    maximumElasticWorkerCount
    int

    MaximumElasticWorkerCount: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan

    maximumNumberOfWorkers
    int

    MaximumNumberOfWorkers: Maximum number of instances that can be assigned to this App Service plan.

    numberOfSites
    int

    NumberOfSites: Number of apps assigned to this App Service plan.

    numberOfWorkers
    int

    NumberOfWorkers: The number of instances that are assigned to this App Service plan.

    perSiteScaling
    bool

    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.

    provisioningState
    Serverfarm_Properties_ProvisioningState_STATUS

    ProvisioningState: Provisioning state of the App Service Plan.

    reserved
    bool

    Reserved: If Linux app service plan true, false otherwise.

    resourceGroup
    string

    ResourceGroup: Resource group of the App Service plan.

    spotExpirationTime
    string

    SpotExpirationTime: The time when the server farm expires. Valid only if it is a spot server farm.

    status
    Serverfarm_Properties_Status_STATUS

    Status: App Service plan status.

    subscription
    string

    Subscription: App Service plan subscription.

    targetWorkerCount
    int

    TargetWorkerCount: Scaling worker count.

    targetWorkerSizeId
    int

    TargetWorkerSizeId: Scaling worker size ID.

    workerTierName
    string

    WorkerTierName: Target worker tier assigned to the App Service plan.

    zoneRedundant
    bool

    ZoneRedundant: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.

    Serverfarm_Properties_Spec_ARM

    (Appears on:Serverfarm_Spec_ARM)

    Field Description
    elasticScaleEnabled
    bool

    ElasticScaleEnabled: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku

    freeOfferExpirationTime
    string

    FreeOfferExpirationTime: The time when the server farm free offer expires.

    hostingEnvironmentProfile
    HostingEnvironmentProfile_ARM

    HostingEnvironmentProfile: Specification for the App Service Environment to use for the App Service plan.

    hyperV
    bool

    HyperV: If Hyper-V container app service plan true, false otherwise.

    isSpot
    bool

    IsSpot: If true, this App Service Plan owns spot instances.

    isXenon
    bool

    IsXenon: Obsolete: If Hyper-V container app service plan true, false otherwise.

    kubeEnvironmentProfile
    KubeEnvironmentProfile_ARM

    KubeEnvironmentProfile: Specification for the Kubernetes Environment to use for the App Service plan.

    maximumElasticWorkerCount
    int

    MaximumElasticWorkerCount: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan

    perSiteScaling
    bool

    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.

    reserved
    bool

    Reserved: If Linux app service plan true, false otherwise.

    spotExpirationTime
    string

    SpotExpirationTime: The time when the server farm expires. Valid only if it is a spot server farm.

    targetWorkerCount
    int

    TargetWorkerCount: Scaling worker count.

    targetWorkerSizeId
    int

    TargetWorkerSizeId: Scaling worker size ID.

    workerTierName
    string

    WorkerTierName: Target worker tier assigned to the App Service plan.

    zoneRedundant
    bool

    ZoneRedundant: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.

    Serverfarm_Properties_Status_STATUS (string alias)

    (Appears on:Serverfarm_Properties_STATUS_ARM, Serverfarm_STATUS)

    Value Description

    "Creating"

    "Pending"

    "Ready"

    Serverfarm_STATUS

    (Appears on:ServerFarm)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    elasticScaleEnabled
    bool

    ElasticScaleEnabled: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku

    extendedLocation
    ExtendedLocation_STATUS

    ExtendedLocation: Extended Location.

    freeOfferExpirationTime
    string

    FreeOfferExpirationTime: The time when the server farm free offer expires.

    geoRegion
    string

    GeoRegion: Geographical location for the App Service plan.

    hostingEnvironmentProfile
    HostingEnvironmentProfile_STATUS

    HostingEnvironmentProfile: Specification for the App Service Environment to use for the App Service plan.

    hyperV
    bool

    HyperV: If Hyper-V container app service plan true, false otherwise.

    id
    string

    Id: Resource Id.

    isSpot
    bool

    IsSpot: If true, this App Service Plan owns spot instances.

    isXenon
    bool

    IsXenon: Obsolete: If Hyper-V container app service plan true, false otherwise.

    kind
    string

    Kind: Kind of resource.

    kubeEnvironmentProfile
    KubeEnvironmentProfile_STATUS

    KubeEnvironmentProfile: Specification for the Kubernetes Environment to use for the App Service plan.

    location
    string

    Location: Resource Location.

    maximumElasticWorkerCount
    int

    MaximumElasticWorkerCount: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan

    maximumNumberOfWorkers
    int

    MaximumNumberOfWorkers: Maximum number of instances that can be assigned to this App Service plan.

    name
    string

    Name: Resource Name.

    numberOfSites
    int

    NumberOfSites: Number of apps assigned to this App Service plan.

    numberOfWorkers
    int

    NumberOfWorkers: The number of instances that are assigned to this App Service plan.

    perSiteScaling
    bool

    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.

    provisioningState
    Serverfarm_Properties_ProvisioningState_STATUS

    ProvisioningState: Provisioning state of the App Service Plan.

    reserved
    bool

    Reserved: If Linux app service plan true, false otherwise.

    resourceGroup
    string

    ResourceGroup: Resource group of the App Service plan.

    sku
    SkuDescription_STATUS

    Sku: Description of a SKU for a scalable resource.

    spotExpirationTime
    string

    SpotExpirationTime: The time when the server farm expires. Valid only if it is a spot server farm.

    status
    Serverfarm_Properties_Status_STATUS

    Status: App Service plan status.

    subscription
    string

    Subscription: App Service plan subscription.

    tags
    map[string]string

    Tags: Resource tags.

    targetWorkerCount
    int

    TargetWorkerCount: Scaling worker count.

    targetWorkerSizeId
    int

    TargetWorkerSizeId: Scaling worker size ID.

    type
    string

    Type: Resource type.

    workerTierName
    string

    WorkerTierName: Target worker tier assigned to the App Service plan.

    zoneRedundant
    bool

    ZoneRedundant: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.

    Serverfarm_STATUS_ARM

    Field Description
    extendedLocation
    ExtendedLocation_STATUS_ARM

    ExtendedLocation: Extended Location.

    id
    string

    Id: Resource Id.

    kind
    string

    Kind: Kind of resource.

    location
    string

    Location: Resource Location.

    name
    string

    Name: Resource Name.

    properties
    Serverfarm_Properties_STATUS_ARM

    Properties: AppServicePlan resource specific properties

    sku
    SkuDescription_STATUS_ARM

    Sku: Description of a SKU for a scalable resource.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    Serverfarm_Spec

    (Appears on:ServerFarm)

    Field Description
    azureName
    string

    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.

    elasticScaleEnabled
    bool

    ElasticScaleEnabled: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku

    extendedLocation
    ExtendedLocation

    ExtendedLocation: Extended Location.

    freeOfferExpirationTime
    string

    FreeOfferExpirationTime: The time when the server farm free offer expires.

    hostingEnvironmentProfile
    HostingEnvironmentProfile

    HostingEnvironmentProfile: Specification for the App Service Environment to use for the App Service plan.

    hyperV
    bool

    HyperV: If Hyper-V container app service plan true, false otherwise.

    isSpot
    bool

    IsSpot: If true, this App Service Plan owns spot instances.

    isXenon
    bool

    IsXenon: Obsolete: If Hyper-V container app service plan true, false otherwise.

    kind
    string

    Kind: Kind of resource.

    kubeEnvironmentProfile
    KubeEnvironmentProfile

    KubeEnvironmentProfile: Specification for the Kubernetes Environment to use for the App Service plan.

    location
    string

    Location: Resource Location.

    maximumElasticWorkerCount
    int

    MaximumElasticWorkerCount: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan

    owner
    genruntime.KnownResourceReference

    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

    perSiteScaling
    bool

    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.

    reserved
    bool

    Reserved: If Linux app service plan true, false otherwise.

    sku
    SkuDescription

    Sku: Description of a SKU for a scalable resource.

    spotExpirationTime
    string

    SpotExpirationTime: The time when the server farm expires. Valid only if it is a spot server farm.

    tags
    map[string]string

    Tags: Resource tags.

    targetWorkerCount
    int

    TargetWorkerCount: Scaling worker count.

    targetWorkerSizeId
    int

    TargetWorkerSizeId: Scaling worker size ID.

    workerTierName
    string

    WorkerTierName: Target worker tier assigned to the App Service plan.

    zoneRedundant
    bool

    ZoneRedundant: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.

    Serverfarm_Spec_ARM

    Field Description
    extendedLocation
    ExtendedLocation_ARM

    ExtendedLocation: Extended Location.

    kind
    string

    Kind: Kind of resource.

    location
    string

    Location: Resource Location.

    name
    string
    properties
    Serverfarm_Properties_Spec_ARM

    Properties: AppServicePlan resource specific properties

    sku
    SkuDescription_ARM

    Sku: Description of a SKU for a scalable resource.

    tags
    map[string]string

    Tags: Resource tags.

    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}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Site_Spec


    azureName
    string

    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.

    clientAffinityEnabled
    bool

    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.

    clientCertEnabled
    bool

    ClientCertEnabled: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.

    clientCertExclusionPaths
    string

    ClientCertExclusionPaths: client certificate authentication comma-separated exclusion paths

    clientCertMode
    Site_Properties_ClientCertMode_Spec

    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.

    cloningInfo
    CloningInfo

    CloningInfo: If specified during app creation, the app is cloned from a source app.

    containerSize
    int

    ContainerSize: Size of the function container.

    customDomainVerificationId
    string

    CustomDomainVerificationId: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.

    dailyMemoryTimeQuota
    int

    DailyMemoryTimeQuota: Maximum allowed daily memory-time quota (applicable on dynamic apps only).

    enabled
    bool

    Enabled: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).

    extendedLocation
    ExtendedLocation

    ExtendedLocation: Extended Location.

    hostNameSslStates
    []HostNameSslState

    HostNameSslStates: Hostname SSL states are used to manage the SSL bindings for app’s hostnames.

    hostNamesDisabled
    bool

    HostNamesDisabled: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.

    hostingEnvironmentProfile
    HostingEnvironmentProfile

    HostingEnvironmentProfile: App Service Environment to use for the app.

    httpsOnly
    bool

    HttpsOnly: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests

    hyperV
    bool

    HyperV: Hyper-V sandbox.

    identity
    ManagedServiceIdentity

    Identity: Managed service identity.

    isXenon
    bool

    IsXenon: Obsolete: Hyper-V sandbox.

    keyVaultReferenceIdentity
    string

    KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication.

    kind
    string

    Kind: Kind of resource.

    location
    string

    Location: Resource Location.

    owner
    genruntime.KnownResourceReference

    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

    publicNetworkAccess
    string

    PublicNetworkAccess: Property to allow or block all public traffic. Allowed Values: ‘Enabled’, ‘Disabled’ or an empty string.

    redundancyMode
    Site_Properties_RedundancyMode_Spec

    RedundancyMode: Site redundancy mode

    reserved
    bool

    Reserved: true if reserved; otherwise, false.

    scmSiteAlsoStopped
    bool

    ScmSiteAlsoStopped: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.

    serverFarmReference
    genruntime.ResourceReference

    ServerFarmReference: Resource ID of the associated App Service plan, formatted as: “/​subscriptions/​{subscriptionID}/​resourceGroups/​{groupName}/​providers/​Microsoft.Web/​serverfarms/​{appServicePlanName}”.

    siteConfig
    SiteConfig

    SiteConfig: Configuration of the app.

    storageAccountRequired
    bool

    StorageAccountRequired: Checks if Customer provided storage account is required

    tags
    map[string]string

    Tags: Resource tags.

    virtualNetworkSubnetReference
    genruntime.ResourceReference

    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}

    vnetContentShareEnabled
    bool

    VnetContentShareEnabled: To enable accessing content over virtual network

    vnetImagePullEnabled
    bool

    VnetImagePullEnabled: To enable pulling image over Virtual Network

    vnetRouteAllEnabled
    bool

    VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

    status
    Site_STATUS

    SiteConfig

    (Appears on:Site_Spec)

    Configuration of an App Service app.

    Field Description
    acrUseManagedIdentityCreds
    bool

    AcrUseManagedIdentityCreds: Flag to use Managed Identity Creds for ACR pull

    acrUserManagedIdentityID
    string

    AcrUserManagedIdentityID: If using user managed identity, the user managed identity ClientId

    alwaysOn
    bool

    AlwaysOn: true if Always On is enabled; otherwise, false.

    apiDefinition
    ApiDefinitionInfo

    ApiDefinition: Information about the formal API definition for the app.

    apiManagementConfig
    ApiManagementConfig

    ApiManagementConfig: Azure API management settings linked to the app.

    appCommandLine
    string

    AppCommandLine: App command line to launch.

    appSettings
    []NameValuePair

    AppSettings: Application settings.

    autoHealEnabled
    bool

    AutoHealEnabled: true if Auto Heal is enabled; otherwise, false.

    autoHealRules
    AutoHealRules

    AutoHealRules: Auto Heal rules.

    autoSwapSlotName
    string

    AutoSwapSlotName: Auto-swap slot name.

    azureStorageAccounts
    map[string]./api/web/v1api20220301.AzureStorageInfoValue

    AzureStorageAccounts: List of Azure Storage Accounts.

    connectionStrings
    []ConnStringInfo

    ConnectionStrings: Connection strings.

    cors
    CorsSettings

    Cors: Cross-Origin Resource Sharing (CORS) settings.

    defaultDocuments
    []string

    DefaultDocuments: Default documents.

    detailedErrorLoggingEnabled
    bool

    DetailedErrorLoggingEnabled: true if detailed error logging is enabled; otherwise, false.

    documentRoot
    string

    DocumentRoot: Document root.

    experiments
    Experiments

    Experiments: This is work around for polymorphic types.

    ftpsState
    SiteConfig_FtpsState

    FtpsState: State of FTP / FTPS service

    functionAppScaleLimit
    int

    FunctionAppScaleLimit: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans

    functionsRuntimeScaleMonitoringEnabled
    bool

    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.

    handlerMappings
    []HandlerMapping

    HandlerMappings: Handler mappings.

    healthCheckPath
    string

    HealthCheckPath: Health check path

    http20Enabled
    bool

    Http20Enabled: Http20Enabled: configures a web site to allow clients to connect over http2.0

    httpLoggingEnabled
    bool

    HttpLoggingEnabled: true if HTTP logging is enabled; otherwise, false.

    ipSecurityRestrictions
    []IpSecurityRestriction

    IpSecurityRestrictions: IP security restrictions for main.

    javaContainer
    string

    JavaContainer: Java container.

    javaContainerVersion
    string

    JavaContainerVersion: Java container version.

    javaVersion
    string

    JavaVersion: Java version.

    keyVaultReferenceIdentity
    string

    KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication.

    limits
    SiteLimits

    Limits: Site limits.

    linuxFxVersion
    string

    LinuxFxVersion: Linux App Framework and version

    loadBalancing
    SiteConfig_LoadBalancing

    LoadBalancing: Site load balancing.

    localMySqlEnabled
    bool

    LocalMySqlEnabled: true to enable local MySQL; otherwise, false.

    logsDirectorySizeLimit
    int

    LogsDirectorySizeLimit: HTTP logs directory size limit.

    managedPipelineMode
    SiteConfig_ManagedPipelineMode

    ManagedPipelineMode: Managed pipeline mode.

    managedServiceIdentityId
    int

    ManagedServiceIdentityId: Managed Service Identity Id

    minTlsVersion
    SiteConfig_MinTlsVersion

    MinTlsVersion: MinTlsVersion: configures the minimum version of TLS required for SSL requests

    minimumElasticInstanceCount
    int

    MinimumElasticInstanceCount: Number of minimum instance count for a site This setting only applies to the Elastic Plans

    netFrameworkVersion
    string

    NetFrameworkVersion: .NET Framework version.

    nodeVersion
    string

    NodeVersion: Version of Node.js.

    numberOfWorkers
    int

    NumberOfWorkers: Number of workers.

    phpVersion
    string

    PhpVersion: Version of PHP.

    powerShellVersion
    string

    PowerShellVersion: Version of PowerShell.

    preWarmedInstanceCount
    int

    PreWarmedInstanceCount: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans

    publicNetworkAccess
    string

    PublicNetworkAccess: Property to allow or block all public traffic.

    publishingUsername
    string

    PublishingUsername: Publishing user name.

    push
    PushSettings

    Push: Push endpoint settings.

    pythonVersion
    string

    PythonVersion: Version of Python.

    remoteDebuggingEnabled
    bool

    RemoteDebuggingEnabled: true if remote debugging is enabled; otherwise, false.

    remoteDebuggingVersion
    string

    RemoteDebuggingVersion: Remote debugging version.

    requestTracingEnabled
    bool

    RequestTracingEnabled: true if request tracing is enabled; otherwise, false.

    requestTracingExpirationTime
    string

    RequestTracingExpirationTime: Request tracing expiration time.

    scmIpSecurityRestrictions
    []IpSecurityRestriction

    ScmIpSecurityRestrictions: IP security restrictions for scm.

    scmIpSecurityRestrictionsUseMain
    bool

    ScmIpSecurityRestrictionsUseMain: IP security restrictions for scm to use main.

    scmMinTlsVersion
    SiteConfig_ScmMinTlsVersion

    ScmMinTlsVersion: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site

    scmType
    SiteConfig_ScmType

    ScmType: SCM type.

    tracingOptions
    string

    TracingOptions: Tracing options.

    use32BitWorkerProcess
    bool

    Use32BitWorkerProcess: true to use 32-bit worker process; otherwise, false.

    virtualApplications
    []VirtualApplication

    VirtualApplications: Virtual applications.

    vnetName
    string

    VnetName: Virtual Network name.

    vnetPrivatePortsCount
    int

    VnetPrivatePortsCount: The number of private ports assigned to this app. These will be assigned dynamically on runtime.

    vnetRouteAllEnabled
    bool

    VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

    webSocketsEnabled
    bool

    WebSocketsEnabled: true if WebSocket is enabled; otherwise, false.

    websiteTimeZone
    string

    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

    windowsFxVersion
    string

    WindowsFxVersion: Xenon App Framework and version

    xManagedServiceIdentityId
    int

    XManagedServiceIdentityId: Explicit Managed Service Identity Id

    SiteConfig_ARM

    (Appears on:Site_Properties_Spec_ARM)

    Configuration of an App Service app.

    Field Description
    acrUseManagedIdentityCreds
    bool

    AcrUseManagedIdentityCreds: Flag to use Managed Identity Creds for ACR pull

    acrUserManagedIdentityID
    string

    AcrUserManagedIdentityID: If using user managed identity, the user managed identity ClientId

    alwaysOn
    bool

    AlwaysOn: true if Always On is enabled; otherwise, false.

    apiDefinition
    ApiDefinitionInfo_ARM

    ApiDefinition: Information about the formal API definition for the app.

    apiManagementConfig
    ApiManagementConfig_ARM

    ApiManagementConfig: Azure API management settings linked to the app.

    appCommandLine
    string

    AppCommandLine: App command line to launch.

    appSettings
    []NameValuePair_ARM

    AppSettings: Application settings.

    autoHealEnabled
    bool

    AutoHealEnabled: true if Auto Heal is enabled; otherwise, false.

    autoHealRules
    AutoHealRules_ARM

    AutoHealRules: Auto Heal rules.

    autoSwapSlotName
    string

    AutoSwapSlotName: Auto-swap slot name.

    azureStorageAccounts
    map[string]./api/web/v1api20220301.AzureStorageInfoValue_ARM

    AzureStorageAccounts: List of Azure Storage Accounts.

    connectionStrings
    []ConnStringInfo_ARM

    ConnectionStrings: Connection strings.

    cors
    CorsSettings_ARM

    Cors: Cross-Origin Resource Sharing (CORS) settings.

    defaultDocuments
    []string

    DefaultDocuments: Default documents.

    detailedErrorLoggingEnabled
    bool

    DetailedErrorLoggingEnabled: true if detailed error logging is enabled; otherwise, false.

    documentRoot
    string

    DocumentRoot: Document root.

    experiments
    Experiments_ARM

    Experiments: This is work around for polymorphic types.

    ftpsState
    SiteConfig_FtpsState

    FtpsState: State of FTP / FTPS service

    functionAppScaleLimit
    int

    FunctionAppScaleLimit: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans

    functionsRuntimeScaleMonitoringEnabled
    bool

    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.

    handlerMappings
    []HandlerMapping_ARM

    HandlerMappings: Handler mappings.

    healthCheckPath
    string

    HealthCheckPath: Health check path

    http20Enabled
    bool

    Http20Enabled: Http20Enabled: configures a web site to allow clients to connect over http2.0

    httpLoggingEnabled
    bool

    HttpLoggingEnabled: true if HTTP logging is enabled; otherwise, false.

    ipSecurityRestrictions
    []IpSecurityRestriction_ARM

    IpSecurityRestrictions: IP security restrictions for main.

    javaContainer
    string

    JavaContainer: Java container.

    javaContainerVersion
    string

    JavaContainerVersion: Java container version.

    javaVersion
    string

    JavaVersion: Java version.

    keyVaultReferenceIdentity
    string

    KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication.

    limits
    SiteLimits_ARM

    Limits: Site limits.

    linuxFxVersion
    string

    LinuxFxVersion: Linux App Framework and version

    loadBalancing
    SiteConfig_LoadBalancing

    LoadBalancing: Site load balancing.

    localMySqlEnabled
    bool

    LocalMySqlEnabled: true to enable local MySQL; otherwise, false.

    logsDirectorySizeLimit
    int

    LogsDirectorySizeLimit: HTTP logs directory size limit.

    managedPipelineMode
    SiteConfig_ManagedPipelineMode

    ManagedPipelineMode: Managed pipeline mode.

    managedServiceIdentityId
    int

    ManagedServiceIdentityId: Managed Service Identity Id

    minTlsVersion
    SiteConfig_MinTlsVersion

    MinTlsVersion: MinTlsVersion: configures the minimum version of TLS required for SSL requests

    minimumElasticInstanceCount
    int

    MinimumElasticInstanceCount: Number of minimum instance count for a site This setting only applies to the Elastic Plans

    netFrameworkVersion
    string

    NetFrameworkVersion: .NET Framework version.

    nodeVersion
    string

    NodeVersion: Version of Node.js.

    numberOfWorkers
    int

    NumberOfWorkers: Number of workers.

    phpVersion
    string

    PhpVersion: Version of PHP.

    powerShellVersion
    string

    PowerShellVersion: Version of PowerShell.

    preWarmedInstanceCount
    int

    PreWarmedInstanceCount: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans

    publicNetworkAccess
    string

    PublicNetworkAccess: Property to allow or block all public traffic.

    publishingUsername
    string

    PublishingUsername: Publishing user name.

    push
    PushSettings_ARM

    Push: Push endpoint settings.

    pythonVersion
    string

    PythonVersion: Version of Python.

    remoteDebuggingEnabled
    bool

    RemoteDebuggingEnabled: true if remote debugging is enabled; otherwise, false.

    remoteDebuggingVersion
    string

    RemoteDebuggingVersion: Remote debugging version.

    requestTracingEnabled
    bool

    RequestTracingEnabled: true if request tracing is enabled; otherwise, false.

    requestTracingExpirationTime
    string

    RequestTracingExpirationTime: Request tracing expiration time.

    scmIpSecurityRestrictions
    []IpSecurityRestriction_ARM

    ScmIpSecurityRestrictions: IP security restrictions for scm.

    scmIpSecurityRestrictionsUseMain
    bool

    ScmIpSecurityRestrictionsUseMain: IP security restrictions for scm to use main.

    scmMinTlsVersion
    SiteConfig_ScmMinTlsVersion

    ScmMinTlsVersion: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site

    scmType
    SiteConfig_ScmType

    ScmType: SCM type.

    tracingOptions
    string

    TracingOptions: Tracing options.

    use32BitWorkerProcess
    bool

    Use32BitWorkerProcess: true to use 32-bit worker process; otherwise, false.

    virtualApplications
    []VirtualApplication_ARM

    VirtualApplications: Virtual applications.

    vnetName
    string

    VnetName: Virtual Network name.

    vnetPrivatePortsCount
    int

    VnetPrivatePortsCount: The number of private ports assigned to this app. These will be assigned dynamically on runtime.

    vnetRouteAllEnabled
    bool

    VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

    webSocketsEnabled
    bool

    WebSocketsEnabled: true if WebSocket is enabled; otherwise, false.

    websiteTimeZone
    string

    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

    windowsFxVersion
    string

    WindowsFxVersion: Xenon App Framework and version

    xManagedServiceIdentityId
    int

    XManagedServiceIdentityId: Explicit Managed Service Identity Id

    SiteConfig_FtpsState (string alias)

    (Appears on:SiteConfig, SiteConfig_ARM)

    Value Description

    "AllAllowed"

    "Disabled"

    "FtpsOnly"

    SiteConfig_FtpsState_STATUS (string alias)

    (Appears on:SiteConfig_STATUS, SiteConfig_STATUS_ARM)

    Value Description

    "AllAllowed"

    "Disabled"

    "FtpsOnly"

    SiteConfig_LoadBalancing (string alias)

    (Appears on:SiteConfig, SiteConfig_ARM)

    Value Description

    "LeastRequests"

    "LeastResponseTime"

    "PerSiteRoundRobin"

    "RequestHash"

    "WeightedRoundRobin"

    "WeightedTotalTraffic"

    SiteConfig_LoadBalancing_STATUS (string alias)

    (Appears on:SiteConfig_STATUS, SiteConfig_STATUS_ARM)

    Value Description

    "LeastRequests"

    "LeastResponseTime"

    "PerSiteRoundRobin"

    "RequestHash"

    "WeightedRoundRobin"

    "WeightedTotalTraffic"

    SiteConfig_ManagedPipelineMode (string alias)

    (Appears on:SiteConfig, SiteConfig_ARM)

    Value Description

    "Classic"

    "Integrated"

    SiteConfig_ManagedPipelineMode_STATUS (string alias)

    (Appears on:SiteConfig_STATUS, SiteConfig_STATUS_ARM)

    Value Description

    "Classic"

    "Integrated"

    SiteConfig_MinTlsVersion (string alias)

    (Appears on:SiteConfig, SiteConfig_ARM)

    Value Description

    "1.0"

    "1.1"

    "1.2"

    SiteConfig_MinTlsVersion_STATUS (string alias)

    (Appears on:SiteConfig_STATUS, SiteConfig_STATUS_ARM)

    Value Description

    "1.0"

    "1.1"

    "1.2"

    SiteConfig_STATUS

    (Appears on:Site_STATUS)

    Configuration of an App Service app.

    Field Description
    acrUseManagedIdentityCreds
    bool

    AcrUseManagedIdentityCreds: Flag to use Managed Identity Creds for ACR pull

    acrUserManagedIdentityID
    string

    AcrUserManagedIdentityID: If using user managed identity, the user managed identity ClientId

    alwaysOn
    bool

    AlwaysOn: true if Always On is enabled; otherwise, false.

    apiDefinition
    ApiDefinitionInfo_STATUS

    ApiDefinition: Information about the formal API definition for the app.

    apiManagementConfig
    ApiManagementConfig_STATUS

    ApiManagementConfig: Azure API management settings linked to the app.

    appCommandLine
    string

    AppCommandLine: App command line to launch.

    appSettings
    []NameValuePair_STATUS

    AppSettings: Application settings.

    autoHealEnabled
    bool

    AutoHealEnabled: true if Auto Heal is enabled; otherwise, false.

    autoHealRules
    AutoHealRules_STATUS

    AutoHealRules: Auto Heal rules.

    autoSwapSlotName
    string

    AutoSwapSlotName: Auto-swap slot name.

    azureStorageAccounts
    map[string]./api/web/v1api20220301.AzureStorageInfoValue_STATUS

    AzureStorageAccounts: List of Azure Storage Accounts.

    connectionStrings
    []ConnStringInfo_STATUS

    ConnectionStrings: Connection strings.

    cors
    CorsSettings_STATUS

    Cors: Cross-Origin Resource Sharing (CORS) settings.

    defaultDocuments
    []string

    DefaultDocuments: Default documents.

    detailedErrorLoggingEnabled
    bool

    DetailedErrorLoggingEnabled: true if detailed error logging is enabled; otherwise, false.

    documentRoot
    string

    DocumentRoot: Document root.

    experiments
    Experiments_STATUS

    Experiments: This is work around for polymorphic types.

    ftpsState
    SiteConfig_FtpsState_STATUS

    FtpsState: State of FTP / FTPS service

    functionAppScaleLimit
    int

    FunctionAppScaleLimit: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans

    functionsRuntimeScaleMonitoringEnabled
    bool

    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.

    handlerMappings
    []HandlerMapping_STATUS

    HandlerMappings: Handler mappings.

    healthCheckPath
    string

    HealthCheckPath: Health check path

    http20Enabled
    bool

    Http20Enabled: Http20Enabled: configures a web site to allow clients to connect over http2.0

    httpLoggingEnabled
    bool

    HttpLoggingEnabled: true if HTTP logging is enabled; otherwise, false.

    ipSecurityRestrictions
    []IpSecurityRestriction_STATUS

    IpSecurityRestrictions: IP security restrictions for main.

    javaContainer
    string

    JavaContainer: Java container.

    javaContainerVersion
    string

    JavaContainerVersion: Java container version.

    javaVersion
    string

    JavaVersion: Java version.

    keyVaultReferenceIdentity
    string

    KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication.

    limits
    SiteLimits_STATUS

    Limits: Site limits.

    linuxFxVersion
    string

    LinuxFxVersion: Linux App Framework and version

    loadBalancing
    SiteConfig_LoadBalancing_STATUS

    LoadBalancing: Site load balancing.

    localMySqlEnabled
    bool

    LocalMySqlEnabled: true to enable local MySQL; otherwise, false.

    logsDirectorySizeLimit
    int

    LogsDirectorySizeLimit: HTTP logs directory size limit.

    machineKey
    SiteMachineKey_STATUS

    MachineKey: Site MachineKey.

    managedPipelineMode
    SiteConfig_ManagedPipelineMode_STATUS

    ManagedPipelineMode: Managed pipeline mode.

    managedServiceIdentityId
    int

    ManagedServiceIdentityId: Managed Service Identity Id

    minTlsVersion
    SiteConfig_MinTlsVersion_STATUS

    MinTlsVersion: MinTlsVersion: configures the minimum version of TLS required for SSL requests

    minimumElasticInstanceCount
    int

    MinimumElasticInstanceCount: Number of minimum instance count for a site This setting only applies to the Elastic Plans

    netFrameworkVersion
    string

    NetFrameworkVersion: .NET Framework version.

    nodeVersion
    string

    NodeVersion: Version of Node.js.

    numberOfWorkers
    int

    NumberOfWorkers: Number of workers.

    phpVersion
    string

    PhpVersion: Version of PHP.

    powerShellVersion
    string

    PowerShellVersion: Version of PowerShell.

    preWarmedInstanceCount
    int

    PreWarmedInstanceCount: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans

    publicNetworkAccess
    string

    PublicNetworkAccess: Property to allow or block all public traffic.

    publishingUsername
    string

    PublishingUsername: Publishing user name.

    push
    PushSettings_STATUS

    Push: Push endpoint settings.

    pythonVersion
    string

    PythonVersion: Version of Python.

    remoteDebuggingEnabled
    bool

    RemoteDebuggingEnabled: true if remote debugging is enabled; otherwise, false.

    remoteDebuggingVersion
    string

    RemoteDebuggingVersion: Remote debugging version.

    requestTracingEnabled
    bool

    RequestTracingEnabled: true if request tracing is enabled; otherwise, false.

    requestTracingExpirationTime
    string

    RequestTracingExpirationTime: Request tracing expiration time.

    scmIpSecurityRestrictions
    []IpSecurityRestriction_STATUS

    ScmIpSecurityRestrictions: IP security restrictions for scm.

    scmIpSecurityRestrictionsUseMain
    bool

    ScmIpSecurityRestrictionsUseMain: IP security restrictions for scm to use main.

    scmMinTlsVersion
    SiteConfig_ScmMinTlsVersion_STATUS

    ScmMinTlsVersion: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site

    scmType
    SiteConfig_ScmType_STATUS

    ScmType: SCM type.

    tracingOptions
    string

    TracingOptions: Tracing options.

    use32BitWorkerProcess
    bool

    Use32BitWorkerProcess: true to use 32-bit worker process; otherwise, false.

    virtualApplications
    []VirtualApplication_STATUS

    VirtualApplications: Virtual applications.

    vnetName
    string

    VnetName: Virtual Network name.

    vnetPrivatePortsCount
    int

    VnetPrivatePortsCount: The number of private ports assigned to this app. These will be assigned dynamically on runtime.

    vnetRouteAllEnabled
    bool

    VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

    webSocketsEnabled
    bool

    WebSocketsEnabled: true if WebSocket is enabled; otherwise, false.

    websiteTimeZone
    string

    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

    windowsFxVersion
    string

    WindowsFxVersion: Xenon App Framework and version

    xManagedServiceIdentityId
    int

    XManagedServiceIdentityId: Explicit Managed Service Identity Id

    SiteConfig_STATUS_ARM

    (Appears on:Site_Properties_STATUS_ARM)

    Configuration of an App Service app.

    Field Description
    acrUseManagedIdentityCreds
    bool

    AcrUseManagedIdentityCreds: Flag to use Managed Identity Creds for ACR pull

    acrUserManagedIdentityID
    string

    AcrUserManagedIdentityID: If using user managed identity, the user managed identity ClientId

    alwaysOn
    bool

    AlwaysOn: true if Always On is enabled; otherwise, false.

    apiDefinition
    ApiDefinitionInfo_STATUS_ARM

    ApiDefinition: Information about the formal API definition for the app.

    apiManagementConfig
    ApiManagementConfig_STATUS_ARM

    ApiManagementConfig: Azure API management settings linked to the app.

    appCommandLine
    string

    AppCommandLine: App command line to launch.

    appSettings
    []NameValuePair_STATUS_ARM

    AppSettings: Application settings.

    autoHealEnabled
    bool

    AutoHealEnabled: true if Auto Heal is enabled; otherwise, false.

    autoHealRules
    AutoHealRules_STATUS_ARM

    AutoHealRules: Auto Heal rules.

    autoSwapSlotName
    string

    AutoSwapSlotName: Auto-swap slot name.

    azureStorageAccounts
    map[string]./api/web/v1api20220301.AzureStorageInfoValue_STATUS_ARM

    AzureStorageAccounts: List of Azure Storage Accounts.

    connectionStrings
    []ConnStringInfo_STATUS_ARM

    ConnectionStrings: Connection strings.

    cors
    CorsSettings_STATUS_ARM

    Cors: Cross-Origin Resource Sharing (CORS) settings.

    defaultDocuments
    []string

    DefaultDocuments: Default documents.

    detailedErrorLoggingEnabled
    bool

    DetailedErrorLoggingEnabled: true if detailed error logging is enabled; otherwise, false.

    documentRoot
    string

    DocumentRoot: Document root.

    experiments
    Experiments_STATUS_ARM

    Experiments: This is work around for polymorphic types.

    ftpsState
    SiteConfig_FtpsState_STATUS

    FtpsState: State of FTP / FTPS service

    functionAppScaleLimit
    int

    FunctionAppScaleLimit: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans

    functionsRuntimeScaleMonitoringEnabled
    bool

    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.

    handlerMappings
    []HandlerMapping_STATUS_ARM

    HandlerMappings: Handler mappings.

    healthCheckPath
    string

    HealthCheckPath: Health check path

    http20Enabled
    bool

    Http20Enabled: Http20Enabled: configures a web site to allow clients to connect over http2.0

    httpLoggingEnabled
    bool

    HttpLoggingEnabled: true if HTTP logging is enabled; otherwise, false.

    ipSecurityRestrictions
    []IpSecurityRestriction_STATUS_ARM

    IpSecurityRestrictions: IP security restrictions for main.

    javaContainer
    string

    JavaContainer: Java container.

    javaContainerVersion
    string

    JavaContainerVersion: Java container version.

    javaVersion
    string

    JavaVersion: Java version.

    keyVaultReferenceIdentity
    string

    KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication.

    limits
    SiteLimits_STATUS_ARM

    Limits: Site limits.

    linuxFxVersion
    string

    LinuxFxVersion: Linux App Framework and version

    loadBalancing
    SiteConfig_LoadBalancing_STATUS

    LoadBalancing: Site load balancing.

    localMySqlEnabled
    bool

    LocalMySqlEnabled: true to enable local MySQL; otherwise, false.

    logsDirectorySizeLimit
    int

    LogsDirectorySizeLimit: HTTP logs directory size limit.

    machineKey
    SiteMachineKey_STATUS_ARM

    MachineKey: Site MachineKey.

    managedPipelineMode
    SiteConfig_ManagedPipelineMode_STATUS

    ManagedPipelineMode: Managed pipeline mode.

    managedServiceIdentityId
    int

    ManagedServiceIdentityId: Managed Service Identity Id

    minTlsVersion
    SiteConfig_MinTlsVersion_STATUS

    MinTlsVersion: MinTlsVersion: configures the minimum version of TLS required for SSL requests

    minimumElasticInstanceCount
    int

    MinimumElasticInstanceCount: Number of minimum instance count for a site This setting only applies to the Elastic Plans

    netFrameworkVersion
    string

    NetFrameworkVersion: .NET Framework version.

    nodeVersion
    string

    NodeVersion: Version of Node.js.

    numberOfWorkers
    int

    NumberOfWorkers: Number of workers.

    phpVersion
    string

    PhpVersion: Version of PHP.

    powerShellVersion
    string

    PowerShellVersion: Version of PowerShell.

    preWarmedInstanceCount
    int

    PreWarmedInstanceCount: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans

    publicNetworkAccess
    string

    PublicNetworkAccess: Property to allow or block all public traffic.

    publishingUsername
    string

    PublishingUsername: Publishing user name.

    push
    PushSettings_STATUS_ARM

    Push: Push endpoint settings.

    pythonVersion
    string

    PythonVersion: Version of Python.

    remoteDebuggingEnabled
    bool

    RemoteDebuggingEnabled: true if remote debugging is enabled; otherwise, false.

    remoteDebuggingVersion
    string

    RemoteDebuggingVersion: Remote debugging version.

    requestTracingEnabled
    bool

    RequestTracingEnabled: true if request tracing is enabled; otherwise, false.

    requestTracingExpirationTime
    string

    RequestTracingExpirationTime: Request tracing expiration time.

    scmIpSecurityRestrictions
    []IpSecurityRestriction_STATUS_ARM

    ScmIpSecurityRestrictions: IP security restrictions for scm.

    scmIpSecurityRestrictionsUseMain
    bool

    ScmIpSecurityRestrictionsUseMain: IP security restrictions for scm to use main.

    scmMinTlsVersion
    SiteConfig_ScmMinTlsVersion_STATUS

    ScmMinTlsVersion: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site

    scmType
    SiteConfig_ScmType_STATUS

    ScmType: SCM type.

    tracingOptions
    string

    TracingOptions: Tracing options.

    use32BitWorkerProcess
    bool

    Use32BitWorkerProcess: true to use 32-bit worker process; otherwise, false.

    virtualApplications
    []VirtualApplication_STATUS_ARM

    VirtualApplications: Virtual applications.

    vnetName
    string

    VnetName: Virtual Network name.

    vnetPrivatePortsCount
    int

    VnetPrivatePortsCount: The number of private ports assigned to this app. These will be assigned dynamically on runtime.

    vnetRouteAllEnabled
    bool

    VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

    webSocketsEnabled
    bool

    WebSocketsEnabled: true if WebSocket is enabled; otherwise, false.

    websiteTimeZone
    string

    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

    windowsFxVersion
    string

    WindowsFxVersion: Xenon App Framework and version

    xManagedServiceIdentityId
    int

    XManagedServiceIdentityId: Explicit Managed Service Identity Id

    SiteConfig_ScmMinTlsVersion (string alias)

    (Appears on:SiteConfig, SiteConfig_ARM)

    Value Description

    "1.0"

    "1.1"

    "1.2"

    SiteConfig_ScmMinTlsVersion_STATUS (string alias)

    (Appears on:SiteConfig_STATUS, SiteConfig_STATUS_ARM)

    Value Description

    "1.0"

    "1.1"

    "1.2"

    SiteConfig_ScmType (string alias)

    (Appears on:SiteConfig, SiteConfig_ARM)

    Value Description

    "BitbucketGit"

    "BitbucketHg"

    "CodePlexGit"

    "CodePlexHg"

    "Dropbox"

    "ExternalGit"

    "ExternalHg"

    "GitHub"

    "LocalGit"

    "None"

    "OneDrive"

    "Tfs"

    "VSO"

    "VSTSRM"

    SiteConfig_ScmType_STATUS (string alias)

    (Appears on:SiteConfig_STATUS, SiteConfig_STATUS_ARM)

    Value Description

    "BitbucketGit"

    "BitbucketHg"

    "CodePlexGit"

    "CodePlexHg"

    "Dropbox"

    "ExternalGit"

    "ExternalHg"

    "GitHub"

    "LocalGit"

    "None"

    "OneDrive"

    "Tfs"

    "VSO"

    "VSTSRM"

    SiteLimits

    (Appears on:SiteConfig)

    Metric limits set on an app.

    Field Description
    maxDiskSizeInMb
    int

    MaxDiskSizeInMb: Maximum allowed disk size usage in MB.

    maxMemoryInMb
    int

    MaxMemoryInMb: Maximum allowed memory usage in MB.

    maxPercentageCpu
    float64

    MaxPercentageCpu: Maximum allowed CPU usage percentage.

    SiteLimits_ARM

    (Appears on:SiteConfig_ARM)

    Metric limits set on an app.

    Field Description
    maxDiskSizeInMb
    int

    MaxDiskSizeInMb: Maximum allowed disk size usage in MB.

    maxMemoryInMb
    int

    MaxMemoryInMb: Maximum allowed memory usage in MB.

    maxPercentageCpu
    float64

    MaxPercentageCpu: Maximum allowed CPU usage percentage.

    SiteLimits_STATUS

    (Appears on:SiteConfig_STATUS)

    Metric limits set on an app.

    Field Description
    maxDiskSizeInMb
    int

    MaxDiskSizeInMb: Maximum allowed disk size usage in MB.

    maxMemoryInMb
    int

    MaxMemoryInMb: Maximum allowed memory usage in MB.

    maxPercentageCpu
    float64

    MaxPercentageCpu: Maximum allowed CPU usage percentage.

    SiteLimits_STATUS_ARM

    (Appears on:SiteConfig_STATUS_ARM)

    Metric limits set on an app.

    Field Description
    maxDiskSizeInMb
    int

    MaxDiskSizeInMb: Maximum allowed disk size usage in MB.

    maxMemoryInMb
    int

    MaxMemoryInMb: Maximum allowed memory usage in MB.

    maxPercentageCpu
    float64

    MaxPercentageCpu: Maximum allowed CPU usage percentage.

    SiteMachineKey_STATUS

    (Appears on:SiteConfig_STATUS)

    MachineKey of an app.

    Field Description
    decryption
    string

    Decryption: Algorithm used for decryption.

    decryptionKey
    string

    DecryptionKey: Decryption key.

    validation
    string

    Validation: MachineKey validation.

    validationKey
    string

    ValidationKey: Validation key.

    SiteMachineKey_STATUS_ARM

    (Appears on:SiteConfig_STATUS_ARM)

    MachineKey of an app.

    Field Description
    decryption
    string

    Decryption: Algorithm used for decryption.

    decryptionKey
    string

    DecryptionKey: Decryption key.

    validation
    string

    Validation: MachineKey validation.

    validationKey
    string

    ValidationKey: Validation key.

    Site_Properties_AvailabilityState_STATUS (string alias)

    (Appears on:Site_Properties_STATUS_ARM, Site_STATUS)

    Value Description

    "DisasterRecoveryMode"

    "Limited"

    "Normal"

    Site_Properties_ClientCertMode_STATUS (string alias)

    (Appears on:Site_Properties_STATUS_ARM, Site_STATUS)

    Value Description

    "Optional"

    "OptionalInteractiveUser"

    "Required"

    Site_Properties_ClientCertMode_Spec (string alias)

    (Appears on:Site_Properties_Spec_ARM, Site_Spec)

    Value Description

    "Optional"

    "OptionalInteractiveUser"

    "Required"

    Site_Properties_RedundancyMode_STATUS (string alias)

    (Appears on:Site_Properties_STATUS_ARM, Site_STATUS)

    Value Description

    "ActiveActive"

    "Failover"

    "GeoRedundant"

    "Manual"

    "None"

    Site_Properties_RedundancyMode_Spec (string alias)

    (Appears on:Site_Properties_Spec_ARM, Site_Spec)

    Value Description

    "ActiveActive"

    "Failover"

    "GeoRedundant"

    "Manual"

    "None"

    Site_Properties_STATUS_ARM

    (Appears on:Site_STATUS_ARM)

    Field Description
    availabilityState
    Site_Properties_AvailabilityState_STATUS

    AvailabilityState: Management information availability state for the app.

    clientAffinityEnabled
    bool

    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.

    clientCertEnabled
    bool

    ClientCertEnabled: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.

    clientCertExclusionPaths
    string

    ClientCertExclusionPaths: client certificate authentication comma-separated exclusion paths

    clientCertMode
    Site_Properties_ClientCertMode_STATUS

    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.

    cloningInfo
    CloningInfo_STATUS_ARM

    CloningInfo: If specified during app creation, the app is cloned from a source app.

    containerSize
    int

    ContainerSize: Size of the function container.

    customDomainVerificationId
    string

    CustomDomainVerificationId: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.

    dailyMemoryTimeQuota
    int

    DailyMemoryTimeQuota: Maximum allowed daily memory-time quota (applicable on dynamic apps only).

    defaultHostName
    string

    DefaultHostName: Default hostname of the app. Read-only.

    enabled
    bool

    Enabled: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).

    enabledHostNames
    []string

    EnabledHostNames: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames.

    hostNameSslStates
    []HostNameSslState_STATUS_ARM

    HostNameSslStates: Hostname SSL states are used to manage the SSL bindings for app’s hostnames.

    hostNames
    []string

    HostNames: Hostnames associated with the app.

    hostNamesDisabled
    bool

    HostNamesDisabled: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.

    hostingEnvironmentProfile
    HostingEnvironmentProfile_STATUS_ARM

    HostingEnvironmentProfile: App Service Environment to use for the app.

    httpsOnly
    bool

    HttpsOnly: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests

    hyperV
    bool

    HyperV: Hyper-V sandbox.

    inProgressOperationId
    string

    InProgressOperationId: Specifies an operation id if this site has a pending operation.

    isDefaultContainer
    bool

    IsDefaultContainer: true if the app is a default container; otherwise, false.

    isXenon
    bool

    IsXenon: Obsolete: Hyper-V sandbox.

    keyVaultReferenceIdentity
    string

    KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication.

    lastModifiedTimeUtc
    string

    LastModifiedTimeUtc: Last time the app was modified, in UTC. Read-only.

    maxNumberOfWorkers
    int

    MaxNumberOfWorkers: Maximum number of workers. This only applies to Functions container.

    outboundIpAddresses
    string

    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.

    possibleOutboundIpAddresses
    string

    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.

    publicNetworkAccess
    string

    PublicNetworkAccess: Property to allow or block all public traffic. Allowed Values: ‘Enabled’, ‘Disabled’ or an empty string.

    redundancyMode
    Site_Properties_RedundancyMode_STATUS

    RedundancyMode: Site redundancy mode

    repositorySiteName
    string

    RepositorySiteName: Name of the repository site.

    reserved
    bool

    Reserved: true if reserved; otherwise, false.

    resourceGroup
    string

    ResourceGroup: Name of the resource group the app belongs to. Read-only.

    scmSiteAlsoStopped
    bool

    ScmSiteAlsoStopped: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.

    serverFarmId
    string

    ServerFarmId: Resource ID of the associated App Service plan, formatted as: “/​subscriptions/​{subscriptionID}/​resourceGroups/​{groupName}/​providers/​Microsoft.Web/​serverfarms/​{appServicePlanName}”.

    siteConfig
    SiteConfig_STATUS_ARM

    SiteConfig: Configuration of the app.

    slotSwapStatus
    SlotSwapStatus_STATUS_ARM

    SlotSwapStatus: Status of the last deployment slot swap operation.

    state
    string

    State: Current state of the app.

    storageAccountRequired
    bool

    StorageAccountRequired: Checks if Customer provided storage account is required

    suspendedTill
    string

    SuspendedTill: App suspended till in case memory-time quota is exceeded.

    targetSwapSlot
    string

    TargetSwapSlot: Specifies which deployment slot this app will swap into. Read-only.

    trafficManagerHostNames
    []string

    TrafficManagerHostNames: Azure Traffic Manager hostnames associated with the app. Read-only.

    usageState
    Site_Properties_UsageState_STATUS

    UsageState: State indicating whether the app has exceeded its quota usage. Read-only.

    virtualNetworkSubnetId
    string

    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}

    vnetContentShareEnabled
    bool

    VnetContentShareEnabled: To enable accessing content over virtual network

    vnetImagePullEnabled
    bool

    VnetImagePullEnabled: To enable pulling image over Virtual Network

    vnetRouteAllEnabled
    bool

    VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

    Site_Properties_Spec_ARM

    (Appears on:Site_Spec_ARM)

    Field Description
    clientAffinityEnabled
    bool

    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.

    clientCertEnabled
    bool

    ClientCertEnabled: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.

    clientCertExclusionPaths
    string

    ClientCertExclusionPaths: client certificate authentication comma-separated exclusion paths

    clientCertMode
    Site_Properties_ClientCertMode_Spec

    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.

    cloningInfo
    CloningInfo_ARM

    CloningInfo: If specified during app creation, the app is cloned from a source app.

    containerSize
    int

    ContainerSize: Size of the function container.

    customDomainVerificationId
    string

    CustomDomainVerificationId: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.

    dailyMemoryTimeQuota
    int

    DailyMemoryTimeQuota: Maximum allowed daily memory-time quota (applicable on dynamic apps only).

    enabled
    bool

    Enabled: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).

    hostNameSslStates
    []HostNameSslState_ARM

    HostNameSslStates: Hostname SSL states are used to manage the SSL bindings for app’s hostnames.

    hostNamesDisabled
    bool

    HostNamesDisabled: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.

    hostingEnvironmentProfile
    HostingEnvironmentProfile_ARM

    HostingEnvironmentProfile: App Service Environment to use for the app.

    httpsOnly
    bool

    HttpsOnly: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests

    hyperV
    bool

    HyperV: Hyper-V sandbox.

    isXenon
    bool

    IsXenon: Obsolete: Hyper-V sandbox.

    keyVaultReferenceIdentity
    string

    KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication.

    publicNetworkAccess
    string

    PublicNetworkAccess: Property to allow or block all public traffic. Allowed Values: ‘Enabled’, ‘Disabled’ or an empty string.

    redundancyMode
    Site_Properties_RedundancyMode_Spec

    RedundancyMode: Site redundancy mode

    reserved
    bool

    Reserved: true if reserved; otherwise, false.

    scmSiteAlsoStopped
    bool

    ScmSiteAlsoStopped: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.

    serverFarmId
    string
    siteConfig
    SiteConfig_ARM

    SiteConfig: Configuration of the app.

    storageAccountRequired
    bool

    StorageAccountRequired: Checks if Customer provided storage account is required

    virtualNetworkSubnetId
    string
    vnetContentShareEnabled
    bool

    VnetContentShareEnabled: To enable accessing content over virtual network

    vnetImagePullEnabled
    bool

    VnetImagePullEnabled: To enable pulling image over Virtual Network

    vnetRouteAllEnabled
    bool

    VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

    Site_Properties_UsageState_STATUS (string alias)

    (Appears on:Site_Properties_STATUS_ARM, Site_STATUS)

    Value Description

    "Exceeded"

    "Normal"

    Site_STATUS

    (Appears on:Site)

    A web app, a mobile app backend, or an API app.

    Field Description
    availabilityState
    Site_Properties_AvailabilityState_STATUS

    AvailabilityState: Management information availability state for the app.

    clientAffinityEnabled
    bool

    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.

    clientCertEnabled
    bool

    ClientCertEnabled: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.

    clientCertExclusionPaths
    string

    ClientCertExclusionPaths: client certificate authentication comma-separated exclusion paths

    clientCertMode
    Site_Properties_ClientCertMode_STATUS

    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.

    cloningInfo
    CloningInfo_STATUS

    CloningInfo: If specified during app creation, the app is cloned from a source app.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    containerSize
    int

    ContainerSize: Size of the function container.

    customDomainVerificationId
    string

    CustomDomainVerificationId: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.

    dailyMemoryTimeQuota
    int

    DailyMemoryTimeQuota: Maximum allowed daily memory-time quota (applicable on dynamic apps only).

    defaultHostName
    string

    DefaultHostName: Default hostname of the app. Read-only.

    enabled
    bool

    Enabled: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).

    enabledHostNames
    []string

    EnabledHostNames: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames.

    extendedLocation
    ExtendedLocation_STATUS

    ExtendedLocation: Extended Location.

    hostNameSslStates
    []HostNameSslState_STATUS

    HostNameSslStates: Hostname SSL states are used to manage the SSL bindings for app’s hostnames.

    hostNames
    []string

    HostNames: Hostnames associated with the app.

    hostNamesDisabled
    bool

    HostNamesDisabled: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.

    hostingEnvironmentProfile
    HostingEnvironmentProfile_STATUS

    HostingEnvironmentProfile: App Service Environment to use for the app.

    httpsOnly
    bool

    HttpsOnly: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests

    hyperV
    bool

    HyperV: Hyper-V sandbox.

    id
    string

    Id: Resource Id.

    identity
    ManagedServiceIdentity_STATUS

    Identity: Managed service identity.

    inProgressOperationId
    string

    InProgressOperationId: Specifies an operation id if this site has a pending operation.

    isDefaultContainer
    bool

    IsDefaultContainer: true if the app is a default container; otherwise, false.

    isXenon
    bool

    IsXenon: Obsolete: Hyper-V sandbox.

    keyVaultReferenceIdentity
    string

    KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication.

    kind
    string

    Kind: Kind of resource.

    lastModifiedTimeUtc
    string

    LastModifiedTimeUtc: Last time the app was modified, in UTC. Read-only.

    location
    string

    Location: Resource Location.

    maxNumberOfWorkers
    int

    MaxNumberOfWorkers: Maximum number of workers. This only applies to Functions container.

    name
    string

    Name: Resource Name.

    outboundIpAddresses
    string

    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.

    possibleOutboundIpAddresses
    string

    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.

    publicNetworkAccess
    string

    PublicNetworkAccess: Property to allow or block all public traffic. Allowed Values: ‘Enabled’, ‘Disabled’ or an empty string.

    redundancyMode
    Site_Properties_RedundancyMode_STATUS

    RedundancyMode: Site redundancy mode

    repositorySiteName
    string

    RepositorySiteName: Name of the repository site.

    reserved
    bool

    Reserved: true if reserved; otherwise, false.

    resourceGroup
    string

    ResourceGroup: Name of the resource group the app belongs to. Read-only.

    scmSiteAlsoStopped
    bool

    ScmSiteAlsoStopped: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.

    serverFarmId
    string

    ServerFarmId: Resource ID of the associated App Service plan, formatted as: “/​subscriptions/​{subscriptionID}/​resourceGroups/​{groupName}/​providers/​Microsoft.Web/​serverfarms/​{appServicePlanName}”.

    siteConfig
    SiteConfig_STATUS

    SiteConfig: Configuration of the app.

    slotSwapStatus
    SlotSwapStatus_STATUS

    SlotSwapStatus: Status of the last deployment slot swap operation.

    state
    string

    State: Current state of the app.

    storageAccountRequired
    bool

    StorageAccountRequired: Checks if Customer provided storage account is required

    suspendedTill
    string

    SuspendedTill: App suspended till in case memory-time quota is exceeded.

    tags
    map[string]string

    Tags: Resource tags.

    targetSwapSlot
    string

    TargetSwapSlot: Specifies which deployment slot this app will swap into. Read-only.

    trafficManagerHostNames
    []string

    TrafficManagerHostNames: Azure Traffic Manager hostnames associated with the app. Read-only.

    type
    string

    Type: Resource type.

    usageState
    Site_Properties_UsageState_STATUS

    UsageState: State indicating whether the app has exceeded its quota usage. Read-only.

    virtualNetworkSubnetId
    string

    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}

    vnetContentShareEnabled
    bool

    VnetContentShareEnabled: To enable accessing content over virtual network

    vnetImagePullEnabled
    bool

    VnetImagePullEnabled: To enable pulling image over Virtual Network

    vnetRouteAllEnabled
    bool

    VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

    Site_STATUS_ARM

    A web app, a mobile app backend, or an API app.

    Field Description
    extendedLocation
    ExtendedLocation_STATUS_ARM

    ExtendedLocation: Extended Location.

    id
    string

    Id: Resource Id.

    identity
    ManagedServiceIdentity_STATUS_ARM

    Identity: Managed service identity.

    kind
    string

    Kind: Kind of resource.

    location
    string

    Location: Resource Location.

    name
    string

    Name: Resource Name.

    properties
    Site_Properties_STATUS_ARM

    Properties: Site resource specific properties

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: Resource type.

    Site_Spec

    (Appears on:Site)

    Field Description
    azureName
    string

    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.

    clientAffinityEnabled
    bool

    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.

    clientCertEnabled
    bool

    ClientCertEnabled: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.

    clientCertExclusionPaths
    string

    ClientCertExclusionPaths: client certificate authentication comma-separated exclusion paths

    clientCertMode
    Site_Properties_ClientCertMode_Spec

    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.

    cloningInfo
    CloningInfo

    CloningInfo: If specified during app creation, the app is cloned from a source app.

    containerSize
    int

    ContainerSize: Size of the function container.

    customDomainVerificationId
    string

    CustomDomainVerificationId: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.

    dailyMemoryTimeQuota
    int

    DailyMemoryTimeQuota: Maximum allowed daily memory-time quota (applicable on dynamic apps only).

    enabled
    bool

    Enabled: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).

    extendedLocation
    ExtendedLocation

    ExtendedLocation: Extended Location.

    hostNameSslStates
    []HostNameSslState

    HostNameSslStates: Hostname SSL states are used to manage the SSL bindings for app’s hostnames.

    hostNamesDisabled
    bool

    HostNamesDisabled: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.

    hostingEnvironmentProfile
    HostingEnvironmentProfile

    HostingEnvironmentProfile: App Service Environment to use for the app.

    httpsOnly
    bool

    HttpsOnly: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests

    hyperV
    bool

    HyperV: Hyper-V sandbox.

    identity
    ManagedServiceIdentity

    Identity: Managed service identity.

    isXenon
    bool

    IsXenon: Obsolete: Hyper-V sandbox.

    keyVaultReferenceIdentity
    string

    KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication.

    kind
    string

    Kind: Kind of resource.

    location
    string

    Location: Resource Location.

    owner
    genruntime.KnownResourceReference

    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

    publicNetworkAccess
    string

    PublicNetworkAccess: Property to allow or block all public traffic. Allowed Values: ‘Enabled’, ‘Disabled’ or an empty string.

    redundancyMode
    Site_Properties_RedundancyMode_Spec

    RedundancyMode: Site redundancy mode

    reserved
    bool

    Reserved: true if reserved; otherwise, false.

    scmSiteAlsoStopped
    bool

    ScmSiteAlsoStopped: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.

    serverFarmReference
    genruntime.ResourceReference

    ServerFarmReference: Resource ID of the associated App Service plan, formatted as: “/​subscriptions/​{subscriptionID}/​resourceGroups/​{groupName}/​providers/​Microsoft.Web/​serverfarms/​{appServicePlanName}”.

    siteConfig
    SiteConfig

    SiteConfig: Configuration of the app.

    storageAccountRequired
    bool

    StorageAccountRequired: Checks if Customer provided storage account is required

    tags
    map[string]string

    Tags: Resource tags.

    virtualNetworkSubnetReference
    genruntime.ResourceReference

    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}

    vnetContentShareEnabled
    bool

    VnetContentShareEnabled: To enable accessing content over virtual network

    vnetImagePullEnabled
    bool

    VnetImagePullEnabled: To enable pulling image over Virtual Network

    vnetRouteAllEnabled
    bool

    VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

    Site_Spec_ARM

    Field Description
    extendedLocation
    ExtendedLocation_ARM

    ExtendedLocation: Extended Location.

    identity
    ManagedServiceIdentity_ARM

    Identity: Managed service identity.

    kind
    string

    Kind: Kind of resource.

    location
    string

    Location: Resource Location.

    name
    string
    properties
    Site_Properties_Spec_ARM

    Properties: Site resource specific properties

    tags
    map[string]string

    Tags: Resource tags.

    SkuCapacity

    (Appears on:SkuDescription)

    Description of the App Service plan scale options.

    Field Description
    default
    int

    Default: Default number of workers for this App Service plan SKU.

    elasticMaximum
    int

    ElasticMaximum: Maximum number of Elastic workers for this App Service plan SKU.

    maximum
    int

    Maximum: Maximum number of workers for this App Service plan SKU.

    minimum
    int

    Minimum: Minimum number of workers for this App Service plan SKU.

    scaleType
    string

    ScaleType: Available scale configurations for an App Service plan.

    SkuCapacity_ARM

    (Appears on:SkuDescription_ARM)

    Description of the App Service plan scale options.

    Field Description
    default
    int

    Default: Default number of workers for this App Service plan SKU.

    elasticMaximum
    int

    ElasticMaximum: Maximum number of Elastic workers for this App Service plan SKU.

    maximum
    int

    Maximum: Maximum number of workers for this App Service plan SKU.

    minimum
    int

    Minimum: Minimum number of workers for this App Service plan SKU.

    scaleType
    string

    ScaleType: Available scale configurations for an App Service plan.

    SkuCapacity_STATUS

    (Appears on:SkuDescription_STATUS)

    Description of the App Service plan scale options.

    Field Description
    default
    int

    Default: Default number of workers for this App Service plan SKU.

    elasticMaximum
    int

    ElasticMaximum: Maximum number of Elastic workers for this App Service plan SKU.

    maximum
    int

    Maximum: Maximum number of workers for this App Service plan SKU.

    minimum
    int

    Minimum: Minimum number of workers for this App Service plan SKU.

    scaleType
    string

    ScaleType: Available scale configurations for an App Service plan.

    SkuCapacity_STATUS_ARM

    (Appears on:SkuDescription_STATUS_ARM)

    Description of the App Service plan scale options.

    Field Description
    default
    int

    Default: Default number of workers for this App Service plan SKU.

    elasticMaximum
    int

    ElasticMaximum: Maximum number of Elastic workers for this App Service plan SKU.

    maximum
    int

    Maximum: Maximum number of workers for this App Service plan SKU.

    minimum
    int

    Minimum: Minimum number of workers for this App Service plan SKU.

    scaleType
    string

    ScaleType: Available scale configurations for an App Service plan.

    SkuDescription

    (Appears on:Serverfarm_Spec)

    Description of a SKU for a scalable resource.

    Field Description
    capabilities
    []Capability

    Capabilities: Capabilities of the SKU, e.g., is traffic manager enabled?

    capacity
    int

    Capacity: Current number of instances assigned to the resource.

    family
    string

    Family: Family code of the resource SKU.

    locations
    []string

    Locations: Locations of the SKU.

    name
    string

    Name: Name of the resource SKU.

    size
    string

    Size: Size specifier of the resource SKU.

    skuCapacity
    SkuCapacity

    SkuCapacity: Min, max, and default scale values of the SKU.

    tier
    string

    Tier: Service tier of the resource SKU.

    SkuDescription_ARM

    (Appears on:Serverfarm_Spec_ARM)

    Description of a SKU for a scalable resource.

    Field Description
    capabilities
    []Capability_ARM

    Capabilities: Capabilities of the SKU, e.g., is traffic manager enabled?

    capacity
    int

    Capacity: Current number of instances assigned to the resource.

    family
    string

    Family: Family code of the resource SKU.

    locations
    []string

    Locations: Locations of the SKU.

    name
    string

    Name: Name of the resource SKU.

    size
    string

    Size: Size specifier of the resource SKU.

    skuCapacity
    SkuCapacity_ARM

    SkuCapacity: Min, max, and default scale values of the SKU.

    tier
    string

    Tier: Service tier of the resource SKU.

    SkuDescription_STATUS

    (Appears on:Serverfarm_STATUS)

    Description of a SKU for a scalable resource.

    Field Description
    capabilities
    []Capability_STATUS

    Capabilities: Capabilities of the SKU, e.g., is traffic manager enabled?

    capacity
    int

    Capacity: Current number of instances assigned to the resource.

    family
    string

    Family: Family code of the resource SKU.

    locations
    []string

    Locations: Locations of the SKU.

    name
    string

    Name: Name of the resource SKU.

    size
    string

    Size: Size specifier of the resource SKU.

    skuCapacity
    SkuCapacity_STATUS

    SkuCapacity: Min, max, and default scale values of the SKU.

    tier
    string

    Tier: Service tier of the resource SKU.

    SkuDescription_STATUS_ARM

    (Appears on:Serverfarm_STATUS_ARM)

    Description of a SKU for a scalable resource.

    Field Description
    capabilities
    []Capability_STATUS_ARM

    Capabilities: Capabilities of the SKU, e.g., is traffic manager enabled?

    capacity
    int

    Capacity: Current number of instances assigned to the resource.

    family
    string

    Family: Family code of the resource SKU.

    locations
    []string

    Locations: Locations of the SKU.

    name
    string

    Name: Name of the resource SKU.

    size
    string

    Size: Size specifier of the resource SKU.

    skuCapacity
    SkuCapacity_STATUS_ARM

    SkuCapacity: Min, max, and default scale values of the SKU.

    tier
    string

    Tier: Service tier of the resource SKU.

    SlotSwapStatus_STATUS

    (Appears on:Site_STATUS)

    The status of the last successful slot swap operation.

    Field Description
    destinationSlotName
    string

    DestinationSlotName: The destination slot of the last swap operation.

    sourceSlotName
    string

    SourceSlotName: The source slot of the last swap operation.

    timestampUtc
    string

    TimestampUtc: The time the last successful slot swap completed.

    SlotSwapStatus_STATUS_ARM

    (Appears on:Site_Properties_STATUS_ARM)

    The status of the last successful slot swap operation.

    Field Description
    destinationSlotName
    string

    DestinationSlotName: The destination slot of the last swap operation.

    sourceSlotName
    string

    SourceSlotName: The source slot of the last swap operation.

    timestampUtc
    string

    TimestampUtc: The time the last successful slot swap completed.

    SlowRequestsBasedTrigger

    (Appears on:AutoHealTriggers)

    Trigger based on request execution time.

    Field Description
    count
    int

    Count: Request Count.

    path
    string

    Path: Request Path.

    timeInterval
    string

    TimeInterval: Time interval.

    timeTaken
    string

    TimeTaken: Time taken.

    SlowRequestsBasedTrigger_ARM

    (Appears on:AutoHealTriggers_ARM)

    Trigger based on request execution time.

    Field Description
    count
    int

    Count: Request Count.

    path
    string

    Path: Request Path.

    timeInterval
    string

    TimeInterval: Time interval.

    timeTaken
    string

    TimeTaken: Time taken.

    SlowRequestsBasedTrigger_STATUS

    (Appears on:AutoHealTriggers_STATUS)

    Trigger based on request execution time.

    Field Description
    count
    int

    Count: Request Count.

    path
    string

    Path: Request Path.

    timeInterval
    string

    TimeInterval: Time interval.

    timeTaken
    string

    TimeTaken: Time taken.

    SlowRequestsBasedTrigger_STATUS_ARM

    (Appears on:AutoHealTriggers_STATUS_ARM)

    Trigger based on request execution time.

    Field Description
    count
    int

    Count: Request Count.

    path
    string

    Path: Request Path.

    timeInterval
    string

    TimeInterval: Time interval.

    timeTaken
    string

    TimeTaken: Time taken.

    StatusCodesBasedTrigger

    (Appears on:AutoHealTriggers)

    Trigger based on status code.

    Field Description
    count
    int

    Count: Request Count.

    path
    string

    Path: Request Path

    status
    int

    Status: HTTP status code.

    subStatus
    int

    SubStatus: Request Sub Status.

    timeInterval
    string

    TimeInterval: Time interval.

    win32Status
    int

    Win32Status: Win32 error code.

    StatusCodesBasedTrigger_ARM

    (Appears on:AutoHealTriggers_ARM)

    Trigger based on status code.

    Field Description
    count
    int

    Count: Request Count.

    path
    string

    Path: Request Path

    status
    int

    Status: HTTP status code.

    subStatus
    int

    SubStatus: Request Sub Status.

    timeInterval
    string

    TimeInterval: Time interval.

    win32Status
    int

    Win32Status: Win32 error code.

    StatusCodesBasedTrigger_STATUS

    (Appears on:AutoHealTriggers_STATUS)

    Trigger based on status code.

    Field Description
    count
    int

    Count: Request Count.

    path
    string

    Path: Request Path

    status
    int

    Status: HTTP status code.

    subStatus
    int

    SubStatus: Request Sub Status.

    timeInterval
    string

    TimeInterval: Time interval.

    win32Status
    int

    Win32Status: Win32 error code.

    StatusCodesBasedTrigger_STATUS_ARM

    (Appears on:AutoHealTriggers_STATUS_ARM)

    Trigger based on status code.

    Field Description
    count
    int

    Count: Request Count.

    path
    string

    Path: Request Path

    status
    int

    Status: HTTP status code.

    subStatus
    int

    SubStatus: Request Sub Status.

    timeInterval
    string

    TimeInterval: Time interval.

    win32Status
    int

    Win32Status: Win32 error code.

    StatusCodesRangeBasedTrigger

    (Appears on:AutoHealTriggers)

    Trigger based on range of status codes.

    Field Description
    count
    int

    Count: Request Count.

    path
    string
    statusCodes
    string

    StatusCodes: HTTP status code.

    timeInterval
    string

    TimeInterval: Time interval.

    StatusCodesRangeBasedTrigger_ARM

    (Appears on:AutoHealTriggers_ARM)

    Trigger based on range of status codes.

    Field Description
    count
    int

    Count: Request Count.

    path
    string
    statusCodes
    string

    StatusCodes: HTTP status code.

    timeInterval
    string

    TimeInterval: Time interval.

    StatusCodesRangeBasedTrigger_STATUS

    (Appears on:AutoHealTriggers_STATUS)

    Trigger based on range of status codes.

    Field Description
    count
    int

    Count: Request Count.

    path
    string
    statusCodes
    string

    StatusCodes: HTTP status code.

    timeInterval
    string

    TimeInterval: Time interval.

    StatusCodesRangeBasedTrigger_STATUS_ARM

    (Appears on:AutoHealTriggers_STATUS_ARM)

    Trigger based on range of status codes.

    Field Description
    count
    int

    Count: Request Count.

    path
    string
    statusCodes
    string

    StatusCodes: HTTP status code.

    timeInterval
    string

    TimeInterval: Time interval.

    UserAssignedIdentityDetails

    (Appears on:ManagedServiceIdentity)

    Information about the user assigned identity for the resource

    Field Description
    reference
    genruntime.ResourceReference

    UserAssignedIdentityDetails_ARM

    (Appears on:ManagedServiceIdentity_ARM)

    Information about the user assigned identity for the resource

    UserAssignedIdentity_STATUS

    (Appears on:ManagedServiceIdentity_STATUS)

    User Assigned identity.

    Field Description
    clientId
    string

    ClientId: Client Id of user assigned identity

    principalId
    string

    PrincipalId: Principal Id of user assigned identity

    UserAssignedIdentity_STATUS_ARM

    (Appears on:ManagedServiceIdentity_STATUS_ARM)

    User Assigned identity.

    Field Description
    clientId
    string

    ClientId: Client Id of user assigned identity

    principalId
    string

    PrincipalId: Principal Id of user assigned identity

    VirtualApplication

    (Appears on:SiteConfig)

    Virtual application in an app.

    Field Description
    physicalPath
    string

    PhysicalPath: Physical path.

    preloadEnabled
    bool

    PreloadEnabled: true if preloading is enabled; otherwise, false.

    virtualDirectories
    []VirtualDirectory

    VirtualDirectories: Virtual directories for virtual application.

    virtualPath
    string

    VirtualPath: Virtual path.

    VirtualApplication_ARM

    (Appears on:SiteConfig_ARM)

    Virtual application in an app.

    Field Description
    physicalPath
    string

    PhysicalPath: Physical path.

    preloadEnabled
    bool

    PreloadEnabled: true if preloading is enabled; otherwise, false.

    virtualDirectories
    []VirtualDirectory_ARM

    VirtualDirectories: Virtual directories for virtual application.

    virtualPath
    string

    VirtualPath: Virtual path.

    VirtualApplication_STATUS

    (Appears on:SiteConfig_STATUS)

    Virtual application in an app.

    Field Description
    physicalPath
    string

    PhysicalPath: Physical path.

    preloadEnabled
    bool

    PreloadEnabled: true if preloading is enabled; otherwise, false.

    virtualDirectories
    []VirtualDirectory_STATUS

    VirtualDirectories: Virtual directories for virtual application.

    virtualPath
    string

    VirtualPath: Virtual path.

    VirtualApplication_STATUS_ARM

    (Appears on:SiteConfig_STATUS_ARM)

    Virtual application in an app.

    Field Description
    physicalPath
    string

    PhysicalPath: Physical path.

    preloadEnabled
    bool

    PreloadEnabled: true if preloading is enabled; otherwise, false.

    virtualDirectories
    []VirtualDirectory_STATUS_ARM

    VirtualDirectories: Virtual directories for virtual application.

    virtualPath
    string

    VirtualPath: Virtual path.

    VirtualDirectory

    (Appears on:VirtualApplication)

    Directory for virtual application.

    Field Description
    physicalPath
    string

    PhysicalPath: Physical path.

    virtualPath
    string

    VirtualPath: Path to virtual application.

    VirtualDirectory_ARM

    (Appears on:VirtualApplication_ARM)

    Directory for virtual application.

    Field Description
    physicalPath
    string

    PhysicalPath: Physical path.

    virtualPath
    string

    VirtualPath: Path to virtual application.

    VirtualDirectory_STATUS

    (Appears on:VirtualApplication_STATUS)

    Directory for virtual application.

    Field Description
    physicalPath
    string

    PhysicalPath: Physical path.

    virtualPath
    string

    VirtualPath: Path to virtual application.

    VirtualDirectory_STATUS_ARM

    (Appears on:VirtualApplication_STATUS_ARM)

    Directory for virtual application.

    Field Description
    physicalPath
    string

    PhysicalPath: Physical path.

    virtualPath
    string

    VirtualPath: Path to virtual application.