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

azure-native.containerservice.getManagedClusterSnapshot

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

A managed cluster snapshot resource.

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

Other available API versions: 2022-02-02-preview, 2022-03-02-preview, 2022-04-02-preview, 2022-05-02-preview, 2022-06-02-preview, 2022-07-02-preview, 2022-08-02-preview, 2022-08-03-preview, 2022-09-02-preview, 2022-10-02-preview, 2022-11-02-preview, 2023-01-02-preview, 2023-02-02-preview, 2023-03-02-preview, 2023-04-02-preview, 2023-05-02-preview, 2023-06-02-preview, 2023-07-02-preview, 2023-08-02-preview, 2023-09-02-preview, 2023-10-02-preview, 2023-11-02-preview, 2024-01-02-preview, 2024-02-02-preview, 2024-03-02-preview, 2024-04-02-preview, 2024-05-02-preview, 2024-06-02-preview, 2024-07-02-preview, 2024-09-02-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native containerservice [ApiVersion]. See the version guide for details.

Using getManagedClusterSnapshot

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 getManagedClusterSnapshot(args: GetManagedClusterSnapshotArgs, opts?: InvokeOptions): Promise<GetManagedClusterSnapshotResult>
function getManagedClusterSnapshotOutput(args: GetManagedClusterSnapshotOutputArgs, opts?: InvokeOptions): Output<GetManagedClusterSnapshotResult>
Copy
def get_managed_cluster_snapshot(resource_group_name: Optional[str] = None,
                                 resource_name: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetManagedClusterSnapshotResult
def get_managed_cluster_snapshot_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                 resource_name: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetManagedClusterSnapshotResult]
Copy
func LookupManagedClusterSnapshot(ctx *Context, args *LookupManagedClusterSnapshotArgs, opts ...InvokeOption) (*LookupManagedClusterSnapshotResult, error)
func LookupManagedClusterSnapshotOutput(ctx *Context, args *LookupManagedClusterSnapshotOutputArgs, opts ...InvokeOption) LookupManagedClusterSnapshotResultOutput
Copy

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

public static class GetManagedClusterSnapshot 
{
    public static Task<GetManagedClusterSnapshotResult> InvokeAsync(GetManagedClusterSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetManagedClusterSnapshotResult> Invoke(GetManagedClusterSnapshotInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetManagedClusterSnapshotResult> getManagedClusterSnapshot(GetManagedClusterSnapshotArgs args, InvokeOptions options)
public static Output<GetManagedClusterSnapshotResult> getManagedClusterSnapshot(GetManagedClusterSnapshotArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:containerservice:getManagedClusterSnapshot
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the managed cluster 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.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the managed cluster 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.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the managed cluster 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.
resourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the managed cluster 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.
resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the managed cluster 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.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the managed cluster resource.

getManagedClusterSnapshot 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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
ManagedClusterPropertiesReadOnly Pulumi.AzureNative.ContainerService.Outputs.ManagedClusterPropertiesForSnapshotResponse
What the properties will be showed when getting managed cluster snapshot. Those properties are read-only.
Name string
The name of the 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"
CreationData Pulumi.AzureNative.ContainerService.Outputs.CreationDataResponse
CreationData to be used to specify the source resource ID to create this snapshot.
SnapshotType string
The type of a snapshot. The default is NodePool.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
ManagedClusterPropertiesReadOnly ManagedClusterPropertiesForSnapshotResponse
What the properties will be showed when getting managed cluster snapshot. Those properties are read-only.
Name string
The name of the 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"
CreationData CreationDataResponse
CreationData to be used to specify the source resource ID to create this snapshot.
SnapshotType string
The type of a snapshot. The default is NodePool.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
managedClusterPropertiesReadOnly ManagedClusterPropertiesForSnapshotResponse
What the properties will be showed when getting managed cluster snapshot. Those properties are read-only.
name String
The name of the 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"
creationData CreationDataResponse
CreationData to be used to specify the source resource ID to create this snapshot.
snapshotType String
The type of a snapshot. The default is NodePool.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location string
The geo-location where the resource lives
managedClusterPropertiesReadOnly ManagedClusterPropertiesForSnapshotResponse
What the properties will be showed when getting managed cluster snapshot. Those properties are read-only.
name string
The name of the 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"
creationData CreationDataResponse
CreationData to be used to specify the source resource ID to create this snapshot.
snapshotType string
The type of a snapshot. The default is NodePool.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location str
The geo-location where the resource lives
managed_cluster_properties_read_only ManagedClusterPropertiesForSnapshotResponse
What the properties will be showed when getting managed cluster snapshot. Those properties are read-only.
name str
The name of the 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"
creation_data CreationDataResponse
CreationData to be used to specify the source resource ID to create this snapshot.
snapshot_type str
The type of a snapshot. The default is NodePool.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
managedClusterPropertiesReadOnly Property Map
What the properties will be showed when getting managed cluster snapshot. Those properties are read-only.
name String
The name of the 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"
creationData Property Map
CreationData to be used to specify the source resource ID to create this snapshot.
snapshotType String
The type of a snapshot. The default is NodePool.
tags Map<String>
Resource tags.

Supporting Types

CreationDataResponse

SourceResourceId string
This is the ARM ID of the source object to be used to create the target object.
SourceResourceId string
This is the ARM ID of the source object to be used to create the target object.
sourceResourceId String
This is the ARM ID of the source object to be used to create the target object.
sourceResourceId string
This is the ARM ID of the source object to be used to create the target object.
source_resource_id str
This is the ARM ID of the source object to be used to create the target object.
sourceResourceId String
This is the ARM ID of the source object to be used to create the target object.

ManagedClusterPropertiesForSnapshotResponse

NetworkProfile This property is required. Pulumi.AzureNative.ContainerService.Inputs.NetworkProfileForSnapshotResponse
The current network profile.
EnableRbac bool
Whether the cluster has enabled Kubernetes Role-Based Access Control or not.
KubernetesVersion string
The current kubernetes version.
Sku Pulumi.AzureNative.ContainerService.Inputs.ManagedClusterSKUResponse
The current managed cluster sku.
NetworkProfile This property is required. NetworkProfileForSnapshotResponse
The current network profile.
EnableRbac bool
Whether the cluster has enabled Kubernetes Role-Based Access Control or not.
KubernetesVersion string
The current kubernetes version.
Sku ManagedClusterSKUResponse
The current managed cluster sku.
networkProfile This property is required. NetworkProfileForSnapshotResponse
The current network profile.
enableRbac Boolean
Whether the cluster has enabled Kubernetes Role-Based Access Control or not.
kubernetesVersion String
The current kubernetes version.
sku ManagedClusterSKUResponse
The current managed cluster sku.
networkProfile This property is required. NetworkProfileForSnapshotResponse
The current network profile.
enableRbac boolean
Whether the cluster has enabled Kubernetes Role-Based Access Control or not.
kubernetesVersion string
The current kubernetes version.
sku ManagedClusterSKUResponse
The current managed cluster sku.
network_profile This property is required. NetworkProfileForSnapshotResponse
The current network profile.
enable_rbac bool
Whether the cluster has enabled Kubernetes Role-Based Access Control or not.
kubernetes_version str
The current kubernetes version.
sku ManagedClusterSKUResponse
The current managed cluster sku.
networkProfile This property is required. Property Map
The current network profile.
enableRbac Boolean
Whether the cluster has enabled Kubernetes Role-Based Access Control or not.
kubernetesVersion String
The current kubernetes version.
sku Property Map
The current managed cluster sku.

ManagedClusterSKUResponse

Name string
The name of a managed cluster SKU.
Tier string
If not specified, the default is 'Free'. See AKS Pricing Tier for more details.
Name string
The name of a managed cluster SKU.
Tier string
If not specified, the default is 'Free'. See AKS Pricing Tier for more details.
name String
The name of a managed cluster SKU.
tier String
If not specified, the default is 'Free'. See AKS Pricing Tier for more details.
name string
The name of a managed cluster SKU.
tier string
If not specified, the default is 'Free'. See AKS Pricing Tier for more details.
name str
The name of a managed cluster SKU.
tier str
If not specified, the default is 'Free'. See AKS Pricing Tier for more details.
name String
The name of a managed cluster SKU.
tier String
If not specified, the default is 'Free'. See AKS Pricing Tier for more details.

NetworkProfileForSnapshotResponse

LoadBalancerSku string
loadBalancerSku for managed cluster snapshot.
NetworkMode string
networkMode for managed cluster snapshot.
NetworkPlugin string
networkPlugin for managed cluster snapshot.
NetworkPluginMode string
NetworkPluginMode for managed cluster snapshot.
NetworkPolicy string
networkPolicy for managed cluster snapshot.
LoadBalancerSku string
loadBalancerSku for managed cluster snapshot.
NetworkMode string
networkMode for managed cluster snapshot.
NetworkPlugin string
networkPlugin for managed cluster snapshot.
NetworkPluginMode string
NetworkPluginMode for managed cluster snapshot.
NetworkPolicy string
networkPolicy for managed cluster snapshot.
loadBalancerSku String
loadBalancerSku for managed cluster snapshot.
networkMode String
networkMode for managed cluster snapshot.
networkPlugin String
networkPlugin for managed cluster snapshot.
networkPluginMode String
NetworkPluginMode for managed cluster snapshot.
networkPolicy String
networkPolicy for managed cluster snapshot.
loadBalancerSku string
loadBalancerSku for managed cluster snapshot.
networkMode string
networkMode for managed cluster snapshot.
networkPlugin string
networkPlugin for managed cluster snapshot.
networkPluginMode string
NetworkPluginMode for managed cluster snapshot.
networkPolicy string
networkPolicy for managed cluster snapshot.
load_balancer_sku str
loadBalancerSku for managed cluster snapshot.
network_mode str
networkMode for managed cluster snapshot.
network_plugin str
networkPlugin for managed cluster snapshot.
network_plugin_mode str
NetworkPluginMode for managed cluster snapshot.
network_policy str
networkPolicy for managed cluster snapshot.
loadBalancerSku String
loadBalancerSku for managed cluster snapshot.
networkMode String
networkMode for managed cluster snapshot.
networkPlugin String
networkPlugin for managed cluster snapshot.
networkPluginMode String
NetworkPluginMode for managed cluster snapshot.
networkPolicy String
networkPolicy for managed cluster snapshot.

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