Share via

ScriptCmdlet interface

  • Reference
Package:
@azure/arm-avs

A cmdlet available for script execution

Extends
ProxyResource

Properties

audience

Specifies whether a script cmdlet is intended to be invoked only through automation or visible to customers NOTE: This property will not be serialized. It can only be populated by the server.
description

Description of the scripts functionality NOTE: This property will not be serialized. It can only be populated by the server.
parameters

Parameters the script will accept NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

The provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
timeout

Recommended time limit for execution NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

audience

Specifies whether a script cmdlet is intended to be invoked only through automation or visible to customers NOTE: This property will not be serialized. It can only be populated by the server.

audience?: string

Property Value

string

description

Description of the scripts functionality NOTE: This property will not be serialized. It can only be populated by the server.

description?: string

Property Value

string

parameters

Parameters the script will accept NOTE: This property will not be serialized. It can only be populated by the server.

parameters?: ScriptParameter[]

Property Value

ScriptParameter[]

provisioningState

The provisioning state of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

timeout

Recommended time limit for execution NOTE: This property will not be serialized. It can only be populated by the server.

timeout?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type