Share via

TemplateSpecs interface

  • Reference
Package:
@azure/arm-templatespecs

Interface representing a TemplateSpecs.

Methods

createOrUpdate(string, string, TemplateSpec, TemplateSpecsCreateOrUpdateOptionalParams)

Creates or updates a Template Spec.
delete(string, string, TemplateSpecsDeleteOptionalParams)

Deletes a Template Spec by name. When operation completes, status code 200 returned without content.
get(string, string, TemplateSpecsGetOptionalParams)

Gets a Template Spec with a given name.
listByResourceGroup(string, TemplateSpecsListByResourceGroupOptionalParams)

Lists all the Template Specs within the specified resource group.
listBySubscription(TemplateSpecsListBySubscriptionOptionalParams)

Lists all the Template Specs within the specified subscriptions.
update(string, string, TemplateSpecsUpdateOptionalParams)

Updates Template Spec tags with specified values.

Method Details

createOrUpdate(string, string, TemplateSpec, TemplateSpecsCreateOrUpdateOptionalParams)

Creates or updates a Template Spec.

function createOrUpdate(resourceGroupName: string, templateSpecName: string, templateSpec: TemplateSpec, options?: TemplateSpecsCreateOrUpdateOptionalParams): Promise<TemplateSpec>

Parameters

resourceGroupName

string

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

templateSpecName

string

Name of the Template Spec.

templateSpec
TemplateSpec

Template Spec supplied to the operation.

options
TemplateSpecsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<TemplateSpec>

delete(string, string, TemplateSpecsDeleteOptionalParams)

Deletes a Template Spec by name. When operation completes, status code 200 returned without content.

function delete(resourceGroupName: string, templateSpecName: string, options?: TemplateSpecsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

templateSpecName

string

Name of the Template Spec.

options
TemplateSpecsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, TemplateSpecsGetOptionalParams)

Gets a Template Spec with a given name.

function get(resourceGroupName: string, templateSpecName: string, options?: TemplateSpecsGetOptionalParams): Promise<TemplateSpec>

Parameters

resourceGroupName

string

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

templateSpecName

string

Name of the Template Spec.

options
TemplateSpecsGetOptionalParams

The options parameters.

Returns

Promise<TemplateSpec>

listByResourceGroup(string, TemplateSpecsListByResourceGroupOptionalParams)

Lists all the Template Specs within the specified resource group.

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

Parameters

resourceGroupName

string

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

options
TemplateSpecsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<TemplateSpec, TemplateSpec[], PageSettings>

listBySubscription(TemplateSpecsListBySubscriptionOptionalParams)

Lists all the Template Specs within the specified subscriptions.

function listBySubscription(options?: TemplateSpecsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<TemplateSpec, TemplateSpec[], PageSettings>

Parameters

options
TemplateSpecsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<TemplateSpec, TemplateSpec[], PageSettings>

update(string, string, TemplateSpecsUpdateOptionalParams)

Updates Template Spec tags with specified values.

function update(resourceGroupName: string, templateSpecName: string, options?: TemplateSpecsUpdateOptionalParams): Promise<TemplateSpec>

Parameters

resourceGroupName

string

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

templateSpecName

string

Name of the Template Spec.

options
TemplateSpecsUpdateOptionalParams

The options parameters.

Returns

Promise<TemplateSpec>