Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. labservices
  5. getSchedule
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.labservices.getSchedule

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Returns the properties of a lab Schedule.

Uses Azure REST API version 2023-06-07.

Other available API versions: 2021-10-01-preview, 2021-11-15-preview, 2022-08-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native labservices [ApiVersion]. See the version guide for details.

Using getSchedule

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 getSchedule(args: GetScheduleArgs, opts?: InvokeOptions): Promise<GetScheduleResult>
function getScheduleOutput(args: GetScheduleOutputArgs, opts?: InvokeOptions): Output<GetScheduleResult>
Copy
def get_schedule(lab_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 schedule_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetScheduleResult
def get_schedule_output(lab_name: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 schedule_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetScheduleResult]
Copy
func LookupSchedule(ctx *Context, args *LookupScheduleArgs, opts ...InvokeOption) (*LookupScheduleResult, error)
func LookupScheduleOutput(ctx *Context, args *LookupScheduleOutputArgs, opts ...InvokeOption) LookupScheduleResultOutput
Copy

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

public static class GetSchedule 
{
    public static Task<GetScheduleResult> InvokeAsync(GetScheduleArgs args, InvokeOptions? opts = null)
    public static Output<GetScheduleResult> Invoke(GetScheduleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetScheduleResult> getSchedule(GetScheduleArgs args, InvokeOptions options)
public static Output<GetScheduleResult> getSchedule(GetScheduleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:labservices:getSchedule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

LabName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ScheduleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.
LabName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ScheduleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.
labName
This property is required.
Changes to this property will trigger replacement.
String
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
scheduleName
This property is required.
Changes to this property will trigger replacement.
String
The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.
labName
This property is required.
Changes to this property will trigger replacement.
string
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
scheduleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.
lab_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
schedule_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.
labName
This property is required.
Changes to this property will trigger replacement.
String
The name of the lab that uniquely identifies it within containing lab plan. Used in resource URIs.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
scheduleName
This property is required.
Changes to this property will trigger replacement.
String
The name of the schedule that uniquely identifies it within containing lab. Used in resource URIs.

getSchedule Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
ProvisioningState string
Current provisioning state of the schedule.
ResourceOperationError Pulumi.AzureNative.LabServices.Outputs.ResourceOperationErrorResponse
Error details of last operation done on schedule.
StopAt string
When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead.
SystemData Pulumi.AzureNative.LabServices.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the schedule.
TimeZoneId string
The IANA timezone id for the schedule.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Notes string
Notes for this schedule.
RecurrencePattern Pulumi.AzureNative.LabServices.Outputs.RecurrencePatternResponse
The recurrence pattern of the scheduled actions.
StartAt string
When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
ProvisioningState string
Current provisioning state of the schedule.
ResourceOperationError ResourceOperationErrorResponse
Error details of last operation done on schedule.
StopAt string
When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the schedule.
TimeZoneId string
The IANA timezone id for the schedule.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Notes string
Notes for this schedule.
RecurrencePattern RecurrencePatternResponse
The recurrence pattern of the scheduled actions.
StartAt string
When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
provisioningState String
Current provisioning state of the schedule.
resourceOperationError ResourceOperationErrorResponse
Error details of last operation done on schedule.
stopAt String
When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the schedule.
timeZoneId String
The IANA timezone id for the schedule.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
notes String
Notes for this schedule.
recurrencePattern RecurrencePatternResponse
The recurrence pattern of the scheduled actions.
startAt String
When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
provisioningState string
Current provisioning state of the schedule.
resourceOperationError ResourceOperationErrorResponse
Error details of last operation done on schedule.
stopAt string
When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the schedule.
timeZoneId string
The IANA timezone id for the schedule.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
notes string
Notes for this schedule.
recurrencePattern RecurrencePatternResponse
The recurrence pattern of the scheduled actions.
startAt string
When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
provisioning_state str
Current provisioning state of the schedule.
resource_operation_error ResourceOperationErrorResponse
Error details of last operation done on schedule.
stop_at str
When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the schedule.
time_zone_id str
The IANA timezone id for the schedule.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
notes str
Notes for this schedule.
recurrence_pattern RecurrencePatternResponse
The recurrence pattern of the scheduled actions.
start_at str
When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
provisioningState String
Current provisioning state of the schedule.
resourceOperationError Property Map
Error details of last operation done on schedule.
stopAt String
When lab user virtual machines will be stopped. Timestamp offsets will be ignored and timeZoneId is used instead.
systemData Property Map
Metadata pertaining to creation and last modification of the schedule.
timeZoneId String
The IANA timezone id for the schedule.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
notes String
Notes for this schedule.
recurrencePattern Property Map
The recurrence pattern of the scheduled actions.
startAt String
When lab user virtual machines will be started. Timestamp offsets will be ignored and timeZoneId is used instead.

Supporting Types

RecurrencePatternResponse

ExpirationDate This property is required. string
When the recurrence will expire. This date is inclusive.
Frequency This property is required. string
The frequency of the recurrence.
Interval int
The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used.
WeekDays List<string>
The week days the schedule runs. Used for when the Frequency is set to Weekly.
ExpirationDate This property is required. string
When the recurrence will expire. This date is inclusive.
Frequency This property is required. string
The frequency of the recurrence.
Interval int
The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used.
WeekDays []string
The week days the schedule runs. Used for when the Frequency is set to Weekly.
expirationDate This property is required. String
When the recurrence will expire. This date is inclusive.
frequency This property is required. String
The frequency of the recurrence.
interval Integer
The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used.
weekDays List<String>
The week days the schedule runs. Used for when the Frequency is set to Weekly.
expirationDate This property is required. string
When the recurrence will expire. This date is inclusive.
frequency This property is required. string
The frequency of the recurrence.
interval number
The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used.
weekDays string[]
The week days the schedule runs. Used for when the Frequency is set to Weekly.
expiration_date This property is required. str
When the recurrence will expire. This date is inclusive.
frequency This property is required. str
The frequency of the recurrence.
interval int
The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used.
week_days Sequence[str]
The week days the schedule runs. Used for when the Frequency is set to Weekly.
expirationDate This property is required. String
When the recurrence will expire. This date is inclusive.
frequency This property is required. String
The frequency of the recurrence.
interval Number
The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used.
weekDays List<String>
The week days the schedule runs. Used for when the Frequency is set to Weekly.

ResourceOperationErrorResponse

Action string
The operation action that failed
Code string
The code that corresponds to the type of operation failure
Message string
The operation failure message
Timestamp string
The datetime of when the error occured
Action string
The operation action that failed
Code string
The code that corresponds to the type of operation failure
Message string
The operation failure message
Timestamp string
The datetime of when the error occured
action String
The operation action that failed
code String
The code that corresponds to the type of operation failure
message String
The operation failure message
timestamp String
The datetime of when the error occured
action string
The operation action that failed
code string
The code that corresponds to the type of operation failure
message string
The operation failure message
timestamp string
The datetime of when the error occured
action str
The operation action that failed
code str
The code that corresponds to the type of operation failure
message str
The operation failure message
timestamp str
The datetime of when the error occured
action String
The operation action that failed
code String
The code that corresponds to the type of operation failure
message String
The operation failure message
timestamp String
The datetime of when the error occured

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native