1. Packages
  2. Azure Native
  3. API Docs
  4. containerservice
  5. getAutoUpgradeProfile
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

azure-native.containerservice.getAutoUpgradeProfile

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

Get a AutoUpgradeProfile

Uses Azure REST API version 2024-05-02-preview.

Using getAutoUpgradeProfile

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 getAutoUpgradeProfile(args: GetAutoUpgradeProfileArgs, opts?: InvokeOptions): Promise<GetAutoUpgradeProfileResult>
function getAutoUpgradeProfileOutput(args: GetAutoUpgradeProfileOutputArgs, opts?: InvokeOptions): Output<GetAutoUpgradeProfileResult>
Copy
def get_auto_upgrade_profile(auto_upgrade_profile_name: Optional[str] = None,
                             fleet_name: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetAutoUpgradeProfileResult
def get_auto_upgrade_profile_output(auto_upgrade_profile_name: Optional[pulumi.Input[str]] = None,
                             fleet_name: Optional[pulumi.Input[str]] = None,
                             resource_group_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetAutoUpgradeProfileResult]
Copy
func LookupAutoUpgradeProfile(ctx *Context, args *LookupAutoUpgradeProfileArgs, opts ...InvokeOption) (*LookupAutoUpgradeProfileResult, error)
func LookupAutoUpgradeProfileOutput(ctx *Context, args *LookupAutoUpgradeProfileOutputArgs, opts ...InvokeOption) LookupAutoUpgradeProfileResultOutput
Copy

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

public static class GetAutoUpgradeProfile 
{
    public static Task<GetAutoUpgradeProfileResult> InvokeAsync(GetAutoUpgradeProfileArgs args, InvokeOptions? opts = null)
    public static Output<GetAutoUpgradeProfileResult> Invoke(GetAutoUpgradeProfileInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAutoUpgradeProfileResult> getAutoUpgradeProfile(GetAutoUpgradeProfileArgs args, InvokeOptions options)
public static Output<GetAutoUpgradeProfileResult> getAutoUpgradeProfile(GetAutoUpgradeProfileArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:containerservice:getAutoUpgradeProfile
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AutoUpgradeProfileName
This property is required.
Changes to this property will trigger replacement.
string
The name of the AutoUpgradeProfile resource.
FleetName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Fleet resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AutoUpgradeProfileName
This property is required.
Changes to this property will trigger replacement.
string
The name of the AutoUpgradeProfile resource.
FleetName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Fleet resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
autoUpgradeProfileName
This property is required.
Changes to this property will trigger replacement.
String
The name of the AutoUpgradeProfile resource.
fleetName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Fleet resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
autoUpgradeProfileName
This property is required.
Changes to this property will trigger replacement.
string
The name of the AutoUpgradeProfile resource.
fleetName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Fleet resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
auto_upgrade_profile_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the AutoUpgradeProfile resource.
fleet_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Fleet resource.
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.
autoUpgradeProfileName
This property is required.
Changes to this property will trigger replacement.
String
The name of the AutoUpgradeProfile resource.
fleetName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Fleet resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getAutoUpgradeProfile Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Channel string
Configures how auto-upgrade will be run.
ETag string
If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
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 AutoUpgradeProfile resource.
SystemData Pulumi.AzureNative.ContainerService.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Disabled bool
If set to False: the auto upgrade has effect - target managed clusters will be upgraded on schedule. If set to True: the auto upgrade has no effect - no upgrade will be run on the target managed clusters. This is a boolean and not an enum because enabled/disabled are all available states of the auto upgrade profile. By default, this is set to False.
NodeImageSelection Pulumi.AzureNative.ContainerService.Outputs.AutoUpgradeNodeImageSelectionResponse
The node image upgrade to be applied to the target clusters in auto upgrade.
UpdateStrategyId string
The resource id of the UpdateStrategy resource to reference. If not specified, the auto upgrade will run on all clusters which are members of the fleet.
AzureApiVersion string
The Azure API version of the resource.
Channel string
Configures how auto-upgrade will be run.
ETag string
If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
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 AutoUpgradeProfile resource.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Disabled bool
If set to False: the auto upgrade has effect - target managed clusters will be upgraded on schedule. If set to True: the auto upgrade has no effect - no upgrade will be run on the target managed clusters. This is a boolean and not an enum because enabled/disabled are all available states of the auto upgrade profile. By default, this is set to False.
NodeImageSelection AutoUpgradeNodeImageSelectionResponse
The node image upgrade to be applied to the target clusters in auto upgrade.
UpdateStrategyId string
The resource id of the UpdateStrategy resource to reference. If not specified, the auto upgrade will run on all clusters which are members of the fleet.
azureApiVersion String
The Azure API version of the resource.
channel String
Configures how auto-upgrade will be run.
eTag String
If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
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 AutoUpgradeProfile resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
disabled Boolean
If set to False: the auto upgrade has effect - target managed clusters will be upgraded on schedule. If set to True: the auto upgrade has no effect - no upgrade will be run on the target managed clusters. This is a boolean and not an enum because enabled/disabled are all available states of the auto upgrade profile. By default, this is set to False.
nodeImageSelection AutoUpgradeNodeImageSelectionResponse
The node image upgrade to be applied to the target clusters in auto upgrade.
updateStrategyId String
The resource id of the UpdateStrategy resource to reference. If not specified, the auto upgrade will run on all clusters which are members of the fleet.
azureApiVersion string
The Azure API version of the resource.
channel string
Configures how auto-upgrade will be run.
eTag string
If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
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 AutoUpgradeProfile resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
disabled boolean
If set to False: the auto upgrade has effect - target managed clusters will be upgraded on schedule. If set to True: the auto upgrade has no effect - no upgrade will be run on the target managed clusters. This is a boolean and not an enum because enabled/disabled are all available states of the auto upgrade profile. By default, this is set to False.
nodeImageSelection AutoUpgradeNodeImageSelectionResponse
The node image upgrade to be applied to the target clusters in auto upgrade.
updateStrategyId string
The resource id of the UpdateStrategy resource to reference. If not specified, the auto upgrade will run on all clusters which are members of the fleet.
azure_api_version str
The Azure API version of the resource.
channel str
Configures how auto-upgrade will be run.
e_tag str
If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
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 AutoUpgradeProfile resource.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
disabled bool
If set to False: the auto upgrade has effect - target managed clusters will be upgraded on schedule. If set to True: the auto upgrade has no effect - no upgrade will be run on the target managed clusters. This is a boolean and not an enum because enabled/disabled are all available states of the auto upgrade profile. By default, this is set to False.
node_image_selection AutoUpgradeNodeImageSelectionResponse
The node image upgrade to be applied to the target clusters in auto upgrade.
update_strategy_id str
The resource id of the UpdateStrategy resource to reference. If not specified, the auto upgrade will run on all clusters which are members of the fleet.
azureApiVersion String
The Azure API version of the resource.
channel String
Configures how auto-upgrade will be run.
eTag String
If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
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 AutoUpgradeProfile resource.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
disabled Boolean
If set to False: the auto upgrade has effect - target managed clusters will be upgraded on schedule. If set to True: the auto upgrade has no effect - no upgrade will be run on the target managed clusters. This is a boolean and not an enum because enabled/disabled are all available states of the auto upgrade profile. By default, this is set to False.
nodeImageSelection Property Map
The node image upgrade to be applied to the target clusters in auto upgrade.
updateStrategyId String
The resource id of the UpdateStrategy resource to reference. If not specified, the auto upgrade will run on all clusters which are members of the fleet.

Supporting Types

AutoUpgradeNodeImageSelectionResponse

Type This property is required. string
The node image upgrade type.
Type This property is required. string
The node image upgrade type.
type This property is required. String
The node image upgrade type.
type This property is required. string
The node image upgrade type.
type This property is required. str
The node image upgrade type.
type This property is required. String
The node image upgrade type.

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