VirtualMachineScaleSetListResult interface

The List Virtual Machine operation response.

Extends
VirtualMachineScaleSet>

Properties

Array
length

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

nextLink

The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS.

Methods

concat(ConcatArray<VirtualMachineScaleSet>[])

Combines two or more arrays.

concat(T | ConcatArray<T>[])

Combines two or more arrays.

copyWithin(number, number, number)

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

entries()

Returns an iterable of key, value pairs for every entry in the array

every((value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet[]) => unknown, any)

Determines whether all the members of an array satisfy the specified test.

fill(VirtualMachineScaleSet, number, number)

Returns the this object after filling the section identified by start and end with value

filter((value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet[]) => boolean, any)

Returns the elements of an array that meet the condition specified in a callback function.

filter((value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet[]) => unknown, any)

Returns the elements of an array that meet the condition specified in a callback function.

find((this: void, value: VirtualMachineScaleSet, index: number, obj: VirtualMachineScaleSet[]) => boolean, any)

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

find((value: VirtualMachineScaleSet, index: number, obj: VirtualMachineScaleSet[]) => unknown, any)

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

findIndex((value: VirtualMachineScaleSet, index: number, obj: VirtualMachineScaleSet[]) => unknown, any)

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

forEach((value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet[]) => void, any)

Performs the specified action for each element in an array.

includes(VirtualMachineScaleSet, number)

Determines whether an array includes a certain element, returning true or false as appropriate.

indexOf(VirtualMachineScaleSet, number)

Returns the index of the first occurrence of a value in an array.

join(string)

Adds all the elements of an array separated by the specified separator string.

keys()

Returns an iterable of keys in the array

lastIndexOf(VirtualMachineScaleSet, number)

Returns the index of the last occurrence of a specified value in an array.

map((value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet[]) => U, any)

Calls a defined callback function on each element of an array, and returns an array that contains the results.

pop()

Removes the last element from an array and returns it.

push(VirtualMachineScaleSet[])

Appends new elements to an array, and returns the new length of the array.

reduce((previousValue: U, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet[]) => U, U)

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

reduce((previousValue: VirtualMachineScaleSet, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet[]) => VirtualMachineScaleSet)

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

reduce((previousValue: VirtualMachineScaleSet, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet[]) => VirtualMachineScaleSet, VirtualMachineScaleSet)

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

reduceRight((previousValue: U, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet[]) => U, U)

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

reduceRight((previousValue: VirtualMachineScaleSet, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet[]) => VirtualMachineScaleSet)

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

reduceRight((previousValue: VirtualMachineScaleSet, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet[]) => VirtualMachineScaleSet, VirtualMachineScaleSet)

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

reverse()

Reverses the elements in an Array.

shift()

Removes the first element from an array and returns it.

slice(number, number)

Returns a section of an array.

some((value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet[]) => unknown, any)

Determines whether the specified callback function returns true for any element of an array.

sort((a: VirtualMachineScaleSet, b: VirtualMachineScaleSet) => number)

Sorts an array.

splice(number, number)

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

splice(number, number, VirtualMachineScaleSet[])

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

toLocaleString()

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

toString()

Returns a string representation of an array.

unshift(VirtualMachineScaleSet[])

Inserts new elements at the start of an array.

values()

Returns an iterable of values in the array

Property Details

Array

Array: ArrayConstructor

Property Value

ArrayConstructor

length

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

length: number

Property Value

number

The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS.

nextLink?: string

Property Value

string

Method Details

concat(ConcatArray<VirtualMachineScaleSet>[])

Combines two or more arrays.

function concat(items: ConcatArray<VirtualMachineScaleSet>[])

Parameters

items
ConcatArray<VirtualMachineScaleSet>[]

Additional items to add to the end of array1.

Returns

concat(T | ConcatArray<T>[])

Combines two or more arrays.

function concat(items: T | ConcatArray<T>[])

Parameters

items
T | ConcatArray<T>[]

Additional items to add to the end of array1.

Returns

copyWithin(number, number, number)

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

function copyWithin(target: number, start: number, end?: number)

Parameters

target
number

If target is negative, it is treated as length+target where length is the length of the array.

start
number

If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

end
number

If not specified, length of the this object is used as its default value.

Returns

this

entries()

Returns an iterable of key, value pairs for every entry in the array

function entries()

Returns

IterableIterator<Object>

every((value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet[]) => unknown, any)

Determines whether all the members of an array satisfy the specified test.

function every(callbackfn: (value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet[]) => unknown, thisArg?: any)

Parameters

callbackfn
(value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet) => unknown[]

A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

thisArg
any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

fill(VirtualMachineScaleSet, number, number)

Returns the this object after filling the section identified by start and end with value

function fill(value: VirtualMachineScaleSet, start?: number, end?: number)

Parameters

value
VirtualMachineScaleSet

value to fill array section with

start
number

index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

end
number

index to stop filling the array at. If end is negative, it is treated as length+end.

Returns

this

filter((value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet[]) => boolean, any)

Returns the elements of an array that meet the condition specified in a callback function.

function filter<S>(callbackfn: (value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet[]) => boolean, thisArg?: any)

Parameters

callbackfn
(value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet) => boolean[]

A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

thisArg
any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

S[]

filter((value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet[]) => unknown, any)

Returns the elements of an array that meet the condition specified in a callback function.

function filter(callbackfn: (value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet[]) => unknown, thisArg?: any)

Parameters

callbackfn
(value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet) => unknown[]

A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

thisArg
any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

find((this: void, value: VirtualMachineScaleSet, index: number, obj: VirtualMachineScaleSet[]) => boolean, any)

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

function find<S>(predicate: (this: void, value: VirtualMachineScaleSet, index: number, obj: VirtualMachineScaleSet[]) => boolean, thisArg?: any)

Parameters

predicate
(this: void, value: VirtualMachineScaleSet, index: number, obj: VirtualMachineScaleSet) => boolean[]

find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

thisArg
any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

S | undefined

find((value: VirtualMachineScaleSet, index: number, obj: VirtualMachineScaleSet[]) => unknown, any)

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

function find(predicate: (value: VirtualMachineScaleSet, index: number, obj: VirtualMachineScaleSet[]) => unknown, thisArg?: any)

Parameters

predicate
(value: VirtualMachineScaleSet, index: number, obj: VirtualMachineScaleSet) => unknown[]
thisArg
any

Returns

findIndex((value: VirtualMachineScaleSet, index: number, obj: VirtualMachineScaleSet[]) => unknown, any)

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

function findIndex(predicate: (value: VirtualMachineScaleSet, index: number, obj: VirtualMachineScaleSet[]) => unknown, thisArg?: any)

Parameters

predicate
(value: VirtualMachineScaleSet, index: number, obj: VirtualMachineScaleSet) => unknown[]

find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

thisArg
any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

number

forEach((value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet[]) => void, any)

Performs the specified action for each element in an array.

function forEach(callbackfn: (value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet[]) => void, thisArg?: any)

Parameters

callbackfn
(value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet) => void[]

A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

thisArg
any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

includes(VirtualMachineScaleSet, number)

Determines whether an array includes a certain element, returning true or false as appropriate.

function includes(searchElement: VirtualMachineScaleSet, fromIndex?: number)

Parameters

searchElement
VirtualMachineScaleSet

The element to search for.

fromIndex
number

The position in this array at which to begin searching for searchElement.

Returns

boolean

indexOf(VirtualMachineScaleSet, number)

Returns the index of the first occurrence of a value in an array.

function indexOf(searchElement: VirtualMachineScaleSet, fromIndex?: number)

Parameters

searchElement
VirtualMachineScaleSet

The value to locate in the array.

fromIndex
number

The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns

number

join(string)

Adds all the elements of an array separated by the specified separator string.

function join(separator?: string)

Parameters

separator
string

A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns

string

keys()

Returns an iterable of keys in the array

function keys()

Returns

IterableIterator<number>

lastIndexOf(VirtualMachineScaleSet, number)

Returns the index of the last occurrence of a specified value in an array.

function lastIndexOf(searchElement: VirtualMachineScaleSet, fromIndex?: number)

Parameters

searchElement
VirtualMachineScaleSet

The value to locate in the array.

fromIndex
number

The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

Returns

number

map((value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet[]) => U, any)

Calls a defined callback function on each element of an array, and returns an array that contains the results.

function map<U>(callbackfn: (value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet[]) => U, thisArg?: any)

Parameters

callbackfn
(value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet) => U[]

A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

thisArg
any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

pop()

Removes the last element from an array and returns it.

function pop()

Returns

push(VirtualMachineScaleSet[])

Appends new elements to an array, and returns the new length of the array.

function push(items: VirtualMachineScaleSet[])

Parameters

items
VirtualMachineScaleSet[]

New elements of the Array.

Returns

number

reduce((previousValue: U, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet[]) => U, U)

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

function reduce<U>(callbackfn: (previousValue: U, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet[]) => U, initialValue: U)

Parameters

callbackfn
(previousValue: U, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet) => U[]

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

initialValue
U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

reduce((previousValue: VirtualMachineScaleSet, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet[]) => VirtualMachineScaleSet)

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

function reduce(callbackfn: (previousValue: VirtualMachineScaleSet, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet[]) => VirtualMachineScaleSet)

Parameters

callbackfn
(previousValue: VirtualMachineScaleSet, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet) => VirtualMachineScaleSet[]

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns

reduce((previousValue: VirtualMachineScaleSet, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet[]) => VirtualMachineScaleSet, VirtualMachineScaleSet)

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

function reduce(callbackfn: (previousValue: VirtualMachineScaleSet, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet[]) => VirtualMachineScaleSet, initialValue: VirtualMachineScaleSet)

Parameters

callbackfn
(previousValue: VirtualMachineScaleSet, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet) => VirtualMachineScaleSet[]
initialValue
VirtualMachineScaleSet

Returns

reduceRight((previousValue: U, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet[]) => U, U)

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

function reduceRight<U>(callbackfn: (previousValue: U, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet[]) => U, initialValue: U)

Parameters

callbackfn
(previousValue: U, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet) => U[]

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

initialValue
U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

reduceRight((previousValue: VirtualMachineScaleSet, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet[]) => VirtualMachineScaleSet)

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

function reduceRight(callbackfn: (previousValue: VirtualMachineScaleSet, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet[]) => VirtualMachineScaleSet)

Parameters

callbackfn
(previousValue: VirtualMachineScaleSet, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet) => VirtualMachineScaleSet[]

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns

reduceRight((previousValue: VirtualMachineScaleSet, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet[]) => VirtualMachineScaleSet, VirtualMachineScaleSet)

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

function reduceRight(callbackfn: (previousValue: VirtualMachineScaleSet, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet[]) => VirtualMachineScaleSet, initialValue: VirtualMachineScaleSet)

Parameters

callbackfn
(previousValue: VirtualMachineScaleSet, currentValue: VirtualMachineScaleSet, currentIndex: number, array: VirtualMachineScaleSet) => VirtualMachineScaleSet[]
initialValue
VirtualMachineScaleSet

Returns

reverse()

Reverses the elements in an Array.

function reverse()

Returns

shift()

Removes the first element from an array and returns it.

function shift()

Returns

slice(number, number)

Returns a section of an array.

function slice(start?: number, end?: number)

Parameters

start
number

The beginning of the specified portion of the array.

end
number

The end of the specified portion of the array.

Returns

some((value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet[]) => unknown, any)

Determines whether the specified callback function returns true for any element of an array.

function some(callbackfn: (value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet[]) => unknown, thisArg?: any)

Parameters

callbackfn
(value: VirtualMachineScaleSet, index: number, array: VirtualMachineScaleSet) => unknown[]

A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

thisArg
any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

sort((a: VirtualMachineScaleSet, b: VirtualMachineScaleSet) => number)

Sorts an array.

function sort(compareFn?: (a: VirtualMachineScaleSet, b: VirtualMachineScaleSet) => number)

Parameters

compareFn
(a: VirtualMachineScaleSet, b: VirtualMachineScaleSet) => number

The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns

this

splice(number, number)

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

function splice(start: number, deleteCount?: number)

Parameters

start
number

The zero-based location in the array from which to start removing elements.

deleteCount
number

The number of elements to remove.

Returns

splice(number, number, VirtualMachineScaleSet[])

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

function splice(start: number, deleteCount: number, items: VirtualMachineScaleSet[])

Parameters

start
number

The zero-based location in the array from which to start removing elements.

deleteCount
number

The number of elements to remove.

items
VirtualMachineScaleSet[]

Elements to insert into the array in place of the deleted elements.

Returns

toLocaleString()

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

function toLocaleString()

Returns

string

toString()

Returns a string representation of an array.

function toString()

Returns

string

unshift(VirtualMachineScaleSet[])

Inserts new elements at the start of an array.

function unshift(items: VirtualMachineScaleSet[])

Parameters

items
VirtualMachineScaleSet[]

Elements to insert at the start of the Array.

Returns

number

values()

Returns an iterable of values in the array

function values()

Returns

IterableIterator<VirtualMachineScaleSet>