Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-dashboard

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

AutoGeneratedDomainNameLabelScope

AutoGeneratedDomainNameLabelScope: string

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

Known values supported by the service

TenantReuse

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

GrafanaCreateResponse

GrafanaCreateResponse: ManagedGrafana

Contains response data for the create operation.

GrafanaGetResponse

GrafanaGetResponse: ManagedGrafana

Contains response data for the get operation.

GrafanaListByResourceGroupNextResponse

GrafanaListByResourceGroupNextResponse: ManagedGrafanaListResponse

Contains response data for the listByResourceGroupNext operation.

GrafanaListByResourceGroupResponse

GrafanaListByResourceGroupResponse: ManagedGrafanaListResponse

Contains response data for the listByResourceGroup operation.

GrafanaListNextResponse

GrafanaListNextResponse: ManagedGrafanaListResponse

Contains response data for the listNext operation.

GrafanaListResponse

GrafanaListResponse: ManagedGrafanaListResponse

Contains response data for the list operation.

GrafanaUpdateResponse

GrafanaUpdateResponse: ManagedGrafana

Contains response data for the update operation.

IdentityType

IdentityType: string

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

Known values supported by the service

None
SystemAssigned

LastModifiedByType

LastModifiedByType: string

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

Known values supported by the service

User
Application
ManagedIdentity
Key

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

ProvisioningState

ProvisioningState: string

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

Known values supported by the service

Accepted
Creating
Updating
Deleting
Succeeded
Failed
Canceled
Deleted
NotSpecified

ZoneRedundancy

ZoneRedundancy: string

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

Known values supported by the service

Disabled
Enabled

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 ManagedGrafana

ManagedGrafana: object

type

type: object

className

className: string = "ManagedGrafana"

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"

identity

identity: object

serializedName

serializedName: string = "identity"

type

type: object

className

className: string = "ManagedIdentity"

name

name: string = "Composite"

location

location: object

serializedName

serializedName: string = "location"

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"

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "ManagedGrafanaProperties"

name

name: string = "Composite"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "ResourceSku"

name

name: string = "Composite"

systemData

systemData: object

serializedName

serializedName: string = "systemData"

type

type: object

className

className: string = "SystemData"

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 = "String"

type

type: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const ManagedGrafanaListResponse

ManagedGrafanaListResponse: object

type

type: object

className

className: string = "ManagedGrafanaListResponse"

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 = "ManagedGrafana"

name

name: string = "Composite"

Const ManagedGrafanaProperties

ManagedGrafanaProperties: object

type

type: object

className

className: string = "ManagedGrafanaProperties"

name

name: string = "Composite"

modelProperties

modelProperties: object

autoGeneratedDomainNameLabelScope

autoGeneratedDomainNameLabelScope: object

serializedName

serializedName: string = "autoGeneratedDomainNameLabelScope"

type

type: object

name

name: string = "String"

endpoint

endpoint: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "endpoint"

type

type: object

name

name: string = "String"

grafanaVersion

grafanaVersion: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "grafanaVersion"

type

type: object

name

name: string = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "provisioningState"

type

type: object

name

name: string = "String"

zoneRedundancy

zoneRedundancy: object

defaultValue

defaultValue: string = "Disabled"

serializedName

serializedName: string = "zoneRedundancy"

type

type: object

name

name: string = "String"

Const ManagedGrafanaUpdateParameters

ManagedGrafanaUpdateParameters: object

type

type: object

className

className: string = "ManagedGrafanaUpdateParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

identity

identity: object

serializedName

serializedName: string = "identity"

type

type: object

className

className: string = "ManagedIdentity"

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 = "String"

Const ManagedIdentity

ManagedIdentity: object

type

type: object

className

className: string = "ManagedIdentity"

name

name: string = "Composite"

modelProperties

modelProperties: object

principalId

principalId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "principalId"

type

type: object

name

name: string = "String"

tenantId

tenantId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: string = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

userAssignedIdentities

userAssignedIdentities: object

serializedName

serializedName: string = "userAssignedIdentities"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

className

className: string = "UserAssignedIdentity"

name

name: string = "Composite"

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 = "OperationResult"

name

name: string = "Composite"

Const OperationResult

OperationResult: object

type

type: object

className

className: string = "OperationResult"

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 ResourceSku

ResourceSku: object

type

type: object

className

className: string = "ResourceSku"

name

name: string = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

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 UserAssignedIdentity

UserAssignedIdentity: object

type

type: object

className

className: string = "UserAssignedIdentity"

name

name: string = "Composite"

modelProperties

modelProperties: object

clientId

clientId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "clientId"

type

type: object

name

name: string = "String"

principalId

principalId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "principalId"

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-09-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 createOperationSpec

createOperationSpec: 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.Dashboard/grafana/{workspaceName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.requestBodyParameters

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ManagedGrafana

201

201: object

bodyMapper

bodyMapper: any = Mappers.ManagedGrafana

202

202: object

bodyMapper

bodyMapper: any = Mappers.ManagedGrafana

204

204: object

bodyMapper

bodyMapper: any = Mappers.ManagedGrafana

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.Dashboard/grafana/{workspaceName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

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.Dashboard/grafana/{workspaceName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ManagedGrafana

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.ManagedGrafanaListResponse

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.Dashboard/grafana"

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.ManagedGrafanaListResponse

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,Parameters.subscriptionId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ManagedGrafanaListResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const listOperationSpec

listOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/subscriptions/{subscriptionId}/providers/Microsoft.Dashboard/grafana"

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.ManagedGrafanaListResponse

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

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 requestBodyParameters

requestBodyParameters: object

mapper

mapper: any = ManagedGrafanaMapper

parameterPath

parameterPath: string = "requestBodyParameters"

Const requestBodyParameters1

requestBodyParameters1: object

mapper

mapper: any = ManagedGrafanaUpdateParametersMapper

parameterPath

parameterPath: string = "requestBodyParameters"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "resourceGroupName"

constraints

constraints: object

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.Dashboard/grafana/{workspaceName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.requestBodyParameters1

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ManagedGrafana

default

default: object

bodyMapper

bodyMapper: any = Mappers.ErrorResponse

Const workspaceName

workspaceName: object

parameterPath

parameterPath: string = "workspaceName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "workspaceName"

type

type: object

name

name: string = "String"

Generated using TypeDoc