Microsoft Azure Common Definitions

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: >-
          <code>true</code> if the App Service Environment is suspended;
          otherwise, <code>false</code>. 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 <code>true</code>, apps assigned to this App Service plan can
              be scaled independently.

              If <code>false</code>, 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 <code>true</code>, 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 <code>true</code>, <code>false</code>
              otherwise.
            default: false
            type: boolean
            x-ms-mutability:
              - create
              - read
          isXenon:
            description: >-
              Obsolete: If Hyper-V container app service plan <code>true</code>,
              <code>false</code> otherwise.
            default: false
            type: boolean
            x-ms-mutability:
              - create
              - read
          hyperV:
            description: >-
              If Hyper-V container app service plan <code>true</code>,
              <code>false</code> 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 <code>true</code>, this App Service Plan will perform
              availability zone balancing.

              If <code>false</code>, 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: >-
          <code>true</code> to overwrite destination app; otherwise,
          <code>false</code>.
        type: boolean
      cloneCustomHostNames:
        description: >-
          <code>true</code> to clone custom hostnames from source app;
          otherwise, <code>false</code>.
        type: boolean
      cloneSourceControl:
        description: >-
          <code>true</code> to clone source control from source app; otherwise,
          <code>false</code>.
        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: >-
          <code>true</code> 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

# --- truncated at 32 KB (108 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/common-definitions-openapi-original.yml