Categorygithub.com/Azure/azure-sdk-for-go/sdk/resourcemanager/loadtesting/armloadtesting
modulepackage
1.2.0
Repository: https://github.com/azure/azure-sdk-for-go.git
Documentation: pkg.go.dev

# README

Azure Load Testing Module for Go

PkgGoDev

The armloadtesting module provides operations for working with Azure Load Testing.

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 Load Testing module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/loadtesting/armloadtesting

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Load Testing. 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 Load Testing 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 := armloadtesting.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 := armloadtesting.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.NewLoadTestsClient()

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 Load Testing 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

NewClientFactory creates a new instance of ClientFactory with the specified values.
NewLoadTestsClient creates a new instance of LoadTestsClient with the specified values.
NewOperationsClient creates a new instance of OperationsClient with the specified values.
NewQuotasClient creates a new instance of QuotasClient with the specified values.
PossibleActionTypeValues returns the possible values for the ActionType const type.
PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.
PossibleManagedServiceIdentityTypeValues returns the possible values for the ManagedServiceIdentityType const type.
PossibleOriginValues returns the possible values for the Origin const type.
PossibleResourceStateValues returns the possible values for the ResourceState 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

# Structs

CheckQuotaAvailabilityResponse - Check quota availability response object.
CheckQuotaAvailabilityResponseProperties - Check quota availability response properties.
ClientFactory is a client factory used to create any client in this module.
EncryptionProperties - Key and identity details for Customer Managed Key encryption of load test resource.
EncryptionPropertiesIdentity - All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
EndpointDependency - A domain name and connection details used to access a dependency.
EndpointDetail - Details about the connection between the Batch service and the endpoint.
LoadTestProperties - LoadTest resource properties.
LoadTestResource - LoadTest details.
LoadTestResourcePageList - List of resources page result.
LoadTestResourcePatchRequestBody - LoadTest resource patch request body.
LoadTestResourcePatchRequestBodyProperties - Load Test resource properties.
LoadTestsClient contains the methods for the LoadTests group.
LoadTestsClientBeginCreateOrUpdateOptions contains the optional parameters for the LoadTestsClient.BeginCreateOrUpdate method.
LoadTestsClientBeginDeleteOptions contains the optional parameters for the LoadTestsClient.BeginDelete method.
LoadTestsClientBeginUpdateOptions contains the optional parameters for the LoadTestsClient.BeginUpdate method.
LoadTestsClientCreateOrUpdateResponse contains the response from method LoadTestsClient.BeginCreateOrUpdate.
LoadTestsClientDeleteResponse contains the response from method LoadTestsClient.BeginDelete.
LoadTestsClientGetOptions contains the optional parameters for the LoadTestsClient.Get method.
LoadTestsClientGetResponse contains the response from method LoadTestsClient.Get.
LoadTestsClientListByResourceGroupOptions contains the optional parameters for the LoadTestsClient.NewListByResourceGroupPager method.
LoadTestsClientListByResourceGroupResponse contains the response from method LoadTestsClient.NewListByResourceGroupPager.
LoadTestsClientListBySubscriptionOptions contains the optional parameters for the LoadTestsClient.NewListBySubscriptionPager method.
LoadTestsClientListBySubscriptionResponse contains the response from method LoadTestsClient.NewListBySubscriptionPager.
LoadTestsClientListOutboundNetworkDependenciesEndpointsOptions contains the optional parameters for the LoadTestsClient.NewListOutboundNetworkDependenciesEndpointsPager method.
LoadTestsClientListOutboundNetworkDependenciesEndpointsResponse contains the response from method LoadTestsClient.NewListOutboundNetworkDependenciesEndpointsPager.
LoadTestsClientUpdateResponse contains the response from method LoadTestsClient.BeginUpdate.
ManagedServiceIdentity - Managed service identity (system assigned and/or user assigned identities).
Operation - Details of a REST API operation, returned from the Resource Provider Operations API.
OperationDisplay - Localized display information for this particular operation.
OperationListResult - A list of REST API operations supported by an Azure Resource Provider.
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.
OutboundEnvironmentEndpoint - A collection of related endpoints from the same service for which the Batch service requires outbound access.
OutboundEnvironmentEndpointCollection - Values returned by the List operation.
QuotaBucketRequest - Request object of new quota for a quota bucket.
QuotaBucketRequestProperties - New quota request request properties.
QuotaBucketRequestPropertiesDimensions - Dimensions for new quota request.
QuotaResource - Quota bucket details object.
QuotaResourceList - List of quota bucket objects.
QuotaResourceProperties - Quota bucket resource properties.
QuotasClient contains the methods for the Quotas group.
QuotasClientCheckAvailabilityOptions contains the optional parameters for the QuotasClient.CheckAvailability method.
QuotasClientCheckAvailabilityResponse contains the response from method QuotasClient.CheckAvailability.
QuotasClientGetOptions contains the optional parameters for the QuotasClient.Get method.
QuotasClientGetResponse contains the response from method QuotasClient.Get.
QuotasClientListOptions contains the optional parameters for the QuotasClient.NewListPager method.
QuotasClientListResponse contains the response from method QuotasClient.NewListPager.
SystemData - Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity - User assigned identity properties.

# Type aliases

ActionType - Enum.
CreatedByType - The type of identity that created the resource.
ManagedServiceIdentityType - Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Origin - The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX.
ResourceState - Resources provisioning states.
Type - Managed identity type to use for accessing encryption key Url.