Categorygithub.com/Azure/azure-sdk-for-go/sdk/resourcemanager/integrationspaces/armintegrationspaces
modulepackage
0.1.0
Repository: https://github.com/azure/azure-sdk-for-go.git
Documentation: pkg.go.dev

# README

Azure Integrationspaces Module for Go

PkgGoDev

The armintegrationspaces module provides operations for working with Azure Integrationspaces.

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

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/integrationspaces/armintegrationspaces

Authorization

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

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

NewApplicationResourcesClient creates a new instance of ApplicationResourcesClient with the specified values.
NewApplicationsClient creates a new instance of ApplicationsClient with the specified values.
NewBusinessProcessesClient creates a new instance of BusinessProcessesClient with the specified values.
NewBusinessProcessVersionsClient creates a new instance of BusinessProcessVersionsClient with the specified values.
NewClientFactory creates a new instance of ClientFactory with the specified values.
NewInfrastructureResourcesClient creates a new instance of InfrastructureResourcesClient with the specified values.
NewOperationsClient creates a new instance of OperationsClient with the specified values.
NewSpacesClient creates a new instance of SpacesClient with the specified values.
PossibleActionTypeValues returns the possible values for the ActionType const type.
PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.
PossibleOriginValues returns the possible values for the Origin const type.
PossibleProvisioningStateValues returns the possible values for the ProvisioningState 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
ProvisioningStateCanceled - Resource creation was canceled.
No description provided by the author
ProvisioningStateFailed - Resource creation failed.
No description provided by the author
ProvisioningStateSucceeded - Resource has been created.
No description provided by the author

# Structs

Application - An integration application under space.
ApplicationListResult - The response of a Application list operation.
ApplicationProperties - The properties of application.
ApplicationResource - A resource under application.
ApplicationResourceListResult - The response of a ApplicationResource list operation.
ApplicationResourceProperties - The properties of application resource.
ApplicationResourcesClient contains the methods for the ApplicationResources group.
ApplicationResourcesClientCreateOrUpdateOptions contains the optional parameters for the ApplicationResourcesClient.CreateOrUpdate method.
ApplicationResourcesClientCreateOrUpdateResponse contains the response from method ApplicationResourcesClient.CreateOrUpdate.
ApplicationResourcesClientDeleteOptions contains the optional parameters for the ApplicationResourcesClient.Delete method.
ApplicationResourcesClientDeleteResponse contains the response from method ApplicationResourcesClient.Delete.
ApplicationResourcesClientGetOptions contains the optional parameters for the ApplicationResourcesClient.Get method.
ApplicationResourcesClientGetResponse contains the response from method ApplicationResourcesClient.Get.
ApplicationResourcesClientListByApplicationOptions contains the optional parameters for the ApplicationResourcesClient.NewListByApplicationPager method.
ApplicationResourcesClientListByApplicationResponse contains the response from method ApplicationResourcesClient.NewListByApplicationPager.
ApplicationResourcesClientPatchOptions contains the optional parameters for the ApplicationResourcesClient.Patch method.
ApplicationResourcesClientPatchResponse contains the response from method ApplicationResourcesClient.Patch.
ApplicationResourceUpdate - The type used for update operations of the ApplicationResource.
ApplicationResourceUpdateProperties - The updatable properties of the ApplicationResource.
ApplicationsClient contains the methods for the Applications group.
ApplicationsClientCreateOrUpdateOptions contains the optional parameters for the ApplicationsClient.CreateOrUpdate method.
ApplicationsClientCreateOrUpdateResponse contains the response from method ApplicationsClient.CreateOrUpdate.
ApplicationsClientDeleteBusinessProcessDevelopmentArtifactOptions contains the optional parameters for the ApplicationsClient.DeleteBusinessProcessDevelopmentArtifact method.
ApplicationsClientDeleteBusinessProcessDevelopmentArtifactResponse contains the response from method ApplicationsClient.DeleteBusinessProcessDevelopmentArtifact.
ApplicationsClientDeleteOptions contains the optional parameters for the ApplicationsClient.Delete method.
ApplicationsClientDeleteResponse contains the response from method ApplicationsClient.Delete.
ApplicationsClientGetBusinessProcessDevelopmentArtifactOptions contains the optional parameters for the ApplicationsClient.GetBusinessProcessDevelopmentArtifact method.
ApplicationsClientGetBusinessProcessDevelopmentArtifactResponse contains the response from method ApplicationsClient.GetBusinessProcessDevelopmentArtifact.
ApplicationsClientGetOptions contains the optional parameters for the ApplicationsClient.Get method.
ApplicationsClientGetResponse contains the response from method ApplicationsClient.Get.
ApplicationsClientListBusinessProcessDevelopmentArtifactsOptions contains the optional parameters for the ApplicationsClient.ListBusinessProcessDevelopmentArtifacts method.
ApplicationsClientListBusinessProcessDevelopmentArtifactsResponse contains the response from method ApplicationsClient.ListBusinessProcessDevelopmentArtifacts.
ApplicationsClientListBySpaceOptions contains the optional parameters for the ApplicationsClient.NewListBySpacePager method.
ApplicationsClientListBySpaceResponse contains the response from method ApplicationsClient.NewListBySpacePager.
ApplicationsClientPatchOptions contains the optional parameters for the ApplicationsClient.Patch method.
ApplicationsClientPatchResponse contains the response from method ApplicationsClient.Patch.
ApplicationsClientSaveBusinessProcessDevelopmentArtifactOptions contains the optional parameters for the ApplicationsClient.SaveBusinessProcessDevelopmentArtifact method.
ApplicationsClientSaveBusinessProcessDevelopmentArtifactResponse contains the response from method ApplicationsClient.SaveBusinessProcessDevelopmentArtifact.
ApplicationsClientValidateBusinessProcessDevelopmentArtifactOptions contains the optional parameters for the ApplicationsClient.ValidateBusinessProcessDevelopmentArtifact method.
ApplicationsClientValidateBusinessProcessDevelopmentArtifactResponse contains the response from method ApplicationsClient.ValidateBusinessProcessDevelopmentArtifact.
ApplicationUpdate - The type used for update operations of the Application.
ApplicationUpdateProperties - The updatable properties of the Application.
BusinessProcess - A business process under application.
BusinessProcessDevelopmentArtifactProperties - The properties of business process development artifact.
BusinessProcessesClient contains the methods for the BusinessProcesses group.
BusinessProcessesClientCreateOrUpdateOptions contains the optional parameters for the BusinessProcessesClient.CreateOrUpdate method.
BusinessProcessesClientCreateOrUpdateResponse contains the response from method BusinessProcessesClient.CreateOrUpdate.
BusinessProcessesClientDeleteOptions contains the optional parameters for the BusinessProcessesClient.Delete method.
BusinessProcessesClientDeleteResponse contains the response from method BusinessProcessesClient.Delete.
BusinessProcessesClientGetOptions contains the optional parameters for the BusinessProcessesClient.Get method.
BusinessProcessesClientGetResponse contains the response from method BusinessProcessesClient.Get.
BusinessProcessesClientListByApplicationOptions contains the optional parameters for the BusinessProcessesClient.NewListByApplicationPager method.
BusinessProcessesClientListByApplicationResponse contains the response from method BusinessProcessesClient.NewListByApplicationPager.
BusinessProcessesClientPatchOptions contains the optional parameters for the BusinessProcessesClient.Patch method.
BusinessProcessesClientPatchResponse contains the response from method BusinessProcessesClient.Patch.
BusinessProcessIdentifier - The properties of business process identifier.
BusinessProcessListResult - The response of a BusinessProcess list operation.
BusinessProcessMappingItem - The properties of business process mapping.
BusinessProcessProperties - The properties of business process.
BusinessProcessReference - The business process reference.
BusinessProcessStage - The properties of business process stage.
BusinessProcessUpdate - The type used for update operations of the BusinessProcess.
BusinessProcessUpdateProperties - The updatable properties of the BusinessProcess.
BusinessProcessVersion - A business process version.
BusinessProcessVersionListResult - The response of a BusinessProcessVersion list operation.
BusinessProcessVersionsClient contains the methods for the BusinessProcessVersions group.
BusinessProcessVersionsClientGetOptions contains the optional parameters for the BusinessProcessVersionsClient.Get method.
BusinessProcessVersionsClientGetResponse contains the response from method BusinessProcessVersionsClient.Get.
BusinessProcessVersionsClientListByBusinessProcessOptions contains the optional parameters for the BusinessProcessVersionsClient.NewListByBusinessProcessPager method.
BusinessProcessVersionsClientListByBusinessProcessResponse contains the response from method BusinessProcessVersionsClient.NewListByBusinessProcessPager.
ClientFactory is a client factory used to create any client in this module.
FlowTrackingDefinition - The workflow tracking definition.
GetOrDeleteBusinessProcessDevelopmentArtifactRequest - The business process development artifact get or delete request.
InfrastructureResource - An infrastructure resource under Space.
InfrastructureResourceListResult - The response of a InfrastructureResource list operation.
InfrastructureResourceProperties - The properties of infrastructure resource.
InfrastructureResourcesClient contains the methods for the InfrastructureResources group.
InfrastructureResourcesClientCreateOrUpdateOptions contains the optional parameters for the InfrastructureResourcesClient.CreateOrUpdate method.
InfrastructureResourcesClientCreateOrUpdateResponse contains the response from method InfrastructureResourcesClient.CreateOrUpdate.
InfrastructureResourcesClientDeleteOptions contains the optional parameters for the InfrastructureResourcesClient.Delete method.
InfrastructureResourcesClientDeleteResponse contains the response from method InfrastructureResourcesClient.Delete.
InfrastructureResourcesClientGetOptions contains the optional parameters for the InfrastructureResourcesClient.Get method.
InfrastructureResourcesClientGetResponse contains the response from method InfrastructureResourcesClient.Get.
InfrastructureResourcesClientListBySpaceOptions contains the optional parameters for the InfrastructureResourcesClient.NewListBySpacePager method.
InfrastructureResourcesClientListBySpaceResponse contains the response from method InfrastructureResourcesClient.NewListBySpacePager.
InfrastructureResourcesClientPatchOptions contains the optional parameters for the InfrastructureResourcesClient.Patch method.
InfrastructureResourcesClientPatchResponse contains the response from method InfrastructureResourcesClient.Patch.
InfrastructureResourceUpdate - The type used for update operations of the InfrastructureResource.
InfrastructureResourceUpdateProperties - The updatable properties of the InfrastructureResource.
ListBusinessProcessDevelopmentArtifactsResponse - The business process development artifact get collection response.
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.
SaveOrGetBusinessProcessDevelopmentArtifactResponse - The business process development artifact save or get response.
SaveOrValidateBusinessProcessDevelopmentArtifactRequest - The business process development artifact save or validate request.
Space - An integration space.
SpaceListResult - The response of a Space list operation.
SpaceResourceProperties - The properties of space.
SpacesClient contains the methods for the Spaces group.
SpacesClientCreateOrUpdateOptions contains the optional parameters for the SpacesClient.CreateOrUpdate method.
SpacesClientCreateOrUpdateResponse contains the response from method SpacesClient.CreateOrUpdate.
SpacesClientDeleteOptions contains the optional parameters for the SpacesClient.Delete method.
SpacesClientDeleteResponse contains the response from method SpacesClient.Delete.
SpacesClientGetOptions contains the optional parameters for the SpacesClient.Get method.
SpacesClientGetResponse contains the response from method SpacesClient.Get.
SpacesClientListByResourceGroupOptions contains the optional parameters for the SpacesClient.NewListByResourceGroupPager method.
SpacesClientListByResourceGroupResponse contains the response from method SpacesClient.NewListByResourceGroupPager.
SpacesClientListBySubscriptionOptions contains the optional parameters for the SpacesClient.NewListBySubscriptionPager method.
SpacesClientListBySubscriptionResponse contains the response from method SpacesClient.NewListBySubscriptionPager.
SpacesClientPatchOptions contains the optional parameters for the SpacesClient.Patch method.
SpacesClientPatchResponse contains the response from method SpacesClient.Patch.
SpaceUpdate - The type used for update operations of the Space.
SpaceUpdateProperties - The updatable properties of the Space.
SystemData - Metadata pertaining to creation and last modification of the resource.
TrackingCorrelationContext - The tracking correlation context.
TrackingDataStore - The properties of tracking data store.
TrackingEventDefinition - The tracking event definition.
TrackingProfileDefinition - The tracking profile for the business process.

# Type aliases

ActionType - Enum.
CreatedByType - The type of identity that created the resource.
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.