GlobalVMShutdownSchedule

Manages automated shutdown schedules for Azure VMs that are not within an Azure DevTest Lab. While this is part of the DevTest Labs service in Azure, this resource applies only to standard VMs, not DevTest Lab VMs. To manage automated shutdown schedules for DevTest Lab VMs, reference the azure.devtest.Schedule resource

Create a GlobalVMShutdownSchedule Resource

new GlobalVMShutdownSchedule(name: string, args: GlobalVMShutdownScheduleArgs, opts?: CustomResourceOptions);

def GlobalVMShutdownSchedule(resource_name, opts=None, daily_recurrence_time=None, enabled=None, location=None, notification_settings=None, tags=None, timezone=None, virtual_machine_id=None, __props__=None);

func NewGlobalVMShutdownSchedule(ctx *Context, name string, args GlobalVMShutdownScheduleArgs, opts ...ResourceOption) (*GlobalVMShutdownSchedule, error)

public GlobalVMShutdownSchedule(string name, GlobalVMShutdownScheduleArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args GlobalVMShutdownScheduleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args GlobalVMShutdownScheduleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GlobalVMShutdownScheduleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

GlobalVMShutdownSchedule Resource Properties

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

Inputs

The GlobalVMShutdownSchedule resource accepts the following input properties:

DailyRecurrenceTime string: The time each day when the schedule takes effect. Must match the format HHmm where HH is 00-23 and mm is 00-59 (e.g. 0930, 2300, etc.)
NotificationSettings GlobalVMShutdownScheduleNotificationSettingsArgs
Timezone string: The time zone ID (e.g. Pacific Standard time). Refer to this guide for a full list of accepted time zone names.
VirtualMachineId string: The resource ID of the target ARM-based Virtual Machine. Changing this forces a new resource to be created.
Enabled bool: Whether to enable the schedule. Possible values are true and false. Defaults to true.
Location string: The location where the schedule is created. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

DailyRecurrenceTime string: The time each day when the schedule takes effect. Must match the format HHmm where HH is 00-23 and mm is 00-59 (e.g. 0930, 2300, etc.)
NotificationSettings GlobalVMShutdownScheduleNotificationSettings
Timezone string: The time zone ID (e.g. Pacific Standard time). Refer to this guide for a full list of accepted time zone names.
VirtualMachineId string: The resource ID of the target ARM-based Virtual Machine. Changing this forces a new resource to be created.
Enabled bool: Whether to enable the schedule. Possible values are true and false. Defaults to true.
Location string: The location where the schedule is created. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.

dailyRecurrenceTime string: The time each day when the schedule takes effect. Must match the format HHmm where HH is 00-23 and mm is 00-59 (e.g. 0930, 2300, etc.)
notificationSettings GlobalVMShutdownScheduleNotificationSettings
timezone string: The time zone ID (e.g. Pacific Standard time). Refer to this guide for a full list of accepted time zone names.
virtualMachineId string: The resource ID of the target ARM-based Virtual Machine. Changing this forces a new resource to be created.
enabled boolean: Whether to enable the schedule. Possible values are true and false. Defaults to true.
location string: The location where the schedule is created. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

daily_recurrence_time str: The time each day when the schedule takes effect. Must match the format HHmm where HH is 00-23 and mm is 00-59 (e.g. 0930, 2300, etc.)
notification_settings Dict[GlobalVMShutdownScheduleNotificationSettings]
timezone str: The time zone ID (e.g. Pacific Standard time). Refer to this guide for a full list of accepted time zone names.
virtual_machine_id str: The resource ID of the target ARM-based Virtual Machine. Changing this forces a new resource to be created.
enabled bool: Whether to enable the schedule. Possible values are true and false. Defaults to true.
location str: The location where the schedule is created. Changing this forces a new resource to be created.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing GlobalVMShutdownSchedule Resource

Get an existing GlobalVMShutdownSchedule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GlobalVMShutdownScheduleState, opts?: CustomResourceOptions): GlobalVMShutdownSchedule

static get(resource_name, id, opts=None, daily_recurrence_time=None, enabled=None, location=None, notification_settings=None, tags=None, timezone=None, virtual_machine_id=None, __props__=None);

func GetGlobalVMShutdownSchedule(ctx *Context, name string, id IDInput, state *GlobalVMShutdownScheduleState, opts ...ResourceOption) (*GlobalVMShutdownSchedule, error)

public static GlobalVMShutdownSchedule Get(string name, Input<string> id, GlobalVMShutdownScheduleState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

DailyRecurrenceTime string: The time each day when the schedule takes effect. Must match the format HHmm where HH is 00-23 and mm is 00-59 (e.g. 0930, 2300, etc.)
Enabled bool: Whether to enable the schedule. Possible values are true and false. Defaults to true.
Location string: The location where the schedule is created. Changing this forces a new resource to be created.
NotificationSettings GlobalVMShutdownScheduleNotificationSettingsArgs
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
Timezone string: The time zone ID (e.g. Pacific Standard time). Refer to this guide for a full list of accepted time zone names.
VirtualMachineId string: The resource ID of the target ARM-based Virtual Machine. Changing this forces a new resource to be created.

DailyRecurrenceTime string: The time each day when the schedule takes effect. Must match the format HHmm where HH is 00-23 and mm is 00-59 (e.g. 0930, 2300, etc.)
Enabled bool: Whether to enable the schedule. Possible values are true and false. Defaults to true.
Location string: The location where the schedule is created. Changing this forces a new resource to be created.
NotificationSettings GlobalVMShutdownScheduleNotificationSettings
Tags map[string]string: A mapping of tags to assign to the resource.
Timezone string: The time zone ID (e.g. Pacific Standard time). Refer to this guide for a full list of accepted time zone names.
VirtualMachineId string: The resource ID of the target ARM-based Virtual Machine. Changing this forces a new resource to be created.

dailyRecurrenceTime string: The time each day when the schedule takes effect. Must match the format HHmm where HH is 00-23 and mm is 00-59 (e.g. 0930, 2300, etc.)
enabled boolean: Whether to enable the schedule. Possible values are true and false. Defaults to true.
location string: The location where the schedule is created. Changing this forces a new resource to be created.
notificationSettings GlobalVMShutdownScheduleNotificationSettings
tags {[key: string]: string}: A mapping of tags to assign to the resource.
timezone string: The time zone ID (e.g. Pacific Standard time). Refer to this guide for a full list of accepted time zone names.
virtualMachineId string: The resource ID of the target ARM-based Virtual Machine. Changing this forces a new resource to be created.

daily_recurrence_time str: The time each day when the schedule takes effect. Must match the format HHmm where HH is 00-23 and mm is 00-59 (e.g. 0930, 2300, etc.)
enabled bool: Whether to enable the schedule. Possible values are true and false. Defaults to true.
location str: The location where the schedule is created. Changing this forces a new resource to be created.
notification_settings Dict[GlobalVMShutdownScheduleNotificationSettings]
tags Dict[str, str]: A mapping of tags to assign to the resource.
timezone str: The time zone ID (e.g. Pacific Standard time). Refer to this guide for a full list of accepted time zone names.
virtual_machine_id str: The resource ID of the target ARM-based Virtual Machine. Changing this forces a new resource to be created.

Supporting Types

GlobalVMShutdownScheduleNotificationSettings

See the input and output API doc for this type.

Enabled bool: Whether to enable pre-shutdown notifications. Possible values are true and false. Defaults to false
TimeInMinutes int: Time in minutes between 15 and 120 before a shutdown event at which a notification will be sent. Defaults to 30.
WebhookUrl string: The webhook URL to which the notification will be sent. Required if enabled is true. Optional otherwise.

Enabled bool: Whether to enable pre-shutdown notifications. Possible values are true and false. Defaults to false
TimeInMinutes int: Time in minutes between 15 and 120 before a shutdown event at which a notification will be sent. Defaults to 30.
WebhookUrl string: The webhook URL to which the notification will be sent. Required if enabled is true. Optional otherwise.

enabled boolean: Whether to enable pre-shutdown notifications. Possible values are true and false. Defaults to false
timeInMinutes number: Time in minutes between 15 and 120 before a shutdown event at which a notification will be sent. Defaults to 30.
webhookUrl string: The webhook URL to which the notification will be sent. Required if enabled is true. Optional otherwise.

enabled bool: Whether to enable pre-shutdown notifications. Possible values are true and false. Defaults to false
timeInMinutes float: Time in minutes between 15 and 120 before a shutdown event at which a notification will be sent. Defaults to 30.
webhookUrl str: The webhook URL to which the notification will be sent. Required if enabled is true. Optional otherwise.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud