Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. network
  5. VirtualApplianceSite
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.network.VirtualApplianceSite

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Virtual Appliance Site resource. Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 2020-11-01.

Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

Example Usage

Create Network Virtual Appliance Site

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var virtualApplianceSite = new AzureNative.Network.VirtualApplianceSite("virtualApplianceSite", new()
    {
        AddressPrefix = "192.168.1.0/24",
        NetworkVirtualApplianceName = "nva",
        O365Policy = new AzureNative.Network.Inputs.Office365PolicyPropertiesArgs
        {
            BreakOutCategories = new AzureNative.Network.Inputs.BreakOutCategoryPoliciesArgs
            {
                Allow = true,
                Default = true,
                Optimize = true,
            },
        },
        ResourceGroupName = "rg1",
        SiteName = "site1",
    });

});
Copy
package main

import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewVirtualApplianceSite(ctx, "virtualApplianceSite", &network.VirtualApplianceSiteArgs{
			AddressPrefix:               pulumi.String("192.168.1.0/24"),
			NetworkVirtualApplianceName: pulumi.String("nva"),
			O365Policy: &network.Office365PolicyPropertiesArgs{
				BreakOutCategories: &network.BreakOutCategoryPoliciesArgs{
					Allow:    pulumi.Bool(true),
					Default:  pulumi.Bool(true),
					Optimize: pulumi.Bool(true),
				},
			},
			ResourceGroupName: pulumi.String("rg1"),
			SiteName:          pulumi.String("site1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.VirtualApplianceSite;
import com.pulumi.azurenative.network.VirtualApplianceSiteArgs;
import com.pulumi.azurenative.network.inputs.Office365PolicyPropertiesArgs;
import com.pulumi.azurenative.network.inputs.BreakOutCategoryPoliciesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var virtualApplianceSite = new VirtualApplianceSite("virtualApplianceSite", VirtualApplianceSiteArgs.builder()
            .addressPrefix("192.168.1.0/24")
            .networkVirtualApplianceName("nva")
            .o365Policy(Office365PolicyPropertiesArgs.builder()
                .breakOutCategories(BreakOutCategoryPoliciesArgs.builder()
                    .allow(true)
                    .default_(true)
                    .optimize(true)
                    .build())
                .build())
            .resourceGroupName("rg1")
            .siteName("site1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const virtualApplianceSite = new azure_native.network.VirtualApplianceSite("virtualApplianceSite", {
    addressPrefix: "192.168.1.0/24",
    networkVirtualApplianceName: "nva",
    o365Policy: {
        breakOutCategories: {
            allow: true,
            "default": true,
            optimize: true,
        },
    },
    resourceGroupName: "rg1",
    siteName: "site1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

virtual_appliance_site = azure_native.network.VirtualApplianceSite("virtualApplianceSite",
    address_prefix="192.168.1.0/24",
    network_virtual_appliance_name="nva",
    o365_policy={
        "break_out_categories": {
            "allow": True,
            "default": True,
            "optimize": True,
        },
    },
    resource_group_name="rg1",
    site_name="site1")
Copy
resources:
  virtualApplianceSite:
    type: azure-native:network:VirtualApplianceSite
    properties:
      addressPrefix: 192.168.1.0/24
      networkVirtualApplianceName: nva
      o365Policy:
        breakOutCategories:
          allow: true
          default: true
          optimize: true
      resourceGroupName: rg1
      siteName: site1
Copy

Create VirtualApplianceSite Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new VirtualApplianceSite(name: string, args: VirtualApplianceSiteArgs, opts?: CustomResourceOptions);
@overload
def VirtualApplianceSite(resource_name: str,
                         args: VirtualApplianceSiteArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def VirtualApplianceSite(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         network_virtual_appliance_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         address_prefix: Optional[str] = None,
                         id: Optional[str] = None,
                         name: Optional[str] = None,
                         o365_policy: Optional[Office365PolicyPropertiesArgs] = None,
                         site_name: Optional[str] = None)
func NewVirtualApplianceSite(ctx *Context, name string, args VirtualApplianceSiteArgs, opts ...ResourceOption) (*VirtualApplianceSite, error)
public VirtualApplianceSite(string name, VirtualApplianceSiteArgs args, CustomResourceOptions? opts = null)
public VirtualApplianceSite(String name, VirtualApplianceSiteArgs args)
public VirtualApplianceSite(String name, VirtualApplianceSiteArgs args, CustomResourceOptions options)

type: azure-native:network:VirtualApplianceSite
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VirtualApplianceSiteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. VirtualApplianceSiteArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. VirtualApplianceSiteArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. VirtualApplianceSiteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VirtualApplianceSiteArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var virtualApplianceSiteResource = new AzureNative.Network.VirtualApplianceSite("virtualApplianceSiteResource", new()
{
    NetworkVirtualApplianceName = "string",
    ResourceGroupName = "string",
    AddressPrefix = "string",
    Id = "string",
    Name = "string",
    O365Policy = 
    {
        { "breakOutCategories", 
        {
            { "allow", false },
            { "default", false },
            { "optimize", false },
        } },
    },
    SiteName = "string",
});
Copy
example, err := network.NewVirtualApplianceSite(ctx, "virtualApplianceSiteResource", &network.VirtualApplianceSiteArgs{
	NetworkVirtualApplianceName: "string",
	ResourceGroupName:           "string",
	AddressPrefix:               "string",
	Id:                          "string",
	Name:                        "string",
	O365Policy: map[string]interface{}{
		"breakOutCategories": map[string]interface{}{
			"allow":    false,
			"default":  false,
			"optimize": false,
		},
	},
	SiteName: "string",
})
Copy
var virtualApplianceSiteResource = new VirtualApplianceSite("virtualApplianceSiteResource", VirtualApplianceSiteArgs.builder()
    .networkVirtualApplianceName("string")
    .resourceGroupName("string")
    .addressPrefix("string")
    .id("string")
    .name("string")
    .o365Policy(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .siteName("string")
    .build());
Copy
virtual_appliance_site_resource = azure_native.network.VirtualApplianceSite("virtualApplianceSiteResource",
    network_virtual_appliance_name=string,
    resource_group_name=string,
    address_prefix=string,
    id=string,
    name=string,
    o365_policy={
        breakOutCategories: {
            allow: False,
            default: False,
            optimize: False,
        },
    },
    site_name=string)
Copy
const virtualApplianceSiteResource = new azure_native.network.VirtualApplianceSite("virtualApplianceSiteResource", {
    networkVirtualApplianceName: "string",
    resourceGroupName: "string",
    addressPrefix: "string",
    id: "string",
    name: "string",
    o365Policy: {
        breakOutCategories: {
            allow: false,
            "default": false,
            optimize: false,
        },
    },
    siteName: "string",
});
Copy
type: azure-native:network:VirtualApplianceSite
properties:
    addressPrefix: string
    id: string
    name: string
    networkVirtualApplianceName: string
    o365Policy:
        breakOutCategories:
            allow: false
            default: false
            optimize: false
    resourceGroupName: string
    siteName: string
Copy

VirtualApplianceSite Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The VirtualApplianceSite resource accepts the following input properties:

NetworkVirtualApplianceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Network Virtual Appliance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
AddressPrefix string
Address Prefix.
Id string
Resource ID.
Name string
Name of the virtual appliance site.
O365Policy Pulumi.AzureNative.Network.Inputs.Office365PolicyProperties
Office 365 Policy.
SiteName Changes to this property will trigger replacement. string
The name of the site.
NetworkVirtualApplianceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Network Virtual Appliance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
AddressPrefix string
Address Prefix.
Id string
Resource ID.
Name string
Name of the virtual appliance site.
O365Policy Office365PolicyPropertiesArgs
Office 365 Policy.
SiteName Changes to this property will trigger replacement. string
The name of the site.
networkVirtualApplianceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Network Virtual Appliance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
addressPrefix String
Address Prefix.
id String
Resource ID.
name String
Name of the virtual appliance site.
o365Policy Office365PolicyProperties
Office 365 Policy.
siteName Changes to this property will trigger replacement. String
The name of the site.
networkVirtualApplianceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Network Virtual Appliance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
addressPrefix string
Address Prefix.
id string
Resource ID.
name string
Name of the virtual appliance site.
o365Policy Office365PolicyProperties
Office 365 Policy.
siteName Changes to this property will trigger replacement. string
The name of the site.
network_virtual_appliance_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Network Virtual Appliance.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
address_prefix str
Address Prefix.
id str
Resource ID.
name str
Name of the virtual appliance site.
o365_policy Office365PolicyPropertiesArgs
Office 365 Policy.
site_name Changes to this property will trigger replacement. str
The name of the site.
networkVirtualApplianceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Network Virtual Appliance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
addressPrefix String
Address Prefix.
id String
Resource ID.
name String
Name of the virtual appliance site.
o365Policy Property Map
Office 365 Policy.
siteName Changes to this property will trigger replacement. String
The name of the site.

Outputs

All input properties are implicitly available as output properties. Additionally, the VirtualApplianceSite resource produces the following output properties:

Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
The provider-assigned unique ID for this managed resource.
ProvisioningState string
The provisioning state of the resource.
Type string
Site type.
Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
The provider-assigned unique ID for this managed resource.
ProvisioningState string
The provisioning state of the resource.
Type string
Site type.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
The provider-assigned unique ID for this managed resource.
provisioningState String
The provisioning state of the resource.
type String
Site type.
etag string
A unique read-only string that changes whenever the resource is updated.
id string
The provider-assigned unique ID for this managed resource.
provisioningState string
The provisioning state of the resource.
type string
Site type.
etag str
A unique read-only string that changes whenever the resource is updated.
id str
The provider-assigned unique ID for this managed resource.
provisioning_state str
The provisioning state of the resource.
type str
Site type.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
The provider-assigned unique ID for this managed resource.
provisioningState String
The provisioning state of the resource.
type String
Site type.

Supporting Types

BreakOutCategoryPolicies
, BreakOutCategoryPoliciesArgs

Allow bool
Flag to control breakout of o365 allow category.
Default bool
Flag to control breakout of o365 default category.
Optimize bool
Flag to control breakout of o365 optimize category.
Allow bool
Flag to control breakout of o365 allow category.
Default bool
Flag to control breakout of o365 default category.
Optimize bool
Flag to control breakout of o365 optimize category.
allow Boolean
Flag to control breakout of o365 allow category.
default_ Boolean
Flag to control breakout of o365 default category.
optimize Boolean
Flag to control breakout of o365 optimize category.
allow boolean
Flag to control breakout of o365 allow category.
default boolean
Flag to control breakout of o365 default category.
optimize boolean
Flag to control breakout of o365 optimize category.
allow bool
Flag to control breakout of o365 allow category.
default bool
Flag to control breakout of o365 default category.
optimize bool
Flag to control breakout of o365 optimize category.
allow Boolean
Flag to control breakout of o365 allow category.
default Boolean
Flag to control breakout of o365 default category.
optimize Boolean
Flag to control breakout of o365 optimize category.

BreakOutCategoryPoliciesResponse
, BreakOutCategoryPoliciesResponseArgs

Allow bool
Flag to control breakout of o365 allow category.
Default bool
Flag to control breakout of o365 default category.
Optimize bool
Flag to control breakout of o365 optimize category.
Allow bool
Flag to control breakout of o365 allow category.
Default bool
Flag to control breakout of o365 default category.
Optimize bool
Flag to control breakout of o365 optimize category.
allow Boolean
Flag to control breakout of o365 allow category.
default_ Boolean
Flag to control breakout of o365 default category.
optimize Boolean
Flag to control breakout of o365 optimize category.
allow boolean
Flag to control breakout of o365 allow category.
default boolean
Flag to control breakout of o365 default category.
optimize boolean
Flag to control breakout of o365 optimize category.
allow bool
Flag to control breakout of o365 allow category.
default bool
Flag to control breakout of o365 default category.
optimize bool
Flag to control breakout of o365 optimize category.
allow Boolean
Flag to control breakout of o365 allow category.
default Boolean
Flag to control breakout of o365 default category.
optimize Boolean
Flag to control breakout of o365 optimize category.

Office365PolicyProperties
, Office365PolicyPropertiesArgs

BreakOutCategories BreakOutCategoryPolicies
Office 365 breakout categories.
breakOutCategories BreakOutCategoryPolicies
Office 365 breakout categories.
breakOutCategories BreakOutCategoryPolicies
Office 365 breakout categories.
break_out_categories BreakOutCategoryPolicies
Office 365 breakout categories.
breakOutCategories Property Map
Office 365 breakout categories.

Office365PolicyPropertiesResponse
, Office365PolicyPropertiesResponseArgs

breakOutCategories Property Map
Office 365 breakout categories.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:network:VirtualApplianceSite site1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/virtualApplianceSites/{siteName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native