Appliances | @azure/arm-resourceconnector

Interface representing a Appliances.

Hierarchy

Appliances

Implemented by

AppliancesImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, resourceName: string, parameters: Appliance, options?: AppliancesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<AppliancesCreateOrUpdateResponse>, AppliancesCreateOrUpdateResponse>>

- Defined in operationsInterfaces/appliances.ts:78
Creates or updates an Appliance in the specified Subscription and Resource Group.

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.
- Optional options: AppliancesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<AppliancesCreateOrUpdateResponse>, AppliancesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

- Defined in operationsInterfaces/appliances.ts:96
Creates or updates an Appliance in the specified Subscription and Resource Group.

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.
- Optional options: AppliancesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<AppliancesCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, resourceName: string, options?: AppliancesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/appliances.ts:108
Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  Appliances name.
- Optional options: AppliancesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/appliances.ts:119
Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  Appliances name.
- Optional options: AppliancesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/appliances.ts:66
Gets the details of an Appliance with a specified resource group and name.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  Appliances name.
- Optional options: AppliancesGetOptionalParams
  
  The options parameters.
Returns Promise<AppliancesGetResponse>

getUpgradeGraph

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

- Defined in operationsInterfaces/appliances.ts:166
Gets the upgrade graph of an Appliance with a specified resource group and name and specific release train.

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
- Optional options: AppliancesGetUpgradeGraphOptionalParams
  
  The options parameters.
Returns Promise<AppliancesGetUpgradeGraphResponse>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: AppliancesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Appliance>

- Defined in operationsInterfaces/appliances.ts:56
Gets a list of Appliances in the specified subscription and resource group. The operation returns properties of each Appliance.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: AppliancesListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Appliance>

listBySubscription

listBySubscription(options?: AppliancesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Appliance>

- Defined in operationsInterfaces/appliances.ts:47
Gets a list of Appliances in the specified subscription. The operation returns properties of each Appliance

Parameters
- Optional options: AppliancesListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Appliance>

listClusterCustomerUserCredential

listClusterCustomerUserCredential(resourceGroupName: string, resourceName: string, options?: AppliancesListClusterCustomerUserCredentialOptionalParams): Promise<AppliancesListClusterCustomerUserCredentialResponse>

- Defined in operationsInterfaces/appliances.ts:142
Returns the cluster customer user credentials for the dedicated appliance.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  Appliances name.
- Optional options: AppliancesListClusterCustomerUserCredentialOptionalParams
  
  The options parameters.
Returns Promise<AppliancesListClusterCustomerUserCredentialResponse>

listClusterUserCredential

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

- Defined in operationsInterfaces/appliances.ts:153
Returns the cluster user credentials for the dedicated appliance.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  Appliances name.
- Optional options: AppliancesListClusterUserCredentialOptionalParams
  
  The options parameters.
Returns Promise<AppliancesListClusterUserCredentialResponse>

listOperations

listOperations(options?: AppliancesListOperationsOptionalParams): PagedAsyncIterableIterator<ApplianceOperation>

- Defined in operationsInterfaces/appliances.ts:39
Lists all available Appliances operations.

Parameters
- Optional options: AppliancesListOperationsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ApplianceOperation>

update

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

- Defined in operationsInterfaces/appliances.ts:131
Updates an Appliance with the specified Resource Name in the specified Resource Group and Subscription.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  Appliances name.
- Optional options: AppliancesUpdateOptionalParams
  
  The options parameters.
Returns Promise<AppliancesUpdateResponse>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

resourceName: string

parameters: Appliance

Optional options: AppliancesCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<AppliancesCreateOrUpdateResponse>, AppliancesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

resourceName: string

parameters: Appliance

Optional options: AppliancesCreateOrUpdateOptionalParams

Returns Promise<AppliancesCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

resourceName: string

Optional options: AppliancesDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

resourceName: string

Optional options: AppliancesDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

resourceName: string

Optional options: AppliancesGetOptionalParams

Returns Promise<AppliancesGetResponse>

getUpgradeGraph

Parameters

resourceGroupName: string

resourceName: string

upgradeGraph: string

Optional options: AppliancesGetUpgradeGraphOptionalParams

Returns Promise<AppliancesGetUpgradeGraphResponse>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: AppliancesListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<Appliance>

listBySubscription

Parameters

Optional options: AppliancesListBySubscriptionOptionalParams

Returns PagedAsyncIterableIterator<Appliance>

listClusterCustomerUserCredential

Parameters

resourceGroupName: string

resourceName: string

Optional options: AppliancesListClusterCustomerUserCredentialOptionalParams

Returns Promise<AppliancesListClusterCustomerUserCredentialResponse>

listClusterUserCredential

Parameters

resourceGroupName: string

resourceName: string

Optional options: AppliancesListClusterUserCredentialOptionalParams

Returns Promise<AppliancesListClusterUserCredentialResponse>

listOperations

Parameters

Optional options: AppliancesListOperationsOptionalParams

Returns PagedAsyncIterableIterator<ApplianceOperation>

update

Parameters

resourceGroupName: string

resourceName: string

Optional options: AppliancesUpdateOptionalParams

Returns Promise<AppliancesUpdateResponse>