Addons interface
Interface representing a Addons.
Methods
| begin |
Create or update a addon. |
| begin |
Create or update a addon. |
| begin |
Deletes the addon on the device. |
| begin |
Deletes the addon on the device. |
| get(string, string, string, string, Addons |
Gets a specific addon by name. |
| list |
Lists all the addons configured in the role. |
Method Details
beginCreateOrUpdate(string, string, string, string, AddonUnion, AddonsCreateOrUpdateOptionalParams)
Create or update a addon.
function beginCreateOrUpdate(deviceName: string, roleName: string, addonName: string, resourceGroupName: string, addon: AddonUnion, options?: AddonsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<AddonUnion>, AddonUnion>>Parameters
- deviceName
-
string
The device name.
- roleName
-
string
The role name.
- addonName
-
string
The addon name.
- resourceGroupName
-
string
The resource group name.
- addon
- AddonUnion
The addon properties.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<AddonUnion>, AddonUnion>>
beginCreateOrUpdateAndWait(string, string, string, string, AddonUnion, AddonsCreateOrUpdateOptionalParams)
Create or update a addon.
function beginCreateOrUpdateAndWait(deviceName: string, roleName: string, addonName: string, resourceGroupName: string, addon: AddonUnion, options?: AddonsCreateOrUpdateOptionalParams): Promise<AddonUnion>Parameters
- deviceName
-
string
The device name.
- roleName
-
string
The role name.
- addonName
-
string
The addon name.
- resourceGroupName
-
string
The resource group name.
- addon
- AddonUnion
The addon properties.
The options parameters.
Returns
Promise<AddonUnion>
beginDelete(string, string, string, string, AddonsDeleteOptionalParams)
Deletes the addon on the device.
function beginDelete(deviceName: string, roleName: string, addonName: string, resourceGroupName: string, options?: AddonsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- deviceName
-
string
The device name.
- roleName
-
string
The role name.
- addonName
-
string
The addon name.
- resourceGroupName
-
string
The resource group name.
- options
- AddonsDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, string, string, AddonsDeleteOptionalParams)
Deletes the addon on the device.
function beginDeleteAndWait(deviceName: string, roleName: string, addonName: string, resourceGroupName: string, options?: AddonsDeleteOptionalParams): Promise<void>Parameters
- deviceName
-
string
The device name.
- roleName
-
string
The role name.
- addonName
-
string
The addon name.
- resourceGroupName
-
string
The resource group name.
- options
- AddonsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, string, AddonsGetOptionalParams)
Gets a specific addon by name.
function get(deviceName: string, roleName: string, addonName: string, resourceGroupName: string, options?: AddonsGetOptionalParams): Promise<AddonUnion>Parameters
- deviceName
-
string
The device name.
- roleName
-
string
The role name.
- addonName
-
string
The addon name.
- resourceGroupName
-
string
The resource group name.
- options
- AddonsGetOptionalParams
The options parameters.
Returns
Promise<AddonUnion>
listByRole(string, string, string, AddonsListByRoleOptionalParams)
Lists all the addons configured in the role.
function listByRole(deviceName: string, roleName: string, resourceGroupName: string, options?: AddonsListByRoleOptionalParams): PagedAsyncIterableIterator<AddonUnion, AddonUnion[], PageSettings>Parameters
- deviceName
-
string
The device name.
- roleName
-
string
The role name.
- resourceGroupName
-
string
The resource group name.
- options
- AddonsListByRoleOptionalParams
The options parameters.