Bastion Hosts - Update

Service:

Virtual Networks

API Version:

2026-01-01

Updates Tags or identity for BastionHost resource

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}?api-version=2026-01-01

URI Parameters

Name	In	Required	Type	Description
bastionHostName	path	True	string	The name of the Bastion Host.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
identity	ManagedServiceIdentity	The identity of the BastionHost, if configured.
tags	object	Resource tags.

Responses

Name	Type	Description
200 OK	BastionHost	Azure operation completed successfully.
202 Accepted		Resource update request accepted. Headers Azure-AsyncOperation: string Retry-After: integer
Other Status Codes	CloudError	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Patch Bastion Host

Sample request

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant?api-version=2026-01-01

{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/bastionidentity": {}
    }
  },
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

Java

import com.azure.resourcemanager.network.models.BastionHostUpdate;
import com.azure.resourcemanager.network.models.ManagedServiceIdentity;
import com.azure.resourcemanager.network.models.ManagedServiceIdentityUserAssignedIdentities;
import com.azure.resourcemanager.network.models.ResourceIdentityType;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for BastionHosts Update.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-01-01/BastionHostPatch.json
     */
    /**
     * Sample code: Patch Bastion Host.
     * 
     * @param manager Entry point to NetworkManager.
     */
    public static void patchBastionHost(com.azure.resourcemanager.network.NetworkManager manager) {
        manager.serviceClient().getBastionHosts().update("rg1", "bastionhosttenant", new BastionHostUpdate()
            .withIdentity(new ManagedServiceIdentity().withType(ResourceIdentityType.USER_ASSIGNED)
                .withUserAssignedIdentities(mapOf(
                    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/bastionidentity",
                    new ManagedServiceIdentityUserAssignedIdentities())))
            .withTags(mapOf("tag1", "value1", "tag2", "value2")), com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python bastion_host_patch.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.bastion_hosts.begin_update(
        resource_group_name="rg1",
        bastion_host_name="bastionhosttenant",
        parameters={
            "identity": {
                "type": "UserAssigned",
                "userAssignedIdentities": {
                    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/bastionidentity": {}
                },
            },
            "tags": {"tag1": "value1", "tag2": "value2"},
        },
    ).result()
    print(response)


# x-ms-original-file: 2026-01-01/BastionHostPatch.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v12"
)

// Generated from example definition: 2026-01-01/BastionHostPatch.json
func ExampleBastionHostsClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewBastionHostsClient().BeginUpdate(ctx, "rg1", "bastionhosttenant", armnetwork.BastionHostUpdate{
		Identity: &armnetwork.ManagedServiceIdentity{
			Type: to.Ptr(armnetwork.ResourceIdentityTypeUserAssigned),
			UserAssignedIdentities: map[string]*armnetwork.ManagedServiceIdentityUserAssignedIdentities{
				"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/bastionidentity": {},
			},
		},
		Tags: map[string]*string{
			"tag1": to.Ptr("value1"),
			"tag2": to.Ptr("value2"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armnetwork.BastionHostsClientUpdateResponse{
	// 	BastionHost: armnetwork.BastionHost{
	// 		Name: to.Ptr("bastionhosttenant"),
	// 		Type: to.Ptr("Microsoft.Network/bastionHosts"),
	// 		Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant"),
	// 		Location: to.Ptr("West US"),
	// 		Properties: &armnetwork.BastionHostPropertiesFormat{
	// 			DisableCopyPaste: to.Ptr(false),
	// 			DNSName: to.Ptr("bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com"),
	// 			EnableIPConnect: to.Ptr(false),
	// 			EnableKerberos: to.Ptr(false),
	// 			EnablePrivateOnlyBastion: to.Ptr(false),
	// 			EnableSessionRecording: to.Ptr(false),
	// 			EnableShareableLink: to.Ptr(false),
	// 			EnableTunneling: to.Ptr(false),
	// 			IPConfigurations: []*armnetwork.BastionHostIPConfiguration{
	// 				{
	// 					Name: to.Ptr("bastionHostIpConfiguration"),
	// 					Type: to.Ptr("Microsoft.Network/bastionHosts/bastionHostIpConfigurations"),
	// 					Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration"),
	// 					Properties: &armnetwork.BastionHostIPConfigurationPropertiesFormat{
	// 						PrivateIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodDynamic),
	// 						ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 						PublicIPAddress: &armnetwork.SubResource{
	// 							ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"),
	// 						},
	// 						Subnet: &armnetwork.SubResource{
	// 							ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet"),
	// 						},
	// 					},
	// 				},
	// 			},
	// 			ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
	// 			ScaleUnits: to.Ptr[int32](2),
	// 		},
	// 		SKU: &armnetwork.SKU{
	// 			Name: to.Ptr(armnetwork.BastionHostSKUNameStandard),
	// 		},
	// 		Tags: map[string]*string{
	// 			"tag1": to.Ptr("value1"),
	// 			"tag2": to.Ptr("value2"),
	// 		},
	// 		Identity: &armnetwork.ManagedServiceIdentity{
	// 			UserAssignedIdentities: map[string]*armnetwork.ManagedServiceIdentityUserAssignedIdentities{
	// 				"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/bastionidentity": &armnetwork.ManagedServiceIdentityUserAssignedIdentities{
	// 					PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 					ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 				},
	// 			},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to updates Tags or identity for BastionHost resource
 *
 * @summary updates Tags or identity for BastionHost resource
 * x-ms-original-file: 2026-01-01/BastionHostPatch.json
 */
async function patchBastionHost() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.bastionHosts.update("rg1", "bastionhosttenant", {
    identity: {
      type: "UserAssigned",
      userAssignedIdentities: {
        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/bastionidentity":
          {},
      },
    },
    tags: { tag1: "value1", tag2: "value2" },
  });
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "name": "bastionhosttenant",
  "type": "Microsoft.Network/bastionHosts",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant",
  "location": "West US",
  "properties": {
    "disableCopyPaste": false,
    "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com",
    "enableIpConnect": false,
    "enableKerberos": false,
    "enablePrivateOnlyBastion": false,
    "enableSessionRecording": false,
    "enableShareableLink": false,
    "enableTunneling": false,
    "ipConfigurations": [
      {
        "name": "bastionHostIpConfiguration",
        "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations",
        "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration",
        "properties": {
          "privateIPAllocationMethod": "Dynamic",
          "provisioningState": "Succeeded",
          "publicIPAddress": {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"
          },
          "subnet": {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet"
          }
        }
      }
    ],
    "provisioningState": "Succeeded",
    "scaleUnits": 2
  },
  "sku": {
    "name": "Standard"
  },
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "identity": {
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/bastionidentity": {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "clientId": "00000000-0000-0000-0000-000000000000"
      }
    }
  }
}

Status code:

202

azure-asyncoperation: http://azure.async.operation/status

Definitions

Name	Description
BastionHost	Bastion Host resource.
BastionHostIPConfiguration	IP configuration of an Bastion Host.
BastionHostPropertiesFormatNetworkAcls
BastionHostSkuName	The name of the sku of this Bastion Host.
BastionHostUpdate	Parameters supplied to update the Bastion Host identity or tags.
BastionSessionRecordingConfiguration	Bastion Session Recording Configuration.
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
IPAllocationMethod	IP address allocation method.
IPRule
ManagedServiceIdentity	Identity for the resource.
ManagedServiceIdentityUserAssignedIdentities
ProvisioningState	Provisioning states of a resource.
ResourceIdentityType	The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
SessionRecordingIdentity	The identity to use for accessing the blob container where recordings will be stored
SessionRecordingIdentityType	The type of identity to use
Sku	The sku of this Bastion Host.
SubResource	Reference to another subresource.

BastionHost

Object

Bastion Host resource.

Name	Type	Default value	Description
etag	string		A unique read-only string that changes whenever the resource is updated.
id	string		Resource ID.
identity	ManagedServiceIdentity		The identity assigned to the Bastion Host resource
location	string		Resource location.
name	string		Resource name.
properties.disableCopyPaste	boolean	False	Enable/Disable Copy/Paste feature of the Bastion Host resource.
properties.dnsName	string		FQDN for the endpoint on which bastion host is accessible.
properties.enableFileCopy	boolean	False	Enable/Disable File Copy feature of the Bastion Host resource.
properties.enableIpConnect	boolean	False	Enable/Disable IP Connect feature of the Bastion Host resource.
properties.enableKerberos	boolean	False	Enable/Disable Kerberos feature of the Bastion Host resource.
properties.enablePrivateOnlyBastion	boolean	False	Enable/Disable Private Only feature of the Bastion Host resource.
properties.enableSessionRecording	boolean	False	Enable/Disable Session Recording feature of the Bastion Host resource.
properties.enableShareableLink	boolean	False	Enable/Disable Shareable Link of the Bastion Host resource.
properties.enableTunneling	boolean	False	Enable/Disable Tunneling feature of the Bastion Host resource.
properties.ipConfigurations	BastionHostIPConfiguration[]		IP configuration of the Bastion Host resource.
properties.networkAcls	BastionHostPropertiesFormatNetworkAcls
properties.provisioningState	ProvisioningState		The provisioning state of the bastion host resource.
properties.scaleUnits	integer (int32) minimum: 2 maximum: 50		The scale units for the Bastion Host resource.
properties.sessionRecordingConfiguration	BastionSessionRecordingConfiguration		The storage account and identity to use for session recording
properties.virtualNetwork	SubResource		Reference to an existing virtual network required for Developer Bastion Host only.
sku	Sku		The sku of this Bastion Host.
tags	object		Resource tags.
type	string		Resource type.
zones	string[]		A list of availability zones denoting where the resource needs to come from.

BastionHostIPConfiguration

Object

IP configuration of an Bastion Host.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID.
name	string	Name of the resource that is unique within a resource group. This name can be used to access the resource.
properties.privateIPAllocationMethod	IPAllocationMethod	Private IP allocation method.
properties.provisioningState	ProvisioningState	The provisioning state of the bastion host IP configuration resource.
properties.publicIPAddress	SubResource	Reference of the PublicIP resource. Null for private only bastion
properties.subnet	SubResource	Reference of the subnet resource.
type	string	Ip configuration type.

BastionHostPropertiesFormatNetworkAcls

Object

Name	Type	Description
ipRules	IPRule[]	Sets the IP ACL rules for Developer Bastion Host.

BastionHostSkuName

Enumeration

The name of the sku of this Bastion Host.

Value	Description
Basic	Basic
Standard	Standard
Developer	Developer
Premium	Premium

BastionHostUpdate

Object

Parameters supplied to update the Bastion Host identity or tags.

Name	Type	Description
identity	ManagedServiceIdentity	The identity of the BastionHost, if configured.
tags	object	Resource tags.

BastionSessionRecordingConfiguration

Object

Bastion Session Recording Configuration.

Name	Type	Description
blobContainerUri	string (uri)	The blob container to store the recordings. Ex: https://contosostorage.blob.core.windows.net/contosorecordings.
identity	SessionRecordingIdentity	The identity to use for accessing the blob container where recordings will be stored

CloudError

Object

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

Object

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

IPAllocationMethod

Enumeration

IP address allocation method.

Value	Description
Static	Static
Dynamic	Dynamic

IPRule

Object

Name	Type	Description
addressPrefix	string	Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.

ManagedServiceIdentity

Object

Identity for the resource.

Name	Type	Description
principalId	string	The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string	The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
type	ResourceIdentityType	The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
userAssignedIdentities	<string,  ManagedServiceIdentityUserAssignedIdentities>	The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ManagedServiceIdentityUserAssignedIdentities

Object

Name	Type	Description
clientId	string	The client id of user assigned identity.
principalId	string	The principal id of user assigned identity.

ProvisioningState

Enumeration

Provisioning states of a resource.

Value	Description
Failed	Failed
Succeeded	Succeeded
Canceled	Canceled
Creating	Creating
Updating	Updating
Deleting	Deleting

ResourceIdentityType

Enumeration

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.

Value	Description
SystemAssigned	SystemAssigned
UserAssigned	UserAssigned
SystemAssigned, UserAssigned	SystemAssigned, UserAssigned
None	None

SessionRecordingIdentity

Object

The identity to use for accessing the blob container where recordings will be stored

Name	Type	Description
type	SessionRecordingIdentityType	The type of identity to use
userAssignedIdentityId	string (arm-id)	User assigned identity to use for accessing blob container Uri. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identity type systemAssigned.

SessionRecordingIdentityType

Enumeration

The type of identity to use

Value	Description
SystemAssigned	System assigned identity
UserAssigned	User assigned identity

Sku

Object

The sku of this Bastion Host.

Name	Type	Default value	Description
name	BastionHostSkuName	Standard	The name of the sku of this Bastion Host.

SubResource

Object

Reference to another subresource.

Name	Type	Description
id	string	Resource ID.