Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-loadtestservice

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

ActionType

ActionType: string

Defines values for ActionType.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal

CreatedByType

CreatedByType: string

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

LoadTestResource

LoadTestResource: TrackedResource & { dataPlaneURI?: undefined | string; description?: undefined | string; identity?: SystemAssignedServiceIdentity; provisioningState?: ResourceState }

LoadTest details

LoadTestsCreateOrUpdateResponse

LoadTestsCreateOrUpdateResponse: LoadTestResource

Contains response data for the createOrUpdate operation.

LoadTestsGetResponse

LoadTestsGetResponse: LoadTestResource

Contains response data for the get operation.

LoadTestsListByResourceGroupNextResponse

LoadTestsListByResourceGroupNextResponse: LoadTestResourcePageList

Contains response data for the listByResourceGroupNext operation.

LoadTestsListByResourceGroupResponse

LoadTestsListByResourceGroupResponse: LoadTestResourcePageList

Contains response data for the listByResourceGroup operation.

LoadTestsListBySubscriptionNextResponse

LoadTestsListBySubscriptionNextResponse: LoadTestResourcePageList

Contains response data for the listBySubscriptionNext operation.

LoadTestsListBySubscriptionResponse

LoadTestsListBySubscriptionResponse: LoadTestResourcePageList

Contains response data for the listBySubscription operation.

LoadTestsUpdateResponse

LoadTestsUpdateResponse: LoadTestResource

Contains response data for the update operation.

OperationsListNextResponse

OperationsListNextResponse: OperationListResult

Contains response data for the listNext operation.

OperationsListResponse

OperationsListResponse: OperationListResult

Contains response data for the list operation.

Origin

Origin: string

Defines values for Origin.
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user
system
user,system

ResourceState

ResourceState: string

Defines values for ResourceState.
KnownResourceState can be used interchangeably with ResourceState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Failed
Canceled
Deleted

SystemAssignedServiceIdentityType

SystemAssignedServiceIdentityType: string

Defines values for SystemAssignedServiceIdentityType.
KnownSystemAssignedServiceIdentityType can be used interchangeably with SystemAssignedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None
SystemAssigned

TrackedResource

TrackedResource: Resource & { location: string; tags?: undefined | {} }

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Variables

Const serializer

serializer: any = coreClient.createSerializer(Mappers, /* isXml */ false)

Object literals

Const $host

$host: object

parameterPath

parameterPath: string = "$host"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "$host"

type

type: object

name

name: string = "String"

Const ErrorAdditionalInfo

ErrorAdditionalInfo: object

type

type: object

className

className: string = "ErrorAdditionalInfo"

name

name: string = "Composite"

modelProperties

modelProperties: object

info

info: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "info"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "any"

type

type: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const ErrorDetail

ErrorDetail: object

type

type: object

className

className: string = "ErrorDetail"

name

name: string = "Composite"

modelProperties

modelProperties: object

additionalInfo

additionalInfo: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "additionalInfo"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorAdditionalInfo"

name

name: string = "Composite"

code

code: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

details

details: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorDetail"

name

name: string = "Composite"

message

message: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

target

target: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "target"

type

type: object

name

name: string = "String"

Const ErrorResponse

ErrorResponse: object

type

type: object

className

className: string = "ErrorResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorDetail"

name

name: string = "Composite"

Const LoadTestResource

LoadTestResource: object

type

type: object

className

className: string = "LoadTestResource"

name

name: string = "Composite"

modelProperties

modelProperties: object

dataPlaneURI

dataPlaneURI: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.dataPlaneURI"

constraints

constraints: object

MaxLength

MaxLength: number = 2083

type

type: object

name

name: string = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

constraints

constraints: object

MaxLength

MaxLength: number = 512

type

type: object

name

name: string = "String"

identity

identity: object

serializedName

serializedName: string = "identity"

type

type: object

className

className: string = "SystemAssignedServiceIdentity"

name

name: string = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: string = "String"

Const LoadTestResourcePageList

LoadTestResourcePageList: object

type

type: object

className

className: string = "LoadTestResourcePageList"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "LoadTestResource"

name

name: string = "Composite"

Const LoadTestResourcePatchRequestBody

LoadTestResourcePatchRequestBody: object

type

type: object

className

className: string = "LoadTestResourcePatchRequestBody"

name

name: string = "Composite"

modelProperties

modelProperties: object

identity

identity: object

serializedName

serializedName: string = "identity"

type

type: object

className

className: string = "SystemAssignedServiceIdentity"

name

name: string = "Composite"

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "LoadTestResourcePatchRequestBodyProperties"

name

name: string = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "any"

Const LoadTestResourcePatchRequestBodyProperties

LoadTestResourcePatchRequestBodyProperties: object

type

type: object

className

className: string = "LoadTestResourcePatchRequestBodyProperties"

name

name: string = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

constraints

constraints: object

MaxLength

MaxLength: number = 512

type

type: object

name

name: string = "String"

Const Operation

Operation: object

type

type: object

className

className: string = "Operation"

name

name: string = "Composite"

modelProperties

modelProperties: object

actionType

actionType: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "actionType"

type

type: object

name

name: string = "String"

display

display: object

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "OperationDisplay"

name

name: string = "Composite"

isDataAction

isDataAction: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "isDataAction"

type

type: object

name

name: string = "Boolean"

name

name: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

origin

origin: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "origin"

type

type: object

name

name: string = "String"

Const OperationDisplay

OperationDisplay: object

type

type: object

className

className: string = "OperationDisplay"

name

name: string = "Composite"

modelProperties

modelProperties: object

description

description: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "description"

type

type: object

name

name: string = "String"

operation

operation: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "operation"

type

type: object

name

name: string = "String"

provider

provider: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "provider"

type

type: object

name

name: string = "String"

resource

resource: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "resource"

type

type: object

name

name: string = "String"

Const OperationListResult

OperationListResult: object

type

type: object

className

className: string = "OperationListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Operation"

name

name: string = "Composite"

Const Resource

Resource: object

type

type: object

className

className: string = "Resource"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

name

name: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

systemData

systemData: object

serializedName

serializedName: string = "systemData"

type

type: object

className

className: string = "SystemData"

name

name: string = "Composite"

type

type: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const SystemAssignedServiceIdentity

SystemAssignedServiceIdentity: object

type

type: object

className

className: string = "SystemAssignedServiceIdentity"

name

name: string = "Composite"

modelProperties

modelProperties: object

principalId

principalId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "principalId"

type

type: object

name

name: string = "Uuid"

tenantId

tenantId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: string = "Uuid"

type

type: object

required

required: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const SystemData

SystemData: object

type

type: object

className

className: string = "SystemData"

name

name: string = "Composite"

modelProperties

modelProperties: object

createdAt

createdAt: object

serializedName

serializedName: string = "createdAt"

type

type: object

name

name: string = "DateTime"

createdBy

createdBy: object

serializedName

serializedName: string = "createdBy"

type

type: object

name

name: string = "String"

createdByType

createdByType: object

serializedName

serializedName: string = "createdByType"

type

type: object

name

name: string = "String"

lastModifiedAt

lastModifiedAt: object

serializedName

serializedName: string = "lastModifiedAt"

type

type: object

name

name: string = "DateTime"

lastModifiedBy

lastModifiedBy: object

serializedName

serializedName: string = "lastModifiedBy"

type

type: object

name

name: string = "String"

lastModifiedByType

lastModifiedByType: object

serializedName

serializedName: string = "lastModifiedByType"

type

type: object

name

name: string = "String"

Const TrackedResource

TrackedResource: object

type

type: object

className

className: string = "TrackedResource"

name

name: string = "Composite"

modelProperties

modelProperties: object

location

location: object

required

required: boolean = true

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2021-12-01-preview"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const contentType

contentType: object

parameterPath

parameterPath: string[] = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const createOrUpdateOperationSpec

createOrUpdateOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LoadTestService/loadTests/{loadTestName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.loadTestResource

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.loadTestName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.LoadTestResource

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const deleteOperationSpec

deleteOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LoadTestService/loadTests/{loadTestName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.loadTestName]

responses

responses: object

200

200: {}

Type declaration

201

201: {}

Type declaration

202

202: {}

Type declaration

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const getOperationSpec

getOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LoadTestService/loadTests/{loadTestName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.loadTestName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.LoadTestResource

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const listByResourceGroupNextOperationSpec

listByResourceGroupNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.nextLink,Parameters.subscriptionId,Parameters.resourceGroupName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.LoadTestResourcePageList

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const listByResourceGroupOperationSpec

listByResourceGroupOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LoadTestService/loadTests"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.LoadTestResourcePageList

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const listBySubscriptionNextOperationSpec

listBySubscriptionNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.nextLink,Parameters.subscriptionId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.LoadTestResourcePageList

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const listBySubscriptionOperationSpec

listBySubscriptionOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/subscriptions/{subscriptionId}/providers/Microsoft.LoadTestService/loadTests"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.subscriptionId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.LoadTestResourcePageList

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const listNextOperationSpec

listNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.OperationListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const listOperationSpec

listOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/providers/Microsoft.LoadTestService/operations"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.OperationListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const loadTestName

loadTestName: object

parameterPath

parameterPath: string = "loadTestName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "loadTestName"

type

type: object

name

name: string = "String"

Const loadTestResource

loadTestResource: object

mapper

mapper: any = LoadTestResourceMapper

parameterPath

parameterPath: string = "loadTestResource"

Const loadTestResourcePatchRequestBody

loadTestResourcePatchRequestBody: object

mapper

mapper: any = LoadTestResourcePatchRequestBodyMapper

parameterPath

parameterPath: string = "loadTestResourcePatchRequestBody"

Const nextLink

nextLink: object

parameterPath

parameterPath: string = "nextLink"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "resourceGroupName"

constraints

constraints: object

MaxLength

MaxLength: number = 90

MinLength

MinLength: number = 1

type

type: object

name

name: string = "String"

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "subscriptionId"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: string = "String"

Const updateOperationSpec

updateOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "PATCH"

mediaType

mediaType: string = "json"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LoadTestService/loadTests/{loadTestName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.loadTestResourcePatchRequestBody

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host,Parameters.subscriptionId,Parameters.resourceGroupName,Parameters.loadTestName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.LoadTestResource

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Generated using TypeDoc