EntitiesOperations interface

Package:

@azure/arm-cloudhealth

Interface representing a Entities operations.

Properties

addDataAnnotation	Add a data annotation to an entity
createOrUpdate	Create a Entity
delete	Delete a Entity
get	Get a Entity
getDataAnnotations	Retrieve data annotations for an entity
getHistory	Retrieve the health state transition history for an entity
getSignalHistory	Retrieve the time series history for a signal on an entity
getSignalRecommendations	Get recommended signal configurations for a given Entity (only applicable for Entities representing Azure resources)
ingestHealthReport	Ingest a health report for a specific signal on an entity (the entity must already exist)
listByHealthModel	List Entity resources by HealthModel

Property Details

addDataAnnotation

Add a data annotation to an entity

addDataAnnotation: (resourceGroupName: string, healthModelName: string, entityName: string, body: AddDataAnnotationRequest, options?: EntitiesAddDataAnnotationOptionalParams) => Promise<DataAnnotation>

Property Value

(resourceGroupName: string, healthModelName: string, entityName: string, body: AddDataAnnotationRequest, options?: EntitiesAddDataAnnotationOptionalParams) => Promise<DataAnnotation>

createOrUpdate

Create a Entity

createOrUpdate: (resourceGroupName: string, healthModelName: string, entityName: string, resource: Entity, options?: EntitiesCreateOrUpdateOptionalParams) => PollerLike<OperationState<Entity>, Entity>

Property Value

(resourceGroupName: string, healthModelName: string, entityName: string, resource: Entity, options?: EntitiesCreateOrUpdateOptionalParams) => PollerLike<OperationState<Entity>, Entity>

delete

Delete a Entity

delete: (resourceGroupName: string, healthModelName: string, entityName: string, options?: EntitiesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, healthModelName: string, entityName: string, options?: EntitiesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get a Entity

get: (resourceGroupName: string, healthModelName: string, entityName: string, options?: EntitiesGetOptionalParams) => Promise<Entity>

Property Value

(resourceGroupName: string, healthModelName: string, entityName: string, options?: EntitiesGetOptionalParams) => Promise<Entity>

getDataAnnotations

Retrieve data annotations for an entity

getDataAnnotations: (resourceGroupName: string, healthModelName: string, entityName: string, body: GetDataAnnotationsRequest, options?: EntitiesGetDataAnnotationsOptionalParams) => Promise<GetDataAnnotationsResponse>

Property Value

(resourceGroupName: string, healthModelName: string, entityName: string, body: GetDataAnnotationsRequest, options?: EntitiesGetDataAnnotationsOptionalParams) => Promise<GetDataAnnotationsResponse>

getHistory

Retrieve the health state transition history for an entity

getHistory: (resourceGroupName: string, healthModelName: string, entityName: string, body: EntityHistoryRequest, options?: EntitiesGetHistoryOptionalParams) => Promise<EntityHistoryResponse>

Property Value

(resourceGroupName: string, healthModelName: string, entityName: string, body: EntityHistoryRequest, options?: EntitiesGetHistoryOptionalParams) => Promise<EntityHistoryResponse>

getSignalHistory

Retrieve the time series history for a signal on an entity

getSignalHistory: (resourceGroupName: string, healthModelName: string, entityName: string, body: SignalHistoryRequest, options?: EntitiesGetSignalHistoryOptionalParams) => Promise<SignalHistoryResponse>

Property Value

(resourceGroupName: string, healthModelName: string, entityName: string, body: SignalHistoryRequest, options?: EntitiesGetSignalHistoryOptionalParams) => Promise<SignalHistoryResponse>

getSignalRecommendations

Get recommended signal configurations for a given Entity (only applicable for Entities representing Azure resources)

getSignalRecommendations: (resourceGroupName: string, healthModelName: string, entityName: string, options?: EntitiesGetSignalRecommendationsOptionalParams) => Promise<GetSignalRecommendationsResponse>

Property Value

(resourceGroupName: string, healthModelName: string, entityName: string, options?: EntitiesGetSignalRecommendationsOptionalParams) => Promise<GetSignalRecommendationsResponse>

ingestHealthReport

Ingest a health report for a specific signal on an entity (the entity must already exist)

ingestHealthReport: (resourceGroupName: string, healthModelName: string, entityName: string, body: HealthReportRequest, options?: EntitiesIngestHealthReportOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, healthModelName: string, entityName: string, body: HealthReportRequest, options?: EntitiesIngestHealthReportOptionalParams) => Promise<void>

listByHealthModel

List Entity resources by HealthModel

listByHealthModel: (resourceGroupName: string, healthModelName: string, options?: EntitiesListByHealthModelOptionalParams) => PagedAsyncIterableIterator<Entity, Entity[], PageSettings>

Property Value

(resourceGroupName: string, healthModelName: string, options?: EntitiesListByHealthModelOptionalParams) => PagedAsyncIterableIterator<Entity, Entity[], PageSettings>