Categorygithub.com/Azure/azure-sdk-for-go/sdk/resourcemanager/elastic/armelastic
modulepackage
1.0.0
Repository: https://github.com/azure/azure-sdk-for-go.git
Documentation: pkg.go.dev

# README

Azure Elastic Module for Go

PkgGoDev

The armelastic module provides operations for working with Azure Elastic.

Source code

Getting started

Prerequisites

  • an Azure subscription
  • Go 1.18 or above (You could download and install the latest version of Go from here. It will replace the existing Go on your machine. If you want to install multiple Go versions on the same machine, you could refer this doc.)

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Elastic module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/elastic/armelastic

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Elastic. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Client Factory

Azure Elastic module consists of one or more clients. We provide a client factory which could be used to create any client in this module.

clientFactory, err := armelastic.NewClientFactory(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
clientFactory, err := armelastic.NewClientFactory(<subscription ID>, cred, &options)

Clients

A client groups a set of related APIs, providing access to its functionality. Create one or more clients to access the APIs you require using client factory.

client := clientFactory.NewAllTrafficFiltersClient()

Fakes

The fake package contains types used for constructing in-memory fake servers used in unit tests. This allows writing tests to cover various success/error conditions without the need for connecting to a live service.

Please see https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/samples/fakes for details and examples on how to use fakes.

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Elastic label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

# Packages

No description provided by the author

# Functions

NewAllTrafficFiltersClient creates a new instance of AllTrafficFiltersClient with the specified values.
NewAssociateTrafficFilterClient creates a new instance of AssociateTrafficFilterClient with the specified values.
NewBillingInfoClient creates a new instance of BillingInfoClient with the specified values.
NewClientFactory creates a new instance of ClientFactory with the specified values.
NewConnectedPartnerResourcesClient creates a new instance of ConnectedPartnerResourcesClient with the specified values.
NewCreateAndAssociateIPFilterClient creates a new instance of CreateAndAssociateIPFilterClient with the specified values.
NewCreateAndAssociatePLFilterClient creates a new instance of CreateAndAssociatePLFilterClient with the specified values.
NewDeploymentInfoClient creates a new instance of DeploymentInfoClient with the specified values.
NewDetachAndDeleteTrafficFilterClient creates a new instance of DetachAndDeleteTrafficFilterClient with the specified values.
NewDetachTrafficFilterClient creates a new instance of DetachTrafficFilterClient with the specified values.
NewExternalUserClient creates a new instance of ExternalUserClient with the specified values.
NewListAssociatedTrafficFiltersClient creates a new instance of ListAssociatedTrafficFiltersClient with the specified values.
NewMonitorClient creates a new instance of MonitorClient with the specified values.
NewMonitoredResourcesClient creates a new instance of MonitoredResourcesClient with the specified values.
NewMonitorsClient creates a new instance of MonitorsClient with the specified values.
NewOpenAIClient creates a new instance of OpenAIClient with the specified values.
NewOperationsClient creates a new instance of OperationsClient with the specified values.
NewOrganizationsClient creates a new instance of OrganizationsClient with the specified values.
NewTagRulesClient creates a new instance of TagRulesClient with the specified values.
NewTrafficFiltersClient creates a new instance of TrafficFiltersClient with the specified values.
NewUpgradableVersionsClient creates a new instance of UpgradableVersionsClient with the specified values.
NewVersionsClient creates a new instance of VersionsClient with the specified values.
NewVMCollectionClient creates a new instance of VMCollectionClient with the specified values.
NewVMHostClient creates a new instance of VMHostClient with the specified values.
NewVMIngestionClient creates a new instance of VMIngestionClient with the specified values.
PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.
PossibleElasticDeploymentStatusValues returns the possible values for the ElasticDeploymentStatus const type.
PossibleLiftrResourceCategoriesValues returns the possible values for the LiftrResourceCategories const type.
PossibleManagedIdentityTypesValues returns the possible values for the ManagedIdentityTypes const type.
PossibleMonitoringStatusValues returns the possible values for the MonitoringStatus const type.
PossibleOperationNameValues returns the possible values for the OperationName const type.
PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.
PossibleSendingLogsValues returns the possible values for the SendingLogs const type.
PossibleTagActionValues returns the possible values for the TagAction const type.
PossibleTypeValues returns the possible values for the Type const type.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

AllTrafficFiltersClient contains the methods for the AllTrafficFilters group.
AllTrafficFiltersClientListOptions contains the optional parameters for the AllTrafficFiltersClient.List method.
AllTrafficFiltersClientListResponse contains the response from method AllTrafficFiltersClient.List.
AssociateTrafficFilterClient contains the methods for the AssociateTrafficFilter group.
AssociateTrafficFilterClientAssociateResponse contains the response from method AssociateTrafficFilterClient.BeginAssociate.
AssociateTrafficFilterClientBeginAssociateOptions contains the optional parameters for the AssociateTrafficFilterClient.BeginAssociate method.
BillingInfoClient contains the methods for the BillingInfo group.
BillingInfoClientGetOptions contains the optional parameters for the BillingInfoClient.Get method.
BillingInfoClientGetResponse contains the response from method BillingInfoClient.Get.
BillingInfoResponse - Marketplace Subscription and Organization details to which resource gets billed into.
ClientFactory is a client factory used to create any client in this module.
CloudDeployment - Details of the user's elastic deployment associated with the monitor resource.
CloudUser - Details of the user's elastic account.
CompanyInfo - Company information of the user to be passed to partners.
ConnectedPartnerResourceProperties - Connected Partner Resource Properties.
ConnectedPartnerResourcesClient contains the methods for the ConnectedPartnerResources group.
ConnectedPartnerResourcesClientListOptions contains the optional parameters for the ConnectedPartnerResourcesClient.NewListPager method.
ConnectedPartnerResourcesClientListResponse contains the response from method ConnectedPartnerResourcesClient.NewListPager.
ConnectedPartnerResourcesListFormat - Connected Partner Resources List Format.
ConnectedPartnerResourcesListResponse - List of all active elastic deployments.
CreateAndAssociateIPFilterClient contains the methods for the CreateAndAssociateIPFilter group.
CreateAndAssociateIPFilterClientBeginCreateOptions contains the optional parameters for the CreateAndAssociateIPFilterClient.BeginCreate method.
CreateAndAssociateIPFilterClientCreateResponse contains the response from method CreateAndAssociateIPFilterClient.BeginCreate.
CreateAndAssociatePLFilterClient contains the methods for the CreateAndAssociatePLFilter group.
CreateAndAssociatePLFilterClientBeginCreateOptions contains the optional parameters for the CreateAndAssociatePLFilterClient.BeginCreate method.
CreateAndAssociatePLFilterClientCreateResponse contains the response from method CreateAndAssociatePLFilterClient.BeginCreate.
DeploymentInfoClient contains the methods for the DeploymentInfo group.
DeploymentInfoClientListOptions contains the optional parameters for the DeploymentInfoClient.List method.
DeploymentInfoClientListResponse contains the response from method DeploymentInfoClient.List.
DeploymentInfoResponse - The properties of deployment in Elastic cloud corresponding to the Elastic monitor resource.
DetachAndDeleteTrafficFilterClient contains the methods for the DetachAndDeleteTrafficFilter group.
DetachAndDeleteTrafficFilterClientDeleteOptions contains the optional parameters for the DetachAndDeleteTrafficFilterClient.Delete method.
DetachAndDeleteTrafficFilterClientDeleteResponse contains the response from method DetachAndDeleteTrafficFilterClient.Delete.
DetachTrafficFilterClient contains the methods for the DetachTrafficFilter group.
DetachTrafficFilterClientBeginUpdateOptions contains the optional parameters for the DetachTrafficFilterClient.BeginUpdate method.
DetachTrafficFilterClientUpdateResponse contains the response from method DetachTrafficFilterClient.BeginUpdate.
ExternalUserClient contains the methods for the ExternalUser group.
ExternalUserClientCreateOrUpdateOptions contains the optional parameters for the ExternalUserClient.CreateOrUpdate method.
ExternalUserClientCreateOrUpdateResponse contains the response from method ExternalUserClient.CreateOrUpdate.
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.
IdentityProperties - Identity properties.
ListAssociatedTrafficFiltersClient contains the methods for the ListAssociatedTrafficFilters group.
ListAssociatedTrafficFiltersClientListOptions contains the optional parameters for the ListAssociatedTrafficFiltersClient.List method.
ListAssociatedTrafficFiltersClientListResponse contains the response from method ListAssociatedTrafficFiltersClient.List.
LogRules - Set of rules for sending logs for the Monitor resource.
MarketplaceSaaSInfo - Marketplace SAAS Info of the resource.
MarketplaceSaaSInfoMarketplaceSubscription - Marketplace Subscription.
MonitorClient contains the methods for the Monitor group.
MonitorClientBeginUpgradeOptions contains the optional parameters for the MonitorClient.BeginUpgrade method.
MonitorClientUpgradeResponse contains the response from method MonitorClient.BeginUpgrade.
MonitoredResource - The properties of a resource currently being monitored by the Elastic monitor resource.
MonitoredResourceListResponse - Response of a list operation.
MonitoredResourcesClient contains the methods for the MonitoredResources group.
MonitoredResourcesClientListOptions contains the optional parameters for the MonitoredResourcesClient.NewListPager method.
MonitoredResourcesClientListResponse contains the response from method MonitoredResourcesClient.NewListPager.
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.
MonitorProperties - Properties specific to the monitor resource.
MonitorResource - Monitor resource.
MonitorResourceListResponse - Response of a list operation.
MonitorResourceUpdateParameters - Monitor resource update parameters.
MonitorsClient contains the methods for the Monitors group.
MonitorsClientBeginCreateOptions contains the optional parameters for the MonitorsClient.BeginCreate method.
MonitorsClientBeginDeleteOptions contains the optional parameters for the MonitorsClient.BeginDelete method.
MonitorsClientCreateResponse contains the response from method MonitorsClient.BeginCreate.
MonitorsClientDeleteResponse contains the response from method MonitorsClient.BeginDelete.
MonitorsClientGetOptions contains the optional parameters for the MonitorsClient.Get method.
MonitorsClientGetResponse contains the response from method MonitorsClient.Get.
MonitorsClientListByResourceGroupOptions contains the optional parameters for the MonitorsClient.NewListByResourceGroupPager method.
MonitorsClientListByResourceGroupResponse contains the response from method MonitorsClient.NewListByResourceGroupPager.
MonitorsClientListOptions contains the optional parameters for the MonitorsClient.NewListPager method.
MonitorsClientListResponse contains the response from method MonitorsClient.NewListPager.
MonitorsClientUpdateOptions contains the optional parameters for the MonitorsClient.Update method.
MonitorsClientUpdateResponse contains the response from method MonitorsClient.Update.
MonitorUpgrade - Upgrade elastic monitor version.
OpenAIClient contains the methods for the OpenAI group.
OpenAIClientCreateOrUpdateOptions contains the optional parameters for the OpenAIClient.CreateOrUpdate method.
OpenAIClientCreateOrUpdateResponse contains the response from method OpenAIClient.CreateOrUpdate.
OpenAIClientDeleteOptions contains the optional parameters for the OpenAIClient.Delete method.
OpenAIClientDeleteResponse contains the response from method OpenAIClient.Delete.
OpenAIClientGetOptions contains the optional parameters for the OpenAIClient.Get method.
OpenAIClientGetResponse contains the response from method OpenAIClient.Get.
OpenAIClientGetStatusOptions contains the optional parameters for the OpenAIClient.GetStatus method.
OpenAIClientGetStatusResponse contains the response from method OpenAIClient.GetStatus.
OpenAIClientListOptions contains the optional parameters for the OpenAIClient.NewListPager method.
OpenAIClientListResponse contains the response from method OpenAIClient.NewListPager.
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.
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.
OperationsClient contains the methods for the Operations group.
OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
OperationsClientListResponse contains the response from method OperationsClient.NewListPager.
OrganizationsClient contains the methods for the Organizations group.
OrganizationsClientGetAPIKeyOptions contains the optional parameters for the OrganizationsClient.GetAPIKey method.
OrganizationsClientGetAPIKeyResponse contains the response from method OrganizationsClient.GetAPIKey.
OrganizationsClientGetElasticToAzureSubscriptionMappingOptions contains the optional parameters for the OrganizationsClient.GetElasticToAzureSubscriptionMapping method.
OrganizationsClientGetElasticToAzureSubscriptionMappingResponse contains the response from method OrganizationsClient.GetElasticToAzureSubscriptionMapping.
OrganizationToAzureSubscriptionMappingResponse - The Azure Subscription ID to which the Organization of the logged in user belongs and gets billed into.
OrganizationToAzureSubscriptionMappingResponseProperties - The properties of Azure Subscription ID to which the Organization of the logged in user belongs and gets billed into.
PartnerBillingEntity - Partner Billing details associated with the resource.
PlanDetails - Plan details of the monitor resource.
Properties - Elastic Resource Properties.
ResourceSKU - Microsoft.Elastic SKU.
SystemData - Metadata pertaining to creation and last modification of the resource.
TagRulesClient contains the methods for the TagRules group.
TagRulesClientBeginDeleteOptions contains the optional parameters for the TagRulesClient.BeginDelete method.
TagRulesClientCreateOrUpdateOptions contains the optional parameters for the TagRulesClient.CreateOrUpdate method.
TagRulesClientCreateOrUpdateResponse contains the response from method TagRulesClient.CreateOrUpdate.
TagRulesClientDeleteResponse contains the response from method TagRulesClient.BeginDelete.
TagRulesClientGetOptions contains the optional parameters for the TagRulesClient.Get method.
TagRulesClientGetResponse contains the response from method TagRulesClient.Get.
TagRulesClientListOptions contains the optional parameters for the TagRulesClient.NewListPager method.
TagRulesClientListResponse contains the response from method TagRulesClient.NewListPager.
TrafficFilter - Elastic traffic filter object.
TrafficFilterResponse - List of elastic traffic filters in the account.
TrafficFilterRule - Elastic traffic filter rule object.
TrafficFiltersClient contains the methods for the TrafficFilters group.
TrafficFiltersClientDeleteOptions contains the optional parameters for the TrafficFiltersClient.Delete method.
TrafficFiltersClientDeleteResponse contains the response from method TrafficFiltersClient.Delete.
UpgradableVersionsClient contains the methods for the UpgradableVersions group.
UpgradableVersionsClientDetailsOptions contains the optional parameters for the UpgradableVersionsClient.Details method.
UpgradableVersionsClientDetailsResponse contains the response from method UpgradableVersionsClient.Details.
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.
No description provided by the author
UserEmailID - Email Id of the User Organization, of which the API Key must be returned.
UserInfo - User Information to be passed to partners.
VersionListFormat - Elastic Version List Format.
VersionListProperties - Elastic Version Properties.
VersionsClient contains the methods for the ElasticVersions group.
VersionsClientListOptions contains the optional parameters for the VersionsClient.NewListPager method.
VersionsClientListResponse contains the response from method VersionsClient.NewListPager.
VersionsListResponse - List of elastic versions available in a region.
VMCollectionClient contains the methods for the VMCollection group.
VMCollectionClientUpdateOptions contains the optional parameters for the VMCollectionClient.Update method.
VMCollectionClientUpdateResponse contains the response from method VMCollectionClient.Update.
VMCollectionUpdate - Update VM resource collection.
VMHostClient contains the methods for the VMHost group.
VMHostClientListOptions contains the optional parameters for the VMHostClient.NewListPager method.
VMHostClientListResponse contains the response from method VMHostClient.NewListPager.
VMHostListResponse - Response of a list operation.
VMIngestionClient contains the methods for the VMIngestion group.
VMIngestionClientDetailsOptions contains the optional parameters for the VMIngestionClient.Details method.
VMIngestionClientDetailsResponse contains the response from method VMIngestionClient.Details.
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

CreatedByType - The type of identity that created the resource.
ElasticDeploymentStatus - Flag specifying if the Elastic deployment status is healthy or not.
No description provided by the author
ManagedIdentityTypes - Managed Identity types.
MonitoringStatus - Flag specifying if the resource monitoring is enabled or disabled.
OperationName - Operation to be performed on the given vm resource id.
ProvisioningState - Provisioning state of Elastic resource.
SendingLogs - Flag indicating the status of the resource for sending logs operation to Elastic.
TagAction - Valid actions for a filtering tag.
Type - Type of the elastic filter.