1. Packages
  2. Azure Native
  3. API Docs
  4. storsimple
  5. BandwidthSetting
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi

azure-native.storsimple.BandwidthSetting

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi

The bandwidth setting.

Uses Azure REST API version 2017-06-01. In version 2.x of the Azure Native provider, it used API version 2017-06-01.

Example Usage

BandwidthSettingsCreateOrUpdate

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

return await Deployment.RunAsync(() => 
{
    var bandwidthSetting = new AzureNative.StorSimple.BandwidthSetting("bandwidthSetting", new()
    {
        BandwidthSettingName = "BWSForTest",
        ManagerName = "ManagerForSDKTest1",
        ResourceGroupName = "ResourceGroupForSDKTest",
        Schedules = new[]
        {
            new AzureNative.StorSimple.Inputs.BandwidthScheduleArgs
            {
                Days = new[]
                {
                    AzureNative.StorSimple.DayOfWeek.Saturday,
                    AzureNative.StorSimple.DayOfWeek.Sunday,
                },
                RateInMbps = 10,
                Start = new AzureNative.StorSimple.Inputs.TimeArgs
                {
                    Hours = 10,
                    Minutes = 0,
                    Seconds = 0,
                },
                Stop = new AzureNative.StorSimple.Inputs.TimeArgs
                {
                    Hours = 20,
                    Minutes = 0,
                    Seconds = 0,
                },
            },
        },
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storsimple.NewBandwidthSetting(ctx, "bandwidthSetting", &storsimple.BandwidthSettingArgs{
			BandwidthSettingName: pulumi.String("BWSForTest"),
			ManagerName:          pulumi.String("ManagerForSDKTest1"),
			ResourceGroupName:    pulumi.String("ResourceGroupForSDKTest"),
			Schedules: storsimple.BandwidthScheduleArray{
				&storsimple.BandwidthScheduleArgs{
					Days: storsimple.DayOfWeekArray{
						storsimple.DayOfWeekSaturday,
						storsimple.DayOfWeekSunday,
					},
					RateInMbps: pulumi.Int(10),
					Start: &storsimple.TimeArgs{
						Hours:   pulumi.Int(10),
						Minutes: pulumi.Int(0),
						Seconds: pulumi.Int(0),
					},
					Stop: &storsimple.TimeArgs{
						Hours:   pulumi.Int(20),
						Minutes: pulumi.Int(0),
						Seconds: pulumi.Int(0),
					},
				},
			},
		})
		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.storsimple.BandwidthSetting;
import com.pulumi.azurenative.storsimple.BandwidthSettingArgs;
import com.pulumi.azurenative.storsimple.inputs.BandwidthScheduleArgs;
import com.pulumi.azurenative.storsimple.inputs.TimeArgs;
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 bandwidthSetting = new BandwidthSetting("bandwidthSetting", BandwidthSettingArgs.builder()
            .bandwidthSettingName("BWSForTest")
            .managerName("ManagerForSDKTest1")
            .resourceGroupName("ResourceGroupForSDKTest")
            .schedules(BandwidthScheduleArgs.builder()
                .days(                
                    "Saturday",
                    "Sunday")
                .rateInMbps(10)
                .start(TimeArgs.builder()
                    .hours(10)
                    .minutes(0)
                    .seconds(0)
                    .build())
                .stop(TimeArgs.builder()
                    .hours(20)
                    .minutes(0)
                    .seconds(0)
                    .build())
                .build())
            .build());

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

const bandwidthSetting = new azure_native.storsimple.BandwidthSetting("bandwidthSetting", {
    bandwidthSettingName: "BWSForTest",
    managerName: "ManagerForSDKTest1",
    resourceGroupName: "ResourceGroupForSDKTest",
    schedules: [{
        days: [
            azure_native.storsimple.DayOfWeek.Saturday,
            azure_native.storsimple.DayOfWeek.Sunday,
        ],
        rateInMbps: 10,
        start: {
            hours: 10,
            minutes: 0,
            seconds: 0,
        },
        stop: {
            hours: 20,
            minutes: 0,
            seconds: 0,
        },
    }],
});
Copy
import pulumi
import pulumi_azure_native as azure_native

bandwidth_setting = azure_native.storsimple.BandwidthSetting("bandwidthSetting",
    bandwidth_setting_name="BWSForTest",
    manager_name="ManagerForSDKTest1",
    resource_group_name="ResourceGroupForSDKTest",
    schedules=[{
        "days": [
            azure_native.storsimple.DayOfWeek.SATURDAY,
            azure_native.storsimple.DayOfWeek.SUNDAY,
        ],
        "rate_in_mbps": 10,
        "start": {
            "hours": 10,
            "minutes": 0,
            "seconds": 0,
        },
        "stop": {
            "hours": 20,
            "minutes": 0,
            "seconds": 0,
        },
    }])
Copy
resources:
  bandwidthSetting:
    type: azure-native:storsimple:BandwidthSetting
    properties:
      bandwidthSettingName: BWSForTest
      managerName: ManagerForSDKTest1
      resourceGroupName: ResourceGroupForSDKTest
      schedules:
        - days:
            - Saturday
            - Sunday
          rateInMbps: 10
          start:
            hours: 10
            minutes: 0
            seconds: 0
          stop:
            hours: 20
            minutes: 0
            seconds: 0
Copy

Create BandwidthSetting Resource

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

Constructor syntax

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

@overload
def BandwidthSetting(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     manager_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     schedules: Optional[Sequence[BandwidthScheduleArgs]] = None,
                     bandwidth_setting_name: Optional[str] = None,
                     kind: Optional[Kind] = None)
func NewBandwidthSetting(ctx *Context, name string, args BandwidthSettingArgs, opts ...ResourceOption) (*BandwidthSetting, error)
public BandwidthSetting(string name, BandwidthSettingArgs args, CustomResourceOptions? opts = null)
public BandwidthSetting(String name, BandwidthSettingArgs args)
public BandwidthSetting(String name, BandwidthSettingArgs args, CustomResourceOptions options)
type: azure-native:storsimple:BandwidthSetting
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. BandwidthSettingArgs
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. BandwidthSettingArgs
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. BandwidthSettingArgs
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. BandwidthSettingArgs
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. BandwidthSettingArgs
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 bandwidthSettingResource = new AzureNative.StorSimple.BandwidthSetting("bandwidthSettingResource", new()
{
    ManagerName = "string",
    ResourceGroupName = "string",
    Schedules = new[]
    {
        new AzureNative.StorSimple.Inputs.BandwidthScheduleArgs
        {
            Days = new[]
            {
                AzureNative.StorSimple.DayOfWeek.Sunday,
            },
            RateInMbps = 0,
            Start = new AzureNative.StorSimple.Inputs.TimeArgs
            {
                Hours = 0,
                Minutes = 0,
                Seconds = 0,
            },
            Stop = new AzureNative.StorSimple.Inputs.TimeArgs
            {
                Hours = 0,
                Minutes = 0,
                Seconds = 0,
            },
        },
    },
    BandwidthSettingName = "string",
    Kind = AzureNative.StorSimple.Kind.Series8000,
});
Copy
example, err := storsimple.NewBandwidthSetting(ctx, "bandwidthSettingResource", &storsimple.BandwidthSettingArgs{
	ManagerName:       pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	Schedules: storsimple.BandwidthScheduleArray{
		&storsimple.BandwidthScheduleArgs{
			Days: storsimple.DayOfWeekArray{
				storsimple.DayOfWeekSunday,
			},
			RateInMbps: pulumi.Int(0),
			Start: &storsimple.TimeArgs{
				Hours:   pulumi.Int(0),
				Minutes: pulumi.Int(0),
				Seconds: pulumi.Int(0),
			},
			Stop: &storsimple.TimeArgs{
				Hours:   pulumi.Int(0),
				Minutes: pulumi.Int(0),
				Seconds: pulumi.Int(0),
			},
		},
	},
	BandwidthSettingName: pulumi.String("string"),
	Kind:                 storsimple.KindSeries8000,
})
Copy
var bandwidthSettingResource = new BandwidthSetting("bandwidthSettingResource", BandwidthSettingArgs.builder()
    .managerName("string")
    .resourceGroupName("string")
    .schedules(BandwidthScheduleArgs.builder()
        .days("Sunday")
        .rateInMbps(0)
        .start(TimeArgs.builder()
            .hours(0)
            .minutes(0)
            .seconds(0)
            .build())
        .stop(TimeArgs.builder()
            .hours(0)
            .minutes(0)
            .seconds(0)
            .build())
        .build())
    .bandwidthSettingName("string")
    .kind("Series8000")
    .build());
Copy
bandwidth_setting_resource = azure_native.storsimple.BandwidthSetting("bandwidthSettingResource",
    manager_name="string",
    resource_group_name="string",
    schedules=[{
        "days": [azure_native.storsimple.DayOfWeek.SUNDAY],
        "rate_in_mbps": 0,
        "start": {
            "hours": 0,
            "minutes": 0,
            "seconds": 0,
        },
        "stop": {
            "hours": 0,
            "minutes": 0,
            "seconds": 0,
        },
    }],
    bandwidth_setting_name="string",
    kind=azure_native.storsimple.Kind.SERIES8000)
Copy
const bandwidthSettingResource = new azure_native.storsimple.BandwidthSetting("bandwidthSettingResource", {
    managerName: "string",
    resourceGroupName: "string",
    schedules: [{
        days: [azure_native.storsimple.DayOfWeek.Sunday],
        rateInMbps: 0,
        start: {
            hours: 0,
            minutes: 0,
            seconds: 0,
        },
        stop: {
            hours: 0,
            minutes: 0,
            seconds: 0,
        },
    }],
    bandwidthSettingName: "string",
    kind: azure_native.storsimple.Kind.Series8000,
});
Copy
type: azure-native:storsimple:BandwidthSetting
properties:
    bandwidthSettingName: string
    kind: Series8000
    managerName: string
    resourceGroupName: string
    schedules:
        - days:
            - Sunday
          rateInMbps: 0
          start:
            hours: 0
            minutes: 0
            seconds: 0
          stop:
            hours: 0
            minutes: 0
            seconds: 0
Copy

BandwidthSetting 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 BandwidthSetting resource accepts the following input properties:

ManagerName
This property is required.
Changes to this property will trigger replacement.
string
The manager name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name
Schedules This property is required. List<Pulumi.AzureNative.StorSimple.Inputs.BandwidthSchedule>
The schedules.
BandwidthSettingName Changes to this property will trigger replacement. string
The bandwidth setting name.
Kind Pulumi.AzureNative.StorSimple.Kind
The Kind of the object. Currently only Series8000 is supported
ManagerName
This property is required.
Changes to this property will trigger replacement.
string
The manager name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name
Schedules This property is required. []BandwidthScheduleArgs
The schedules.
BandwidthSettingName Changes to this property will trigger replacement. string
The bandwidth setting name.
Kind Kind
The Kind of the object. Currently only Series8000 is supported
managerName
This property is required.
Changes to this property will trigger replacement.
String
The manager name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name
schedules This property is required. List<BandwidthSchedule>
The schedules.
bandwidthSettingName Changes to this property will trigger replacement. String
The bandwidth setting name.
kind Kind
The Kind of the object. Currently only Series8000 is supported
managerName
This property is required.
Changes to this property will trigger replacement.
string
The manager name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name
schedules This property is required. BandwidthSchedule[]
The schedules.
bandwidthSettingName Changes to this property will trigger replacement. string
The bandwidth setting name.
kind Kind
The Kind of the object. Currently only Series8000 is supported
manager_name
This property is required.
Changes to this property will trigger replacement.
str
The manager name
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name
schedules This property is required. Sequence[BandwidthScheduleArgs]
The schedules.
bandwidth_setting_name Changes to this property will trigger replacement. str
The bandwidth setting name.
kind Kind
The Kind of the object. Currently only Series8000 is supported
managerName
This property is required.
Changes to this property will trigger replacement.
String
The manager name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name
schedules This property is required. List<Property Map>
The schedules.
bandwidthSettingName Changes to this property will trigger replacement. String
The bandwidth setting name.
kind "Series8000"
The Kind of the object. Currently only Series8000 is supported

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the object.
Type string
The hierarchical type of the object.
VolumeCount int
The number of volumes that uses the bandwidth setting.
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the object.
Type string
The hierarchical type of the object.
VolumeCount int
The number of volumes that uses the bandwidth setting.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the object.
type String
The hierarchical type of the object.
volumeCount Integer
The number of volumes that uses the bandwidth setting.
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the object.
type string
The hierarchical type of the object.
volumeCount number
The number of volumes that uses the bandwidth setting.
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the object.
type str
The hierarchical type of the object.
volume_count int
The number of volumes that uses the bandwidth setting.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the object.
type String
The hierarchical type of the object.
volumeCount Number
The number of volumes that uses the bandwidth setting.

Supporting Types

BandwidthSchedule
, BandwidthScheduleArgs

Days This property is required. List<Pulumi.AzureNative.StorSimple.DayOfWeek>
The days of the week when this schedule is applicable.
RateInMbps This property is required. int
The rate in Mbps.
Start This property is required. Pulumi.AzureNative.StorSimple.Inputs.Time
The start time of the schedule.
Stop This property is required. Pulumi.AzureNative.StorSimple.Inputs.Time
The stop time of the schedule.
Days This property is required. []DayOfWeek
The days of the week when this schedule is applicable.
RateInMbps This property is required. int
The rate in Mbps.
Start This property is required. Time
The start time of the schedule.
Stop This property is required. Time
The stop time of the schedule.
days This property is required. List<DayOfWeek>
The days of the week when this schedule is applicable.
rateInMbps This property is required. Integer
The rate in Mbps.
start This property is required. Time
The start time of the schedule.
stop This property is required. Time
The stop time of the schedule.
days This property is required. DayOfWeek[]
The days of the week when this schedule is applicable.
rateInMbps This property is required. number
The rate in Mbps.
start This property is required. Time
The start time of the schedule.
stop This property is required. Time
The stop time of the schedule.
days This property is required. Sequence[DayOfWeek]
The days of the week when this schedule is applicable.
rate_in_mbps This property is required. int
The rate in Mbps.
start This property is required. Time
The start time of the schedule.
stop This property is required. Time
The stop time of the schedule.
days This property is required. List<"Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday">
The days of the week when this schedule is applicable.
rateInMbps This property is required. Number
The rate in Mbps.
start This property is required. Property Map
The start time of the schedule.
stop This property is required. Property Map
The stop time of the schedule.

BandwidthScheduleResponse
, BandwidthScheduleResponseArgs

Days This property is required. List<string>
The days of the week when this schedule is applicable.
RateInMbps This property is required. int
The rate in Mbps.
Start This property is required. Pulumi.AzureNative.StorSimple.Inputs.TimeResponse
The start time of the schedule.
Stop This property is required. Pulumi.AzureNative.StorSimple.Inputs.TimeResponse
The stop time of the schedule.
Days This property is required. []string
The days of the week when this schedule is applicable.
RateInMbps This property is required. int
The rate in Mbps.
Start This property is required. TimeResponse
The start time of the schedule.
Stop This property is required. TimeResponse
The stop time of the schedule.
days This property is required. List<String>
The days of the week when this schedule is applicable.
rateInMbps This property is required. Integer
The rate in Mbps.
start This property is required. TimeResponse
The start time of the schedule.
stop This property is required. TimeResponse
The stop time of the schedule.
days This property is required. string[]
The days of the week when this schedule is applicable.
rateInMbps This property is required. number
The rate in Mbps.
start This property is required. TimeResponse
The start time of the schedule.
stop This property is required. TimeResponse
The stop time of the schedule.
days This property is required. Sequence[str]
The days of the week when this schedule is applicable.
rate_in_mbps This property is required. int
The rate in Mbps.
start This property is required. TimeResponse
The start time of the schedule.
stop This property is required. TimeResponse
The stop time of the schedule.
days This property is required. List<String>
The days of the week when this schedule is applicable.
rateInMbps This property is required. Number
The rate in Mbps.
start This property is required. Property Map
The start time of the schedule.
stop This property is required. Property Map
The stop time of the schedule.

DayOfWeek
, DayOfWeekArgs

Sunday
Sunday
Monday
Monday
Tuesday
Tuesday
Wednesday
Wednesday
Thursday
Thursday
Friday
Friday
Saturday
Saturday
DayOfWeekSunday
Sunday
DayOfWeekMonday
Monday
DayOfWeekTuesday
Tuesday
DayOfWeekWednesday
Wednesday
DayOfWeekThursday
Thursday
DayOfWeekFriday
Friday
DayOfWeekSaturday
Saturday
Sunday
Sunday
Monday
Monday
Tuesday
Tuesday
Wednesday
Wednesday
Thursday
Thursday
Friday
Friday
Saturday
Saturday
Sunday
Sunday
Monday
Monday
Tuesday
Tuesday
Wednesday
Wednesday
Thursday
Thursday
Friday
Friday
Saturday
Saturday
SUNDAY
Sunday
MONDAY
Monday
TUESDAY
Tuesday
WEDNESDAY
Wednesday
THURSDAY
Thursday
FRIDAY
Friday
SATURDAY
Saturday
"Sunday"
Sunday
"Monday"
Monday
"Tuesday"
Tuesday
"Wednesday"
Wednesday
"Thursday"
Thursday
"Friday"
Friday
"Saturday"
Saturday

Kind
, KindArgs

Series8000
Series8000
KindSeries8000
Series8000
Series8000
Series8000
Series8000
Series8000
SERIES8000
Series8000
"Series8000"
Series8000

Time
, TimeArgs

Hours This property is required. int
The hour.
Minutes This property is required. int
The minute.
Seconds This property is required. int
The second.
Hours This property is required. int
The hour.
Minutes This property is required. int
The minute.
Seconds This property is required. int
The second.
hours This property is required. Integer
The hour.
minutes This property is required. Integer
The minute.
seconds This property is required. Integer
The second.
hours This property is required. number
The hour.
minutes This property is required. number
The minute.
seconds This property is required. number
The second.
hours This property is required. int
The hour.
minutes This property is required. int
The minute.
seconds This property is required. int
The second.
hours This property is required. Number
The hour.
minutes This property is required. Number
The minute.
seconds This property is required. Number
The second.

TimeResponse
, TimeResponseArgs

Hours This property is required. int
The hour.
Minutes This property is required. int
The minute.
Seconds This property is required. int
The second.
Hours This property is required. int
The hour.
Minutes This property is required. int
The minute.
Seconds This property is required. int
The second.
hours This property is required. Integer
The hour.
minutes This property is required. Integer
The minute.
seconds This property is required. Integer
The second.
hours This property is required. number
The hour.
minutes This property is required. number
The minute.
seconds This property is required. number
The second.
hours This property is required. int
The hour.
minutes This property is required. int
The minute.
seconds This property is required. int
The second.
hours This property is required. Number
The hour.
minutes This property is required. Number
The minute.
seconds This property is required. Number
The second.

Import

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

$ pulumi import azure-native:storsimple:BandwidthSetting BWSForTest /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/bandwidthSettings/{bandwidthSettingName} 
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi