Azure Native
getMachineExtension
Describes a Machine Extension. API Version: 2020-08-02.
Using getMachineExtension
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 getMachineExtension(args: GetMachineExtensionArgs, opts?: InvokeOptions): Promise<GetMachineExtensionResult>
function getMachineExtensionOutput(args: GetMachineExtensionOutputArgs, opts?: InvokeOptions): Output<GetMachineExtensionResult>
def get_machine_extension(extension_name: Optional[str] = None,
name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetMachineExtensionResult
def get_machine_extension_output(extension_name: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetMachineExtensionResult]
func LookupMachineExtension(ctx *Context, args *LookupMachineExtensionArgs, opts ...InvokeOption) (*LookupMachineExtensionResult, error)
func LookupMachineExtensionOutput(ctx *Context, args *LookupMachineExtensionOutputArgs, opts ...InvokeOption) LookupMachineExtensionResultOutput
> Note: This function is named LookupMachineExtension
in the Go SDK.
public static class GetMachineExtension
{
public static Task<GetMachineExtensionResult> InvokeAsync(GetMachineExtensionArgs args, InvokeOptions? opts = null)
public static Output<GetMachineExtensionResult> Invoke(GetMachineExtensionInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetMachineExtensionResult> getMachineExtension(GetMachineExtensionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: azure-native:hybridcompute:getMachineExtension
Arguments:
# Arguments dictionary
The following arguments are supported:
- Extension
Name string The name of the machine extension.
- Name string
The name of the machine containing the extension.
- Resource
Group stringName The name of the resource group.
- Extension
Name string The name of the machine extension.
- Name string
The name of the machine containing the extension.
- Resource
Group stringName The name of the resource group.
- extension
Name String The name of the machine extension.
- name String
The name of the machine containing the extension.
- resource
Group StringName The name of the resource group.
- extension
Name string The name of the machine extension.
- name string
The name of the machine containing the extension.
- resource
Group stringName The name of the resource group.
- extension_
name str The name of the machine extension.
- name str
The name of the machine containing the extension.
- resource_
group_ strname The name of the resource group.
- extension
Name String The name of the machine extension.
- name String
The name of the machine containing the extension.
- resource
Group StringName The name of the resource group.
getMachineExtension Result
The following output properties are available:
- Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Location string
The geo-location where the resource lives
- Name string
The name of the resource
- Provisioning
State string The provisioning state, which only appears in the response.
- Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Auto
Upgrade boolMinor Version Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- Force
Update stringTag How the extension handler should be forced to update even if the extension configuration has not changed.
- Instance
View Pulumi.Azure Native. Hybrid Compute. Outputs. Machine Extension Properties Response Instance View The machine extension instance view.
- Protected
Settings object The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- Publisher string
The name of the extension handler publisher.
- Settings object
Json formatted public settings for the extension.
- Dictionary<string, string>
Resource tags.
- Type
Handler stringVersion Specifies the version of the script handler.
- Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Location string
The geo-location where the resource lives
- Name string
The name of the resource
- Provisioning
State string The provisioning state, which only appears in the response.
- Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Auto
Upgrade boolMinor Version Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- Force
Update stringTag How the extension handler should be forced to update even if the extension configuration has not changed.
- Instance
View MachineExtension Properties Response Instance View The machine extension instance view.
- Protected
Settings interface{} The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- Publisher string
The name of the extension handler publisher.
- Settings interface{}
Json formatted public settings for the extension.
- map[string]string
Resource tags.
- Type
Handler stringVersion Specifies the version of the script handler.
- id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- location String
The geo-location where the resource lives
- name String
The name of the resource
- provisioning
State String The provisioning state, which only appears in the response.
- type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- auto
Upgrade BooleanMinor Version Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- force
Update StringTag How the extension handler should be forced to update even if the extension configuration has not changed.
- instance
View MachineExtension Properties Response Instance View The machine extension instance view.
- protected
Settings Object The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- publisher String
The name of the extension handler publisher.
- settings Object
Json formatted public settings for the extension.
- Map
Resource tags.
- type
Handler StringVersion Specifies the version of the script handler.
- id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- location string
The geo-location where the resource lives
- name string
The name of the resource
- provisioning
State string The provisioning state, which only appears in the response.
- type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- auto
Upgrade booleanMinor Version Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- force
Update stringTag How the extension handler should be forced to update even if the extension configuration has not changed.
- instance
View MachineExtension Properties Response Instance View The machine extension instance view.
- protected
Settings any The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- publisher string
The name of the extension handler publisher.
- settings any
Json formatted public settings for the extension.
- {[key: string]: string}
Resource tags.
- type
Handler stringVersion Specifies the version of the script handler.
- id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- location str
The geo-location where the resource lives
- name str
The name of the resource
- provisioning_
state str The provisioning state, which only appears in the response.
- type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- auto_
upgrade_ boolminor_ version Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- force_
update_ strtag How the extension handler should be forced to update even if the extension configuration has not changed.
- instance_
view MachineExtension Properties Response Instance View The machine extension instance view.
- protected_
settings Any The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- publisher str
The name of the extension handler publisher.
- settings Any
Json formatted public settings for the extension.
- Mapping[str, str]
Resource tags.
- type_
handler_ strversion Specifies the version of the script handler.
- id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- location String
The geo-location where the resource lives
- name String
The name of the resource
- provisioning
State String The provisioning state, which only appears in the response.
- type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- auto
Upgrade BooleanMinor Version Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- force
Update StringTag How the extension handler should be forced to update even if the extension configuration has not changed.
- instance
View Property Map The machine extension instance view.
- protected
Settings Any The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- publisher String
The name of the extension handler publisher.
- settings Any
Json formatted public settings for the extension.
- Map
Resource tags.
- type
Handler StringVersion Specifies the version of the script handler.
Supporting Types
MachineExtensionInstanceViewResponseStatus
- Code string
The status code.
- Display
Status string The short localizable label for the status.
- Level string
The level code.
- Message string
The detailed status message, including for alerts and error messages.
- Time string
The time of the status.
- Code string
The status code.
- Display
Status string The short localizable label for the status.
- Level string
The level code.
- Message string
The detailed status message, including for alerts and error messages.
- Time string
The time of the status.
- code String
The status code.
- display
Status String The short localizable label for the status.
- level String
The level code.
- message String
The detailed status message, including for alerts and error messages.
- time String
The time of the status.
- code string
The status code.
- display
Status string The short localizable label for the status.
- level string
The level code.
- message string
The detailed status message, including for alerts and error messages.
- time string
The time of the status.
- code str
The status code.
- display_
status str The short localizable label for the status.
- level str
The level code.
- message str
The detailed status message, including for alerts and error messages.
- time str
The time of the status.
- code String
The status code.
- display
Status String The short localizable label for the status.
- level String
The level code.
- message String
The detailed status message, including for alerts and error messages.
- time String
The time of the status.
MachineExtensionPropertiesResponseInstanceView
- Name string
The machine extension name.
- Type string
Specifies the type of the extension; an example is "CustomScriptExtension".
- Type
Handler stringVersion Specifies the version of the script handler.
- Status
Pulumi.
Azure Native. Hybrid Compute. Inputs. Machine Extension Instance View Response Status Instance view status.
- Name string
The machine extension name.
- Type string
Specifies the type of the extension; an example is "CustomScriptExtension".
- Type
Handler stringVersion Specifies the version of the script handler.
- Status
Machine
Extension Instance View Response Status Instance view status.
- name String
The machine extension name.
- type String
Specifies the type of the extension; an example is "CustomScriptExtension".
- type
Handler StringVersion Specifies the version of the script handler.
- status
Machine
Extension Instance View Response Status Instance view status.
- name string
The machine extension name.
- type string
Specifies the type of the extension; an example is "CustomScriptExtension".
- type
Handler stringVersion Specifies the version of the script handler.
- status
Machine
Extension Instance View Response Status Instance view status.
- name str
The machine extension name.
- type str
Specifies the type of the extension; an example is "CustomScriptExtension".
- type_
handler_ strversion Specifies the version of the script handler.
- status
Machine
Extension Instance View Response Status Instance view status.
- name String
The machine extension name.
- type String
Specifies the type of the extension; an example is "CustomScriptExtension".
- type
Handler StringVersion Specifies the version of the script handler.
- status Property Map
Instance view status.
Package Details
- Repository
- https://github.com/pulumi/pulumi-azure-native
- License
- Apache-2.0