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

# README

Azure Playwrighttesting Module for Go

The armplaywrighttesting module provides operations for working with Azure Playwrighttesting.

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 Playwrighttesting module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/playwrighttesting/armplaywrighttesting

Authorization

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

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 Playwrighttesting 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

NewAccountQuotasClient creates a new instance of AccountQuotasClient with the specified values.
NewAccountsClient creates a new instance of AccountsClient with the specified values.
NewClientFactory creates a new instance of ClientFactory 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.
PossibleCheckNameAvailabilityReasonValues returns the possible values for the CheckNameAvailabilityReason const type.
PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.
PossibleEnablementStatusValues returns the possible values for the EnablementStatus const type.
PossibleFreeTrialStateValues returns the possible values for the FreeTrialState const type.
PossibleOfferingTypeValues returns the possible values for the OfferingType const type.
PossibleOriginValues returns the possible values for the Origin const type.
PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.
PossibleQuotaNamesValues returns the possible values for the QuotaNames 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
EnablementStatusDisabled - The feature is Disabled.
EnablementStatusEnabled - The feature is Enabled.
FreeTrialStateActive - The free-trial is Active.
FreeTrialStateExpired - The free-trial is Expired.
FreeTrialStateNotEligible - The free-trial is Not Eligible.
FreeTrialStateNotRegistered - The free-trial is Not Registered.
OfferingTypeGeneralAvailability - The offeringType is GeneralAvailability.
OfferingTypeNotApplicable - The offeringType is NotApplicable.
OfferingTypePrivatePreview - The offeringType is PrivatePreview.
OfferingTypePublicPreview - The offeringType is PublicPreview.
No description provided by the author
No description provided by the author
No description provided by the author
ProvisioningStateAccepted - Change accepted for processing..
ProvisioningStateCanceled - Resource creation was canceled.
ProvisioningStateCreating - Creation in progress..
ProvisioningStateDeleting - Deletion in progress..
ProvisioningStateFailed - Resource creation failed.
ProvisioningStateSucceeded - Resource has been created.
QuotaNamesReporting - The quota details for reporting feature.
QuotaNamesScalableExecution - The quota details for scalable execution feature.

# Structs

Account - A Playwright service account resource.
AccountFreeTrialProperties - The Playwright service account quota resource free-trial properties.
AccountListResult - The response of a Account list operation.
AccountProperties - Account resource properties.
AccountQuota - A quota resource for a Playwright service account.
AccountQuotaListResult - The response of a AccountQuota list operation.
AccountQuotaProperties - The Playwright service account quota resource properties.
AccountQuotasClient contains the methods for the AccountQuotas group.
AccountQuotasClientGetOptions contains the optional parameters for the AccountQuotasClient.Get method.
AccountQuotasClientGetResponse contains the response from method AccountQuotasClient.Get.
AccountQuotasClientListByAccountOptions contains the optional parameters for the AccountQuotasClient.NewListByAccountPager method.
AccountQuotasClientListByAccountResponse contains the response from method AccountQuotasClient.NewListByAccountPager.
AccountsClient contains the methods for the Accounts group.
AccountsClientBeginCreateOrUpdateOptions contains the optional parameters for the AccountsClient.BeginCreateOrUpdate method.
AccountsClientBeginDeleteOptions contains the optional parameters for the AccountsClient.BeginDelete method.
AccountsClientCheckNameAvailabilityOptions contains the optional parameters for the AccountsClient.CheckNameAvailability method.
AccountsClientCheckNameAvailabilityResponse contains the response from method AccountsClient.CheckNameAvailability.
AccountsClientCreateOrUpdateResponse contains the response from method AccountsClient.BeginCreateOrUpdate.
AccountsClientDeleteResponse contains the response from method AccountsClient.BeginDelete.
AccountsClientGetOptions contains the optional parameters for the AccountsClient.Get method.
AccountsClientGetResponse contains the response from method AccountsClient.Get.
AccountsClientListByResourceGroupOptions contains the optional parameters for the AccountsClient.NewListByResourceGroupPager method.
AccountsClientListByResourceGroupResponse contains the response from method AccountsClient.NewListByResourceGroupPager.
AccountsClientListBySubscriptionOptions contains the optional parameters for the AccountsClient.NewListBySubscriptionPager method.
AccountsClientListBySubscriptionResponse contains the response from method AccountsClient.NewListBySubscriptionPager.
AccountsClientUpdateOptions contains the optional parameters for the AccountsClient.Update method.
AccountsClientUpdateResponse contains the response from method AccountsClient.Update.
AccountUpdate - The type used for update operations of the Account.
AccountUpdateProperties - The updatable properties of the Account.
CheckNameAvailabilityRequest - The check availability request body.
CheckNameAvailabilityResponse - The check availability result.
ClientFactory is a client factory used to create any client in this module.
FreeTrialProperties - The subscription quota resource free-trial properties.
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.
Quota - A subscription quota resource.
QuotaListResult - The response of a Quota list operation.
QuotaProperties - The subscription quota resource properties.
QuotasClient contains the methods for the Quotas group.
QuotasClientGetOptions contains the optional parameters for the QuotasClient.Get method.
QuotasClientGetResponse contains the response from method QuotasClient.Get.
QuotasClientListBySubscriptionOptions contains the optional parameters for the QuotasClient.NewListBySubscriptionPager method.
QuotasClientListBySubscriptionResponse contains the response from method QuotasClient.NewListBySubscriptionPager.
SystemData - Metadata pertaining to creation and last modification of the resource.

# Type aliases

ActionType - Enum.
CheckNameAvailabilityReason - The reason why the given name is not available.
CreatedByType - The type of identity that created the resource.
EnablementStatus - This property sets the connection region for Playwright client workers to cloud-hosted browsers.
FreeTrialState - The free-trial state.
OfferingType - Offering type state.
Origin - The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX.
ProvisioningState - The status of the current operation.
No description provided by the author