Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. devcenter
  5. getSchedule
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.devcenter.getSchedule

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

Gets a schedule resource. Azure REST API version: 2023-04-01.

Other available API versions: 2023-08-01-preview, 2023-10-01-preview, 2024-02-01, 2024-05-01-preview, 2024-06-01-preview, 2024-07-01-preview, 2024-08-01-preview, 2024-10-01-preview.

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(pool_name: Optional[str] = None,
                 project_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 schedule_name: Optional[str] = None,
                 top: Optional[int] = None,
                 opts: Optional[InvokeOptions] = None) -> GetScheduleResult
def get_schedule_output(pool_name: Optional[pulumi.Input[str]] = None,
                 project_name: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 schedule_name: Optional[pulumi.Input[str]] = None,
                 top: Optional[pulumi.Input[int]] = 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:devcenter:getSchedule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PoolName
This property is required.
Changes to this property will trigger replacement.
string
Name of the pool.
ProjectName
This property is required.
Changes to this property will trigger replacement.
string
The name of the project.
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.
Top int
The maximum number of resources to return from the operation. Example: '$top=10'.
PoolName
This property is required.
Changes to this property will trigger replacement.
string
Name of the pool.
ProjectName
This property is required.
Changes to this property will trigger replacement.
string
The name of the project.
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.
Top int
The maximum number of resources to return from the operation. Example: '$top=10'.
poolName
This property is required.
Changes to this property will trigger replacement.
String
Name of the pool.
projectName
This property is required.
Changes to this property will trigger replacement.
String
The name of the project.
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.
top Integer
The maximum number of resources to return from the operation. Example: '$top=10'.
poolName
This property is required.
Changes to this property will trigger replacement.
string
Name of the pool.
projectName
This property is required.
Changes to this property will trigger replacement.
string
The name of the project.
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.
top number
The maximum number of resources to return from the operation. Example: '$top=10'.
pool_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the pool.
project_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the project.
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.
top int
The maximum number of resources to return from the operation. Example: '$top=10'.
poolName
This property is required.
Changes to this property will trigger replacement.
String
Name of the pool.
projectName
This property is required.
Changes to this property will trigger replacement.
String
The name of the project.
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.
top Number
The maximum number of resources to return from the operation. Example: '$top=10'.

getSchedule Result

The following output properties are available:

Frequency string
The frequency of this scheduled task.
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
The provisioning state of the resource.
SystemData Pulumi.AzureNative.DevCenter.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Time string
The target time to trigger the action. The format is HH:MM.
TimeZone string
The IANA timezone id at which the schedule should execute.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
State string
Indicates whether or not this scheduled task is enabled.
Frequency string
The frequency of this scheduled task.
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
The provisioning state of the resource.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Time string
The target time to trigger the action. The format is HH:MM.
TimeZone string
The IANA timezone id at which the schedule should execute.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
State string
Indicates whether or not this scheduled task is enabled.
frequency String
The frequency of this scheduled task.
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
The provisioning state of the resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
time String
The target time to trigger the action. The format is HH:MM.
timeZone String
The IANA timezone id at which the schedule should execute.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
state String
Indicates whether or not this scheduled task is enabled.
frequency string
The frequency of this scheduled task.
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
The provisioning state of the resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
time string
The target time to trigger the action. The format is HH:MM.
timeZone string
The IANA timezone id at which the schedule should execute.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
state string
Indicates whether or not this scheduled task is enabled.
frequency str
The frequency of this scheduled task.
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
The provisioning state of the resource.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
time str
The target time to trigger the action. The format is HH:MM.
time_zone str
The IANA timezone id at which the schedule should execute.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
state str
Indicates whether or not this scheduled task is enabled.
frequency String
The frequency of this scheduled task.
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
The provisioning state of the resource.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
time String
The target time to trigger the action. The format is HH:MM.
timeZone String
The IANA timezone id at which the schedule should execute.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
state String
Indicates whether or not this scheduled task is enabled.

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-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