How to use permissions in Azure Spring Apps

Article
10/15/2024

Note

The Basic, Standard, and Enterprise plans will be deprecated starting from mid-March, 2025, with a 3 year retirement period. We recommend transitioning to Azure Container Apps. For more information, see the Azure Spring Apps retirement announcement.

The Standard consumption and dedicated plan will be deprecated starting September 30, 2024, with a complete shutdown after six months. We recommend transitioning to Azure Container Apps.

This article shows you how to create custom roles that delegate permissions to Azure Spring Apps resources. Custom roles extend Azure built-in roles with various stock permissions.

We'll implement the following custom roles.

Developer role:
- Deploy
- Test
- Restart apps
- Apply and make changes to app configurations in the Git repository
- Get log streams
DevOps Engineer role:
- Create, read, update, and delete everything in Azure Spring Apps
Ops - Site Reliability Engineering role:
- Restart apps
- Get log streams
- Can't make changes to apps or configurations
Azure Pipelines / Jenkins / GitHub Actions role:
- Perform create, read, update, and delete operations
- Use Terraform or ARM templates to create and configure everything in Azure Spring Apps and apps within a service instance: Azure Pipelines, Jenkins, and GitHub Actions

Define the Developer role

The Developer role includes permissions to restart apps and see their log streams. This role can't make changes to apps or configurations.

Portal
JSON

In the Azure portal, open the subscription where you want to assign the custom role.
Open Access control (IAM).
Select Add.
Select Add custom role.
Select Next:
Select Add permissions:
In the search box, search for Microsoft.app. Select Azure Spring Apps:
Select the permissions for the Developer role.

Under Microsoft.AppPlatform/Spring, select:
- Write : Create or Update Azure Spring Apps service instance
- Read : Get Azure Spring Apps service instance
- Other : List Azure Spring Apps service instance test keys
Under Microsoft.AppPlatform/Spring/apps, select:
- Read : Read Azure Spring Apps application
- Other : Get Azure Spring Apps application resource upload URL
Under Microsoft.AppPlatform/Spring/apps/bindings, select:
- Read : Read Azure Spring Apps application binding
Under Microsoft.AppPlatform/Spring/apps/deployments, select:
- Write : Write Azure Spring Apps application deployment
- Read : Read Azure Spring Apps application deployment
- Other : Start Azure Spring Apps application deployment
- Other : Stop Azure Spring Apps application deployment
- Other : Restart Azure Spring Apps application deployment
- Other : Get Azure Spring Apps application deployment log file URL
Under Microsoft.AppPlatform/Spring/apps/domains, select:
- Read : Read Azure Spring Apps application custom domain
Under Microsoft.AppPlatform/Spring/certificates, select:
- Read : Read Azure Spring Apps certificate
Under Microsoft.AppPlatform/locations/operationResults/Spring, select:
- Read : Read operation result
Under Microsoft.AppPlatform/locations/operationStatus/operationId, select:
- Read : Read operation status
Select Add.
Review the permissions.
Select Review and create.

In the Azure portal, open the subscription where you want to assign the custom role.
Open Access control (IAM).
Select Add.
Select Add custom role.
Select Next.
Select the JSON tab.
Select Edit, and then delete the default text:

Paste in the following JSON to define the Developer role:

Basic/Standard plan

{
   "properties": {
     "roleName": "Developer",
     "description": "",
     "assignableScopes": [
       "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
     ],
     "permissions": [
       {
         "actions": [
           "Microsoft.AppPlatform/Spring/write",
           "Microsoft.AppPlatform/Spring/read",
           "Microsoft.AppPlatform/Spring/listTestKeys/action",
           "Microsoft.AppPlatform/Spring/apps/read",
           "Microsoft.AppPlatform/Spring/apps/getResourceUploadUrl/action",
           "Microsoft.AppPlatform/Spring/apps/bindings/read",
           "Microsoft.AppPlatform/Spring/apps/domains/read",
           "Microsoft.AppPlatform/Spring/apps/deployments/write",
           "Microsoft.AppPlatform/Spring/apps/deployments/read",
           "Microsoft.AppPlatform/Spring/apps/deployments/start/action",
           "Microsoft.AppPlatform/Spring/apps/deployments/stop/action",
           "Microsoft.AppPlatform/Spring/apps/deployments/restart/action",
           "Microsoft.AppPlatform/Spring/apps/deployments/getLogFileUrl/action",
           "Microsoft.AppPlatform/Spring/certificates/read",
           "Microsoft.AppPlatform/locations/operationResults/Spring/read",
           "Microsoft.AppPlatform/locations/operationStatus/operationId/read"
         ],
         "notActions": [],
         "dataActions": [],
         "notDataActions": []
       }
     ]
   }
}

Select Save.
Review the permissions.
Select Review and create.

Define the DevOps Engineer role

This procedure defines a role that has permissions to deploy, test, and restart Azure Spring Apps apps.

Portal
JSON

Repeat steps 1 through 4 in the procedure for adding the Developer role.
Select the permissions for the DevOps Engineer role:

Under Microsoft.AppPlatform/Spring, select:
- Write : Create or Update Azure Spring Apps service instance
- Delete : Delete Azure Spring Apps service instance
- Read : Get Azure Spring Apps service instance
- Other : Enable Azure Spring Apps service instance test endpoint
- Other : Disable Azure Spring Apps service instance test endpoint
- Other : List Azure Spring Apps service instance test keys
- Other : Regenerate Azure Spring Apps service instance test key
Under Microsoft.AppPlatform/Spring/apps, select:
- Write : Write Azure Spring Apps application
- Delete : Delete Azure Spring Apps application
- Read : Read Azure Spring Apps application
- Other : Get Azure Spring Apps application resource upload URL
- Other : Validate Azure Spring Apps application custom domain
Under Microsoft.AppPlatform/Spring/apps/bindings, select:
- Write : Write Azure Spring Apps application binding
- Delete : Delete Azure Spring Apps application binding
- Read : Read Azure Spring Apps application binding
Under Microsoft.AppPlatform/Spring/apps/deployments, select:
- Write : Write Azure Spring Apps application deployment
- Delete : Delete Azure Spring Apps application deployment
- Read : Read Azure Spring Apps application deployment
- Other : Start Azure Spring Apps application deployment
- Other : Stop Azure Spring Apps application deployment
- Other : Restart Azure Spring Apps application deployment
- Other : Get Azure Spring Apps application deployment log file URL
Under Microsoft.AppPlatform/Spring/apps/deployments/skus, select:
- Read : List application deployment available skus
Under Microsoft.AppPlatform/locations, select:
- Other : Check name availability
Under Microsoft.AppPlatform/locations/operationResults/Spring select:
- Read : Read operation result
Under Microsoft.AppPlatform/locations/operationStatus/operationId, select:
- Read : Read operation status
Under Microsoft.AppPlatform/skus, select:
- Read : List available skus
Select Add.
Review the permissions.
Select Review and create.

Repeat steps 1 through 4 from the procedure for adding the Developer role.
Select Next.
Select the JSON tab.
Select Edit, and then delete the default text:

Paste in the following JSON to define the DevOps Engineer role:

Basic/Standard plan

{
   "properties": {
     "roleName": "DevOps engineer",
     "description": "",
     "assignableScopes": [
       "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
     ],
     "permissions": [
       {
         "actions": [
           "Microsoft.AppPlatform/Spring/write",
           "Microsoft.AppPlatform/Spring/delete",
           "Microsoft.AppPlatform/Spring/read",
           "Microsoft.AppPlatform/Spring/enableTestEndpoint/action",
           "Microsoft.AppPlatform/Spring/disableTestEndpoint/action",
           "Microsoft.AppPlatform/Spring/listTestKeys/action",
           "Microsoft.AppPlatform/Spring/regenerateTestKey/action",
           "Microsoft.AppPlatform/Spring/apps/write",
           "Microsoft.AppPlatform/Spring/apps/delete",
           "Microsoft.AppPlatform/Spring/apps/read",
           "Microsoft.AppPlatform/Spring/apps/getResourceUploadUrl/action",
           "Microsoft.AppPlatform/Spring/apps/validateDomain/action",
           "Microsoft.AppPlatform/Spring/apps/bindings/write",
           "Microsoft.AppPlatform/Spring/apps/bindings/delete",
           "Microsoft.AppPlatform/Spring/apps/bindings/read",
           "Microsoft.AppPlatform/Spring/apps/deployments/write",
           "Microsoft.AppPlatform/Spring/apps/deployments/delete",
           "Microsoft.AppPlatform/Spring/apps/deployments/read",
           "Microsoft.AppPlatform/Spring/apps/deployments/start/action",
           "Microsoft.AppPlatform/Spring/apps/deployments/stop/action",
           "Microsoft.AppPlatform/Spring/apps/deployments/restart/action",
           "Microsoft.AppPlatform/Spring/apps/deployments/getLogFileUrl/action",
           "Microsoft.AppPlatform/Spring/apps/deployments/skus/read",
           "Microsoft.AppPlatform/locations/checkNameAvailability/action",
           "Microsoft.AppPlatform/locations/operationResults/Spring/read",
           "Microsoft.AppPlatform/locations/operationStatus/operationId/read",
           "Microsoft.AppPlatform/skus/read"
         ],
         "notActions": [],
         "dataActions": [],
         "notDataActions": []
       }
     ]
   }
}

Review the permissions.
Select Review and create.

Define the Ops - Site Reliability Engineering role

This procedure defines a role that has permissions to deploy, test, and restart Azure Spring Apps apps.

Portal
JSON

Repeat steps 1 through 4 from the procedure for adding the Developer role.
Select the permissions for the Ops - Site Reliability Engineering role:

Under Microsoft.AppPlatform/Spring, select:
- Read : Get Azure Spring Apps service instance
- Other : List Azure Spring Apps service instance test keys
Under Microsoft.AppPlatform/Spring/apps, select:
- Read : Read Azure Spring Apps application
Under Microsoft.AppPlatform/apps/deployments, select:
- Read : Read Azure Spring Apps application deployment
- Other : Start Azure Spring Apps application deployment
- Other : Stop Azure Spring Apps application deployment
- Other : Restart Azure Spring Apps application deployment
Under Microsoft.AppPlatform/locations/operationResults/Spring, select:
- Read : Read operation result
Under Microsoft.AppPlatform/locations/operationStatus/operationId, select:
- Read : Read operation status
Select Add.
Review the permissions.
Select Review and create.

Repeat steps 1 through 4 from the procedure for adding the Developer role.
Select Next.
Select the JSON tab.
Select Edit, and then delete the default text:

Paste in the following JSON to define the Ops - Site Reliability Engineering role:

Basic/Standard plan

{
   "properties": {
     "roleName": "Ops - Site Reliability Engineering",
     "description": "",
     "assignableScopes": [
       "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
     ],
     "permissions": [
       {
         "actions": [
           "Microsoft.AppPlatform/Spring/read",
           "Microsoft.AppPlatform/Spring/listTestKeys/action",
           "Microsoft.AppPlatform/Spring/apps/read",
           "Microsoft.AppPlatform/Spring/apps/deployments/read",
           "Microsoft.AppPlatform/Spring/apps/deployments/start/action",
           "Microsoft.AppPlatform/Spring/apps/deployments/stop/action",
           "Microsoft.AppPlatform/Spring/apps/deployments/restart/action",
           "Microsoft.AppPlatform/Spring/apps/deployments/getLogFileUrl/action",
           "Microsoft.AppPlatform/locations/operationResults/Spring/read",
           "Microsoft.AppPlatform/locations/operationStatus/operationId/read"
         ],
         "notActions": [],
         "dataActions": [],
         "notDataActions": []
       }
     ]
   }
}

Review the permissions.
Select Review and create.

Define the Azure Pipelines / Jenkins / GitHub Actions role

This role can create and configure everything in Azure Spring Apps and apps with a service instance. This role is for releasing or deploying code.

Portal
JSON

Repeat steps 1 through 4 from the procedure for adding the Developer role.
Open the Permissions options.
Select the permissions for the Azure Pipelines / Jenkins / GitHub Actions role:

Under Microsoft.AppPlatform/Spring, select:
- Write : Create or Update Azure Spring Apps service instance
- Delete : Delete Azure Spring Apps service instance
- Read : Get Azure Spring Apps service instance
- Other : Enable Azure Spring Apps service instance test endpoint
- Other : Disable Azure Spring Apps service instance test endpoint
- Other : List Azure Spring Apps service instance test keys
- Other : Regenerate Azure Spring Apps service instance test key
Under Microsoft.AppPlatform/Spring/apps, select:
- Write : Write Azure Spring Apps application
- Delete : Delete Azure Spring Apps application
- Read : Read Azure Spring Apps application
- Other : Get Azure Spring Apps application resource upload URL
- Other : Validate Azure Spring Apps application custom domain
Under Microsoft.AppPlatform/Spring/apps/bindings, select:
- Write : Write Azure Spring Apps application binding
- Delete : Delete Azure Spring Apps application binding
- Read : Read Azure Spring Apps application binding
Under Microsoft.AppPlatform/Spring/apps/deployments, select:
- Write : Write Azure Spring Apps application deployment
- Delete : Delete Azure Spring Apps application deployment
- Read : Read Azure Spring Apps application deployment
- Other : Start Azure Spring Apps application deployment
- Other : Stop Azure Spring Apps application deployment
- Other : Restart Azure Spring Apps application deployment
- Other : Get Azure Spring Apps application deployment log file URL
Under Microsoft.AppPlatform/Spring/apps/deployments/skus, select:
- Read : List application deployment available skus
Under Microsoft.AppPlatform/locations, select:
- Other : Check name availability
Under Microsoft.AppPlatform/locations/operationResults/Spring, select:
- Read : Read operation result
Under Microsoft.AppPlatform/locations/operationStatus/operationId, select:
- Read : Read operation status
Under Microsoft.AppPlatform/skus, select:
- Read : List available skus
Select Add.
Review the permissions.
Select Review and create.

Repeat steps 1 through 4 from the procedure for adding the Developer role.
Select Next.
Select the JSON tab.
Select Edit, and then delete the default text:

Paste in the following JSON to define the Azure Pipelines / Jenkins / GitHub Actions role:

Basic/Standard plan

{
   "properties": {
     "roleName": "Azure Pipelines/Provisioning",
     "description": "",
     "assignableScopes": [
       "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
     ],
     "permissions": [
       {
         "actions": [
           "Microsoft.AppPlatform/Spring/write",
           "Microsoft.AppPlatform/Spring/delete",
           "Microsoft.AppPlatform/Spring/read",
           "Microsoft.AppPlatform/Spring/enableTestEndpoint/action",
           "Microsoft.AppPlatform/Spring/disableTestEndpoint/action",
           "Microsoft.AppPlatform/Spring/listTestKeys/action",
           "Microsoft.AppPlatform/Spring/regenerateTestKey/action",
           "Microsoft.AppPlatform/Spring/apps/write",
           "Microsoft.AppPlatform/Spring/apps/delete",
           "Microsoft.AppPlatform/Spring/apps/read",
           "Microsoft.AppPlatform/Spring/apps/getResourceUploadUrl/action",
           "Microsoft.AppPlatform/Spring/apps/validateDomain/action",
           "Microsoft.AppPlatform/Spring/apps/bindings/write",
           "Microsoft.AppPlatform/Spring/apps/bindings/delete",
           "Microsoft.AppPlatform/Spring/apps/bindings/read",
           "Microsoft.AppPlatform/Spring/apps/deployments/write",
           "Microsoft.AppPlatform/Spring/apps/deployments/delete",
           "Microsoft.AppPlatform/Spring/apps/deployments/read",
           "Microsoft.AppPlatform/Spring/apps/deployments/start/action",
           "Microsoft.AppPlatform/Spring/apps/deployments/stop/action",
           "Microsoft.AppPlatform/Spring/apps/deployments/restart/action",
           "Microsoft.AppPlatform/Spring/apps/deployments/getLogFileUrl/action",
           "Microsoft.AppPlatform/skus/read",
           "Microsoft.AppPlatform/locations/checkNameAvailability/action",
           "Microsoft.AppPlatform/locations/operationResults/Spring/read",
           "Microsoft.AppPlatform/locations/operationStatus/operationId/read"
         ],
         "notActions": [],
         "dataActions": [],
         "notDataActions": []
       }
     ]
   }
}

Select Add.
Review the permissions.

Next steps

Create or update Azure custom roles using the Azure portal

For more information about three methods that define custom permissions, see:

How to use permissions in Azure Spring Apps

Define the Developer role

Define the DevOps Engineer role

Define the Ops - Site Reliability Engineering role

Define the Azure Pipelines / Jenkins / GitHub Actions role

Next steps

Additional resources