EdgeMachinesOperations interface

Package:

@azure/arm-azurestackhci

Interface representing a EdgeMachines operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginRefreshApplicableUpdates
beginRefreshApplicableUpdatesAndWait
beginRefreshSecuritySettings
beginRefreshSecuritySettingsAndWait
beginUpdate
beginUpdateAndWait
beginValidate
beginValidateAndWait
createOrUpdate	Create or update an edge machine.
delete	Delete an edge machine.
get	Get an edge machine.
listByResourceGroup	List all edge machines in a resource group.
listBySubscription	List all edge machines in a subscription.
refreshApplicableUpdates	Trigger an on-demand refresh of applicable updates for the edge machine. Creates or updates the default EdgeMachineUpdate child resource with the latest set of applicable updates.
refreshSecuritySettings	Trigger an on-demand sync of edge machine security settings from Guest Configuration. Creates the default security settings child resource if it does not already exist.
update	Update an edge machine.
validate	A long-running resource action to validate the edge machine.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, edgeMachineName: string, resource: EdgeMachine, options?: EdgeMachinesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<EdgeMachine>, EdgeMachine>>

Property Value

(resourceGroupName: string, edgeMachineName: string, resource: EdgeMachine, options?: EdgeMachinesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<EdgeMachine>, EdgeMachine>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, edgeMachineName: string, resource: EdgeMachine, options?: EdgeMachinesCreateOrUpdateOptionalParams) => Promise<EdgeMachine>

Property Value

(resourceGroupName: string, edgeMachineName: string, resource: EdgeMachine, options?: EdgeMachinesCreateOrUpdateOptionalParams) => Promise<EdgeMachine>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesDeleteOptionalParams) => Promise<void>

beginRefreshApplicableUpdates

Warning

This API is now deprecated.

use refreshApplicableUpdates instead

beginRefreshApplicableUpdates: (resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesRefreshApplicableUpdatesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesRefreshApplicableUpdatesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginRefreshApplicableUpdatesAndWait

Warning

This API is now deprecated.

use refreshApplicableUpdates instead

beginRefreshApplicableUpdatesAndWait: (resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesRefreshApplicableUpdatesOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesRefreshApplicableUpdatesOptionalParams) => Promise<void>

beginRefreshSecuritySettings

Warning

This API is now deprecated.

use refreshSecuritySettings instead

beginRefreshSecuritySettings: (resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesRefreshSecuritySettingsOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesRefreshSecuritySettingsOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginRefreshSecuritySettingsAndWait

Warning

This API is now deprecated.

use refreshSecuritySettings instead

beginRefreshSecuritySettingsAndWait: (resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesRefreshSecuritySettingsOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesRefreshSecuritySettingsOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, edgeMachineName: string, properties: EdgeMachinePatch, options?: EdgeMachinesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<EdgeMachine>, EdgeMachine>>

Property Value

(resourceGroupName: string, edgeMachineName: string, properties: EdgeMachinePatch, options?: EdgeMachinesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<EdgeMachine>, EdgeMachine>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, edgeMachineName: string, properties: EdgeMachinePatch, options?: EdgeMachinesUpdateOptionalParams) => Promise<EdgeMachine>

Property Value

(resourceGroupName: string, edgeMachineName: string, properties: EdgeMachinePatch, options?: EdgeMachinesUpdateOptionalParams) => Promise<EdgeMachine>

beginValidate

Warning

This API is now deprecated.

use validate instead

beginValidate: (resourceGroupName: string, edgeMachineName: string, body: EdgeMachineValidateRequest, options?: EdgeMachinesValidateOptionalParams) => Promise<SimplePollerLike<OperationState<EdgeMachineValidateResponse>, EdgeMachineValidateResponse>>

Property Value

(resourceGroupName: string, edgeMachineName: string, body: EdgeMachineValidateRequest, options?: EdgeMachinesValidateOptionalParams) => Promise<SimplePollerLike<OperationState<EdgeMachineValidateResponse>, EdgeMachineValidateResponse>>

beginValidateAndWait

Warning

This API is now deprecated.

use validate instead

beginValidateAndWait: (resourceGroupName: string, edgeMachineName: string, body: EdgeMachineValidateRequest, options?: EdgeMachinesValidateOptionalParams) => Promise<EdgeMachineValidateResponse>

Property Value

(resourceGroupName: string, edgeMachineName: string, body: EdgeMachineValidateRequest, options?: EdgeMachinesValidateOptionalParams) => Promise<EdgeMachineValidateResponse>

createOrUpdate

Create or update an edge machine.

createOrUpdate: (resourceGroupName: string, edgeMachineName: string, resource: EdgeMachine, options?: EdgeMachinesCreateOrUpdateOptionalParams) => PollerLike<OperationState<EdgeMachine>, EdgeMachine>

Property Value

(resourceGroupName: string, edgeMachineName: string, resource: EdgeMachine, options?: EdgeMachinesCreateOrUpdateOptionalParams) => PollerLike<OperationState<EdgeMachine>, EdgeMachine>

delete

Delete an edge machine.

delete: (resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get an edge machine.

get: (resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesGetOptionalParams) => Promise<EdgeMachine>

Property Value

(resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesGetOptionalParams) => Promise<EdgeMachine>

listByResourceGroup

List all edge machines in a resource group.

listByResourceGroup: (resourceGroupName: string, options?: EdgeMachinesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<EdgeMachine, EdgeMachine[], PageSettings>

Property Value

(resourceGroupName: string, options?: EdgeMachinesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<EdgeMachine, EdgeMachine[], PageSettings>

listBySubscription

List all edge machines in a subscription.

listBySubscription: (options?: EdgeMachinesListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<EdgeMachine, EdgeMachine[], PageSettings>

Property Value

(options?: EdgeMachinesListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<EdgeMachine, EdgeMachine[], PageSettings>

refreshApplicableUpdates

Trigger an on-demand refresh of applicable updates for the edge machine. Creates or updates the default EdgeMachineUpdate child resource with the latest set of applicable updates.

refreshApplicableUpdates: (resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesRefreshApplicableUpdatesOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesRefreshApplicableUpdatesOptionalParams) => PollerLike<OperationState<void>, void>

refreshSecuritySettings

Trigger an on-demand sync of edge machine security settings from Guest Configuration. Creates the default security settings child resource if it does not already exist.

refreshSecuritySettings: (resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesRefreshSecuritySettingsOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, edgeMachineName: string, options?: EdgeMachinesRefreshSecuritySettingsOptionalParams) => PollerLike<OperationState<void>, void>

update

Update an edge machine.

update: (resourceGroupName: string, edgeMachineName: string, properties: EdgeMachinePatch, options?: EdgeMachinesUpdateOptionalParams) => PollerLike<OperationState<EdgeMachine>, EdgeMachine>

Property Value

(resourceGroupName: string, edgeMachineName: string, properties: EdgeMachinePatch, options?: EdgeMachinesUpdateOptionalParams) => PollerLike<OperationState<EdgeMachine>, EdgeMachine>

validate

A long-running resource action to validate the edge machine.

validate: (resourceGroupName: string, edgeMachineName: string, body: EdgeMachineValidateRequest, options?: EdgeMachinesValidateOptionalParams) => PollerLike<OperationState<EdgeMachineValidateResponse>, EdgeMachineValidateResponse>

Property Value

(resourceGroupName: string, edgeMachineName: string, body: EdgeMachineValidateRequest, options?: EdgeMachinesValidateOptionalParams) => PollerLike<OperationState<EdgeMachineValidateResponse>, EdgeMachineValidateResponse>