swagger: '2.0'
info:
version: '2023-01-01'
title: Microsoft Azure Common Definitions
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
paths: {}
definitions:
ApiDefinitionInfo:
description: Information about the formal API definition for the app.
type: object
properties:
url:
description: The URL of the API definition.
type: string
ApiManagementConfig:
description: Azure API management (APIM) configuration linked to the app.
type: object
properties:
id:
description: APIM-Api Identifier.
type: string
AppServiceEnvironment:
description: Description of an App Service Environment.
required:
- virtualNetwork
type: object
properties:
provisioningState:
description: Provisioning state of the App Service Environment.
enum:
- Succeeded
- Failed
- Canceled
- InProgress
- Deleting
type: string
readOnly: true
x-ms-enum:
name: ProvisioningState
modelAsString: false
status:
description: Current status of the App Service Environment.
enum:
- Preparing
- Ready
- Scaling
- Deleting
type: string
readOnly: true
x-ms-enum:
name: HostingEnvironmentStatus
modelAsString: false
virtualNetwork:
$ref: '#/definitions/VirtualNetworkProfile'
description: Description of the Virtual Network.
internalLoadBalancingMode:
description: >-
Specifies which endpoints to serve internally in the Virtual Network
for the App Service Environment.
enum:
- None
- Web
- Publishing
- Web, Publishing
type: string
x-ms-enum:
name: LoadBalancingMode
modelAsString: true
multiSize:
description: Front-end VM size, e.g. "Medium", "Large".
type: string
multiRoleCount:
format: int32
description: Number of front-end instances.
type: integer
readOnly: true
ipsslAddressCount:
format: int32
description: Number of IP SSL addresses reserved for the App Service Environment.
type: integer
dnsSuffix:
description: DNS suffix of the App Service Environment.
type: string
maximumNumberOfMachines:
format: int32
description: Maximum number of VMs in the App Service Environment.
type: integer
readOnly: true
frontEndScaleFactor:
format: int32
description: Scale factor for front-ends.
type: integer
suspended:
description: >-
true if the App Service Environment is suspended;
otherwise, false. The environment can be suspended, e.g.
when the management endpoint is no longer available
(most likely because NSG blocked the incoming traffic).
type: boolean
readOnly: true
clusterSettings:
description: >-
Custom settings for changing the behavior of the App Service
Environment.
type: array
items:
$ref: '#/definitions/NameValuePair'
x-ms-identifiers:
- name
userWhitelistedIpRanges:
description: User added ip ranges to whitelist on ASE db
type: array
items:
type: string
hasLinuxWorkers:
description: Flag that displays whether an ASE has linux workers or not
type: boolean
readOnly: true
upgradePreference:
description: Upgrade Preference
default: None
enum:
- None
- Early
- Late
- Manual
type: string
x-ms-enum:
name: UpgradePreference
modelAsString: true
values:
- value: None
description: >-
No preference on when this App Service Environment will be
upgraded
- value: Early
description: >-
This App Service Environment will be upgraded before others in
the same region that have Upgrade Preference 'Late'
- value: Late
description: >-
This App Service Environment will be upgraded after others in
the same region that have Upgrade Preference 'Early'
- value: Manual
description: >-
ASEv3 only. Once an upgrade is available, this App Service
Environment will wait 10 days for the upgrade to be manually
initiated. After 10 days the upgrade will begin automatically
dedicatedHostCount:
format: int32
description: Dedicated Host Count
type: integer
zoneRedundant:
description: Whether or not this App Service Environment is zone-redundant.
type: boolean
customDnsSuffixConfiguration:
$ref: '#/definitions/CustomDnsSuffixConfiguration'
networkingConfiguration:
$ref: '#/definitions/AseV3NetworkingConfiguration'
upgradeAvailability:
description: Whether an upgrade is available for this App Service Environment.
enum:
- None
- Ready
type: string
readOnly: true
x-ms-enum:
name: UpgradeAvailability
modelAsString: true
values:
- value: None
description: >-
No upgrade is currently available for this App Service
Environment
- value: Ready
description: >-
An upgrade is ready to be manually initiated on this App Service
Environment
AppServicePlan:
description: App Service plan.
type: object
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
description: AppServicePlan resource specific properties
type: object
properties:
workerTierName:
description: Target worker tier assigned to the App Service plan.
type: string
status:
description: App Service plan status.
enum:
- Ready
- Pending
- Creating
type: string
readOnly: true
x-ms-enum:
name: StatusOptions
modelAsString: false
subscription:
description: App Service plan subscription.
type: string
readOnly: true
hostingEnvironmentProfile:
$ref: '#/definitions/HostingEnvironmentProfile'
description: >-
Specification for the App Service Environment to use for the App
Service plan.
x-ms-mutability:
- create
- read
maximumNumberOfWorkers:
format: int32
description: >-
Maximum number of instances that can be assigned to this App
Service plan.
type: integer
readOnly: true
numberOfWorkers:
format: int32
description: >-
The number of instances that are assigned to this App Service
plan.
type: integer
readOnly: true
geoRegion:
description: Geographical location for the App Service plan.
type: string
readOnly: true
perSiteScaling:
description: >-
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.
default: false
type: boolean
elasticScaleEnabled:
description: >-
ServerFarm supports ElasticScale. Apps in this plan will scale as
if the ServerFarm was ElasticPremium sku
type: boolean
maximumElasticWorkerCount:
format: int32
description: >-
Maximum number of total workers allowed for this
ElasticScaleEnabled App Service Plan
type: integer
numberOfSites:
format: int32
description: Number of apps assigned to this App Service plan.
type: integer
readOnly: true
isSpot:
description: If true, this App Service Plan owns spot instances.
type: boolean
spotExpirationTime:
format: date-time
description: >-
The time when the server farm expires. Valid only if it is a spot
server farm.
type: string
freeOfferExpirationTime:
format: date-time
description: The time when the server farm free offer expires.
type: string
resourceGroup:
description: Resource group of the App Service plan.
type: string
readOnly: true
reserved:
description: >-
If Linux app service plan true, false
otherwise.
default: false
type: boolean
x-ms-mutability:
- create
- read
isXenon:
description: >-
Obsolete: If Hyper-V container app service plan true,
false otherwise.
default: false
type: boolean
x-ms-mutability:
- create
- read
hyperV:
description: >-
If Hyper-V container app service plan true,
false otherwise.
default: false
type: boolean
x-ms-mutability:
- create
- read
targetWorkerCount:
format: int32
description: Scaling worker count.
type: integer
targetWorkerSizeId:
format: int32
description: Scaling worker size ID.
type: integer
provisioningState:
description: Provisioning state of the App Service Plan.
enum:
- Succeeded
- Failed
- Canceled
- InProgress
- Deleting
type: string
readOnly: true
x-ms-enum:
name: ProvisioningState
modelAsString: false
kubeEnvironmentProfile:
$ref: '#/definitions/KubeEnvironmentProfile'
description: >-
Specification for the Kubernetes Environment to use for the App
Service plan.
zoneRedundant:
description: >-
If true, this App Service Plan will perform
availability zone balancing.
If false, this App Service Plan will not perform
availability zone balancing.
default: false
type: boolean
x-ms-client-flatten: true
sku:
$ref: '#/definitions/SkuDescription'
extendedLocation:
$ref: '#/definitions/ExtendedLocation'
AppServicePlanCollection:
description: Collection of App Service plans.
required:
- value
type: object
properties:
value:
description: Collection of resources.
type: array
items:
$ref: '#/definitions/AppServicePlan'
nextLink:
description: Link to next page of resources.
type: string
readOnly: true
ArmIdWrapper:
description: A wrapper for an ARM resource id
type: object
properties:
id:
type: string
readOnly: true
AseV3NetworkingConfiguration:
description: Full view of networking configuration for an ASE.
type: object
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
properties:
properties:
description: AseV3NetworkingConfiguration resource specific properties
type: object
properties:
windowsOutboundIpAddresses:
type: array
items:
type: string
readOnly: true
linuxOutboundIpAddresses:
type: array
items:
type: string
readOnly: true
externalInboundIpAddresses:
type: array
items:
type: string
readOnly: true
internalInboundIpAddresses:
type: array
items:
type: string
readOnly: true
allowNewPrivateEndpointConnections:
description: >-
Property to enable and disable new private endpoint connection
creation on ASE
type: boolean
ftpEnabled:
description: Property to enable and disable FTP on ASEV3
type: boolean
remoteDebugEnabled:
description: Property to enable and disable Remote Debug on ASEV3
type: boolean
inboundIpAddressOverride:
description: >-
Customer provided Inbound IP Address. Only able to be set on Ase
create.
type: string
x-ms-client-flatten: true
AutoHealActions:
description: Actions which to take by the auto-heal module when a rule is triggered.
type: object
properties:
actionType:
description: Predefined action to be taken.
enum:
- Recycle
- LogEvent
- CustomAction
type: string
x-ms-enum:
name: AutoHealActionType
modelAsString: false
customAction:
$ref: '#/definitions/AutoHealCustomAction'
description: Custom action to be taken.
minProcessExecutionTime:
description: |-
Minimum time the process must execute
before taking the action
type: string
AutoHealCustomAction:
description: |-
Custom action to be executed
when an auto heal rule is triggered.
type: object
properties:
exe:
description: Executable to be run.
type: string
parameters:
description: Parameters for the executable.
type: string
AutoHealRules:
description: Rules that can be defined for auto-heal.
type: object
properties:
triggers:
$ref: '#/definitions/AutoHealTriggers'
description: Conditions that describe when to execute the auto-heal actions.
actions:
$ref: '#/definitions/AutoHealActions'
description: Actions to be executed when a rule is triggered.
AutoHealTriggers:
description: Triggers for auto-heal.
type: object
properties:
requests:
$ref: '#/definitions/RequestsBasedTrigger'
description: A rule based on total requests.
privateBytesInKB:
format: int32
description: A rule based on private bytes.
type: integer
statusCodes:
description: A rule based on status codes.
type: array
items:
$ref: '#/definitions/StatusCodesBasedTrigger'
x-ms-identifiers:
- path
slowRequests:
$ref: '#/definitions/SlowRequestsBasedTrigger'
description: A rule based on request execution time.
slowRequestsWithPath:
description: A rule based on multiple Slow Requests Rule with path
type: array
items:
$ref: '#/definitions/SlowRequestsBasedTrigger'
x-ms-identifiers:
- path
statusCodesRange:
description: A rule based on status codes ranges.
type: array
items:
$ref: '#/definitions/StatusCodesRangeBasedTrigger'
x-ms-identifiers:
- path
AzureStorageInfoValue:
description: >-
Azure Files or Blob Storage access information value for dictionary
storage.
type: object
properties:
type:
description: Type of storage.
enum:
- AzureFiles
- AzureBlob
type: string
x-ms-enum:
name: AzureStorageType
modelAsString: false
accountName:
description: Name of the storage account.
type: string
shareName:
description: Name of the file share (container name, for Blob storage).
type: string
accessKey:
description: Access key for the storage account.
type: string
x-ms-secret: true
mountPath:
description: Path to mount the storage within the site's runtime environment.
type: string
state:
description: State of the storage account.
enum:
- Ok
- InvalidCredentials
- InvalidShare
- NotValidated
type: string
readOnly: true
x-ms-enum:
name: AzureStorageState
modelAsString: false
Capability:
description: Describes the capabilities/features allowed for a specific SKU.
type: object
properties:
name:
description: Name of the SKU capability.
type: string
value:
description: Value of the SKU capability.
type: string
reason:
description: Reason of the SKU capability.
type: string
CloningInfo:
description: Information needed for cloning operation.
required:
- sourceWebAppId
type: object
properties:
correlationId:
format: uuid
description: >-
Correlation ID of cloning operation. This ID ties multiple cloning
operations
together to use the same snapshot.
type: string
example: 00000000-0000-0000-0000-000000000000
overwrite:
description: >-
true to overwrite destination app; otherwise,
false.
type: boolean
cloneCustomHostNames:
description: >-
true to clone custom hostnames from source app;
otherwise, false.
type: boolean
cloneSourceControl:
description: >-
true to clone source control from source app; otherwise,
false.
type: boolean
sourceWebAppId:
description: >-
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.
type: string
sourceWebAppLocation:
description: 'Location of source app ex: West US or North Europe'
type: string
hostingEnvironment:
description: App Service Environment.
type: string
appSettingsOverrides:
description: >-
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.
type: object
additionalProperties:
type: string
configureLoadBalancing:
description: >-
true to configure load balancing for source and
destination app.
type: boolean
trafficManagerProfileId:
description: >-
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}.
type: string
trafficManagerProfileName:
description: >-
Name of Traffic Manager profile to create. This is only needed if
Traffic Manager profile does not already exist.
type: string
ConnStringInfo:
description: Database connection string information.
type: object
properties:
name:
description: Name of connection string.
type: string
connectionString:
description: Connection string value.
type: string
type:
description: Type of database.
enum:
- MySql
- SQLServer
- SQLAzure
- Custom
- NotificationHub
- ServiceBus
- EventHub
- ApiHub
- DocDb
- RedisCache
- PostgreSQL
type: string
x-ms-enum:
name: ConnectionStringType
modelAsString: false
Container:
description: Container App container definition.
type: object
properties:
image:
description: Container image tag.
type: string
name:
description: Custom container name.
type: string
command:
description: Container start command.
type: array
items:
type: string
args:
description: Container start command arguments.
type: array
items:
type: string
env:
description: Container environment variables.
type: array
items:
$ref: '#/definitions/EnvironmentVar'
x-ms-identifiers:
- name
resources:
$ref: '#/definitions/ContainerResources'
description: Container resource requirements.
ContainerResources:
description: Container App container resource requirements.
type: object
properties:
cpu:
format: double
description: Required CPU in cores, e.g. 0.5
type: number
memory:
description: Required memory, e.g. "250Mb"
type: string
CorsSettings:
description: Cross-Origin Resource Sharing (CORS) settings for the app.
type: object
properties:
allowedOrigins:
description: >-
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.
type: array
items:
type: string
supportCredentials:
description: >-
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.
type: boolean
CsmOperationCollection:
description: Collection of Azure resource manager operation metadata.
required:
- value
type: object
properties:
value:
description: Collection of resources.
type: array
items:
$ref: '#/definitions/CsmOperationDescription'
x-ms-identifiers:
- name
nextLink:
description: Link to next page of resources.
type: string
readOnly: true
CsmOperationDescription:
description: Description of an operation available for Microsoft.Web resource provider.
type: object
properties:
name:
type: string
isDataAction:
type: boolean
display:
$ref: '#/definitions/CsmOperationDisplay'
origin:
type: string
properties:
$ref: '#/definitions/CsmOperationDescriptionProperties'
CsmOperationDescriptionProperties:
description: Properties available for a Microsoft.Web resource provider operation.
type: object
properties:
serviceSpecification:
$ref: '#/definitions/ServiceSpecification'
CsmOperationDisplay:
description: Meta data about operation used for display in portal.
type: object
properties:
provider:
type: string
resource:
type: string
operation:
type: string
description:
type: string
CsmUsageQuota:
description: Usage of the quota resource.
type: object
properties:
unit:
description: Units of measurement for the quota resource.
type: string
nextResetTime:
format: date-time
description: Next reset time for the resource counter.
type: string
currentValue:
format: int64
description: The current value of the resource counter.
type: integer
limit:
format: int64
description: The resource limit.
type: integer
name:
$ref: '#/definitions/LocalizableString'
description: Quota name.
CsmUsageQuotaCollection:
description: Collection of CSM usage quotas.
required:
- value
type: object
properties:
value:
description: Collection of resources.
type: array
items:
$ref: '#/definitions/CsmUsageQuota'
x-ms-identifiers:
- name
nextLink:
description: Link to next page of resources.
type: string
readOnly: true
CustomDnsSuffixConfiguration:
description: Full view of the custom domain suffix configuration for ASEv3.
type: object
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
properties:
properties:
description: CustomDnsSuffixConfiguration resource specific properties
type: object
properties:
provisioningState:
enum:
- Succeeded
- Failed
- Degraded
- InProgress
type: string
readOnly: true
x-ms-enum:
name: CustomDnsSuffixProvisioningState
modelAsString: false
provisioningDetails:
type: string
readOnly: true
dnsSuffix:
description: >-
The default custom domain suffix to use for all sites deployed on
the ASE.
type: string
certificateUrl:
description: >-
The URL referencing the Azure Key Vault certificate secret that
should be used as the default SSL/TLS certificate for sites with
the custom domain suffix.
type: string
keyVaultReferenceIdentity:
description: >-
The user-assigned identity to use for resolving the key vault
certificate reference. If not specified, the system-assigned ASE
identity will be used if available.
type: string
x-ms-client-flatten: true
CustomScaleRule:
description: Container App container Custom scaling rule.
type: object
properties:
type:
description: |-
Type of the custom scale rule
eg: azure-servicebus, redis etc.
type: string
metadata:
description: Metadata properties to describe custom scale rule.
type: object
additionalProperties:
type: string
auth:
description: Authentication secrets for the custom scale rule.
type: array
items:
$ref: '#/definitions/ScaleRuleAuth'
x-ms-identifiers:
- triggerParameter
Dapr:
description: Container App Dapr configuration.
type: object
properties:
enabled:
description: Boolean indicating if the Dapr side car is enabled
type: boolean
appId:
description: Dapr application identifier
type: string
appPort:
format: int32
description: Port on which the Dapr side car
type: integer
components:
description: Collection of Dapr components
type: array
items:
$ref: '#/definitions/DaprComponent'
x-ms-identifiers:
- name
DaprComponent:
description: Dapr component configuration
type: object
properties:
name:
description: Component name
type: string
type:
description: Component type
type: string
version:
description: Component version
type: string
metadata:
description: Component metadata
type: array
items:
$ref: '#/definitions/DaprMetadata'
x-ms-identifiers:
- name
DaprMetadata:
description: Container App Dapr component metadata.
type: object
properties:
name:
description: Metadata property name.
type: string
value:
description: Metadata property value.
type: string
secretRef:
description: >-
Name of the Container App secret from which to pull the metadata
property value.
type: string
DataProviderMetadata:
description: Additional configuration for a data providers
type: object
properties:
providerName:
type: string
propertyBag:
description: Settings for the data provider
type: array
items:
$ref: '#/definitions/KeyValuePair[String,Object]'
readOnly: true
x-ms-identifiers:
- key
DataTableResponseColumn:
description: Column definition
type: object
properties:
columnName:
description: Name of the column
type: string
dataType:
description: Data type which looks like 'String' or 'Int32'.
type: string
columnType:
description: Column Type
type: string
DataTableResponseObject:
description: Data Table which defines columns and raw row values
type: object
properties:
tableName:
description: Name of the table
type: string
columns:
description: List of columns with data types
type: array
items:
$ref: '#/definitions/DataTableResponseColumn'
x-ms-identifiers:
- columnName
rows:
description: Raw row values
type: array
items:
type: array
items:
type: string
DefaultErrorResponse:
description: App Service error response.
type: object
properties:
error:
description: Error model.
type: object
properties:
code:
description: Standardized string to programmatically identify the error.
type: string
readOnly: true
message:
description: Detailed error description and debugging information.
type: string
readOnly: true
target:
description: Detailed error description and debugging information.
type: string
readOnly: true
details:
type: array
items:
description: Detailed errors.
type: object
properties:
code:
description: Standardized string to programmatically identify the error.
type: string
readOnly: true
message:
description: Detailed error description and debugging information.
type: string
readOnly: true
target:
description: Detailed error description and debugging information.
type: string
readOnly: true
readOnly: true
x-ms-identifiers: []
innererror:
description: More information to debug error.
type: string
readOnly: true
readOnly: true
DeletedSite:
description: A deleted app.
type: object
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
properties:
properties:
description: DeletedSite resource specific properties
type: object
properties:
deletedSiteId:
format: int32
description: Numeric id for the deleted site
type: integer
readOnly: true
deletedTimestamp:
description: Time in UTC when the app was deleted.
type: string
readOnly: true
subscription:
description: Subscription containing the deleted site
type: string
readOnly: true
resourceGroup:
description: ResourceGroup that contained the deleted site
type: string
readOnly: true
deletedSiteName:
description: Name of the deleted site
type: string
readOnly: true
slot:
description: Slot of the deleted site
type: string
readOnly: true
kind:
description: Kind of site that was deleted
type: string
readOnly: true
geoRegionName:
description: Geo Region of the deleted site
type: string
readOnly: true
x-ms-client-flatten: true
DetectorInfo:
description: Definition of Detector
type: object
properties:
id:
description: Id of detector
type: string
readOnly: true
name:
description: Name of detector
type: string
readOnly: true
description:
description: Short description of the detector and its purpose.
type: string
readOnly: true
author:
description: Author of the detector.
type: string
readOnly: true
category:
description: Problem category. This serves for organizing group for detectors.
type: string
readOnly: true
supportTopicList:
description: List of Support Topics for which this detector is enabled.
type: array
items:
$ref: '#/definitions/SupportTopic'
readOnly: true
analysisType:
description: Analysis Types for which this detector should apply to.
type: array
items:
type: string
readOnly: true
type:
description: Whether this detector is an Analysis Detector or not.
enum:
- Detector
- Analysis
- CategoryOverview
type: string
readOnly: true
x-ms-enum:
name: DetectorType
modelAsString: false
score:
format: float
description: Defines score of a detector to power ML based matching.
type: number
readOnly: true
DetectorResponse:
description: Class representing Response from Detector
type: object
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
properties:
properties:
description: DetectorResponse resource specific properties
type: object
properties:
metadata:
$ref: '#/definitions/DetectorInfo'
description: metadata for the detector
dataset:
description: Data Set
type: array
items:
$ref: '#/definitions/DiagnosticData'
x-ms-identifiers: []
status:
$ref: '#/definitions/Status'
description: Indicates status of the most severe insight.
dataProvidersMetadata:
description: >-
Additional configuration for different data providers to be used
by the UI
type: array
items:
$ref: '#/definitions/DataProviderMetadata'
x-ms-identifiers:
- providerName
suggestedUtterances:
$ref: '#/definitions/QueryUtterancesResults'
description: Suggested utterances where the detector can be applicable.
x-ms-client-flatten: true
DetectorResponseCollection:
description: Collection of detector responses
required:
- value
type: object
properties:
value:
description: Collection of resources.
type: array
items:
$ref: '#/definitions/DetectorResponse'
nextLink:
description: Link to next page of resources.
type: string
readOnly: true
DiagnosticData:
description: Set of data with rendering instructions
type: object
properties:
table:
$ref: '#/definitions/DataTableResponseObject'
description: Data in table form
renderingProperties:
$ref: '#/definitions/Rendering'
description: Properties that describe how the table should be rendered
Dimension:
description: >-
Dimension of a resource metric. For e.g. instance specific HTTP requests
for a web app,
where instance name is dimension of the metric HTTP request
type: object
properties:
name:
type: string
displayName:
type: string
internalName:
type: string
toBeExportedForShoebox:
type: boolean
EnvironmentVar:
description: Container App container environment variable.
type: object
properties:
name:
description: Environment variable name.
type: string
value:
description: Non-secret environment variable value.
type: string
secretRef:
description: >-
Name of the Container App secret from which to pull the environment
variable value.
type: string
ErrorEntity:
description: Body of the error response returned from the API.
type: object
properties:
extendedCode:
description: Type of error.
type: string
messageTemplate:
description: Message template.
type: string
parameters:
description: Parameters for the template.
type: array
items:
type: string
innerErrors:
description: Inner errors.
type: array
items:
$ref: '#/definitions/ErrorEntity'
x-ms-identifiers: []
details:
description: Error Details.
type: array
items:
$ref: '#/definitions/ErrorEntity'
x-ms-identifiers: []
target:
description: The error target.
type: string
code:
description: Basic error code.
type: string
message:
description: Any details of the error.
type: string
Experiments:
description: Routing rules in production experiments.
type: object
properties:
rampUpRules:
description: List of ramp-up rules.
type: array
items:
$ref: '#/definitions/RampUpRule'
x-ms-identifiers:
- name
ExtendedLocation:
description: Extended Location.
type: object
properties:
name:
description: Name of extended location.
type: string
type:
description: Type of extended location.
type: string
readOnly: true
HandlerMapping:
description: >-
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.
type: object
properties:
extension:
description: >-
Requests with this extension will be handled using the specified
FastCGI application.
type: string
scriptProcessor:
description: The absolute path to the FastCGI application.
type: string
arguments:
description: Command-line arguments to be passed to the script processor.
type: string
HostNameBinding:
description: A hostname binding object.
type: object
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
properties:
properties:
description: HostNameBinding resource specific properties
type: object
properties:
siteName:
description: App Service app name.
type: string
x-ms-mutability:
- create
- read
domainId:
description: Fully qualified ARM domain resource URI.
type: string
x-ms-mutability:
- create
- read
azureResourceName:
description: Azure resource name.
type: string
x-ms-mutability:
- create
- read
azureResourceType:
description: Azure resource type.
enum:
- Website
- TrafficManager
type: string
x-ms-enum:
name: AzureResourceType
modelAsString: false
x-ms-mutability:
- create
- read
customHostNameDnsRecordType:
description: Custom DNS record type.
enum:
- CName
- A
type: string
x-ms-enum:
name: CustomHostNameDnsRecordType
modelAsString: false
x-ms-mutability:
- create
- read
hostNameType:
description: Hostname type.
enum:
- Verified
- Managed
type: string
x-ms-enum:
name: HostNameType
modelAsString: false
x-ms-mutability:
- create
- read
sslState:
description: SSL type
enum:
- Disabled
- SniEnabled
- IpBasedEnabled
type: string
x-ms-enum:
name: SslState
modelAsString: false
x-ms-mutability:
- create
- read
thumbprint:
description: SSL certificate thumbprint
type: string
x-ms-mutability:
- create
- read
virtualIP:
description: >-
Virtual IP address assigned to the hostname if IP based SSL is
enabled.
type: string
readOnly: true
x-ms-client-flatten: true
HostNameBindingCollection:
description: Collection of hostname bindings.
required:
- value
type: object
properties:
value:
description: Collection of resources.
type: array
items:
$ref: '#/definitions/HostNameBinding'
nextLink:
description: Link to next page of resources.
type: string
readOnly: true
HostNameSslState:
description: SSL-enabled hostname.
type: object
properties:
name:
description: Hostname.
type: string
sslState:
description: SSL type.
enum:
- Disabled
- SniEnabled
- IpBasedEnabled
type: string
x-ms-enum:
name: SslState
modelAsString: false
virtualIP:
description: >-
Virtual IP address assigned to the hostname if IP based SSL is
enabled.
type: string
thumbprint:
description: SSL certificate thumbprint.
type: string
toUpdate:
description: Set to true to update existing hostname.
type: boolean
hostType:
description: Indicates whether the hostname is a standard or repository hostname.
enum:
- Standard
- Repository
type: string
x-ms-enum:
name: HostType
modelAsString: false
HostingEnvironmentProfile:
description: Specification for an App Service Environment to use for this resource.
type: object
properties:
id:
description: Resource ID of the App Service Environment.
type: string
name:
description: Name of the App Service Environment.
type: string
readOnly: true
type:
description: Resource type of the App Service Environment.
type: string
readOnly: true
HttpScaleRule:
description: Container App container Custom scaling rule.
type: object
properties:
metadata:
description: Metadata properties to describe http scale rule.
type: object
additionalProperties:
type: string
auth:
description: Authentication secrets for the custom scale rule.
type: array
items:
$ref: '#/definitions/ScaleRuleAuth'
x-ms-identifiers:
- triggerParameter
HybridConnection:
description: Hybrid Connection contract. This is used to configure a Hybrid Connection.
type: object
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
properties:
properties:
description: HybridConnection resource specific properties
type: object
properties:
serviceBusNamespace:
description: The name of the Service Bus namespace.
type: string
x-ms-mutability:
- create
- read
relayName:
description: The name of the Service Bus relay.
type: string
x-ms-mutability:
- create
- read
relayArmUri:
description: The ARM URI to the Service Bus relay.
type: string
hostname:
description: The hostname of the endpoint.
type: string
port:
format: int32
description: The port of the endpoint.
type: integer
sendKeyName:
description: >-
The name of the Service Bus key which has Send permissions. This
is used to authenticate to Service Bus.
type: string
sendKeyValue:
description: >-
The value of the Service Bus key. This is used to authenticate to
Service Bus. In ARM this key will not be returned
normally, use the POST /listKeys API instead.
type: string
serviceBusSuffix:
description: >-
The suffix for the service bus endpoint. By default this is
.servicebus.windows.net
type: string
x-ms-client-flatten: true
Identifier:
description: A domain specific resource identifier.
type: object
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
properties:
properties:
description: Identifier resource specific properties
type: object
properties:
id:
description: String representation of the identity.
type: string
x-ms-client-name: value
x-ms-client-flatten: true
IdentifierCollection:
description: Collection of identifiers.
required:
- value
type: object
properties:
value:
description: Collection of resources.
type: array
items:
$ref: '#/definitions/Identifier'
nextLink:
description: Link to next page of resources.
type: string
readOnly: true
IpSecurityRestriction:
description: IP security restriction on an app.
type: object
properties:
ipAddress:
description: >-
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.
type: string
subnetMask:
description: >-
Subnet mask for the range of IP addresses the restriction is valid
for.
type: string
vnetSubnetResourceId:
description: Virtual network resource id
type: string
vnetTrafficTag:
format: int32
description: (internal) Vnet traffic tag
type: integer
subnetTrafficTag:
format: int32
description: (internal) Subnet traffic tag
type: integer
action:
description: Allow or Deny access for this IP range.
type: string
tag:
description: >-
Defines what this IP filter will be used for. This is to support IP
filtering on proxies.
enum:
- Default
- XffProxy
- ServiceTag
type: string
x-ms-enum:
name: IpFilterTag
modelAsString: true
priority:
format: int32
description: Priority of IP restriction rule.
type: integer
name:
description: IP restriction rule name.
type: string
description:
description: IP restriction rule description.
type: string
headers:
description: >-
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.
type: object
additionalProperties:
type: array
items:
type: string
KeyValuePair[String,Object]:
type: object
properties:
key:
type: string
readOnly: true
value:
type: object
readOnly: true
KubeEnvironmentProfile:
description: Specification for a Kubernetes Environment to use for this resource.
type: object
properties:
id:
description: Resource ID of the Kubernetes Environment.
type: string
name:
description: Name of the Kubernetes Environment.
type: string
readOnly: true
type:
description: Resource type of the Kubernetes Environment.
type: string
readOnly: true
LocalizableString:
description: Localizable string object containing the name and a localized value.
type: object
properties:
value:
description: Non-localized name.
type: string
localizedValue:
description: Localized name.
type: string
LogSpecification:
description: Log Definition of a single resource metric.
type: object
properties:
name:
type: string
displayName:
type: string
blobDuration:
type: string
logFilterPattern:
type: string
ManagedServiceIdentity:
description: Managed service identity.
type: object
properties:
type:
description: Type of managed service identity.
enum:
- SystemAssigned
- UserAssigned
- SystemAssigned, UserAssigned
- None
type: string
x-ms-enum:
name: ManagedServiceIdentityType
modelAsString: false
tenantId:
description: Tenant of managed service identity.
type: string
readOnly: true
principalId:
description: Principal Id of managed service identity.
type: string
readOnly: true
userAssignedIdentities:
description: >-
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}
type: object
additionalProperties:
$ref: '#/definitions/userAssignedIdentity'
MetricAvailability:
description: Retention policy of a resource metric.
type: object
properties:
timeGrain:
type: string
blobDuration:
type: string
MetricSpecification:
description: Definition of a single resource metric.
type: object
properties:
name:
type: string
displayName:
type: string
displayDescription:
type: string
unit:
type: string
aggregationType:
type: string
supportsInstanceLevelAggregation:
type: boolean
enableRegionalMdmAccount:
type: boolean
sourceMdmAccount:
type: string
sourceMdmNamespace:
type: string
metricFilterPattern:
type: string
fillGapWithZero:
type: boolean
isInternal:
type: boolean
dimensions:
type: array
items:
$ref: '#/definitions/Dimension'
x-ms-identifiers:
- name
category:
type: string
availabilities:
type: array
items:
$ref: '#/definitions/MetricAvailability'
x-ms-identifiers: []
supportedTimeGrainTypes:
type: array
items:
type: string
supportedAggregationTypes:
type: array
items:
type: string
NameIdentifier:
description: Identifies an object.
type: object
properties:
name:
description: Name of the object.
type: string
NameValuePair:
description: Name value pair.
type: object
properties:
name:
description: Pair name.
type: string
value:
description: Pair value.
type: string
Operation:
description: An operation on a resource.
type: object
properties:
id:
description: Operation ID.
type: string
name:
description: Operation name.
type: string
status:
description: The current status of the operation.
enum:
- InProgress
- Failed
- Succeeded
- TimedOut
- Created
type: string
x-ms-enum:
name: OperationStatus
modelAsString: false
errors:
description: Any errors associate with the operation.
type: array
items:
$ref: '#/definitions/ErrorEntity'
x-ms-identifiers: []
createdTime:
format: date-time
description: Time when operation has started.
type: string
modifiedTime:
format: date-time
description: Time when operation has been updated.
type: string
expirationTime:
format: date-time
description: Time when operation will expire.
type: string
geoMasterOperationId:
format: uuid
description: Applicable only for stamp operation ids.
type: string
example: 00000000-0000-0000-0000-000000000000
PrivateEndpointConnectionCollection:
required:
- value
type: object
properties:
value:
description: Collection of resources.
type: array
items:
$ref: '#/definitions/RemotePrivateEndpointConnectionARMResource'
nextLink:
description: Link to next page of resources.
type: string
readOnly: true
PrivateLinkConnectionApprovalRequest:
description: A request to approve or reject a private endpoint connection
type: object
properties:
privateLinkServiceConnectionState:
$ref: '#/definitions/PrivateLinkConnectionState'
PrivateLinkConnectionApprovalRequestResource:
description: Private Endpoint Connection Approval ARM resource.
type: object
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
properties:
properties:
$ref: '#/definitions/PrivateLinkConnectionApprovalRequest'
description: Core resource properties
type: object
x-ms-client-flatten: true
PrivateLinkConnectionState:
description: The state of a private link connection
type: object
properties:
status:
description: Status of a private link connection
type: string
description:
description: Description of a private link connection
type: string
actionsRequired:
description: ActionsRequired for a private link connection
type: string
PrivateLinkResource:
description: A private link resource
required:
- id
- name
- type
- properties
type: object
properties:
id:
type: string
name:
description: Name of a private link resource
type: string
type:
type: string
properties:
$ref: '#/definitions/PrivateLinkResourceProperties'
description: Properties of a private link resource
PrivateLinkResourceProperties:
description: Properties of a private link resource
type: object
properties:
groupId:
description: GroupId of a private link resource
type: string
readOnly: true
requiredMembers:
description: RequiredMembers of a private link resource
type: array
items:
type: string
readOnly: true
requiredZoneNames:
description: RequiredZoneNames of a private link resource
type: array
items:
type: string
readOnly: true
PrivateLinkResourcesWrapper:
description: Wrapper for a collection of private link resources
required:
- value
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/PrivateLinkResource'
ProxyOnlyResource:
description: >-
Azure proxy only resource. This resource is not tracked by Azure Resource
Manager.
type: object
properties:
id:
description: Resource Id.
type: string
readOnly: true
name:
description: Resource Name.
type: string
readOnly: true
kind:
description: Kind of resource.
type: string
type:
description: Resource type.
type: string
readOnly: true
x-ms-azure-resource: true
PushSettings:
description: Push settings for the App.
type: object
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
properties:
properties:
description: PushSettings resource specific properties
required:
- isPushEnabled
type: object
properties:
isPushEnabled:
description: >-
Gets or sets a flag indicating whether the Push endpoint is
enabled.
type: boolean
tagWhitelistJson:
description: >-
Gets or sets a JSON string containing a list of tags that are
whitelisted for use by the push registration endpoint.
type: string
tagsRequiringAuth:
description: >-
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
dynamicTagsJson:
description: >-
Gets or sets a JSON string containing a list of dynamic tags that
will be evaluated from user claims in the push registration
endpoint.
type: string
x-ms-client-flatten: true
QueryUtterancesResult:
description: Result for utterances query.
type: object
properties:
sampleUtterance:
$ref: '#/definitions/SampleUtterance'
description: A sample utterance.
score:
format: float
description: Score of a sample utterance.
type: number
QueryUtterancesResults:
description: Suggested utterances where the detector can be applicable
type: object
properties:
query:
description: Search Query.
type: string
results:
description: Array of utterance results for search query.
type: array
items:
$ref: '#/definitions/QueryUtterancesResult'
x-ms-identifiers: []
QueueScaleRule:
description: Container App container Azure Queue based scaling rule.
type: object
properties:
queueName:
description: Queue name.
type: string
queueLength:
format: int32
description: Queue length.
type: integer
auth:
description: Authentication secrets for the queue scale rule.
type: array
items:
$ref: '#/definitions/ScaleRuleAuth'
x-ms-identifiers:
- triggerParameter
RampUpRule:
description: >-
Routing rules for ramp up testing. This rule allows to redirect static
traffic % to a slot or to gradually change routing % based on performance.
type: object
properties:
actionHostName:
description: >-
Hostname of a slot to which the traffic will be redirected if decided
to. E.g. myapp-stage.azurewebsites.net.
type: string
reroutePercentage:
format: double
description: >-
Percentage of the traffic which will be redirected to
ActionHostName.
type: number
changeStep:
format: double
description: >-
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.
type: number
changeIntervalInMinutes:
format: int32
description: Specifies interval in minutes to reevaluate ReroutePercentage.
type: integer
minReroutePercentage:
format: double
description: Specifies lower boundary above which ReroutePercentage will stay.
type: number
maxReroutePercentage:
format: double
description: Specifies upper boundary below which ReroutePercentage will stay.
type: number
changeDecisionCallbackUrl:
description: >-
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/
type: string
name:
description: >-
Name of the routing rule. The recommended name would be to point to
the slot which will receive the traffic in the experiment.
type: string
RemotePrivateEndpointConnectionARMResource:
description: Remote Private Endpoint Connection ARM resource.
type: object
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
properties:
properties:
description: >-
RemotePrivateEndpointConnectionARMResource resource specific
properties
type: object
properties:
provisioningState:
type: string
readOnly: true
privateEndpoint:
$ref: '#/definitions/ArmIdWrapper'
description: PrivateEndpoint of a remote private endpoint connection
privateLinkServiceConnectionState:
$ref: '#/definitions/PrivateLinkConnectionState'
ipAddresses:
description: Private IPAddresses mapped to the remote private endpoint
type: array
items:
type: string
x-ms-client-flatten: true
Rendering:
description: Instructions for rendering the data
type: object
properties:
type:
description: Rendering Type
enum:
- NoGraph
- Table
- TimeSeries
- TimeSeriesPerInstance
- PieChart
- DataSummary
- Email
- Insights
- DynamicInsight
- Markdown
- Detector
- DropDown
- Card
- Solution
- Guage
- Form
- ChangeSets
- ChangeAnalysisOnboarding
- ChangesView
- AppInsight
- DependencyGraph
- DownTime
- SummaryCard
- SearchComponent
- AppInsightEnablement
type: string
x-ms-enum:
name: RenderingType
modelAsString: false
title:
description: Title of data
type: string
description:
description: Description of the data that will help it be interpreted
type: string
RequestsBasedTrigger:
description: Trigger based on total requests.
type: object
properties:
count:
format: int32
description: Request Count.
type: integer
timeInterval:
description: Time interval.
type: string
Resource:
description: Azure resource. This resource is tracked in Azure Resource Manager
required:
- location
type: object
properties:
id:
description: Resource Id.
type: string
readOnly: true
name:
description: Resource Name.
type: string
readOnly: true
kind:
description: Kind of resource.
type: string
location:
description: Resource Location.
type: string
type:
description: Resource type.
type: string
readOnly: true
tags:
description: Resource tags.
type: object
additionalProperties:
type: string
x-ms-azure-resource: true
SampleUtterance:
description: Sample utterance.
type: object
properties:
text:
description: Text attribute of sample utterance.
type: string
links:
description: Links attribute of sample utterance.
type: array
items:
type: string
qid:
description: Question id of sample utterance (for stackoverflow questions titles).
type: string
Scale:
description: Container App scaling configurations.
type: object
properties:
minReplicas:
format: int32
description: Optional. Minimum number of container replicas.
type: integer
maxReplicas:
format: int32
description: >-
Optional. Maximum number of container replicas. Defaults to 10 if not
set.
type: integer
rules:
description: Scaling rules.
type: array
items:
$ref: '#/definitions/ScaleRule'
x-ms-identifiers:
- name
ScaleRule:
description: Container App container scaling rule.
type: object
properties:
name:
description: Scale Rule Name
type: string
azureQueue:
$ref: '#/definitions/QueueScaleRule'
description: Azure Queue based scaling.
custom:
$ref: '#/definitions/CustomScaleRule'
description: Custom scale rule.
http:
$ref: '#/definitions/HttpScaleRule'
description: HTTP requests based scaling.
ScaleRuleAuth:
description: Auth Secrets for Container App Scale Rule
type: object
properties:
secretRef:
description: Name of the Container App secret from which to pull the auth params.
type: string
triggerParameter:
description: Trigger Parameter that uses the secret
type: string
ServiceSpecification:
description: Resource metrics service provided by Microsoft.Insights resource provider.
type: object
properties:
metricSpecifications:
type: array
items:
$ref: '#/definitions/MetricSpecification'
x-ms-identifiers:
- name
logSpecifications:
type: array
items:
$ref: '#/definitions/LogSpecification'
x-ms-identifiers:
- name
Site:
description: A web app, a mobile app backend, or an API app.
type: object
allOf:
- $ref: '#/definitions/Resource'
properties:
properties:
description: Site resource specific properties
type: object
properties:
state:
description: Current state of the app.
type: string
readOnly: true
hostNames:
description: Hostnames associated with the app.
type: array
items:
type: string
readOnly: true
repositorySiteName:
description: Name of the repository site.
type: string
readOnly: true
usageState:
description: >-
State indicating whether the app has exceeded its quota usage.
Read-only.
enum:
- Normal
- Exceeded
type: string
readOnly: true
x-ms-enum:
name: UsageState
modelAsString: false
enabled:
description: >-
true if the app is enabled; otherwise,
false. Setting this value to false disables the app
(takes the app offline).
type: boolean
enabledHostNames:
description: >-
Enabled hostnames for the app.Hostnames need to be assigned (see
HostNames) AND enabled. Otherwise,
the app is not served on those hostnames.
type: array
items:
type: string
readOnly: true
availabilityState:
description: Management information availability state for the app.
enum:
- Normal
- Limited
- DisasterRecoveryMode
type: string
readOnly: true
x-ms-enum:
name: SiteAvailabilityState
modelAsString: false
hostNameSslStates:
description: >-
Hostname SSL states are used to manage the SSL bindings for app's
hostnames.
type: array
items:
$ref: '#/definitions/HostNameSslState'
x-ms-identifiers:
- name
serverFarmId:
description: >-
Resource ID of the associated App Service plan, formatted as:
"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
type: string
reserved:
description: true if reserved; otherwise, false.
default: false
type: boolean
x-ms-mutability:
- create
- read
isXenon:
description: 'Obsolete: Hyper-V sandbox.'
default: false
type: boolean
x-ms-mutability:
- create
- read
hyperV:
description: Hyper-V sandbox.
default: false
type: boolean
x-ms-mutability:
- create
- read
lastModifiedTimeUtc:
format: date-time
description: Last time the app was modified, in UTC. Read-only.
type: string
readOnly: true
vnetRouteAllEnabled:
description: >-
Virtual Network Route All enabled. This causes all outbound
traffic to have Virtual Network Security Groups and User Defined
Routes applied.
type: boolean
vnetImagePullEnabled:
description: To enable pulling image over Virtual Network
type: boolean
vnetContentShareEnabled:
description: To enable accessing content over virtual network
type: boolean
siteConfig:
$ref: '#/definitions/SiteConfig'
description: Configuration of the app.
daprConfig:
$ref: '#/definitions/DaprConfig'
description: Dapr configuration of the app.
workloadProfileName:
description: Workload profile name for function app to execute on.
type: string
resourceConfig:
$ref: '#/definitions/ResourceConfig'
description: Function app resource requirements.
trafficManagerHostNames:
description: >-
Azure Traffic Manager hostnames associated with the app.
Read-only.
type: array
items:
type: string
readOnly: true
scmSiteAlsoStopped:
description: >-
true to stop SCM (KUDU) site when the app is stopped;
otherwise, false. The default is false.
default: false
type: boolean
targetSwapSlot:
description: >-
Specifies which deployment slot this app will swap into.
Read-only.
type: string
readOnly: true
hostingEnvironmentProfile:
$ref: '#/definitions/HostingEnvironmentProfile'
description: App Service Environment to use for the app.
x-ms-mutability:
- create
- read
clientAffinityEnabled:
description: >-
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.
type: boolean
clientCertEnabled:
description: >-
true to enable client certificate authentication (TLS
mutual authentication); otherwise, false. Default is
false.
type: boolean
clientCertMode:
description: >-
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.
enum:
- Required
- Optional
- OptionalInteractiveUser
type: string
x-ms-enum:
name: ClientCertMode
modelAsString: false
clientCertExclusionPaths:
description: client certificate authentication comma-separated exclusion paths
type: string
hostNamesDisabled:
description: >-
true to disable the public hostnames of the app;
otherwise, false.
If true, the app is only accessible via API management process.
type: boolean
customDomainVerificationId:
description: >-
Unique identifier that verifies the custom domains assigned to the
app. Customer will add this id to a txt record for verification.
type: string
outboundIpAddresses:
description: >-
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.
type: string
readOnly: true
possibleOutboundIpAddresses:
description: >-
List of IP addresses that the app uses for outbound connections
(e.g. database access). Includes VIPs from all tenants except
dataComponent. Read-only.
type: string
readOnly: true
containerSize:
format: int32
description: Size of the function container.
type: integer
dailyMemoryTimeQuota:
format: int32
description: >-
Maximum allowed daily memory-time quota (applicable on dynamic
apps only).
type: integer
suspendedTill:
format: date-time
description: App suspended till in case memory-time quota is exceeded.
type: string
readOnly: true
maxNumberOfWorkers:
format: int32
description: |-
Maximum number of workers.
This only applies to Functions container.
type: integer
readOnly: true
cloningInfo:
$ref: '#/definitions/CloningInfo'
description: >-
If specified during app creation, the app is cloned from a source
app.
x-ms-mutability:
- create
resourceGroup:
description: Name of the resource group the app belongs to. Read-only.
type: string
readOnly: true
isDefaultContainer:
description: >-
true if the app is a default container; otherwise,
false.
type: boolean
readOnly: true
defaultHostName:
description: Default hostname of the app. Read-only.
type: string
readOnly: true
slotSwapStatus:
$ref: '#/definitions/SlotSwapStatus'
description: Status of the last deployment slot swap operation.
readOnly: true
httpsOnly:
description: >-
HttpsOnly: configures a web site to accept only https requests.
Issues redirect for
http requests
type: boolean
redundancyMode:
description: Site redundancy mode
enum:
- None
- Manual
- Failover
- ActiveActive
- GeoRedundant
type: string
x-ms-enum:
name: RedundancyMode
modelAsString: false
inProgressOperationId:
format: uuid
description: Specifies an operation id if this site has a pending operation.
type: string
readOnly: true
example: 00000000-0000-0000-0000-000000000000
publicNetworkAccess:
description: >-
Property to allow or block all public traffic. Allowed Values:
'Enabled', 'Disabled' or an empty string.
type: string
storageAccountRequired:
description: Checks if Customer provided storage account is required
type: boolean
keyVaultReferenceIdentity:
description: Identity to use for Key Vault Reference authentication.
type: string
virtualNetworkSubnetId:
description: >-
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}
type: string
managedEnvironmentId:
description: >-
Azure Resource Manager ID of the customer's selected Managed
Environment on which to host this app. This must be of the form
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}
type: string
x-ms-client-flatten: true
identity:
$ref: '#/definitions/ManagedServiceIdentity'
extendedLocation:
$ref: '#/definitions/ExtendedLocation'
SiteConfig:
description: Configuration of an App Service app.
type: object
properties:
numberOfWorkers:
format: int32
description: Number of workers.
type: integer
defaultDocuments:
description: Default documents.
type: array
items:
type: string
netFrameworkVersion:
description: .NET Framework version.
default: v4.6
type: string
phpVersion:
description: Version of PHP.
type: string
pythonVersion:
description: Version of Python.
type: string
nodeVersion:
description: Version of Node.js.
type: string
powerShellVersion:
description: Version of PowerShell.
type: string
linuxFxVersion:
description: Linux App Framework and version
type: string
windowsFxVersion:
description: Xenon App Framework and version
type: string
requestTracingEnabled:
description: >-
true if request tracing is enabled; otherwise,
false.
type: boolean
requestTracingExpirationTime:
format: date-time
description: Request tracing expiration time.
type: string
remoteDebuggingEnabled:
description: >-
true if remote debugging is enabled; otherwise,
false.
type: boolean
remoteDebuggingVersion:
description: Remote debugging version.
type: string
httpLoggingEnabled:
description: >-
true if HTTP logging is enabled; otherwise,
false.
type: boolean
acrUseManagedIdentityCreds:
description: Flag to use Managed Identity Creds for ACR pull
type: boolean
acrUserManagedIdentityID:
description: If using user managed identity, the user managed identity ClientId
type: string
logsDirectorySizeLimit:
format: int32
description: HTTP logs directory size limit.
type: integer
detailedErrorLoggingEnabled:
description: >-
true if detailed error logging is enabled; otherwise,
false.
type: boolean
publishingUsername:
description: Publishing user name.
type: string
appSettings:
description: Application settings.
type: array
items:
$ref: '#/definitions/NameValuePair'
x-ms-identifiers:
- name
metadata:
description: >-
Application metadata. This property cannot be retrieved, since it may
contain secrets.
type: array
items:
$ref: '#/definitions/NameValuePair'
x-ms-identifiers:
- name
x-ms-mutability:
- create
- update
connectionStrings:
description: Connection strings.
type: array
items:
$ref: '#/definitions/ConnStringInfo'
x-ms-identifiers:
- name
machineKey:
$ref: '#/definitions/SiteMachineKey'
description: Site MachineKey.
readOnly: true
handlerMappings:
description: Handler mappings.
type: array
items:
$ref: '#/definitions/HandlerMapping'
x-ms-identifiers:
- extension
documentRoot:
description: Document root.
type: string
scmType:
description: SCM type.
enum:
- None
- Dropbox
- Tfs
- LocalGit
- GitHub
- CodePlexGit
- CodePlexHg
- BitbucketGit
- BitbucketHg
- ExternalGit
- ExternalHg
- OneDrive
- VSO
- VSTSRM
type: string
x-ms-enum:
name: ScmType
modelAsString: true
use32BitWorkerProcess:
description: >-
true to use 32-bit worker process; otherwise,
false.
type: boolean
webSocketsEnabled:
description: >-
true if WebSocket is enabled; otherwise,
false.
type: boolean
alwaysOn:
description: >-
true if Always On is enabled; otherwise,
false.
type: boolean
javaVersion:
description: Java version.
type: string
javaContainer:
description: Java container.
type: string
javaContainerVersion:
description: Java container version.
type: string
appCommandLine:
description: App command line to launch.
type: string
managedPipelineMode:
description: Managed pipeline mode.
enum:
- Integrated
- Classic
type: string
x-ms-enum:
name: ManagedPipelineMode
modelAsString: false
virtualApplications:
description: Virtual applications.
type: array
items:
$ref: '#/definitions/VirtualApplication'
x-ms-identifiers:
- virtualPath
loadBalancing:
description: Site load balancing.
enum:
- WeightedRoundRobin
- LeastRequests
- LeastResponseTime
- WeightedTotalTraffic
- RequestHash
- PerSiteRoundRobin
type: string
x-ms-enum:
name: SiteLoadBalancing
modelAsString: false
experiments:
$ref: '#/definitions/Experiments'
description: This is work around for polymorphic types.
limits:
$ref: '#/definitions/SiteLimits'
description: Site limits.
autoHealEnabled:
description: >-
true if Auto Heal is enabled; otherwise,
false.
type: boolean
autoHealRules:
$ref: '#/definitions/AutoHealRules'
description: Auto Heal rules.
tracingOptions:
description: Tracing options.
type: string
vnetName:
description: Virtual Network name.
type: string
x-ms-mutability:
- create
- read
vnetRouteAllEnabled:
description: >-
Virtual Network Route All enabled. This causes all outbound traffic to
have Virtual Network Security Groups and User Defined Routes applied.
type: boolean
vnetPrivatePortsCount:
format: int32
description: >-
The number of private ports assigned to this app. These will be
assigned dynamically on runtime.
type: integer
cors:
$ref: '#/definitions/CorsSettings'
description: Cross-Origin Resource Sharing (CORS) settings.
push:
$ref: '#/definitions/PushSettings'
description: Push endpoint settings.
apiDefinition:
$ref: '#/definitions/ApiDefinitionInfo'
description: Information about the formal API definition for the app.
apiManagementConfig:
$ref: '#/definitions/ApiManagementConfig'
description: Azure API management settings linked to the app.
autoSwapSlotName:
description: Auto-swap slot name.
type: string
localMySqlEnabled:
description: >-
true to enable local MySQL; otherwise,
false.
default: false
type: boolean
managedServiceIdentityId:
format: int32
description: Managed Service Identity Id
type: integer
xManagedServiceIdentityId:
format: int32
description: Explicit Managed Service Identity Id
type: integer
keyVaultReferenceIdentity:
description: Identity to use for Key Vault Reference authentication.
type: string
ipSecurityRestrictions:
description: IP security restrictions for main.
type: array
items:
$ref: '#/definitions/IpSecurityRestriction'
x-ms-identifiers:
- name
ipSecurityRestrictionsDefaultAction:
description: Default action for main access restriction if no rules are matched.
enum:
- Allow
- Deny
type: string
x-ms-enum:
name: DefaultAction
modelAsString: true
scmIpSecurityRestrictions:
description: IP security restrictions for scm.
type: array
items:
$ref: '#/definitions/IpSecurityRestriction'
x-ms-identifiers:
- name
scmIpSecurityRestrictionsDefaultAction:
description: Default action for scm access restriction if no rules are matched.
enum:
- Allow
- Deny
type: string
x-ms-enum:
name: DefaultAction
modelAsString: true
scmIpSecurityRestrictionsUseMain:
description: IP security restrictions for scm to use main.
type: boolean
http20Enabled:
description: >-
Http20Enabled: configures a web site to allow clients to connect over
http2.0
default: true
type: boolean
minTlsVersion:
description: >-
MinTlsVersion: configures the minimum version of TLS required for SSL
requests
enum:
- '1.0'
- '1.1'
- '1.2'
type: string
x-ms-enum:
name: SupportedTlsVersions
modelAsString: true
minTlsCipherSuite:
description: The minimum strength TLS cipher suite allowed for an application
enum:
- TLS_AES_256_GCM_SHA384
- TLS_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
type: string
x-ms-enum:
name: TlsCipherSuites
modelAsString: true
scmMinTlsVersion:
description: >-
ScmMinTlsVersion: configures the minimum version of TLS required for
SSL requests for SCM site
enum:
- '1.0'
- '1.1'
- '1.2'
type: string
x-ms-enum:
name: SupportedTlsVersions
modelAsString: true
ftpsState:
description: State of FTP / FTPS service
enum:
- AllAllowed
- FtpsOnly
- Disabled
type: string
x-ms-enum:
name: FtpsState
modelAsString: true
preWarmedInstanceCount:
format: int32
description: |-
Number of preWarmed instances.
This setting only applies to the Consumption and Elastic Plans
maximum: 10
minimum: 0
type: integer
functionAppScaleLimit:
format: int32
description: |-
Maximum number of workers that a site can scale out to.
This setting only applies to the Consumption and Elastic Premium Plans
minimum: 0
type: integer
elasticWebAppScaleLimit:
format: int32
description: >-
Maximum number of workers that a site can scale out to.
This setting only applies to apps in plans where ElasticScaleEnabled
is true
minimum: 0
type: integer
healthCheckPath:
description: Health check path
type: string
functionsRuntimeScaleMonitoringEnabled:
description: >-
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.
type: boolean
websiteTimeZone:
description: >-
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
type: string
minimumElasticInstanceCount:
format: int32
description: |-
Number of minimum instance count for a site
This setting only applies to the Elastic Plans
maximum: 20
minimum: 0
type: integer
azureStorageAccounts:
description: List of Azure Storage Accounts.
type: object
additionalProperties:
$ref: '#/definitions/AzureStorageInfoValue'
publicNetworkAccess:
description: Property to allow or block all public traffic.
type: string
DaprConfig:
description: App Dapr configuration.
type: object
properties:
enabled:
description: Boolean indicating if the Dapr side car is enabled
type: boolean
default: false
appId:
description: Dapr application identifier
type: string
appPort:
format: int32
description: Tells Dapr which port your application is listening on
type: integer
httpReadBufferSize:
type: integer
description: >-
Dapr max size of http header read buffer in KB to handle when sending
multi-KB headers. Default is 65KB.
format: int32
httpMaxRequestSize:
type: integer
description: >-
Increasing max size of request body http servers parameter in MB to
handle uploading of big files. Default is 4 MB.
format: int32
logLevel:
description: >-
Sets the log level for the Dapr sidecar. Allowed values are debug,
info, warn, error. Default is info.
enum:
- info
- debug
- warn
- error
type: string
x-ms-enum:
name: daprLogLevel
modelAsString: true
enableApiLogging:
description: Enables API logging for the Dapr sidecar
type: boolean
ResourceConfig:
description: Function app resource requirements.
type: object
properties:
cpu:
format: double
description: Required CPU in cores, e.g. 0.5
type: number
memory:
description: Required memory, e.g. "1Gi"
type: string
SiteLimits:
description: Metric limits set on an app.
type: object
properties:
maxPercentageCpu:
format: double
description: Maximum allowed CPU usage percentage.
type: number
maxMemoryInMb:
format: int64
description: Maximum allowed memory usage in MB.
type: integer
maxDiskSizeInMb:
format: int64
description: Maximum allowed disk size usage in MB.
type: integer
SiteMachineKey:
description: MachineKey of an app.
type: object
properties:
validation:
description: MachineKey validation.
type: string
validationKey:
description: Validation key.
type: string
decryption:
description: Algorithm used for decryption.
type: string
decryptionKey:
description: Decryption key.
type: string
SkuCapacity:
description: Description of the App Service plan scale options.
type: object
properties:
minimum:
format: int32
description: Minimum number of workers for this App Service plan SKU.
type: integer
maximum:
format: int32
description: Maximum number of workers for this App Service plan SKU.
type: integer
elasticMaximum:
format: int32
description: Maximum number of Elastic workers for this App Service plan SKU.
type: integer
default:
format: int32
description: Default number of workers for this App Service plan SKU.
type: integer
scaleType:
description: Available scale configurations for an App Service plan.
type: string
SkuDescription:
description: Description of a SKU for a scalable resource.
type: object
properties:
name:
description: Name of the resource SKU.
type: string
tier:
description: Service tier of the resource SKU.
type: string
size:
description: Size specifier of the resource SKU.
type: string
family:
description: Family code of the resource SKU.
type: string
capacity:
format: int32
description: Current number of instances assigned to the resource.
type: integer
skuCapacity:
$ref: '#/definitions/SkuCapacity'
description: Min, max, and default scale values of the SKU.
locations:
description: Locations of the SKU.
type: array
items:
type: string
capabilities:
description: Capabilities of the SKU, e.g., is traffic manager enabled?
type: array
items:
$ref: '#/definitions/Capability'
x-ms-identifiers:
- name
SlotSwapStatus:
description: The status of the last successful slot swap operation.
type: object
properties:
timestampUtc:
format: date-time
description: The time the last successful slot swap completed.
type: string
readOnly: true
sourceSlotName:
description: The source slot of the last swap operation.
type: string
readOnly: true
destinationSlotName:
description: The destination slot of the last swap operation.
type: string
readOnly: true
SlowRequestsBasedTrigger:
description: Trigger based on request execution time.
type: object
properties:
timeTaken:
description: Time taken.
type: string
path:
description: Request Path.
type: string
count:
format: int32
description: Request Count.
type: integer
timeInterval:
description: Time interval.
type: string
Snapshot:
description: A snapshot of an app.
type: object
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
properties:
properties:
description: Snapshot resource specific properties
type: object
properties:
time:
description: The time the snapshot was taken.
type: string
readOnly: true
x-ms-client-flatten: true
Status:
description: Identify the status of the most severe insight generated by the detector.
type: object
properties:
message:
description: Descriptive message.
type: string
statusId:
description: Level of the most severe insight generated by the detector.
enum:
- Critical
- Warning
- Info
- Success
- None
type: string
x-ms-enum:
name: InsightStatus
modelAsString: false
StatusCodesBasedTrigger:
description: Trigger based on status code.
type: object
properties:
status:
format: int32
description: HTTP status code.
type: integer
subStatus:
format: int32
description: Request Sub Status.
type: integer
win32Status:
format: int32
description: Win32 error code.
type: integer
count:
format: int32
description: Request Count.
type: integer
timeInterval:
description: Time interval.
type: string
path:
description: Request Path
type: string
StatusCodesRangeBasedTrigger:
description: Trigger based on range of status codes.
type: object
properties:
statusCodes:
description: HTTP status code.
type: string
path:
type: string
count:
format: int32
description: Request Count.
type: integer
timeInterval:
description: Time interval.
type: string
StringDictionary:
description: String dictionary resource.
type: object
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
properties:
properties:
description: Settings.
type: object
additionalProperties:
type: string
x-ms-client-flatten: true
SupportTopic:
description: Defines a unique Support Topic
type: object
properties:
id:
description: Support Topic Id
type: string
readOnly: true
pesId:
description: Unique resource Id
type: string
readOnly: true
Template:
description: |-
Container App versioned application definition.
Defines the desired state of an immutable revision.
Any changes to this section Will result in a new revision being created
type: object
properties:
revisionSuffix:
description: User friendly suffix that is appended to the revision name
type: string
containers:
description: List of container definitions for the Container App.
type: array
items:
$ref: '#/definitions/Container'
x-ms-identifiers:
- name
scale:
$ref: '#/definitions/Scale'
description: Scaling properties for the Container App.
dapr:
$ref: '#/definitions/Dapr'
description: Dapr configuration for the Container App.
User:
description: User credentials used for publishing activity.
type: object
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
properties:
properties:
description: User resource specific properties
required:
- publishingUserName
type: object
properties:
publishingUserName:
description: Username used for publishing.
type: string
publishingPassword:
format: password
description: Password used for publishing.
type: string
publishingPasswordHash:
format: password
description: Password hash used for publishing.
type: string
publishingPasswordHashSalt:
format: password
description: Password hash salt used for publishing.
type: string
scmUri:
description: Url of SCM site.
type: string
x-ms-client-flatten: true
VirtualApplication:
description: Virtual application in an app.
type: object
properties:
virtualPath:
description: Virtual path.
type: string
physicalPath:
description: Physical path.
type: string
preloadEnabled:
description: >-
true if preloading is enabled; otherwise,
false.
type: boolean
virtualDirectories:
description: Virtual directories for virtual application.
type: array
items:
$ref: '#/definitions/VirtualDirectory'
x-ms-identifiers:
- virtualPath
VirtualDirectory:
description: Directory for virtual application.
type: object
properties:
virtualPath:
description: Path to virtual application.
type: string
physicalPath:
description: Physical path.
type: string
VirtualNetworkProfile:
description: Specification for using a Virtual Network.
required:
- id
type: object
properties:
id:
description: Resource id of the Virtual Network.
type: string
name:
description: Name of the Virtual Network (read-only).
type: string
readOnly: true
type:
description: Resource type of the Virtual Network (read-only).
type: string
readOnly: true
subnet:
description: Subnet within the Virtual Network.
type: string
VnetGateway:
description: >-
The Virtual Network gateway contract. This is used to give the Virtual
Network gateway access to the VPN package.
type: object
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
properties:
properties:
description: VnetGateway resource specific properties
required:
- vpnPackageUri
type: object
properties:
vnetName:
description: The Virtual Network name.
type: string
x-ms-mutability:
- create
- read
vpnPackageUri:
description: The URI where the VPN package can be downloaded.
type: string
x-ms-mutability:
- create
- update
x-ms-client-flatten: true
VnetInfo:
description: Virtual Network information contract.
type: object
properties:
vnetResourceId:
description: The Virtual Network's resource ID.
type: string
certThumbprint:
description: The client certificate thumbprint.
type: string
readOnly: true
certBlob:
description: >-
A certificate file (.cer) blob containing the public key of the
private key used to authenticate a
Point-To-Site VPN connection.
type: string
routes:
description: The routes that this Virtual Network connection uses.
type: array
items:
$ref: '#/definitions/VnetRoute'
readOnly: true
resyncRequired:
description: >-
true if a resync is required; otherwise,
false.
type: boolean
readOnly: true
dnsServers:
description: >-
DNS servers to be used by this Virtual Network. This should be a
comma-separated list of IP addresses.
type: string
isSwift:
description: Flag that is used to denote if this is VNET injection
type: boolean
VnetInfoResource:
description: Virtual Network information ARM resource.
type: object
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
properties:
properties:
$ref: '#/definitions/VnetInfo'
description: Core resource properties
type: object
x-ms-client-flatten: true
VnetRoute:
description: >-
Virtual Network route contract used to pass routing information for a
Virtual Network.
type: object
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
properties:
properties:
description: VnetRoute resource specific properties
type: object
properties:
startAddress:
description: >-
The starting address for this route. This may also include a CIDR
notation, in which case the end address must not be specified.
type: string
endAddress:
description: >-
The ending address for this route. If the start address is
specified in CIDR notation, this must be omitted.
type: string
routeType:
description: >-
The type of route this is:
DEFAULT - By default, every app has routes to the local address
ranges specified by RFC1918
INHERITED - Routes inherited from the real Virtual Network routes
STATIC - Static route set on the app only
These values will be used for syncing an app's routes with those
from a Virtual Network.
enum:
- DEFAULT
- INHERITED
- STATIC
type: string
x-ms-enum:
name: RouteType
modelAsString: true
x-ms-client-flatten: true
WebAppCollection:
description: Collection of App Service apps.
required:
- value
type: object
properties:
value:
description: Collection of resources.
type: array
items:
$ref: '#/definitions/Site'
nextLink:
description: Link to next page of resources.
type: string
readOnly: true
userAssignedIdentity:
description: User Assigned identity.
type: object
properties:
principalId:
description: Principal Id of user assigned identity
type: string
readOnly: true
clientId:
description: Client Id of user assigned identity
type: string
readOnly: true
securityDefinitions:
azure_auth:
type: oauth2
description: Azure Active Directory OAuth2 Flow
flow: implicit
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
scopes:
user_impersonation: impersonate your user account
security:
- azure_auth:
- user_impersonation