@azure/arm-elastic package

Classes

Interfaces

AllTrafficFiltersListOptionalParams	Optional parameters.
AllTrafficFiltersOperations	Interface representing a AllTrafficFilters operations.
AssociateTrafficFilterAssociateOptionalParams	Optional parameters.
AssociateTrafficFilterOperations	Interface representing a AssociateTrafficFilter operations.
BillingInfoGetOptionalParams	Optional parameters.
BillingInfoOperations	Interface representing a BillingInfo operations.
BillingInfoResponse	Marketplace Subscription and Organization details to which resource gets billed into.
CompanyInfo	Company information of the user to be passed to partners.
ConnectedPartnerResourceProperties	Connected Partner Resource Properties
ConnectedPartnerResourcesListFormat	Connected Partner Resources List Format
ConnectedPartnerResourcesListOptionalParams	Optional parameters.
ConnectedPartnerResourcesOperations	Interface representing a ConnectedPartnerResources operations.
CreateAndAssociateIPFilterCreateOptionalParams	Optional parameters.
CreateAndAssociateIPFilterOperations	Interface representing a CreateAndAssociateIPFilter operations.
CreateAndAssociatePLFilterCreateOptionalParams	Optional parameters.
CreateAndAssociatePLFilterOperations	Interface representing a CreateAndAssociatePLFilter operations.
DeploymentInfoListOptionalParams	Optional parameters.
DeploymentInfoOperations	Interface representing a DeploymentInfo operations.
DeploymentInfoResponse	The properties of deployment in Elastic cloud corresponding to the Elastic monitor resource.
DetachAndDeleteTrafficFilterDeleteOptionalParams	Optional parameters.
DetachAndDeleteTrafficFilterOperations	Interface representing a DetachAndDeleteTrafficFilter operations.
DetachTrafficFilterOperations	Interface representing a DetachTrafficFilter operations.
DetachTrafficFilterUpdateOptionalParams	Optional parameters.
ElasticCloudDeployment	Details of the user's elastic deployment associated with the monitor resource.
ElasticCloudUser	Details of the user's elastic account.
ElasticMonitorResource	Monitor resource.
ElasticMonitorResourceUpdateParameters	Monitor resource update parameters.
ElasticMonitorUpgrade	Upgrade elastic monitor version
ElasticOrganizationToAzureSubscriptionMappingResponse	The Azure Subscription ID to which the Organization of the logged in user belongs and gets billed into.
ElasticOrganizationToAzureSubscriptionMappingResponseProperties	The properties of Azure Subscription ID to which the Organization of the logged in user belongs and gets billed into.
ElasticProperties	Elastic Resource Properties.
ElasticTrafficFilter	Elastic traffic filter object
ElasticTrafficFilterResponse	List of elastic traffic filters in the account
ElasticTrafficFilterRule	Elastic traffic filter rule object
ElasticVersionListFormat	Elastic Version List Format
ElasticVersionListProperties	Elastic Version Properties
ElasticVersionsListOptionalParams	Optional parameters.
ElasticVersionsOperations	Interface representing a ElasticVersions operations.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
ErrorResponseBody	Error response body.
ExternalUserCreateOrUpdateOptionalParams	Optional parameters.
ExternalUserCreationResponse	The properties of the response we got from elastic while creating external user
ExternalUserInfo	The properties of the request required for creating user on elastic side
ExternalUserOperations	Interface representing a ExternalUser operations.
FilteringTag	The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored.
IdentityProperties	Identity properties.
ListAssociatedTrafficFiltersListOptionalParams	Optional parameters.
ListAssociatedTrafficFiltersOperations	Interface representing a ListAssociatedTrafficFilters operations.
LogRules	Set of rules for sending logs for the Monitor resource.
MarketplaceSaaSInfo	Marketplace SAAS Info of the resource.
MarketplaceSaaSInfoMarketplaceSubscription	Marketplace Subscription
MicrosoftElasticOptionalParams	Optional parameters for the client.
MonitorOperations	Interface representing a Monitor operations.
MonitorProperties	Properties specific to the monitor resource.
MonitorUpgradeOptionalParams	Optional parameters.
MonitoredResource	The properties of a resource currently being monitored by the Elastic monitor resource.
MonitoredResourcesListOptionalParams	Optional parameters.
MonitoredResourcesOperations	Interface representing a MonitoredResources operations.
MonitoredSubscription	The list of subscriptions and it's monitoring status by current Elastic monitor.
MonitoredSubscriptionProperties	The request to update subscriptions needed to be monitored by the Elastic monitor resource.
MonitoredSubscriptionsCreateorUpdateOptionalParams	Optional parameters.
MonitoredSubscriptionsDeleteOptionalParams	Optional parameters.
MonitoredSubscriptionsGetOptionalParams	Optional parameters.
MonitoredSubscriptionsListOptionalParams	Optional parameters.
MonitoredSubscriptionsOperations	Interface representing a MonitoredSubscriptions operations.
MonitoredSubscriptionsUpdateOptionalParams	Optional parameters.
MonitoringTagRules	Capture logs and metrics of Azure resources based on ARM tags.
MonitoringTagRulesProperties	Definition of the properties for a TagRules resource.
MonitorsCreateOptionalParams	Optional parameters.
MonitorsDeleteOptionalParams	Optional parameters.
MonitorsGetOptionalParams	Optional parameters.
MonitorsListByResourceGroupOptionalParams	Optional parameters.
MonitorsListOptionalParams	Optional parameters.
MonitorsOperations	Interface representing a Monitors operations.
MonitorsUpdateOptionalParams	Optional parameters.
OpenAICreateOrUpdateOptionalParams	Optional parameters.
OpenAIDeleteOptionalParams	Optional parameters.
OpenAIGetOptionalParams	Optional parameters.
OpenAIGetStatusOptionalParams	Optional parameters.
OpenAIIntegrationProperties	Open AI Integration details.
OpenAIIntegrationRPModel	Capture properties of Open AI resource Integration.
OpenAIIntegrationStatusResponse	Status of the OpenAI Integration
OpenAIIntegrationStatusResponseProperties	Status of the OpenAI Integration
OpenAIListOptionalParams	Optional parameters.
OpenAIOperations	Interface representing a OpenAI operations.
OperationDisplay	Represents the display information for an operation.
OperationResult	A Microsoft.Elastic REST API operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
OrganizationsGetApiKeyOptionalParams	Optional parameters.
OrganizationsGetElasticToAzureSubscriptionMappingOptionalParams	Optional parameters.
OrganizationsOperations	Interface representing a Organizations operations.
OrganizationsResubscribeOptionalParams	Optional parameters.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PartnerBillingEntity	Partner Billing details associated with the resource.
PlanDetails	Plan details of the monitor resource.
ProjectDetails	Project details of the monitor resource IF it belongs to Serverless offer kind.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceProviderDefaultErrorResponse	RP default error response.
ResourceSku	Represents the SKU of a resource.
RestorePollerOptions
ResubscribeProperties	Resubscribe Properties
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SubscriptionList	The request to update subscriptions needed to be monitored by the Elastic monitor resource.
SystemData	Metadata pertaining to creation and last modification of the resource.
TagRulesCreateOrUpdateOptionalParams	Optional parameters.
TagRulesDeleteOptionalParams	Optional parameters.
TagRulesGetOptionalParams	Optional parameters.
TagRulesListOptionalParams	Optional parameters.
TagRulesOperations	Interface representing a TagRules operations.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
TrafficFiltersDeleteOptionalParams	Optional parameters.
TrafficFiltersOperations	Interface representing a TrafficFilters operations.
UpgradableVersionsDetailsOptionalParams	Optional parameters.
UpgradableVersionsList	Stack Versions that this version can upgrade to
UpgradableVersionsOperations	Interface representing a UpgradableVersions operations.
UserApiKeyResponse	The User Api Key created for the Organization associated with the User Email Id that was passed in the request
UserApiKeyResponseProperties	model interface UserApiKeyResponseProperties
UserEmailId	Email Id of the User Organization, of which the API Key must be returned
UserInfo	User Information to be passed to partners.
VMCollectionUpdate	Update VM resource collection.
VMIngestionDetailsResponse	The vm ingestion details to install an agent.
VMResources	The vm resource properties that is currently being monitored by the Elastic monitor resource.
vMCollectionOperations	Interface representing a vMCollection operations.
vMCollectionUpdateOptionalParams	Optional parameters.
vMHostListOptionalParams	Optional parameters.
vMHostOperations	Interface representing a vMHost operations.
vMIngestionDetailsOptionalParams	Optional parameters.
vMIngestionOperations	Interface representing a vMIngestion operations.

Type Aliases

AzureSupportedClouds	The supported values for cloud setting as a string literal type
ConfigurationType	Configuration type of the Elasticsearch project KnownConfigurationType can be used interchangeably with ConfigurationType, this enum contains the known values that the service supports. Known values supported by the service GeneralPurpose Vector TimeSeries NotApplicable
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
ElasticDeploymentStatus	Flag specifying if the Elastic deployment status is healthy or not. KnownElasticDeploymentStatus can be used interchangeably with ElasticDeploymentStatus, this enum contains the known values that the service supports. Known values supported by the service Healthy Unhealthy
HostingType	Hosting type of the monitor resource - either Hosted deployments or Serverless Projects. KnownHostingType can be used interchangeably with HostingType, this enum contains the known values that the service supports. Known values supported by the service Hosted Serverless
LiftrResourceCategories	Type of LiftrResourceCategories
ManagedIdentityTypes	Managed Identity types. KnownManagedIdentityTypes can be used interchangeably with ManagedIdentityTypes, this enum contains the known values that the service supports. Known values supported by the service SystemAssigned
MonitoringStatus	Flag specifying if the resource monitoring is enabled or disabled. KnownMonitoringStatus can be used interchangeably with MonitoringStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
Operation	The operation for the patch on the resource. KnownOperation can be used interchangeably with Operation, this enum contains the known values that the service supports. Known values supported by the service AddBegin AddComplete DeleteBegin DeleteComplete Active
OperationName	Operation to be performed on the given vm resource id. KnownOperationName can be used interchangeably with OperationName, this enum contains the known values that the service supports. Known values supported by the service Add Delete
ProjectType	Project type; ex: Elasticsearch / Observability / Security KnownProjectType can be used interchangeably with ProjectType, this enum contains the known values that the service supports. Known values supported by the service Elasticsearch Observability Security NotApplicable
ProvisioningState	Provisioning state of Elastic resource. 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
SendingLogs	Flag indicating the status of the resource for sending logs operation to Elastic. KnownSendingLogs can be used interchangeably with SendingLogs, this enum contains the known values that the service supports. Known values supported by the service True False
Status	The state of monitoring. KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports. Known values supported by the service InProgress Active Failed Deleting
TagAction	Valid actions for a filtering tag. Exclusion takes priority over inclusion. KnownTagAction can be used interchangeably with TagAction, this enum contains the known values that the service supports. Known values supported by the service Include Exclude
Type	Type of the elastic filter KnownType can be used interchangeably with Type, this enum contains the known values that the service supports. Known values supported by the service ip azure_private_endpoint

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownConfigurationType	Configuration type of the Elasticsearch project
KnownCreatedByType	The kind of entity that created the resource.
KnownElasticDeploymentStatus	Flag specifying if the Elastic deployment status is healthy or not.
KnownHostingType	Hosting type of the monitor resource - either Hosted deployments or Serverless Projects.
KnownLiftrResourceCategories	Known values of LiftrResourceCategories that the service accepts.
KnownManagedIdentityTypes	Managed Identity types.
KnownMonitoringStatus	Flag specifying if the resource monitoring is enabled or disabled.
KnownOperation	The operation for the patch on the resource.
KnownOperationName	Operation to be performed on the given vm resource id.
KnownProjectType	Project type; ex: Elasticsearch / Observability / Security
KnownProvisioningState	Provisioning state of Elastic resource.
KnownSendingLogs	Flag indicating the status of the resource for sending logs operation to Elastic.
KnownStatus	The state of monitoring.
KnownTagAction	Valid actions for a filtering tag. Exclusion takes priority over inclusion.
KnownType	Type of the elastic filter
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(MicrosoftElastic, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(MicrosoftElastic, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: MicrosoftElastic, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: MicrosoftElastic

serializedState: string

sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

@azure/arm-elastic package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

restorePoller<TResponse, TResult>(MicrosoftElastic, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Parameters

Returns

Variable Details

RestError

Type

Feedback