Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. databoxedge
  5. getBandwidthSchedule
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.databoxedge.getBandwidthSchedule

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the properties of the specified bandwidth schedule.

Uses Azure REST API version 2023-07-01.

Other available API versions: 2022-03-01, 2022-04-01-preview, 2022-12-01-preview, 2023-01-01-preview, 2023-12-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native databoxedge [ApiVersion]. See the version guide for details.

Using getBandwidthSchedule

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getBandwidthSchedule(args: GetBandwidthScheduleArgs, opts?: InvokeOptions): Promise<GetBandwidthScheduleResult>
function getBandwidthScheduleOutput(args: GetBandwidthScheduleOutputArgs, opts?: InvokeOptions): Output<GetBandwidthScheduleResult>
Copy
def get_bandwidth_schedule(device_name: Optional[str] = None,
                           name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetBandwidthScheduleResult
def get_bandwidth_schedule_output(device_name: Optional[pulumi.Input[str]] = None,
                           name: Optional[pulumi.Input[str]] = None,
                           resource_group_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetBandwidthScheduleResult]
Copy
func LookupBandwidthSchedule(ctx *Context, args *LookupBandwidthScheduleArgs, opts ...InvokeOption) (*LookupBandwidthScheduleResult, error)
func LookupBandwidthScheduleOutput(ctx *Context, args *LookupBandwidthScheduleOutputArgs, opts ...InvokeOption) LookupBandwidthScheduleResultOutput
Copy

> Note: This function is named LookupBandwidthSchedule in the Go SDK.

public static class GetBandwidthSchedule 
{
    public static Task<GetBandwidthScheduleResult> InvokeAsync(GetBandwidthScheduleArgs args, InvokeOptions? opts = null)
    public static Output<GetBandwidthScheduleResult> Invoke(GetBandwidthScheduleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetBandwidthScheduleResult> getBandwidthSchedule(GetBandwidthScheduleArgs args, InvokeOptions options)
public static Output<GetBandwidthScheduleResult> getBandwidthSchedule(GetBandwidthScheduleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:databoxedge:getBandwidthSchedule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
Name
This property is required.
Changes to this property will trigger replacement.
string
The bandwidth schedule name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
Name
This property is required.
Changes to this property will trigger replacement.
string
The bandwidth schedule name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name.
name
This property is required.
Changes to this property will trigger replacement.
String
The bandwidth schedule name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.
deviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
name
This property is required.
Changes to this property will trigger replacement.
string
The bandwidth schedule name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
device_name
This property is required.
Changes to this property will trigger replacement.
str
The device name.
name
This property is required.
Changes to this property will trigger replacement.
str
The bandwidth schedule name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name.
name
This property is required.
Changes to this property will trigger replacement.
String
The bandwidth schedule name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.

getBandwidthSchedule Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Days List<string>
The days of the week when this schedule is applicable.
Id string
The path ID that uniquely identifies the object.
Name string
The object name.
RateInMbps int
The bandwidth rate in Mbps.
Start string
The start time of the schedule in UTC.
Stop string
The stop time of the schedule in UTC.
SystemData Pulumi.AzureNative.DataBoxEdge.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of BandwidthSchedule
Type string
The hierarchical type of the object.
AzureApiVersion string
The Azure API version of the resource.
Days []string
The days of the week when this schedule is applicable.
Id string
The path ID that uniquely identifies the object.
Name string
The object name.
RateInMbps int
The bandwidth rate in Mbps.
Start string
The start time of the schedule in UTC.
Stop string
The stop time of the schedule in UTC.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of BandwidthSchedule
Type string
The hierarchical type of the object.
azureApiVersion String
The Azure API version of the resource.
days List<String>
The days of the week when this schedule is applicable.
id String
The path ID that uniquely identifies the object.
name String
The object name.
rateInMbps Integer
The bandwidth rate in Mbps.
start String
The start time of the schedule in UTC.
stop String
The stop time of the schedule in UTC.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of BandwidthSchedule
type String
The hierarchical type of the object.
azureApiVersion string
The Azure API version of the resource.
days string[]
The days of the week when this schedule is applicable.
id string
The path ID that uniquely identifies the object.
name string
The object name.
rateInMbps number
The bandwidth rate in Mbps.
start string
The start time of the schedule in UTC.
stop string
The stop time of the schedule in UTC.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of BandwidthSchedule
type string
The hierarchical type of the object.
azure_api_version str
The Azure API version of the resource.
days Sequence[str]
The days of the week when this schedule is applicable.
id str
The path ID that uniquely identifies the object.
name str
The object name.
rate_in_mbps int
The bandwidth rate in Mbps.
start str
The start time of the schedule in UTC.
stop str
The stop time of the schedule in UTC.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of BandwidthSchedule
type str
The hierarchical type of the object.
azureApiVersion String
The Azure API version of the resource.
days List<String>
The days of the week when this schedule is applicable.
id String
The path ID that uniquely identifies the object.
name String
The object name.
rateInMbps Number
The bandwidth rate in Mbps.
start String
The start time of the schedule in UTC.
stop String
The stop time of the schedule in UTC.
systemData Property Map
Metadata pertaining to creation and last modification of BandwidthSchedule
type String
The hierarchical type of the object.

Supporting Types

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native