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

# README

Azure Network Function Manager Module for Go

PkgGoDev

The armnetworkfunction module provides operations for working with Azure Network Function Manager.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Network Function Manager module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/networkfunction/armnetworkfunction

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Network Function Manager. 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.

Clients

Azure Network Function Manager modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client, err := armnetworkfunction.NewAzureTrafficCollectorsClient(<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,
    },
}
client, err := armnetworkfunction.NewAzureTrafficCollectorsClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Network Function Manager 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.

# Functions

NewAzureTrafficCollectorsByResourceGroupClient creates a new instance of AzureTrafficCollectorsByResourceGroupClient with the specified values.
NewAzureTrafficCollectorsBySubscriptionClient creates a new instance of AzureTrafficCollectorsBySubscriptionClient with the specified values.
NewAzureTrafficCollectorsClient creates a new instance of AzureTrafficCollectorsClient with the specified values.
NewClient creates a new instance of Client with the specified values.
NewCollectorPoliciesClient creates a new instance of CollectorPoliciesClient with the specified values.
PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.
PossibleDestinationTypeValues returns the possible values for the DestinationType const type.
PossibleEmissionTypeValues returns the possible values for the EmissionType const type.
PossibleIngestionTypeValues returns the possible values for the IngestionType const type.
PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.
PossibleSourceTypeValues returns the possible values for the SourceType 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

# Structs

AzureTrafficCollector - Azure Traffic Collector resource.
AzureTrafficCollectorListResult - Response for the ListTrafficCollectors API service call.
AzureTrafficCollectorPropertiesFormat - Azure Traffic Collector resource properties.
AzureTrafficCollectorsByResourceGroupClient contains the methods for the AzureTrafficCollectorsByResourceGroup group.
AzureTrafficCollectorsByResourceGroupClientListOptions contains the optional parameters for the AzureTrafficCollectorsByResourceGroupClient.List method.
AzureTrafficCollectorsByResourceGroupClientListResponse contains the response from method AzureTrafficCollectorsByResourceGroupClient.List.
AzureTrafficCollectorsBySubscriptionClient contains the methods for the AzureTrafficCollectorsBySubscription group.
AzureTrafficCollectorsBySubscriptionClientListOptions contains the optional parameters for the AzureTrafficCollectorsBySubscriptionClient.List method.
AzureTrafficCollectorsBySubscriptionClientListResponse contains the response from method AzureTrafficCollectorsBySubscriptionClient.List.
AzureTrafficCollectorsClient contains the methods for the AzureTrafficCollectors group.
AzureTrafficCollectorsClientBeginCreateOrUpdateOptions contains the optional parameters for the AzureTrafficCollectorsClient.BeginCreateOrUpdate method.
AzureTrafficCollectorsClientBeginDeleteOptions contains the optional parameters for the AzureTrafficCollectorsClient.BeginDelete method.
AzureTrafficCollectorsClientCreateOrUpdateResponse contains the response from method AzureTrafficCollectorsClient.CreateOrUpdate.
AzureTrafficCollectorsClientDeleteResponse contains the response from method AzureTrafficCollectorsClient.Delete.
AzureTrafficCollectorsClientGetOptions contains the optional parameters for the AzureTrafficCollectorsClient.Get method.
AzureTrafficCollectorsClientGetResponse contains the response from method AzureTrafficCollectorsClient.Get.
AzureTrafficCollectorsClientUpdateTagsOptions contains the optional parameters for the AzureTrafficCollectorsClient.UpdateTags method.
AzureTrafficCollectorsClientUpdateTagsResponse contains the response from method AzureTrafficCollectorsClient.UpdateTags.
Client contains the methods for the NetworkFunction group.
ClientListOperationsOptions contains the optional parameters for the Client.ListOperations method.
ClientListOperationsResponse contains the response from method Client.ListOperations.
CloudError - An error response from the service.
CloudErrorBody - An error response from the service.
CollectorPoliciesClient contains the methods for the CollectorPolicies group.
CollectorPoliciesClientBeginCreateOrUpdateOptions contains the optional parameters for the CollectorPoliciesClient.BeginCreateOrUpdate method.
CollectorPoliciesClientBeginDeleteOptions contains the optional parameters for the CollectorPoliciesClient.BeginDelete method.
CollectorPoliciesClientCreateOrUpdateResponse contains the response from method CollectorPoliciesClient.CreateOrUpdate.
CollectorPoliciesClientDeleteResponse contains the response from method CollectorPoliciesClient.Delete.
CollectorPoliciesClientGetOptions contains the optional parameters for the CollectorPoliciesClient.Get method.
CollectorPoliciesClientGetResponse contains the response from method CollectorPoliciesClient.Get.
CollectorPoliciesClientListOptions contains the optional parameters for the CollectorPoliciesClient.List method.
CollectorPoliciesClientListResponse contains the response from method CollectorPoliciesClient.List.
CollectorPolicy - Collector policy resource.
CollectorPolicyListResult - Response for the ListCollectorPolicies API service call.
CollectorPolicyPropertiesFormat - Collection policy properties.
CollectorPolicySystemData - Metadata pertaining to creation and last modification of the resource.
EmissionPoliciesPropertiesFormat - Emission policy properties.
EmissionPolicyDestination - Emission policy destination properties.
IngestionPolicyPropertiesFormat - Ingestion Policy properties.
IngestionSourcesPropertiesFormat - Ingestion policy properties.
Operation - Azure Traffic Collector REST API operation definition.
OperationDisplay - Display metadata associated with the operation.
OperationListResult - Result of the request to list Azure Traffic Collector operations.
ProxyResource - An azure resource object.
ResourceReference - Resource reference properties.
SystemData - Metadata pertaining to creation and last modification of the resource.
TagsObject - Tags object for patch operations.
TrackedResource - Common resource representation.
TrackedResourceSystemData - Metadata pertaining to creation and last modification of the resource.

# Type aliases

CreatedByType - The type of identity that created the resource.
DestinationType - Emission destination type.
EmissionType - Emission format type.
IngestionType - The ingestion type.
ProvisioningState - The current provisioning state.
SourceType - Ingestion source type.