Appliances interface

Package:

@azure/arm-resourceconnector

Interface representing a Appliances.

Methods

beginCreateOrUpdate(string, string, Appliance, AppliancesCreateOrUpdateOptionalParams)	Creates or updates an Appliance in the specified Subscription and Resource Group.
beginCreateOrUpdateAndWait(string, string, Appliance, AppliancesCreateOrUpdateOptionalParams)	Creates or updates an Appliance in the specified Subscription and Resource Group.
beginDelete(string, string, AppliancesDeleteOptionalParams)	Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id.
beginDeleteAndWait(string, string, AppliancesDeleteOptionalParams)	Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id.
get(string, string, AppliancesGetOptionalParams)	Gets the details of an Appliance with a specified resource group and name.
getTelemetryConfig(AppliancesGetTelemetryConfigOptionalParams)	Gets the telemetry config.
getUpgradeGraph(string, string, string, AppliancesGetUpgradeGraphOptionalParams)	Gets the upgrade graph of an Appliance with a specified resource group and name and specific release train.
listByResourceGroup(string, AppliancesListByResourceGroupOptionalParams)	Gets a list of Appliances in the specified subscription and resource group. The operation returns properties of each Appliance.
listBySubscription(AppliancesListBySubscriptionOptionalParams)	Gets a list of Appliances in the specified subscription. The operation returns properties of each Appliance
listClusterUserCredential(string, string, AppliancesListClusterUserCredentialOptionalParams)	Returns the cluster user credentials for the dedicated appliance.
listKeys(string, string, AppliancesListKeysOptionalParams)	Returns the cluster customer credentials for the dedicated appliance.
listOperations(AppliancesListOperationsOptionalParams)	Lists all available Appliances operations.
update(string, string, AppliancesUpdateOptionalParams)	Updates an Appliance with the specified Resource Name in the specified Resource Group and Subscription.

Method Details

beginCreateOrUpdate(string, string, Appliance, AppliancesCreateOrUpdateOptionalParams)

Creates or updates an Appliance in the specified Subscription and Resource Group.

function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, parameters: Appliance, options?: AppliancesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Appliance>, Appliance>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

Appliances name.

parameters

Appliance

Parameters supplied to create or update an Appliance.

options

AppliancesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Appliance>, Appliance>>

beginCreateOrUpdateAndWait(string, string, Appliance, AppliancesCreateOrUpdateOptionalParams)

Creates or updates an Appliance in the specified Subscription and Resource Group.

function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, parameters: Appliance, options?: AppliancesCreateOrUpdateOptionalParams): Promise<Appliance>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

Appliances name.

parameters

Appliance

Parameters supplied to create or update an Appliance.

options

AppliancesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Appliance>

beginDelete(string, string, AppliancesDeleteOptionalParams)

Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id.

function beginDelete(resourceGroupName: string, resourceName: string, options?: AppliancesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

Appliances name.

options

AppliancesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, AppliancesDeleteOptionalParams)

Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id.

function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: AppliancesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

Appliances name.

options

AppliancesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, AppliancesGetOptionalParams)

Gets the details of an Appliance with a specified resource group and name.

function get(resourceGroupName: string, resourceName: string, options?: AppliancesGetOptionalParams): Promise<Appliance>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

Appliances name.

options

AppliancesGetOptionalParams

The options parameters.

Returns

Promise<Appliance>

getTelemetryConfig(AppliancesGetTelemetryConfigOptionalParams)

Gets the telemetry config.

function getTelemetryConfig(options?: AppliancesGetTelemetryConfigOptionalParams): Promise<ApplianceGetTelemetryConfigResult>

Parameters

options

AppliancesGetTelemetryConfigOptionalParams

The options parameters.

Returns

Promise<ApplianceGetTelemetryConfigResult>

getUpgradeGraph(string, string, string, AppliancesGetUpgradeGraphOptionalParams)

Gets the upgrade graph of an Appliance with a specified resource group and name and specific release train.

function getUpgradeGraph(resourceGroupName: string, resourceName: string, upgradeGraph: string, options?: AppliancesGetUpgradeGraphOptionalParams): Promise<UpgradeGraph>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

Appliances name.

upgradeGraph

string

Upgrade graph version, ex - stable

options

AppliancesGetUpgradeGraphOptionalParams

The options parameters.

Returns

Promise<UpgradeGraph>

listByResourceGroup(string, AppliancesListByResourceGroupOptionalParams)

Gets a list of Appliances in the specified subscription and resource group. The operation returns properties of each Appliance.

function listByResourceGroup(resourceGroupName: string, options?: AppliancesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Appliance, Appliance[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options

AppliancesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Appliance, Appliance[], PageSettings>

listBySubscription(AppliancesListBySubscriptionOptionalParams)

Gets a list of Appliances in the specified subscription. The operation returns properties of each Appliance

function listBySubscription(options?: AppliancesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Appliance, Appliance[], PageSettings>

Parameters

options

AppliancesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Appliance, Appliance[], PageSettings>

listClusterUserCredential(string, string, AppliancesListClusterUserCredentialOptionalParams)

Returns the cluster user credentials for the dedicated appliance.

function listClusterUserCredential(resourceGroupName: string, resourceName: string, options?: AppliancesListClusterUserCredentialOptionalParams): Promise<ApplianceListCredentialResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

Appliances name.

options

AppliancesListClusterUserCredentialOptionalParams

The options parameters.

Returns

Promise<ApplianceListCredentialResults>

listKeys(string, string, AppliancesListKeysOptionalParams)

Returns the cluster customer credentials for the dedicated appliance.

function listKeys(resourceGroupName: string, resourceName: string, options?: AppliancesListKeysOptionalParams): Promise<ApplianceListKeysResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

Appliances name.

options

AppliancesListKeysOptionalParams

The options parameters.

Returns

Promise<ApplianceListKeysResults>

listOperations(AppliancesListOperationsOptionalParams)

Lists all available Appliances operations.

function listOperations(options?: AppliancesListOperationsOptionalParams): PagedAsyncIterableIterator<ApplianceOperation, ApplianceOperation[], PageSettings>

Parameters

options

AppliancesListOperationsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ApplianceOperation, ApplianceOperation[], PageSettings>

update(string, string, AppliancesUpdateOptionalParams)

Updates an Appliance with the specified Resource Name in the specified Resource Group and Subscription.

function update(resourceGroupName: string, resourceName: string, options?: AppliancesUpdateOptionalParams): Promise<Appliance>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

Appliances name.

options

AppliancesUpdateOptionalParams

The options parameters.

Returns

Promise<Appliance>