Package version:

Interface Extensions

Interface representing a Extensions.

Hierarchy

Extensions

Index

Methods

create delete get listByFarmBeats update

Methods

create

create(resourceGroupName: string, farmBeatsResourceName: string, extensionId: string, options?: ExtensionsCreateOptionalParams): Promise<Extension>
Install extension.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- farmBeatsResourceName: string
  
  FarmBeats resource name.
- extensionId: string
  
  Id of extension resource.
- Optional options: ExtensionsCreateOptionalParams
  
  The options parameters.
Returns Promise<Extension>
- Defined in operationsInterfaces/extensions.ts:43

delete

delete(resourceGroupName: string, farmBeatsResourceName: string, extensionId: string, options?: ExtensionsDeleteOptionalParams): Promise<void>
Uninstall extension.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- farmBeatsResourceName: string
  
  FarmBeats resource name.
- extensionId: string
  
  Id of extension resource.
- Optional options: ExtensionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/extensions.ts:82

get

get(resourceGroupName: string, farmBeatsResourceName: string, extensionId: string, options?: ExtensionsGetOptionalParams): Promise<Extension>
Get installed extension details by extension id.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- farmBeatsResourceName: string
  
  FarmBeats resource name.
- extensionId: string
  
  Id of extension resource.
- Optional options: ExtensionsGetOptionalParams
  
  The options parameters.
Returns Promise<Extension>
- Defined in operationsInterfaces/extensions.ts:56

listByFarmBeats

listByFarmBeats(resourceGroupName: string, farmBeatsResourceName: string, options?: ExtensionsListByFarmBeatsOptionalParams): PagedAsyncIterableIterator<Extension>
Get installed extensions details.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- farmBeatsResourceName: string
  
  FarmBeats resource name.
- Optional options: ExtensionsListByFarmBeatsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Extension>
- Defined in operationsInterfaces/extensions.ts:31

update

update(resourceGroupName: string, farmBeatsResourceName: string, extensionId: string, options?: ExtensionsUpdateOptionalParams): Promise<Extension>
Upgrade to latest extension.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- farmBeatsResourceName: string
  
  FarmBeats resource name.
- extensionId: string
  
  Id of extension resource.
- Optional options: ExtensionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<Extension>
- Defined in operationsInterfaces/extensions.ts:69

Interface Extensions

Hierarchy

Index

Methods

Methods

create

Parameters

resourceGroupName: string

farmBeatsResourceName: string

extensionId: string

Optional options: ExtensionsCreateOptionalParams

Returns Promise<Extension>

delete

Parameters

resourceGroupName: string

farmBeatsResourceName: string

extensionId: string

Optional options: ExtensionsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

farmBeatsResourceName: string

extensionId: string

Optional options: ExtensionsGetOptionalParams

Returns Promise<Extension>

listByFarmBeats

Parameters

resourceGroupName: string

farmBeatsResourceName: string

Optional options: ExtensionsListByFarmBeatsOptionalParams

Returns PagedAsyncIterableIterator<Extension>

update

Parameters

resourceGroupName: string

farmBeatsResourceName: string

extensionId: string

Optional options: ExtensionsUpdateOptionalParams

Returns Promise<Extension>

Settings

Member Visibility

Theme

`Optional` options: ExtensionsCreateOptionalParams

`Optional` options: ExtensionsDeleteOptionalParams

`Optional` options: ExtensionsGetOptionalParams

`Optional` options: ExtensionsListByFarmBeatsOptionalParams

`Optional` options: ExtensionsUpdateOptionalParams