@azure/arm-elastic package

Classes

MicrosoftElastic

Interfaces

AllTrafficFilters	Interface representing a AllTrafficFilters.
AllTrafficFiltersListOptionalParams	Optional parameters.
AssociateTrafficFilter	Interface representing a AssociateTrafficFilter.
AssociateTrafficFilterAssociateOptionalParams	Optional parameters.
BillingInfo	Interface representing a BillingInfo.
BillingInfoGetOptionalParams	Optional parameters.
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
ConnectedPartnerResources	Interface representing a ConnectedPartnerResources.
ConnectedPartnerResourcesListFormat	Connected Partner Resources List Format
ConnectedPartnerResourcesListNextOptionalParams	Optional parameters.
ConnectedPartnerResourcesListOptionalParams	Optional parameters.
ConnectedPartnerResourcesListResponse	List of all active elastic deployments.
CreateAndAssociateIPFilter	Interface representing a CreateAndAssociateIPFilter.
CreateAndAssociateIPFilterCreateOptionalParams	Optional parameters.
CreateAndAssociatePLFilter	Interface representing a CreateAndAssociatePLFilter.
CreateAndAssociatePLFilterCreateOptionalParams	Optional parameters.
DeploymentInfo	Interface representing a DeploymentInfo.
DeploymentInfoListOptionalParams	Optional parameters.
DeploymentInfoResponse	The properties of deployment in Elastic cloud corresponding to the Elastic monitor resource.
DetachAndDeleteTrafficFilter	Interface representing a DetachAndDeleteTrafficFilter.
DetachAndDeleteTrafficFilterDeleteOptionalParams	Optional parameters.
DetachTrafficFilter	Interface representing a DetachTrafficFilter.
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.
ElasticMonitorResourceListResponse	Response of a list operation.
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
ElasticVersions	Interface representing a ElasticVersions.
ElasticVersionsListNextOptionalParams	Optional parameters.
ElasticVersionsListOptionalParams	Optional parameters.
ElasticVersionsListResponse	List of elastic versions available in a region.
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. (This also follows the OData error response format.).
ErrorResponseBody	Error response body.
ExternalUser	Interface representing a ExternalUser.
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
FilteringTag	The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored.
IdentityProperties	Identity properties.
ListAssociatedTrafficFilters	Interface representing a ListAssociatedTrafficFilters.
ListAssociatedTrafficFiltersListOptionalParams	Optional parameters.
LogRules	Set of rules for sending logs for the Monitor resource.
MarketplaceSaaSInfo	Marketplace SAAS Info of the resource.
MarketplaceSaaSInfoMarketplaceSubscription	Marketplace Subscription
MicrosoftElasticOptionalParams	Optional parameters.
Monitor	Interface representing a Monitor.
MonitorProperties	Properties specific to the monitor resource.
MonitorUpgradeOptionalParams	Optional parameters.
MonitoredResource	The properties of a resource currently being monitored by the Elastic monitor resource.
MonitoredResourceListResponse	Response of a list operation.
MonitoredResources	Interface representing a MonitoredResources.
MonitoredResourcesListNextOptionalParams	Optional parameters.
MonitoredResourcesListOptionalParams	Optional parameters.
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.
MonitoredSubscriptionPropertiesList
MonitoredSubscriptions	Interface representing a MonitoredSubscriptions.
MonitoredSubscriptionsCreateorUpdateOptionalParams	Optional parameters.
MonitoredSubscriptionsDeleteHeaders	Defines headers for MonitoredSubscriptions_delete operation.
MonitoredSubscriptionsDeleteOptionalParams	Optional parameters.
MonitoredSubscriptionsGetOptionalParams	Optional parameters.
MonitoredSubscriptionsListNextOptionalParams	Optional parameters.
MonitoredSubscriptionsListOptionalParams	Optional parameters.
MonitoredSubscriptionsUpdateHeaders	Defines headers for MonitoredSubscriptions_update operation.
MonitoredSubscriptionsUpdateOptionalParams	Optional parameters.
MonitoringTagRules	Capture logs and metrics of Azure resources based on ARM tags.
MonitoringTagRulesListResponse	Response of a list operation.
MonitoringTagRulesProperties	Definition of the properties for a TagRules resource.
Monitors	Interface representing a Monitors.
MonitorsCreateOptionalParams	Optional parameters.
MonitorsDeleteOptionalParams	Optional parameters.
MonitorsGetOptionalParams	Optional parameters.
MonitorsListByResourceGroupNextOptionalParams	Optional parameters.
MonitorsListByResourceGroupOptionalParams	Optional parameters.
MonitorsListNextOptionalParams	Optional parameters.
MonitorsListOptionalParams	Optional parameters.
MonitorsUpdateHeaders	Defines headers for Monitors_update operation.
MonitorsUpdateOptionalParams	Optional parameters.
OpenAI	Interface representing a OpenAI.
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.
OpenAIIntegrationRPModelListResponse	Response of a list operation.
OpenAIIntegrationStatusResponse	Status of the OpenAI Integration
OpenAIIntegrationStatusResponseProperties	Status of the OpenAI Integration
OpenAIListNextOptionalParams	Optional parameters.
OpenAIListOptionalParams	Optional parameters.
OperationDisplay	The object that represents the operation.
OperationListResult	Result of GET request to list the Microsoft.Elastic operations.
OperationResult	A Microsoft.Elastic REST API operation.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
Organizations	Interface representing a Organizations.
OrganizationsGetApiKeyOptionalParams	Optional parameters.
OrganizationsGetElasticToAzureSubscriptionMappingOptionalParams	Optional parameters.
OrganizationsResubscribeHeaders	Defines headers for Organizations_resubscribe operation.
OrganizationsResubscribeOptionalParams	Optional parameters.
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.
ResourceProviderDefaultErrorResponse	RP default error response.
ResourceSku	Microsoft.Elastic SKU.
ResubscribeProperties	Resubscribe Properties
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.
TagRules	Interface representing a TagRules.
TagRulesCreateOrUpdateOptionalParams	Optional parameters.
TagRulesDeleteOptionalParams	Optional parameters.
TagRulesGetOptionalParams	Optional parameters.
TagRulesListNextOptionalParams	Optional parameters.
TagRulesListOptionalParams	Optional parameters.
TrafficFilters	Interface representing a TrafficFilters.
TrafficFiltersDeleteOptionalParams	Optional parameters.
UpgradableVersions	Interface representing a UpgradableVersions.
UpgradableVersionsDetailsOptionalParams	Optional parameters.
UpgradableVersionsList	Stack Versions that this version can upgrade to
UserApiKeyResponse	The User Api Key created for the Organization associated with the User Email Id that was passed in the request
UserApiKeyResponseProperties
UserEmailId	Email Id of the User Organization, of which the API Key must be returned
UserInfo	User Information to be passed to partners.
VMCollection	Interface representing a VMCollection.
VMCollectionUpdate	Update VM resource collection.
VMCollectionUpdateOptionalParams	Optional parameters.
VMHost	Interface representing a VMHost.
VMHostListNextOptionalParams	Optional parameters.
VMHostListOptionalParams	Optional parameters.
VMHostListResponse	Response of a list operation.
VMIngestion	Interface representing a VMIngestion.
VMIngestionDetailsOptionalParams	Optional parameters.
VMIngestionDetailsResponse	The vm ingestion details to install an agent.
VMResources	The vm resource properties that is currently being monitored by the Elastic monitor resource.

Type Aliases

AllTrafficFiltersListResponse	Contains response data for the list operation.
BillingInfoGetResponse	Contains response data for the get operation.
ConfigurationType	Defines values for ConfigurationType. 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
ConnectedPartnerResourcesListNextResponse	Contains response data for the listNext operation.
ConnectedPartnerResourcesListOperationResponse	Contains response data for the list operation.
CreatedByType	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
DeploymentInfoListResponse	Contains response data for the list operation.
ElasticDeploymentStatus	Defines values for ElasticDeploymentStatus. 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
ElasticVersionsListNextResponse	Contains response data for the listNext operation.
ElasticVersionsListOperationResponse	Contains response data for the list operation.
ExternalUserCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
HostingType	Defines values for HostingType. 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	Defines values for LiftrResourceCategories. KnownLiftrResourceCategories can be used interchangeably with LiftrResourceCategories, this enum contains the known values that the service supports. Known values supported by the service Unknown MonitorLogs
ListAssociatedTrafficFiltersListResponse	Contains response data for the list operation.
ManagedIdentityTypes	Defines values for ManagedIdentityTypes. KnownManagedIdentityTypes can be used interchangeably with ManagedIdentityTypes, this enum contains the known values that the service supports. Known values supported by the service SystemAssigned
MonitoredResourcesListNextResponse	Contains response data for the listNext operation.
MonitoredResourcesListResponse	Contains response data for the list operation.
MonitoredSubscriptionsCreateorUpdateResponse	Contains response data for the createorUpdate operation.
MonitoredSubscriptionsDeleteResponse	Contains response data for the delete operation.
MonitoredSubscriptionsGetResponse	Contains response data for the get operation.
MonitoredSubscriptionsListNextResponse	Contains response data for the listNext operation.
MonitoredSubscriptionsListResponse	Contains response data for the list operation.
MonitoredSubscriptionsUpdateResponse	Contains response data for the update operation.
MonitoringStatus	Defines values for MonitoringStatus. 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
MonitorsCreateResponse	Contains response data for the create operation.
MonitorsGetResponse	Contains response data for the get operation.
MonitorsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
MonitorsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
MonitorsListNextResponse	Contains response data for the listNext operation.
MonitorsListResponse	Contains response data for the list operation.
MonitorsUpdateResponse	Contains response data for the update operation.
OpenAICreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
OpenAIGetResponse	Contains response data for the get operation.
OpenAIGetStatusResponse	Contains response data for the getStatus operation.
OpenAIListNextResponse	Contains response data for the listNext operation.
OpenAIListResponse	Contains response data for the list operation.
Operation	Defines values for Operation. 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	Defines values for OperationName. 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
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
OrganizationsGetApiKeyResponse	Contains response data for the getApiKey operation.
OrganizationsGetElasticToAzureSubscriptionMappingResponse	Contains response data for the getElasticToAzureSubscriptionMapping operation.
OrganizationsResubscribeResponse	Contains response data for the resubscribe operation.
ProjectType	Defines values for ProjectType. 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	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
SendingLogs	Defines values for SendingLogs. 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	Defines values for Status. 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	Defines values for TagAction. 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
TagRulesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
TagRulesGetResponse	Contains response data for the get operation.
TagRulesListNextResponse	Contains response data for the listNext operation.
TagRulesListResponse	Contains response data for the list operation.
Type	Defines values for Type. 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
UpgradableVersionsDetailsResponse	Contains response data for the details operation.
VMHostListNextResponse	Contains response data for the listNext operation.
VMHostListOperationResponse	Contains response data for the list operation.
VMIngestionDetailsOperationResponse	Contains response data for the details operation.

Enums

KnownConfigurationType	Known values of ConfigurationType that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownElasticDeploymentStatus	Known values of ElasticDeploymentStatus that the service accepts.
KnownHostingType	Known values of HostingType that the service accepts.
KnownLiftrResourceCategories	Known values of LiftrResourceCategories that the service accepts.
KnownManagedIdentityTypes	Known values of ManagedIdentityTypes that the service accepts.
KnownMonitoringStatus	Known values of MonitoringStatus that the service accepts.
KnownOperation	Known values of Operation that the service accepts.
KnownOperationName	Known values of OperationName that the service accepts.
KnownProjectType	Known values of ProjectType that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.
KnownSendingLogs	Known values of SendingLogs that the service accepts.
KnownStatus	Known values of Status that the service accepts.
KnownTagAction	Known values of TagAction that the service accepts.
KnownType	Known values of Type that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.