azure-native.containerservice.getSnapshot
Explore with Pulumi AI
A node pool snapshot resource. Azure REST API version: 2023-04-01.
Other available API versions: 2023-05-02-preview, 2023-06-01, 2023-06-02-preview, 2023-07-01, 2023-07-02-preview, 2023-08-01, 2023-08-02-preview, 2023-09-01, 2023-09-02-preview, 2023-10-01, 2023-10-02-preview.
Using getSnapshot
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 getSnapshot(args: GetSnapshotArgs, opts?: InvokeOptions): Promise<GetSnapshotResult>
function getSnapshotOutput(args: GetSnapshotOutputArgs, opts?: InvokeOptions): Output<GetSnapshotResult>
def get_snapshot(resource_group_name: Optional[str] = None,
resource_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetSnapshotResult
def get_snapshot_output(resource_group_name: Optional[pulumi.Input[str]] = None,
resource_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetSnapshotResult]
func LookupSnapshot(ctx *Context, args *LookupSnapshotArgs, opts ...InvokeOption) (*LookupSnapshotResult, error)
func LookupSnapshotOutput(ctx *Context, args *LookupSnapshotOutputArgs, opts ...InvokeOption) LookupSnapshotResultOutput
> Note: This function is named LookupSnapshot
in the Go SDK.
public static class GetSnapshot
{
public static Task<GetSnapshotResult> InvokeAsync(GetSnapshotArgs args, InvokeOptions? opts = null)
public static Output<GetSnapshotResult> Invoke(GetSnapshotInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:containerservice:getSnapshot
arguments:
# arguments dictionary
The following arguments are supported:
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Resource
Name string The name of the managed cluster resource.
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Resource
Name string The name of the managed cluster resource.
- resource
Group StringName The name of the resource group. The name is case insensitive.
- resource
Name String The name of the managed cluster resource.
- resource
Group stringName The name of the resource group. The name is case insensitive.
- resource
Name string The name of the managed cluster resource.
- resource_
group_ strname The name of the resource group. The name is case insensitive.
- resource_
name str The name of the managed cluster resource.
- resource
Group StringName The name of the resource group. The name is case insensitive.
- resource
Name String The name of the managed cluster resource.
getSnapshot Result
The following output properties are available:
- Enable
FIPS bool Whether to use a FIPS-enabled OS.
- Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Kubernetes
Version string The version of Kubernetes.
- Location string
The geo-location where the resource lives
- Name string
The name of the resource
- Node
Image stringVersion The version of node image.
- Os
Sku string Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.
- Os
Type string The operating system type. The default is Linux.
- System
Data Pulumi.Azure Native. Container Service. Outputs. System Data Response 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"
- Vm
Size string The size of the VM.
- Creation
Data Pulumi.Azure Native. Container Service. Outputs. Creation Data Response CreationData to be used to specify the source agent pool resource ID to create this snapshot.
- Snapshot
Type string The type of a snapshot. The default is NodePool.
- Dictionary<string, string>
Resource tags.
- Enable
FIPS bool Whether to use a FIPS-enabled OS.
- Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Kubernetes
Version string The version of Kubernetes.
- Location string
The geo-location where the resource lives
- Name string
The name of the resource
- Node
Image stringVersion The version of node image.
- Os
Sku string Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.
- Os
Type string The operating system type. The default is Linux.
- System
Data SystemData Response 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"
- Vm
Size string The size of the VM.
- Creation
Data CreationData Response CreationData to be used to specify the source agent pool resource ID to create this snapshot.
- Snapshot
Type string The type of a snapshot. The default is NodePool.
- map[string]string
Resource tags.
- enable
FIPS Boolean Whether to use a FIPS-enabled OS.
- id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- kubernetes
Version String The version of Kubernetes.
- location String
The geo-location where the resource lives
- name String
The name of the resource
- node
Image StringVersion The version of node image.
- os
Sku String Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.
- os
Type String The operating system type. The default is Linux.
- system
Data SystemData Response 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"
- vm
Size String The size of the VM.
- creation
Data CreationData Response CreationData to be used to specify the source agent pool resource ID to create this snapshot.
- snapshot
Type String The type of a snapshot. The default is NodePool.
- Map<String,String>
Resource tags.
- enable
FIPS boolean Whether to use a FIPS-enabled OS.
- id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- kubernetes
Version string The version of Kubernetes.
- location string
The geo-location where the resource lives
- name string
The name of the resource
- node
Image stringVersion The version of node image.
- os
Sku string Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.
- os
Type string The operating system type. The default is Linux.
- system
Data SystemData Response 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"
- vm
Size string The size of the VM.
- creation
Data CreationData Response CreationData to be used to specify the source agent pool resource ID to create this snapshot.
- snapshot
Type string The type of a snapshot. The default is NodePool.
- {[key: string]: string}
Resource tags.
- enable_
fips bool Whether to use a FIPS-enabled OS.
- id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- kubernetes_
version str The version of Kubernetes.
- location str
The geo-location where the resource lives
- name str
The name of the resource
- node_
image_ strversion The version of node image.
- os_
sku str Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.
- os_
type str The operating system type. The default is Linux.
- system_
data SystemData Response 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"
- vm_
size str The size of the VM.
- creation_
data CreationData Response CreationData to be used to specify the source agent pool resource ID to create this snapshot.
- snapshot_
type str The type of a snapshot. The default is NodePool.
- Mapping[str, str]
Resource tags.
- enable
FIPS Boolean Whether to use a FIPS-enabled OS.
- id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- kubernetes
Version String The version of Kubernetes.
- location String
The geo-location where the resource lives
- name String
The name of the resource
- node
Image StringVersion The version of node image.
- os
Sku String Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.
- os
Type String The operating system type. The default is Linux.
- system
Data 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"
- vm
Size String The size of the VM.
- creation
Data Property Map CreationData to be used to specify the source agent pool resource ID to create this snapshot.
- snapshot
Type String The type of a snapshot. The default is NodePool.
- Map<String>
Resource tags.
Supporting Types
CreationDataResponse
- Source
Resource stringId This is the ARM ID of the source object to be used to create the target object.
- Source
Resource stringId This is the ARM ID of the source object to be used to create the target object.
- source
Resource StringId This is the ARM ID of the source object to be used to create the target object.
- source
Resource stringId This is the ARM ID of the source object to be used to create the target object.
- source_
resource_ strid This is the ARM ID of the source object to be used to create the target object.
- source
Resource StringId This is the ARM ID of the source object to be used to create the target object.
SystemDataResponse
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
- created
At string The timestamp of resource creation (UTC).
- created
By string The identity that created the resource.
- created
By stringType The type of identity that created the resource.
- last
Modified stringAt The timestamp of resource last modification (UTC)
- last
Modified stringBy The identity that last modified the resource.
- last
Modified stringBy Type 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_ strtype The type of identity that created the resource.
- last_
modified_ strat The timestamp of resource last modification (UTC)
- last_
modified_ strby The identity that last modified the resource.
- last_
modified_ strby_ type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0