Microsoft Azure
Microsoft Azure AppPlatform API

The AppPlatform API from Microsoft Azure — 109 operation(s) for appplatform.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector AppPlatform API
schemes:
- https
tags:
- name: AppPlatform
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}:
    get:
      tags:
      - AppPlatform
      description: Get a Service and its properties.
      operationId: microsoftAzureServicesGet
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      responses:
        '200':
          description: Success. The response describes the corresponding Service.
          schema:
            $ref: '#/definitions/ServiceResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Services_Get:
          $ref: ./examples/Services_Get.json
        Services_Get_Consumption:
          $ref: ./examples/Services_Get_Consumption.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename
    put:
      tags:
      - AppPlatform
      description: Create a new Service or update an exiting Service.
      operationId: microsoftAzureServicesCreateorupdate
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      - name: resource
        in: body
        description: Parameters for the create or update operation
        required: true
        schema:
          $ref: '#/definitions/ServiceResource'
      responses:
        '200':
          description: Success. The response describes the updated Service.
          schema:
            $ref: '#/definitions/ServiceResource'
        '201':
          description: Created. The response describes the new Service and contains an Azure-AsyncOperation header to query the operation result.
          schema:
            $ref: '#/definitions/ServiceResource'
        '202':
          description: "Accepted. The response indicates the exiting Service is now updating and contains a Location\r\nheader to query the operation result."
          schema:
            $ref: '#/definitions/ServiceResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Services_CreateOrUpdate:
          $ref: ./examples/Services_CreateOrUpdate.json
        Services_CreateOrUpdate_VNetInjection:
          $ref: ./examples/Services_CreateOrUpdate_VNetInjection.json
        Services_CreateOrUpdate_Enterprise:
          $ref: ./examples/Services_CreateOrUpdate_Enterprise.json
        Services_CreateOrUpdate_Consumption:
          $ref: ./examples/Services_CreateOrUpdate_Consumption.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename
    delete:
      tags:
      - AppPlatform
      description: Operation to delete a Service.
      operationId: microsoftAzureServicesDelete
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      responses:
        '200':
          description: Success. The response indicates the resource is deleted successfully.
        '202':
          description: Accepted. The response indicates the delete operation is performed in the background.
        '204':
          description: Success. The response indicates the resource is already deleted.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Services_Delete:
          $ref: ./examples/Services_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename
    patch:
      tags:
      - AppPlatform
      description: Operation to update an exiting Service.
      operationId: microsoftAzureServicesUpdate
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      - name: resource
        in: body
        description: Parameters for the update operation
        required: true
        schema:
          $ref: '#/definitions/ServiceResource'
      responses:
        '200':
          description: Success. The response describes the updated Service.
          schema:
            $ref: '#/definitions/ServiceResource'
        '202':
          description: "Accepted. The response indicates the exiting Service is now updating and contains a Location\r\nheader to query the operation result."
          schema:
            $ref: '#/definitions/ServiceResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Services_Update:
          $ref: ./examples/Services_Update.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/listTestKeys
  : post:
      tags:
      - AppPlatform
      description: List test keys for a Service.
      operationId: microsoftAzureServicesListtestkeys
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      responses:
        '200':
          description: Success. The response describes the test keys.
          schema:
            $ref: '#/definitions/TestKeys'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Services_ListTestKeys:
          $ref: ./examples/Services_ListTestKeys.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Listtestkeys
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/regenerateTestKey
  : post:
      tags:
      - AppPlatform
      description: Regenerate a test key for a Service.
      operationId: microsoftAzureServicesRegeneratetestkey
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      - name: regenerateTestKeyRequest
        in: body
        description: Parameters for the operation
        required: true
        schema:
          $ref: '#/definitions/RegenerateTestKeyRequestPayload'
      responses:
        '200':
          description: Success.
          schema:
            $ref: '#/definitions/TestKeys'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Services_RegenerateTestKey:
          $ref: ./examples/Services_RegenerateTestKey.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Regeneratetestkey
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/disableTestEndpoint
  : post:
      tags:
      - AppPlatform
      description: Disable test endpoint functionality for a Service.
      operationId: microsoftAzureServicesDisabletestendpoint
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      responses:
        '200':
          description: Success
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Services_DisableTestEndpoint:
          $ref: ./examples/Services_DisableTestEndpoint.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Disabletestendpoint
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/enableTestEndpoint
  : post:
      tags:
      - AppPlatform
      description: Enable test endpoint functionality for a Service.
      operationId: microsoftAzureServicesEnabletestendpoint
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/TestKeys'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Services_EnableTestEndpoint:
          $ref: ./examples/Services_EnableTestEndpoint.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Enabletestendpoint
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/stop
  : post:
      tags:
      - AppPlatform
      description: Stop a Service.
      operationId: microsoftAzureServicesStop
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      responses:
        '202':
          description: Accepted. The response indicates the stop operation is performed in the background.
        '404':
          description: Not found. The response indicates the service does not exist.
          x-ms-error-response: true
        '409':
          description: Conflict. The response indicates the exiting Service is now updating.
          x-ms-error-response: true
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Services_Stop:
          $ref: ./examples/Services_Stop.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Stop
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/start
  : post:
      tags:
      - AppPlatform
      description: Start a Service.
      operationId: microsoftAzureServicesStart
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      responses:
        '202':
          description: Accepted. The response indicates the stop operation is performed in the background.
        '404':
          description: Not found. The response indicates the service does not exist.
          x-ms-error-response: true
        '409':
          description: Conflict. The response indicates the exiting Service is now updating.
          x-ms-error-response: true
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Services_Start:
          $ref: ./examples/Services_Start.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Start
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/flushVirtualNetworkDnsSettings
  : post:
      tags:
      - AppPlatform
      description: Flush Virtual Network DNS settings for a VNET injected Service.
      operationId: microsoftAzureServicesFlushvnetdnssetting
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      responses:
        '200':
          description: Success.
        '202':
          description: Accepted. The response indicates the Flush VNET DNS setting operation is performed in the background.
          headers:
            Location:
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Services_FlushVnetDnsSetting:
          $ref: ./examples/Services_FlushVnetDnsSetting.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Flushvirtualnetworkdnssettings
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/supportedApmTypes
  : get:
      tags:
      - AppPlatform
      description: List supported APM types for a Service.
      operationId: microsoftAzureServicesListsupportedapmtypes
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      responses:
        '200':
          description: Success. The response describes the supported APM types.
          schema:
            $ref: '#/definitions/SupportedApmTypes'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Services_ListSupportedApmTypes:
          $ref: ./examples/Services_ListSupportedApmTypes.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Supportedapmtypes
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/listGloballyEnabledApms
  : post:
      tags:
      - AppPlatform
      description: List globally enabled APMs for a Service.
      operationId: microsoftAzureServicesListgloballyenabledapms
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      responses:
        '200':
          description: Success. The response describes the globally enabled APMs.
          schema:
            $ref: '#/definitions/GloballyEnabledApms'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Services_ListGloballyEnabledApms:
          $ref: ./examples/Services_ListGloballyEnabledApms.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Listgloballyenabledapms
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/enableApmGlobally
  : post:
      tags:
      - AppPlatform
      description: Enable an APM globally.
      operationId: microsoftAzureServicesEnableapmglobally
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      - name: apm
        in: body
        description: The target APM for the enable operation
        required: true
        schema:
          $ref: '#/definitions/ApmReference'
      responses:
        '200':
          description: Success.
        '202':
          description: Accepted. The response indicates the APM is now enabling globally and contains a Location header to query the operation result.
          headers:
            Location:
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        Services_EnableApmGlobally:
          $ref: ./examples/Services_EnableApmGlobally.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Enableapmglobally
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/disableApmGlobally
  : post:
      tags:
      - AppPlatform
      description: Disable an APM globally.
      operationId: microsoftAzureServicesDisableapmglobally
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      - name: apm
        in: body
        description: The target APM for the disable operation
        required: true
        schema:
          $ref: '#/definitions/ApmReference'
      responses:
        '200':
          description: Success.
        '202':
          description: Accepted. The response indicates the APM is now disabling globally and contains a Location header to query the operation result.
          headers:
            Location:
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        Services_DisableApmGlobally:
          $ref: ./examples/Services_DisableApmGlobally.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Disableapmglobally
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apms
  : get:
      tags:
      - AppPlatform
      description: Get collection of APMs.
      operationId: microsoftAzureApmsList
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      responses:
        '200':
          description: Success. The response describes the list of APMs.
          schema:
            $ref: '#/definitions/ApmResourceCollection'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Apms_List:
          $ref: ./examples/Apms_List.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Apms
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apms/{apmName}
  : get:
      tags:
      - AppPlatform
      description: Get the APM by name.
      operationId: microsoftAzureApmsGet
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      - $ref: '#/parameters/ApmNameParameter'
      responses:
        '200':
          description: Success. The response describes the APM.
          schema:
            $ref: '#/definitions/ApmResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Apms_Get:
          $ref: ./examples/Apms_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Apms Apmname
    put:
      tags:
      - AppPlatform
      description: Create or update an APM.
      operationId: microsoftAzureApmsCreateorupdate
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      - $ref: '#/parameters/ApmNameParameter'
      - name: apmResource
        in: body
        description: Parameters for the create or update operation
        required: true
        schema:
          $ref: '#/definitions/ApmResource'
      responses:
        '200':
          description: Success. The response describes the APM updated.
          schema:
            $ref: '#/definitions/ApmResource'
        '201':
          description: Created. The response describes the new APM created and contains an Azure-AsyncOperation header to query the operation result.
          schema:
            $ref: '#/definitions/ApmResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-examples:
        Apms_CreateOrUpdate:
          $ref: ./examples/Apms_CreateOrUpdate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Apms Apmname
    delete:
      tags:
      - AppPlatform
      description: Operation to delete an APM
      operationId: microsoftAzureApmsDelete
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      - $ref: '#/parameters/ApmNameParameter'
      responses:
        '200':
          description: Success. The response indicates the resource is deleted.
        '202':
          description: Accepted. The response indicates the delete operation is performed in the background.
          headers:
            Location:
              type: string
        '204':
          description: Success. The response indicates the resource doesn't exist.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Apms_Delete:
          $ref: ./examples/Apms_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Apms Apmname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apms/{apmName}/listSecretKeys
  : post:
      tags:
      - AppPlatform
      description: List keys of APM sensitive properties.
      operationId: microsoftAzureApmsListsecretkeys
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      - $ref: '#/parameters/ApmNameParameter'
      responses:
        '200':
          description: Success. The response describes the keys of APM sensitive properties.
          schema:
            $ref: '#/definitions/ApmSecretKeys'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Apms_ListSecretKeys:
          $ref: ./examples/Apms_ListSecretKeys.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Apms Apmname Listsecretkeys
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/eurekaServers
  : get:
      tags:
      - AppPlatform
      description: List the eureka server settings.
      operationId: microsoftAzureEurekaserversList
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      responses:
        '200':
          description: Success. The response describes the corresponding eureka server settings.
          schema:
            $ref: '#/definitions/EurekaServerResourceCollection'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        EurekaServers_List_Consumption:
          $ref: ./examples/EurekaServers_List_Consumption.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Eurekaservers
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/eurekaServers/default
  : get:
      tags:
      - AppPlatform
      description: Get the eureka server settings.
      operationId: microsoftAzureEurekaserversGet
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      responses:
        '200':
          description: Success. The response describes the corresponding eureka server settings.
          schema:
            $ref: '#/definitions/EurekaServerResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        EurekaServers_Get_Consumption:
          $ref: ./examples/EurekaServers_Get_Consumption.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Eurekaservers Default
    put:
      tags:
      - AppPlatform
      description: Update the eureka server settings.
      operationId: microsoftAzureEurekaserversUpdateput
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      - name: eurekaServerResource
        in: body
        description: Parameters for the update operation
        required: true
        schema:
          $ref: '#/definitions/EurekaServerResource'
      responses:
        '200':
          description: Success. The response describes the updated eureka server settings.
          schema:
            $ref: '#/definitions/EurekaServerResource'
        '201':
          description: "Created. The response indicates the exiting eureka server settings are now updating and contain a Azure-AsyncOperation\r\nheader to query the operation result."
          schema:
            $ref: '#/definitions/EurekaServerResource'
          headers:
            Location:
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        EurekaServers_UpdatePut_Consumption:
          $ref: ./examples/EurekaServers_UpdatePut_Consumption.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Eurekaservers Default
    patch:
      tags:
      - AppPlatform
      description: Update the eureka server settings.
      operationId: microsoftAzureEurekaserversUpdatepatch
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      - name: eurekaServerResource
        in: body
        description: Parameters for the update operation
        required: true
        schema:
          $ref: '#/definitions/EurekaServerResource'
      responses:
        '200':
          description: Success. The response describes the updated eureka server settings.
          schema:
            $ref: '#/definitions/EurekaServerResource'
        '202':
          description: "Accepted. The response indicates the exiting eureka server settings are now updating and contain a Location\r\nheader to query the operation result."
          schema:
            $ref: '#/definitions/EurekaServerResource'
          headers:
            Location:
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        EurekaServers_UpdatePatch:
          $ref: ./examples/EurekaServers_UpdatePatch_Consumption.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Appplatform Spring Servicename Eurekaservers Default
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configServers/default
  : get:
      tags:
      - AppPlatform
      description: Get the config server and its properties.
      operationId: microsoftAzureConfigserversGet
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ServiceNameParameter'
      responses:
        '200':
          description: Success. The response describes the corresponding Config Server.
          schema:
            $ref: '#/definitions/ConfigServerResource'
        default:
          description: Error response describing why the op

# --- truncated at 32 KB (373 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-appplatform-api-openapi.yml
Microsoft Azure AppPlatform API

Documentation

Specifications

Other Resources

OpenAPI Specification
