armhybridnetwork

package module
v2.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 27, 2023 License: MIT Imports: 14 Imported by: 1

README

Azure Private Edge Zone Module for Go

PkgGoDev

The armhybridnetwork module provides operations for working with Azure Private Edge Zone.

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 Private Edge Zone module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hybridnetwork/armhybridnetwork

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Private Edge Zone. 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 Private Edge Zone 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 := armhybridnetwork.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 := armhybridnetwork.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.NewDevicesClient()

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 Private Edge Zone 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 opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionType

type ActionType string

ActionType - Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

const (
	ActionTypeInternal ActionType = "Internal"
)

func PossibleActionTypeValues

func PossibleActionTypeValues() []ActionType

PossibleActionTypeValues returns the possible values for the ActionType const type.

type ApplicationEnablement

type ApplicationEnablement string

ApplicationEnablement - The application enablement.

const (
	ApplicationEnablementDisabled ApplicationEnablement = "Disabled"
	ApplicationEnablementEnabled  ApplicationEnablement = "Enabled"
	ApplicationEnablementUnknown  ApplicationEnablement = "Unknown"
)

func PossibleApplicationEnablementValues

func PossibleApplicationEnablementValues() []ApplicationEnablement

PossibleApplicationEnablementValues returns the possible values for the ApplicationEnablement const type.

type ArmResourceDefinitionResourceElementTemplate

type ArmResourceDefinitionResourceElementTemplate struct {
	// Artifact profile properties.
	ArtifactProfile *NSDArtifactProfile

	// Name and value pairs that define the parameter values. It can be a well formed escaped JSON string.
	ParameterValues *string

	// The template type.
	TemplateType *TemplateType
}

ArmResourceDefinitionResourceElementTemplate - The arm template RE.

func (ArmResourceDefinitionResourceElementTemplate) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ArmResourceDefinitionResourceElementTemplate.

func (*ArmResourceDefinitionResourceElementTemplate) UnmarshalJSON

func (a *ArmResourceDefinitionResourceElementTemplate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArmResourceDefinitionResourceElementTemplate.

type ArmResourceDefinitionResourceElementTemplateDetails

type ArmResourceDefinitionResourceElementTemplateDetails struct {
	// REQUIRED; The resource element template type.
	ResourceElementType *Type

	// The resource element template type.
	Configuration *ArmResourceDefinitionResourceElementTemplate

	// The depends on profile.
	DependsOnProfile *DependsOnProfile

	// Name of the resource element template.
	Name *string
}

ArmResourceDefinitionResourceElementTemplateDetails - The arm resource definition resource element template details.

func (*ArmResourceDefinitionResourceElementTemplateDetails) GetResourceElementTemplate

GetResourceElementTemplate implements the ResourceElementTemplateClassification interface for type ArmResourceDefinitionResourceElementTemplateDetails.

func (ArmResourceDefinitionResourceElementTemplateDetails) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ArmResourceDefinitionResourceElementTemplateDetails.

func (*ArmResourceDefinitionResourceElementTemplateDetails) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ArmResourceDefinitionResourceElementTemplateDetails.

type ArmTemplateArtifactProfile

type ArmTemplateArtifactProfile struct {
	// Template name.
	TemplateName *string

	// Template version.
	TemplateVersion *string
}

ArmTemplateArtifactProfile - Template artifact profile.

func (ArmTemplateArtifactProfile) MarshalJSON

func (a ArmTemplateArtifactProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ArmTemplateArtifactProfile.

func (*ArmTemplateArtifactProfile) UnmarshalJSON

func (a *ArmTemplateArtifactProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArmTemplateArtifactProfile.

type ArmTemplateMappingRuleProfile

type ArmTemplateMappingRuleProfile struct {
	// List of template parameters.
	TemplateParameters *string
}

ArmTemplateMappingRuleProfile - Template mapping rule profile

func (ArmTemplateMappingRuleProfile) MarshalJSON

func (a ArmTemplateMappingRuleProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ArmTemplateMappingRuleProfile.

func (*ArmTemplateMappingRuleProfile) UnmarshalJSON

func (a *ArmTemplateMappingRuleProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArmTemplateMappingRuleProfile.

type ArtifactAccessCredential

type ArtifactAccessCredential struct {
	// REQUIRED; The credential type.
	CredentialType *CredentialType
}

ArtifactAccessCredential - The artifact manifest credential definition.

func (*ArtifactAccessCredential) GetArtifactAccessCredential

func (a *ArtifactAccessCredential) GetArtifactAccessCredential() *ArtifactAccessCredential

GetArtifactAccessCredential implements the ArtifactAccessCredentialClassification interface for type ArtifactAccessCredential.

func (ArtifactAccessCredential) MarshalJSON

func (a ArtifactAccessCredential) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ArtifactAccessCredential.

func (*ArtifactAccessCredential) UnmarshalJSON

func (a *ArtifactAccessCredential) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArtifactAccessCredential.

type ArtifactAccessCredentialClassification

type ArtifactAccessCredentialClassification interface {
	// GetArtifactAccessCredential returns the ArtifactAccessCredential content of the underlying type.
	GetArtifactAccessCredential() *ArtifactAccessCredential
}

ArtifactAccessCredentialClassification provides polymorphic access to related types. Call the interface's GetArtifactAccessCredential() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ArtifactAccessCredential, *AzureContainerRegistryScopedTokenCredential, *AzureStorageAccountCredential

type ArtifactChangeState

type ArtifactChangeState struct {
	// Artifact update state properties.
	Properties *ArtifactChangeStateProperties
}

ArtifactChangeState - The artifact updating request payload.

func (ArtifactChangeState) MarshalJSON

func (a ArtifactChangeState) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ArtifactChangeState.

func (*ArtifactChangeState) UnmarshalJSON

func (a *ArtifactChangeState) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArtifactChangeState.

type ArtifactChangeStateProperties

type ArtifactChangeStateProperties struct {
	// The artifact state
	ArtifactState *ArtifactState
}

ArtifactChangeStateProperties - The artifact update state properties.

func (ArtifactChangeStateProperties) MarshalJSON

func (a ArtifactChangeStateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ArtifactChangeStateProperties.

func (*ArtifactChangeStateProperties) UnmarshalJSON

func (a *ArtifactChangeStateProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArtifactChangeStateProperties.

type ArtifactManifest

type ArtifactManifest struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// Artifact manifest properties.
	Properties *ArtifactManifestPropertiesFormat

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ArtifactManifest - Artifact manifest properties.

func (ArtifactManifest) MarshalJSON

func (a ArtifactManifest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ArtifactManifest.

func (*ArtifactManifest) UnmarshalJSON

func (a *ArtifactManifest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArtifactManifest.

type ArtifactManifestListResult

type ArtifactManifestListResult struct {
	// A list of artifact manifests.
	Value []*ArtifactManifest

	// READ-ONLY; The URI to get the next set of results.
	NextLink *string
}

ArtifactManifestListResult - A list of artifact manifests.

func (ArtifactManifestListResult) MarshalJSON

func (a ArtifactManifestListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ArtifactManifestListResult.

func (*ArtifactManifestListResult) UnmarshalJSON

func (a *ArtifactManifestListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArtifactManifestListResult.

type ArtifactManifestPropertiesFormat

type ArtifactManifestPropertiesFormat struct {
	// The artifacts list.
	Artifacts []*ManifestArtifactFormat

	// READ-ONLY; The artifact manifest state.
	ArtifactManifestState *ArtifactManifestState

	// READ-ONLY; The provisioning state of the ArtifactManifest resource.
	ProvisioningState *ProvisioningState
}

ArtifactManifestPropertiesFormat - Artifact manifest properties.

func (ArtifactManifestPropertiesFormat) MarshalJSON

func (a ArtifactManifestPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ArtifactManifestPropertiesFormat.

func (*ArtifactManifestPropertiesFormat) UnmarshalJSON

func (a *ArtifactManifestPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArtifactManifestPropertiesFormat.

type ArtifactManifestState

type ArtifactManifestState string

ArtifactManifestState - The artifact manifest state.

const (
	ArtifactManifestStateSucceeded        ArtifactManifestState = "Succeeded"
	ArtifactManifestStateUnknown          ArtifactManifestState = "Unknown"
	ArtifactManifestStateUploaded         ArtifactManifestState = "Uploaded"
	ArtifactManifestStateUploading        ArtifactManifestState = "Uploading"
	ArtifactManifestStateValidating       ArtifactManifestState = "Validating"
	ArtifactManifestStateValidationFailed ArtifactManifestState = "ValidationFailed"
)

func PossibleArtifactManifestStateValues

func PossibleArtifactManifestStateValues() []ArtifactManifestState

PossibleArtifactManifestStateValues returns the possible values for the ArtifactManifestState const type.

type ArtifactManifestUpdateState

type ArtifactManifestUpdateState struct {
	// The artifact manifest state.
	ArtifactManifestState *ArtifactManifestState
}

ArtifactManifestUpdateState - The artifact manifest updating request payload. Only the 'Uploaded' state is allowed for updates. Other states are used for internal state transitioning.

func (ArtifactManifestUpdateState) MarshalJSON

func (a ArtifactManifestUpdateState) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ArtifactManifestUpdateState.

func (*ArtifactManifestUpdateState) UnmarshalJSON

func (a *ArtifactManifestUpdateState) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArtifactManifestUpdateState.

type ArtifactManifestsClient

type ArtifactManifestsClient struct {
	// contains filtered or unexported fields
}

ArtifactManifestsClient contains the methods for the ArtifactManifests group. Don't use this type directly, use NewArtifactManifestsClient() instead.

func NewArtifactManifestsClient

func NewArtifactManifestsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ArtifactManifestsClient, error)

NewArtifactManifestsClient creates a new instance of ArtifactManifestsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ArtifactManifestsClient) BeginCreateOrUpdate

func (client *ArtifactManifestsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, publisherName string, artifactStoreName string, artifactManifestName string, parameters ArtifactManifest, options *ArtifactManifestsClientBeginCreateOrUpdateOptions) (*runtime.Poller[ArtifactManifestsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a artifact manifest. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • artifactStoreName - The name of the artifact store.
  • artifactManifestName - The name of the artifact manifest.
  • parameters - Parameters supplied to the create or update artifact manifest operation.
  • options - ArtifactManifestsClientBeginCreateOrUpdateOptions contains the optional parameters for the ArtifactManifestsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewArtifactManifestsClient().BeginCreateOrUpdate(ctx, "rg", "TestPublisher", "TestArtifactStore", "TestManifest", armhybridnetwork.ArtifactManifest{
	Location: to.Ptr("eastus"),
	Properties: &armhybridnetwork.ArtifactManifestPropertiesFormat{
		Artifacts: []*armhybridnetwork.ManifestArtifactFormat{
			{
				ArtifactName:    to.Ptr("fed-rbac"),
				ArtifactType:    to.Ptr(armhybridnetwork.ArtifactTypeOCIArtifact),
				ArtifactVersion: to.Ptr("1.0.0"),
			},
			{
				ArtifactName:    to.Ptr("nginx"),
				ArtifactType:    to.Ptr(armhybridnetwork.ArtifactTypeOCIArtifact),
				ArtifactVersion: to.Ptr("v1"),
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ArtifactManifest = armhybridnetwork.ArtifactManifest{
// 	Name: to.Ptr("TestManifest"),
// 	Type: to.Ptr("microsoft.hybridnetwork/publishers/artifactStores/artifactManifests"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/microsoft.hybridnetwork/publishers/UnityCloud/artifactStores/TestArtifactStore/artifactManifests/TestManifest"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.ArtifactManifestPropertiesFormat{
// 		ArtifactManifestState: to.Ptr(armhybridnetwork.ArtifactManifestStateUploaded),
// 		Artifacts: []*armhybridnetwork.ManifestArtifactFormat{
// 			{
// 				ArtifactName: to.Ptr("fed-rbac"),
// 				ArtifactType: to.Ptr(armhybridnetwork.ArtifactTypeOCIArtifact),
// 				ArtifactVersion: to.Ptr("1.0.0"),
// 			},
// 			{
// 				ArtifactName: to.Ptr("nginx"),
// 				ArtifactType: to.Ptr(armhybridnetwork.ArtifactTypeOCIArtifact),
// 				ArtifactVersion: to.Ptr("v1"),
// 		}},
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 	},
// }
Output:

func (*ArtifactManifestsClient) BeginDelete

func (client *ArtifactManifestsClient) BeginDelete(ctx context.Context, resourceGroupName string, publisherName string, artifactStoreName string, artifactManifestName string, options *ArtifactManifestsClientBeginDeleteOptions) (*runtime.Poller[ArtifactManifestsClientDeleteResponse], error)

BeginDelete - Deletes the specified artifact manifest. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • artifactStoreName - The name of the artifact store.
  • artifactManifestName - The name of the artifact manifest.
  • options - ArtifactManifestsClientBeginDeleteOptions contains the optional parameters for the ArtifactManifestsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewArtifactManifestsClient().BeginDelete(ctx, "rg", "TestPublisher", "TestArtifactStore", "TestManifest", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ArtifactManifestsClient) BeginUpdateState

func (client *ArtifactManifestsClient) BeginUpdateState(ctx context.Context, resourceGroupName string, publisherName string, artifactStoreName string, artifactManifestName string, parameters ArtifactManifestUpdateState, options *ArtifactManifestsClientBeginUpdateStateOptions) (*runtime.Poller[ArtifactManifestsClientUpdateStateResponse], error)

BeginUpdateState - Update state for artifact manifest. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • artifactStoreName - The name of the artifact store.
  • artifactManifestName - The name of the artifact manifest.
  • parameters - Parameters supplied to update the state of artifact manifest.
  • options - ArtifactManifestsClientBeginUpdateStateOptions contains the optional parameters for the ArtifactManifestsClient.BeginUpdateState method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestUpdateState.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewArtifactManifestsClient().BeginUpdateState(ctx, "rg", "TestPublisher", "TestArtifactStore", "TestArtifactManifestName", armhybridnetwork.ArtifactManifestUpdateState{
	ArtifactManifestState: to.Ptr(armhybridnetwork.ArtifactManifestStateUploaded),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ArtifactManifestUpdateState = armhybridnetwork.ArtifactManifestUpdateState{
// 	ArtifactManifestState: to.Ptr(armhybridnetwork.ArtifactManifestStateUploaded),
// }
Output:

func (*ArtifactManifestsClient) Get

func (client *ArtifactManifestsClient) Get(ctx context.Context, resourceGroupName string, publisherName string, artifactStoreName string, artifactManifestName string, options *ArtifactManifestsClientGetOptions) (ArtifactManifestsClientGetResponse, error)

Get - Gets information about a artifact manifest resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • artifactStoreName - The name of the artifact store.
  • artifactManifestName - The name of the artifact manifest.
  • options - ArtifactManifestsClientGetOptions contains the optional parameters for the ArtifactManifestsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewArtifactManifestsClient().Get(ctx, "rg", "TestPublisher", "TestArtifactStore", "TestManifest", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ArtifactManifest = armhybridnetwork.ArtifactManifest{
// 	Name: to.Ptr("TestManifest"),
// 	Type: to.Ptr("microsoft.hybridnetwork/publishers/artifactStores/artifactManifests"),
// 	ID: to.Ptr("/subscriptions/subid/providers/microsoft.hybridnetwork/publishers/UnityCloud/artifactStores/TestArtifactStore/artifactManifests/TestManifest"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.ArtifactManifestPropertiesFormat{
// 		ArtifactManifestState: to.Ptr(armhybridnetwork.ArtifactManifestStateUploaded),
// 		Artifacts: []*armhybridnetwork.ManifestArtifactFormat{
// 			{
// 				ArtifactName: to.Ptr("fed-rbac"),
// 				ArtifactType: to.Ptr(armhybridnetwork.ArtifactTypeOCIArtifact),
// 				ArtifactVersion: to.Ptr("1.0.0"),
// 			},
// 			{
// 				ArtifactName: to.Ptr("nginx"),
// 				ArtifactType: to.Ptr(armhybridnetwork.ArtifactTypeOCIArtifact),
// 				ArtifactVersion: to.Ptr("v1"),
// 		}},
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 	},
// }
Output:

func (*ArtifactManifestsClient) ListCredential

func (client *ArtifactManifestsClient) ListCredential(ctx context.Context, resourceGroupName string, publisherName string, artifactStoreName string, artifactManifestName string, options *ArtifactManifestsClientListCredentialOptions) (ArtifactManifestsClientListCredentialResponse, error)

ListCredential - List credential for publishing artifacts defined in artifact manifest. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • artifactStoreName - The name of the artifact store.
  • artifactManifestName - The name of the artifact manifest.
  • options - ArtifactManifestsClientListCredentialOptions contains the optional parameters for the ArtifactManifestsClient.ListCredential method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestListCredential.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewArtifactManifestsClient().ListCredential(ctx, "rg", "TestPublisher", "TestArtifactStore", "TestArtifactManifestName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res = armhybridnetwork.ArtifactManifestsClientListCredentialResponse{
// 	                            ArtifactAccessCredentialClassification: &armhybridnetwork.AzureContainerRegistryScopedTokenCredential{
// 		CredentialType: to.Ptr(armhybridnetwork.CredentialTypeAzureContainerRegistryScopedToken),
// 		AcrServerURL: to.Ptr("test.azurecr.io"),
// 		AcrToken: to.Ptr("dummytoken"),
// 		Expiry: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-06-07T18:01:41.334Z"); return t}()),
// 		Repositories: []*string{
// 			to.Ptr("")},
// 			Username: to.Ptr("dummyuser"),
// 		},
// 		                        }
Output:

func (*ArtifactManifestsClient) NewListByArtifactStorePager

func (client *ArtifactManifestsClient) NewListByArtifactStorePager(resourceGroupName string, publisherName string, artifactStoreName string, options *ArtifactManifestsClientListByArtifactStoreOptions) *runtime.Pager[ArtifactManifestsClientListByArtifactStoreResponse]

NewListByArtifactStorePager - Gets information about the artifact manifest.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • artifactStoreName - The name of the artifact store.
  • options - ArtifactManifestsClientListByArtifactStoreOptions contains the optional parameters for the ArtifactManifestsClient.NewListByArtifactStorePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestListByArtifactStore.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewArtifactManifestsClient().NewListByArtifactStorePager("rg", "TestPublisher", "TestArtifactStore", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ArtifactManifestListResult = armhybridnetwork.ArtifactManifestListResult{
	// 	Value: []*armhybridnetwork.ArtifactManifest{
	// 		{
	// 			Name: to.Ptr("TestManifest"),
	// 			Type: to.Ptr("microsoft.hybridnetwork/publishers/artifactStores/artifactManifests"),
	// 			ID: to.Ptr("/subscriptions/subid/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore/artifactManifests/TestManifest"),
	// 			Location: to.Ptr("eastus"),
	// 			Properties: &armhybridnetwork.ArtifactManifestPropertiesFormat{
	// 				ArtifactManifestState: to.Ptr(armhybridnetwork.ArtifactManifestStateUploaded),
	// 				Artifacts: []*armhybridnetwork.ManifestArtifactFormat{
	// 					{
	// 						ArtifactName: to.Ptr("fed-rbac"),
	// 						ArtifactType: to.Ptr(armhybridnetwork.ArtifactTypeOCIArtifact),
	// 						ArtifactVersion: to.Ptr("1.0.0"),
	// 					},
	// 					{
	// 						ArtifactName: to.Ptr("nginx"),
	// 						ArtifactType: to.Ptr(armhybridnetwork.ArtifactTypeOCIArtifact),
	// 						ArtifactVersion: to.Ptr("v1"),
	// 				}},
	// 				ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}
Output:

func (*ArtifactManifestsClient) Update

func (client *ArtifactManifestsClient) Update(ctx context.Context, resourceGroupName string, publisherName string, artifactStoreName string, artifactManifestName string, parameters TagsObject, options *ArtifactManifestsClientUpdateOptions) (ArtifactManifestsClientUpdateResponse, error)

Update - Updates a artifact manifest resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • artifactStoreName - The name of the artifact store.
  • artifactManifestName - The name of the artifact manifest.
  • parameters - Parameters supplied to the create or update artifact manifest operation.
  • options - ArtifactManifestsClientUpdateOptions contains the optional parameters for the ArtifactManifestsClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactManifestUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewArtifactManifestsClient().Update(ctx, "rg", "TestPublisher", "TestArtifactStore", "TestManifest", armhybridnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ArtifactManifest = armhybridnetwork.ArtifactManifest{
// 	Name: to.Ptr("TestManifest"),
// 	Type: to.Ptr("microsoft.hybridnetwork/publishers/artifactStores/artifactManifests"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/microsoft.hybridnetwork/publishers/UnityCloud/artifactStores/TestArtifactStore/artifactManifests/TestManifest"),
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Properties: &armhybridnetwork.ArtifactManifestPropertiesFormat{
// 		ArtifactManifestState: to.Ptr(armhybridnetwork.ArtifactManifestStateUploaded),
// 		Artifacts: []*armhybridnetwork.ManifestArtifactFormat{
// 			{
// 				ArtifactName: to.Ptr("fed-rbac"),
// 				ArtifactType: to.Ptr(armhybridnetwork.ArtifactTypeOCIArtifact),
// 				ArtifactVersion: to.Ptr("1.0.0"),
// 			},
// 			{
// 				ArtifactName: to.Ptr("nginx"),
// 				ArtifactType: to.Ptr(armhybridnetwork.ArtifactTypeOCIArtifact),
// 				ArtifactVersion: to.Ptr("v1"),
// 		}},
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 	},
// }
Output:

type ArtifactManifestsClientBeginCreateOrUpdateOptions

type ArtifactManifestsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ArtifactManifestsClientBeginCreateOrUpdateOptions contains the optional parameters for the ArtifactManifestsClient.BeginCreateOrUpdate method.

type ArtifactManifestsClientBeginDeleteOptions

type ArtifactManifestsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ArtifactManifestsClientBeginDeleteOptions contains the optional parameters for the ArtifactManifestsClient.BeginDelete method.

type ArtifactManifestsClientBeginUpdateStateOptions

type ArtifactManifestsClientBeginUpdateStateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ArtifactManifestsClientBeginUpdateStateOptions contains the optional parameters for the ArtifactManifestsClient.BeginUpdateState method.

type ArtifactManifestsClientCreateOrUpdateResponse

type ArtifactManifestsClientCreateOrUpdateResponse struct {
	// Artifact manifest properties.
	ArtifactManifest
}

ArtifactManifestsClientCreateOrUpdateResponse contains the response from method ArtifactManifestsClient.BeginCreateOrUpdate.

type ArtifactManifestsClientDeleteResponse

type ArtifactManifestsClientDeleteResponse struct {
}

ArtifactManifestsClientDeleteResponse contains the response from method ArtifactManifestsClient.BeginDelete.

type ArtifactManifestsClientGetOptions

type ArtifactManifestsClientGetOptions struct {
}

ArtifactManifestsClientGetOptions contains the optional parameters for the ArtifactManifestsClient.Get method.

type ArtifactManifestsClientGetResponse

type ArtifactManifestsClientGetResponse struct {
	// Artifact manifest properties.
	ArtifactManifest
}

ArtifactManifestsClientGetResponse contains the response from method ArtifactManifestsClient.Get.

type ArtifactManifestsClientListByArtifactStoreOptions

type ArtifactManifestsClientListByArtifactStoreOptions struct {
}

ArtifactManifestsClientListByArtifactStoreOptions contains the optional parameters for the ArtifactManifestsClient.NewListByArtifactStorePager method.

type ArtifactManifestsClientListByArtifactStoreResponse

type ArtifactManifestsClientListByArtifactStoreResponse struct {
	// A list of artifact manifests.
	ArtifactManifestListResult
}

ArtifactManifestsClientListByArtifactStoreResponse contains the response from method ArtifactManifestsClient.NewListByArtifactStorePager.

type ArtifactManifestsClientListCredentialOptions

type ArtifactManifestsClientListCredentialOptions struct {
}

ArtifactManifestsClientListCredentialOptions contains the optional parameters for the ArtifactManifestsClient.ListCredential method.

type ArtifactManifestsClientListCredentialResponse

type ArtifactManifestsClientListCredentialResponse struct {
	// The artifact manifest credential definition.
	ArtifactAccessCredentialClassification
}

ArtifactManifestsClientListCredentialResponse contains the response from method ArtifactManifestsClient.ListCredential.

func (*ArtifactManifestsClientListCredentialResponse) UnmarshalJSON

func (a *ArtifactManifestsClientListCredentialResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArtifactManifestsClientListCredentialResponse.

type ArtifactManifestsClientUpdateOptions

type ArtifactManifestsClientUpdateOptions struct {
}

ArtifactManifestsClientUpdateOptions contains the optional parameters for the ArtifactManifestsClient.Update method.

type ArtifactManifestsClientUpdateResponse

type ArtifactManifestsClientUpdateResponse struct {
	// Artifact manifest properties.
	ArtifactManifest
}

ArtifactManifestsClientUpdateResponse contains the response from method ArtifactManifestsClient.Update.

type ArtifactManifestsClientUpdateStateResponse

type ArtifactManifestsClientUpdateStateResponse struct {
	// The artifact manifest updating request payload. Only the 'Uploaded' state is allowed for updates. Other states are used
	// for internal state transitioning.
	ArtifactManifestUpdateState
}

ArtifactManifestsClientUpdateStateResponse contains the response from method ArtifactManifestsClient.BeginUpdateState.

type ArtifactReplicationStrategy

type ArtifactReplicationStrategy string

ArtifactReplicationStrategy - The replication strategy.

const (
	ArtifactReplicationStrategySingleReplication ArtifactReplicationStrategy = "SingleReplication"
	ArtifactReplicationStrategyUnknown           ArtifactReplicationStrategy = "Unknown"
)

func PossibleArtifactReplicationStrategyValues

func PossibleArtifactReplicationStrategyValues() []ArtifactReplicationStrategy

PossibleArtifactReplicationStrategyValues returns the possible values for the ArtifactReplicationStrategy const type.

type ArtifactState

type ArtifactState string

ArtifactState - The artifact state.

const (
	ArtifactStateActive     ArtifactState = "Active"
	ArtifactStateDeprecated ArtifactState = "Deprecated"
	ArtifactStatePreview    ArtifactState = "Preview"
	ArtifactStateUnknown    ArtifactState = "Unknown"
)

func PossibleArtifactStateValues

func PossibleArtifactStateValues() []ArtifactState

PossibleArtifactStateValues returns the possible values for the ArtifactState const type.

type ArtifactStore

type ArtifactStore struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// ArtifactStores properties.
	Properties *ArtifactStorePropertiesFormat

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ArtifactStore - Artifact store properties.

func (ArtifactStore) MarshalJSON

func (a ArtifactStore) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ArtifactStore.

func (*ArtifactStore) UnmarshalJSON

func (a *ArtifactStore) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArtifactStore.

type ArtifactStoreListResult

type ArtifactStoreListResult struct {
	// A list of artifact stores.
	Value []*ArtifactStore

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string
}

ArtifactStoreListResult - A list of artifact stores.

func (ArtifactStoreListResult) MarshalJSON

func (a ArtifactStoreListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ArtifactStoreListResult.

func (*ArtifactStoreListResult) UnmarshalJSON

func (a *ArtifactStoreListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArtifactStoreListResult.

type ArtifactStorePropertiesFormat

type ArtifactStorePropertiesFormat struct {
	ManagedResourceGroupConfiguration *ArtifactStorePropertiesFormatManagedResourceGroupConfiguration

	// The replication strategy.
	ReplicationStrategy *ArtifactReplicationStrategy

	// The artifact store type.
	StoreType *ArtifactStoreType

	// READ-ONLY; The provisioning state of the application groups resource.
	ProvisioningState *ProvisioningState

	// READ-ONLY; The created storage resource id
	StorageResourceID *string
}

ArtifactStorePropertiesFormat - Artifact store properties.

func (ArtifactStorePropertiesFormat) MarshalJSON

func (a ArtifactStorePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ArtifactStorePropertiesFormat.

func (*ArtifactStorePropertiesFormat) UnmarshalJSON

func (a *ArtifactStorePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ArtifactStorePropertiesFormat.

type ArtifactStorePropertiesFormatManagedResourceGroupConfiguration

type ArtifactStorePropertiesFormatManagedResourceGroupConfiguration struct {
	// The managed resource group location.
	Location *string

	// The managed resource group name.
	Name *string
}

func (ArtifactStorePropertiesFormatManagedResourceGroupConfiguration) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ArtifactStorePropertiesFormatManagedResourceGroupConfiguration.

func (*ArtifactStorePropertiesFormatManagedResourceGroupConfiguration) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type ArtifactStorePropertiesFormatManagedResourceGroupConfiguration.

type ArtifactStoreType

type ArtifactStoreType string

ArtifactStoreType - The artifact store type.

const (
	ArtifactStoreTypeAzureContainerRegistry ArtifactStoreType = "AzureContainerRegistry"
	ArtifactStoreTypeAzureStorageAccount    ArtifactStoreType = "AzureStorageAccount"
	ArtifactStoreTypeUnknown                ArtifactStoreType = "Unknown"
)

func PossibleArtifactStoreTypeValues

func PossibleArtifactStoreTypeValues() []ArtifactStoreType

PossibleArtifactStoreTypeValues returns the possible values for the ArtifactStoreType const type.

type ArtifactStoresClient

type ArtifactStoresClient struct {
	// contains filtered or unexported fields
}

ArtifactStoresClient contains the methods for the ArtifactStores group. Don't use this type directly, use NewArtifactStoresClient() instead.

func NewArtifactStoresClient

func NewArtifactStoresClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ArtifactStoresClient, error)

NewArtifactStoresClient creates a new instance of ArtifactStoresClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ArtifactStoresClient) BeginCreateOrUpdate

func (client *ArtifactStoresClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, publisherName string, artifactStoreName string, parameters ArtifactStore, options *ArtifactStoresClientBeginCreateOrUpdateOptions) (*runtime.Poller[ArtifactStoresClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a artifact store. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • artifactStoreName - The name of the artifact store.
  • parameters - Parameters supplied to the create or update application group operation.
  • options - ArtifactStoresClientBeginCreateOrUpdateOptions contains the optional parameters for the ArtifactStoresClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoreCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewArtifactStoresClient().BeginCreateOrUpdate(ctx, "rg", "TestPublisher", "TestArtifactStore", armhybridnetwork.ArtifactStore{
	Location: to.Ptr("eastus"),
	Properties: &armhybridnetwork.ArtifactStorePropertiesFormat{
		ManagedResourceGroupConfiguration: &armhybridnetwork.ArtifactStorePropertiesFormatManagedResourceGroupConfiguration{
			Name:     to.Ptr("testRg"),
			Location: to.Ptr("eastus"),
		},
		ReplicationStrategy: to.Ptr(armhybridnetwork.ArtifactReplicationStrategySingleReplication),
		StoreType:           to.Ptr(armhybridnetwork.ArtifactStoreTypeAzureContainerRegistry),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ArtifactStore = armhybridnetwork.ArtifactStore{
// 	Name: to.Ptr("TestArtifactStore"),
// 	Type: to.Ptr("microsoft.hybridnetwork/publishers/artifactStores"),
// 	ID: to.Ptr("/subscriptions/subid/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.ArtifactStorePropertiesFormat{
// 		ManagedResourceGroupConfiguration: &armhybridnetwork.ArtifactStorePropertiesFormatManagedResourceGroupConfiguration{
// 			Name: to.Ptr("testRg"),
// 			Location: to.Ptr("eastus"),
// 		},
// 		ReplicationStrategy: to.Ptr(armhybridnetwork.ArtifactReplicationStrategySingleReplication),
// 		StorageResourceID: to.Ptr("TestResourceId"),
// 		StoreType: to.Ptr(armhybridnetwork.ArtifactStoreTypeAzureContainerRegistry),
// 	},
// }
Output:

func (*ArtifactStoresClient) BeginDelete

func (client *ArtifactStoresClient) BeginDelete(ctx context.Context, resourceGroupName string, publisherName string, artifactStoreName string, options *ArtifactStoresClientBeginDeleteOptions) (*runtime.Poller[ArtifactStoresClientDeleteResponse], error)

BeginDelete - Deletes the specified artifact store. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • artifactStoreName - The name of the artifact store.
  • options - ArtifactStoresClientBeginDeleteOptions contains the optional parameters for the ArtifactStoresClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoreDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewArtifactStoresClient().BeginDelete(ctx, "rg", "TestPublisher", "TestArtifactStore", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ArtifactStoresClient) Get

func (client *ArtifactStoresClient) Get(ctx context.Context, resourceGroupName string, publisherName string, artifactStoreName string, options *ArtifactStoresClientGetOptions) (ArtifactStoresClientGetResponse, error)

Get - Gets information about the specified artifact store. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • artifactStoreName - The name of the artifact store.
  • options - ArtifactStoresClientGetOptions contains the optional parameters for the ArtifactStoresClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoreGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewArtifactStoresClient().Get(ctx, "rg", "TestPublisher", "TestArtifactStoreName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ArtifactStore = armhybridnetwork.ArtifactStore{
// 	Name: to.Ptr("TestArtifactStore"),
// 	Type: to.Ptr("microsoft.hybridnetwork/publishers/artifactStores"),
// 	ID: to.Ptr("/subscriptions/subid/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.ArtifactStorePropertiesFormat{
// 		ManagedResourceGroupConfiguration: &armhybridnetwork.ArtifactStorePropertiesFormatManagedResourceGroupConfiguration{
// 			Name: to.Ptr("testRg"),
// 			Location: to.Ptr("eastus"),
// 		},
// 		ReplicationStrategy: to.Ptr(armhybridnetwork.ArtifactReplicationStrategySingleReplication),
// 		StorageResourceID: to.Ptr("TestResourceId"),
// 		StoreType: to.Ptr(armhybridnetwork.ArtifactStoreTypeAzureContainerRegistry),
// 	},
// }
Output:

func (*ArtifactStoresClient) NewListByPublisherPager

func (client *ArtifactStoresClient) NewListByPublisherPager(resourceGroupName string, publisherName string, options *ArtifactStoresClientListByPublisherOptions) *runtime.Pager[ArtifactStoresClientListByPublisherResponse]

NewListByPublisherPager - Gets information of the ArtifactStores under publisher.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • options - ArtifactStoresClientListByPublisherOptions contains the optional parameters for the ArtifactStoresClient.NewListByPublisherPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoresListByPublisherName.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewArtifactStoresClient().NewListByPublisherPager("rg", "TestPublisher", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ArtifactStoreListResult = armhybridnetwork.ArtifactStoreListResult{
	// 	Value: []*armhybridnetwork.ArtifactStore{
	// 		{
	// 			Name: to.Ptr("TestArtifactStore"),
	// 			Type: to.Ptr("microsoft.hybridnetwork/publishers/artifactStores"),
	// 			ID: to.Ptr("/subscriptions/subid/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore"),
	// 			Location: to.Ptr("eastus"),
	// 			Properties: &armhybridnetwork.ArtifactStorePropertiesFormat{
	// 				ManagedResourceGroupConfiguration: &armhybridnetwork.ArtifactStorePropertiesFormatManagedResourceGroupConfiguration{
	// 					Name: to.Ptr("testRg"),
	// 					Location: to.Ptr("eastus"),
	// 				},
	// 				ReplicationStrategy: to.Ptr(armhybridnetwork.ArtifactReplicationStrategySingleReplication),
	// 				StorageResourceID: to.Ptr("TestResourceId"),
	// 				StoreType: to.Ptr(armhybridnetwork.ArtifactStoreTypeAzureContainerRegistry),
	// 			},
	// 	}},
	// }
}
Output:

func (*ArtifactStoresClient) Update

func (client *ArtifactStoresClient) Update(ctx context.Context, resourceGroupName string, publisherName string, artifactStoreName string, parameters TagsObject, options *ArtifactStoresClientUpdateOptions) (ArtifactStoresClientUpdateResponse, error)

Update - Update artifact store resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • artifactStoreName - The name of the artifact store.
  • parameters - Parameters supplied to the create or update application group operation.
  • options - ArtifactStoresClientUpdateOptions contains the optional parameters for the ArtifactStoresClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ArtifactStoreUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewArtifactStoresClient().Update(ctx, "rg", "TestPublisher", "TestArtifactStore", armhybridnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ArtifactStore = armhybridnetwork.ArtifactStore{
// 	Name: to.Ptr("TestArtifactStore"),
// 	Type: to.Ptr("microsoft.hybridnetwork/publishers/artifactStores"),
// 	ID: to.Ptr("/subscriptions/subid/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore"),
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Properties: &armhybridnetwork.ArtifactStorePropertiesFormat{
// 		ManagedResourceGroupConfiguration: &armhybridnetwork.ArtifactStorePropertiesFormatManagedResourceGroupConfiguration{
// 			Name: to.Ptr("testRg"),
// 			Location: to.Ptr("eastus"),
// 		},
// 		ReplicationStrategy: to.Ptr(armhybridnetwork.ArtifactReplicationStrategySingleReplication),
// 		StorageResourceID: to.Ptr("TestResourceId"),
// 		StoreType: to.Ptr(armhybridnetwork.ArtifactStoreTypeAzureContainerRegistry),
// 	},
// }
Output:

type ArtifactStoresClientBeginCreateOrUpdateOptions

type ArtifactStoresClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ArtifactStoresClientBeginCreateOrUpdateOptions contains the optional parameters for the ArtifactStoresClient.BeginCreateOrUpdate method.

type ArtifactStoresClientBeginDeleteOptions

type ArtifactStoresClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ArtifactStoresClientBeginDeleteOptions contains the optional parameters for the ArtifactStoresClient.BeginDelete method.

type ArtifactStoresClientCreateOrUpdateResponse

type ArtifactStoresClientCreateOrUpdateResponse struct {
	// Artifact store properties.
	ArtifactStore
}

ArtifactStoresClientCreateOrUpdateResponse contains the response from method ArtifactStoresClient.BeginCreateOrUpdate.

type ArtifactStoresClientDeleteResponse

type ArtifactStoresClientDeleteResponse struct {
}

ArtifactStoresClientDeleteResponse contains the response from method ArtifactStoresClient.BeginDelete.

type ArtifactStoresClientGetOptions

type ArtifactStoresClientGetOptions struct {
}

ArtifactStoresClientGetOptions contains the optional parameters for the ArtifactStoresClient.Get method.

type ArtifactStoresClientGetResponse

type ArtifactStoresClientGetResponse struct {
	// Artifact store properties.
	ArtifactStore
}

ArtifactStoresClientGetResponse contains the response from method ArtifactStoresClient.Get.

type ArtifactStoresClientListByPublisherOptions

type ArtifactStoresClientListByPublisherOptions struct {
}

ArtifactStoresClientListByPublisherOptions contains the optional parameters for the ArtifactStoresClient.NewListByPublisherPager method.

type ArtifactStoresClientListByPublisherResponse

type ArtifactStoresClientListByPublisherResponse struct {
	// A list of artifact stores.
	ArtifactStoreListResult
}

ArtifactStoresClientListByPublisherResponse contains the response from method ArtifactStoresClient.NewListByPublisherPager.

type ArtifactStoresClientUpdateOptions

type ArtifactStoresClientUpdateOptions struct {
}

ArtifactStoresClientUpdateOptions contains the optional parameters for the ArtifactStoresClient.Update method.

type ArtifactStoresClientUpdateResponse

type ArtifactStoresClientUpdateResponse struct {
	// Artifact store properties.
	ArtifactStore
}

ArtifactStoresClientUpdateResponse contains the response from method ArtifactStoresClient.Update.

type ArtifactType

type ArtifactType string

ArtifactType - The artifact type.

const (
	ArtifactTypeArmTemplate  ArtifactType = "ArmTemplate"
	ArtifactTypeImageFile    ArtifactType = "ImageFile"
	ArtifactTypeOCIArtifact  ArtifactType = "OCIArtifact"
	ArtifactTypeUnknown      ArtifactType = "Unknown"
	ArtifactTypeVhdImageFile ArtifactType = "VhdImageFile"
)

func PossibleArtifactTypeValues

func PossibleArtifactTypeValues() []ArtifactType

PossibleArtifactTypeValues returns the possible values for the ArtifactType const type.

type AzureArcK8SClusterNFVIDetails

type AzureArcK8SClusterNFVIDetails struct {
	// REQUIRED; The NFVI type.
	NfviType *NFVIType

	// The reference to the custom location.
	CustomLocationReference *ReferencedResource

	// Name of the nfvi.
	Name *string
}

AzureArcK8SClusterNFVIDetails - The AzureArcK8sCluster NFVI detail.

func (*AzureArcK8SClusterNFVIDetails) GetNFVIs

func (a *AzureArcK8SClusterNFVIDetails) GetNFVIs() *NFVIs

GetNFVIs implements the NFVIsClassification interface for type AzureArcK8SClusterNFVIDetails.

func (AzureArcK8SClusterNFVIDetails) MarshalJSON

func (a AzureArcK8SClusterNFVIDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureArcK8SClusterNFVIDetails.

func (*AzureArcK8SClusterNFVIDetails) UnmarshalJSON

func (a *AzureArcK8SClusterNFVIDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureArcK8SClusterNFVIDetails.

type AzureArcKubernetesArtifactProfile

type AzureArcKubernetesArtifactProfile struct {
	// The reference to artifact store.
	ArtifactStore *ReferencedResource

	// Helm artifact profile.
	HelmArtifactProfile *HelmArtifactProfile
}

AzureArcKubernetesArtifactProfile - Azure arc kubernetes artifact profile properties.

func (AzureArcKubernetesArtifactProfile) MarshalJSON

func (a AzureArcKubernetesArtifactProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureArcKubernetesArtifactProfile.

func (*AzureArcKubernetesArtifactProfile) UnmarshalJSON

func (a *AzureArcKubernetesArtifactProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureArcKubernetesArtifactProfile.

type AzureArcKubernetesArtifactType

type AzureArcKubernetesArtifactType string

AzureArcKubernetesArtifactType - The artifact type.

const (
	AzureArcKubernetesArtifactTypeHelmPackage AzureArcKubernetesArtifactType = "HelmPackage"
	AzureArcKubernetesArtifactTypeUnknown     AzureArcKubernetesArtifactType = "Unknown"
)

func PossibleAzureArcKubernetesArtifactTypeValues

func PossibleAzureArcKubernetesArtifactTypeValues() []AzureArcKubernetesArtifactType

PossibleAzureArcKubernetesArtifactTypeValues returns the possible values for the AzureArcKubernetesArtifactType const type.

type AzureArcKubernetesDeployMappingRuleProfile

type AzureArcKubernetesDeployMappingRuleProfile struct {
	// The application enablement.
	ApplicationEnablement *ApplicationEnablement

	// The helm mapping rule profile.
	HelmMappingRuleProfile *HelmMappingRuleProfile
}

AzureArcKubernetesDeployMappingRuleProfile - Azure arc kubernetes deploy mapping rule profile.

func (AzureArcKubernetesDeployMappingRuleProfile) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type AzureArcKubernetesDeployMappingRuleProfile.

func (*AzureArcKubernetesDeployMappingRuleProfile) UnmarshalJSON

func (a *AzureArcKubernetesDeployMappingRuleProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureArcKubernetesDeployMappingRuleProfile.

type AzureArcKubernetesHelmApplication

type AzureArcKubernetesHelmApplication struct {
	// REQUIRED; The artifact type.
	ArtifactType *AzureArcKubernetesArtifactType

	// Azure arc kubernetes artifact profile.
	ArtifactProfile *AzureArcKubernetesArtifactProfile

	// Depends on profile definition.
	DependsOnProfile *DependsOnProfile

	// Deploy mapping rule profile.
	DeployParametersMappingRuleProfile *AzureArcKubernetesDeployMappingRuleProfile

	// The name of the network function application.
	Name *string
}

AzureArcKubernetesHelmApplication - Azure arc kubernetes helm application configurations.

func (*AzureArcKubernetesHelmApplication) GetAzureArcKubernetesNetworkFunctionApplication

func (a *AzureArcKubernetesHelmApplication) GetAzureArcKubernetesNetworkFunctionApplication() *AzureArcKubernetesNetworkFunctionApplication

GetAzureArcKubernetesNetworkFunctionApplication implements the AzureArcKubernetesNetworkFunctionApplicationClassification interface for type AzureArcKubernetesHelmApplication.

func (AzureArcKubernetesHelmApplication) MarshalJSON

func (a AzureArcKubernetesHelmApplication) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureArcKubernetesHelmApplication.

func (*AzureArcKubernetesHelmApplication) UnmarshalJSON

func (a *AzureArcKubernetesHelmApplication) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureArcKubernetesHelmApplication.

type AzureArcKubernetesNetworkFunctionApplication

type AzureArcKubernetesNetworkFunctionApplication struct {
	// REQUIRED; The artifact type.
	ArtifactType *AzureArcKubernetesArtifactType

	// Depends on profile definition.
	DependsOnProfile *DependsOnProfile

	// The name of the network function application.
	Name *string
}

AzureArcKubernetesNetworkFunctionApplication - Azure arc kubernetes network function application definition.

func (*AzureArcKubernetesNetworkFunctionApplication) GetAzureArcKubernetesNetworkFunctionApplication

func (a *AzureArcKubernetesNetworkFunctionApplication) GetAzureArcKubernetesNetworkFunctionApplication() *AzureArcKubernetesNetworkFunctionApplication

GetAzureArcKubernetesNetworkFunctionApplication implements the AzureArcKubernetesNetworkFunctionApplicationClassification interface for type AzureArcKubernetesNetworkFunctionApplication.

func (AzureArcKubernetesNetworkFunctionApplication) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type AzureArcKubernetesNetworkFunctionApplication.

func (*AzureArcKubernetesNetworkFunctionApplication) UnmarshalJSON

func (a *AzureArcKubernetesNetworkFunctionApplication) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureArcKubernetesNetworkFunctionApplication.

type AzureArcKubernetesNetworkFunctionApplicationClassification

type AzureArcKubernetesNetworkFunctionApplicationClassification interface {
	// GetAzureArcKubernetesNetworkFunctionApplication returns the AzureArcKubernetesNetworkFunctionApplication content of the underlying type.
	GetAzureArcKubernetesNetworkFunctionApplication() *AzureArcKubernetesNetworkFunctionApplication
}

AzureArcKubernetesNetworkFunctionApplicationClassification provides polymorphic access to related types. Call the interface's GetAzureArcKubernetesNetworkFunctionApplication() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureArcKubernetesHelmApplication, *AzureArcKubernetesNetworkFunctionApplication

type AzureArcKubernetesNetworkFunctionTemplate

type AzureArcKubernetesNetworkFunctionTemplate struct {
	// REQUIRED; The network function type.
	NfviType *ContainerizedNetworkFunctionNFVIType

	// Network function applications.
	NetworkFunctionApplications []AzureArcKubernetesNetworkFunctionApplicationClassification
}

AzureArcKubernetesNetworkFunctionTemplate - Azure Arc kubernetes network function template.

func (*AzureArcKubernetesNetworkFunctionTemplate) GetContainerizedNetworkFunctionTemplate

func (a *AzureArcKubernetesNetworkFunctionTemplate) GetContainerizedNetworkFunctionTemplate() *ContainerizedNetworkFunctionTemplate

GetContainerizedNetworkFunctionTemplate implements the ContainerizedNetworkFunctionTemplateClassification interface for type AzureArcKubernetesNetworkFunctionTemplate.

func (AzureArcKubernetesNetworkFunctionTemplate) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type AzureArcKubernetesNetworkFunctionTemplate.

func (*AzureArcKubernetesNetworkFunctionTemplate) UnmarshalJSON

func (a *AzureArcKubernetesNetworkFunctionTemplate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureArcKubernetesNetworkFunctionTemplate.

type AzureContainerRegistryScopedTokenCredential

type AzureContainerRegistryScopedTokenCredential struct {
	// REQUIRED; The credential type.
	CredentialType *CredentialType

	// The Acr server url
	AcrServerURL *string

	// The credential value.
	AcrToken *string

	// The UTC time when credential will expire.
	Expiry *time.Time

	// The repositories that could be accessed using the current credential.
	Repositories []*string

	// The username of the credential.
	Username *string
}

AzureContainerRegistryScopedTokenCredential - The azure container registry scoped token credential definition.

func (*AzureContainerRegistryScopedTokenCredential) GetArtifactAccessCredential

GetArtifactAccessCredential implements the ArtifactAccessCredentialClassification interface for type AzureContainerRegistryScopedTokenCredential.

func (AzureContainerRegistryScopedTokenCredential) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type AzureContainerRegistryScopedTokenCredential.

func (*AzureContainerRegistryScopedTokenCredential) UnmarshalJSON

func (a *AzureContainerRegistryScopedTokenCredential) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureContainerRegistryScopedTokenCredential.

type AzureCoreArmTemplateArtifactProfile

type AzureCoreArmTemplateArtifactProfile struct {
	// The reference to artifact store.
	ArtifactStore *ReferencedResource

	// Template artifact profile.
	TemplateArtifactProfile *ArmTemplateArtifactProfile
}

AzureCoreArmTemplateArtifactProfile - Azure template artifact profile properties.

func (AzureCoreArmTemplateArtifactProfile) MarshalJSON

func (a AzureCoreArmTemplateArtifactProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureCoreArmTemplateArtifactProfile.

func (*AzureCoreArmTemplateArtifactProfile) UnmarshalJSON

func (a *AzureCoreArmTemplateArtifactProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureCoreArmTemplateArtifactProfile.

type AzureCoreArmTemplateDeployMappingRuleProfile

type AzureCoreArmTemplateDeployMappingRuleProfile struct {
	// The application enablement.
	ApplicationEnablement *ApplicationEnablement

	// The template mapping rule profile.
	TemplateMappingRuleProfile *ArmTemplateMappingRuleProfile
}

AzureCoreArmTemplateDeployMappingRuleProfile - Azure template deploy mapping rule profile.

func (AzureCoreArmTemplateDeployMappingRuleProfile) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type AzureCoreArmTemplateDeployMappingRuleProfile.

func (*AzureCoreArmTemplateDeployMappingRuleProfile) UnmarshalJSON

func (a *AzureCoreArmTemplateDeployMappingRuleProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureCoreArmTemplateDeployMappingRuleProfile.

type AzureCoreArtifactType

type AzureCoreArtifactType string

AzureCoreArtifactType - The artifact type.

const (
	AzureCoreArtifactTypeArmTemplate  AzureCoreArtifactType = "ArmTemplate"
	AzureCoreArtifactTypeUnknown      AzureCoreArtifactType = "Unknown"
	AzureCoreArtifactTypeVhdImageFile AzureCoreArtifactType = "VhdImageFile"
)

func PossibleAzureCoreArtifactTypeValues

func PossibleAzureCoreArtifactTypeValues() []AzureCoreArtifactType

PossibleAzureCoreArtifactTypeValues returns the possible values for the AzureCoreArtifactType const type.

type AzureCoreNFVIDetails

type AzureCoreNFVIDetails struct {
	// REQUIRED; The NFVI type.
	NfviType *NFVIType

	// Location of the Azure core.
	Location *string

	// Name of the nfvi.
	Name *string
}

AzureCoreNFVIDetails - The Azure Core NFVI detail.

func (*AzureCoreNFVIDetails) GetNFVIs

func (a *AzureCoreNFVIDetails) GetNFVIs() *NFVIs

GetNFVIs implements the NFVIsClassification interface for type AzureCoreNFVIDetails.

func (AzureCoreNFVIDetails) MarshalJSON

func (a AzureCoreNFVIDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureCoreNFVIDetails.

func (*AzureCoreNFVIDetails) UnmarshalJSON

func (a *AzureCoreNFVIDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureCoreNFVIDetails.

type AzureCoreNetworkFunctionApplication

type AzureCoreNetworkFunctionApplication struct {
	// REQUIRED; The artifact type.
	ArtifactType *AzureCoreArtifactType

	// Depends on profile definition.
	DependsOnProfile *DependsOnProfile

	// The name of the network function application.
	Name *string
}

AzureCoreNetworkFunctionApplication - Azure virtual network function application definition.

func (*AzureCoreNetworkFunctionApplication) GetAzureCoreNetworkFunctionApplication

func (a *AzureCoreNetworkFunctionApplication) GetAzureCoreNetworkFunctionApplication() *AzureCoreNetworkFunctionApplication

GetAzureCoreNetworkFunctionApplication implements the AzureCoreNetworkFunctionApplicationClassification interface for type AzureCoreNetworkFunctionApplication.

func (AzureCoreNetworkFunctionApplication) MarshalJSON

func (a AzureCoreNetworkFunctionApplication) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureCoreNetworkFunctionApplication.

func (*AzureCoreNetworkFunctionApplication) UnmarshalJSON

func (a *AzureCoreNetworkFunctionApplication) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureCoreNetworkFunctionApplication.

type AzureCoreNetworkFunctionApplicationClassification

type AzureCoreNetworkFunctionApplicationClassification interface {
	// GetAzureCoreNetworkFunctionApplication returns the AzureCoreNetworkFunctionApplication content of the underlying type.
	GetAzureCoreNetworkFunctionApplication() *AzureCoreNetworkFunctionApplication
}

AzureCoreNetworkFunctionApplicationClassification provides polymorphic access to related types. Call the interface's GetAzureCoreNetworkFunctionApplication() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureCoreNetworkFunctionApplication, *AzureCoreNetworkFunctionArmTemplateApplication, *AzureCoreNetworkFunctionVhdApplication

type AzureCoreNetworkFunctionArmTemplateApplication

type AzureCoreNetworkFunctionArmTemplateApplication struct {
	// REQUIRED; The artifact type.
	ArtifactType *AzureCoreArtifactType

	// Azure template artifact profile.
	ArtifactProfile *AzureCoreArmTemplateArtifactProfile

	// Depends on profile definition.
	DependsOnProfile *DependsOnProfile

	// Deploy mapping rule profile.
	DeployParametersMappingRuleProfile *AzureCoreArmTemplateDeployMappingRuleProfile

	// The name of the network function application.
	Name *string
}

AzureCoreNetworkFunctionArmTemplateApplication - Azure core network function Template application definition.

func (*AzureCoreNetworkFunctionArmTemplateApplication) GetAzureCoreNetworkFunctionApplication

func (a *AzureCoreNetworkFunctionArmTemplateApplication) GetAzureCoreNetworkFunctionApplication() *AzureCoreNetworkFunctionApplication

GetAzureCoreNetworkFunctionApplication implements the AzureCoreNetworkFunctionApplicationClassification interface for type AzureCoreNetworkFunctionArmTemplateApplication.

func (AzureCoreNetworkFunctionArmTemplateApplication) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type AzureCoreNetworkFunctionArmTemplateApplication.

func (*AzureCoreNetworkFunctionArmTemplateApplication) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type AzureCoreNetworkFunctionArmTemplateApplication.

type AzureCoreNetworkFunctionTemplate

type AzureCoreNetworkFunctionTemplate struct {
	// REQUIRED; The network function type.
	NfviType *VirtualNetworkFunctionNFVIType

	// Network function applications.
	NetworkFunctionApplications []AzureCoreNetworkFunctionApplicationClassification
}

AzureCoreNetworkFunctionTemplate - Azure virtual network function template.

func (*AzureCoreNetworkFunctionTemplate) GetVirtualNetworkFunctionTemplate

func (a *AzureCoreNetworkFunctionTemplate) GetVirtualNetworkFunctionTemplate() *VirtualNetworkFunctionTemplate

GetVirtualNetworkFunctionTemplate implements the VirtualNetworkFunctionTemplateClassification interface for type AzureCoreNetworkFunctionTemplate.

func (AzureCoreNetworkFunctionTemplate) MarshalJSON

func (a AzureCoreNetworkFunctionTemplate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureCoreNetworkFunctionTemplate.

func (*AzureCoreNetworkFunctionTemplate) UnmarshalJSON

func (a *AzureCoreNetworkFunctionTemplate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureCoreNetworkFunctionTemplate.

type AzureCoreNetworkFunctionVhdApplication

type AzureCoreNetworkFunctionVhdApplication struct {
	// REQUIRED; The artifact type.
	ArtifactType *AzureCoreArtifactType

	// Azure vhd image artifact profile.
	ArtifactProfile *AzureCoreVhdImageArtifactProfile

	// Depends on profile definition.
	DependsOnProfile *DependsOnProfile

	// Deploy mapping rule profile.
	DeployParametersMappingRuleProfile *AzureCoreVhdImageDeployMappingRuleProfile

	// The name of the network function application.
	Name *string
}

AzureCoreNetworkFunctionVhdApplication - Azure core network function vhd application definition.

func (*AzureCoreNetworkFunctionVhdApplication) GetAzureCoreNetworkFunctionApplication

func (a *AzureCoreNetworkFunctionVhdApplication) GetAzureCoreNetworkFunctionApplication() *AzureCoreNetworkFunctionApplication

GetAzureCoreNetworkFunctionApplication implements the AzureCoreNetworkFunctionApplicationClassification interface for type AzureCoreNetworkFunctionVhdApplication.

func (AzureCoreNetworkFunctionVhdApplication) MarshalJSON

func (a AzureCoreNetworkFunctionVhdApplication) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureCoreNetworkFunctionVhdApplication.

func (*AzureCoreNetworkFunctionVhdApplication) UnmarshalJSON

func (a *AzureCoreNetworkFunctionVhdApplication) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureCoreNetworkFunctionVhdApplication.

type AzureCoreVhdImageArtifactProfile

type AzureCoreVhdImageArtifactProfile struct {
	// The reference to artifact store.
	ArtifactStore *ReferencedResource

	// Vhd artifact profile.
	VhdArtifactProfile *VhdImageArtifactProfile
}

AzureCoreVhdImageArtifactProfile - Azure vhd artifact profile properties.

func (AzureCoreVhdImageArtifactProfile) MarshalJSON

func (a AzureCoreVhdImageArtifactProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureCoreVhdImageArtifactProfile.

func (*AzureCoreVhdImageArtifactProfile) UnmarshalJSON

func (a *AzureCoreVhdImageArtifactProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureCoreVhdImageArtifactProfile.

type AzureCoreVhdImageDeployMappingRuleProfile

type AzureCoreVhdImageDeployMappingRuleProfile struct {
	// The application enablement.
	ApplicationEnablement *ApplicationEnablement

	// The vhd mapping rule profile.
	VhdImageMappingRuleProfile *VhdImageMappingRuleProfile
}

AzureCoreVhdImageDeployMappingRuleProfile - Azure vhd deploy mapping rule profile.

func (AzureCoreVhdImageDeployMappingRuleProfile) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type AzureCoreVhdImageDeployMappingRuleProfile.

func (*AzureCoreVhdImageDeployMappingRuleProfile) UnmarshalJSON

func (a *AzureCoreVhdImageDeployMappingRuleProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureCoreVhdImageDeployMappingRuleProfile.

type AzureOperatorNexusArmTemplateArtifactProfile

type AzureOperatorNexusArmTemplateArtifactProfile struct {
	// The reference to artifact store.
	ArtifactStore *ReferencedResource

	// Template artifact profile.
	TemplateArtifactProfile *ArmTemplateArtifactProfile
}

AzureOperatorNexusArmTemplateArtifactProfile - Azure Operator Distributed Services vhd artifact profile properties.

func (AzureOperatorNexusArmTemplateArtifactProfile) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type AzureOperatorNexusArmTemplateArtifactProfile.

func (*AzureOperatorNexusArmTemplateArtifactProfile) UnmarshalJSON

func (a *AzureOperatorNexusArmTemplateArtifactProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureOperatorNexusArmTemplateArtifactProfile.

type AzureOperatorNexusArmTemplateDeployMappingRuleProfile

type AzureOperatorNexusArmTemplateDeployMappingRuleProfile struct {
	// The application enablement.
	ApplicationEnablement *ApplicationEnablement

	// The template mapping rule profile.
	TemplateMappingRuleProfile *ArmTemplateMappingRuleProfile
}

AzureOperatorNexusArmTemplateDeployMappingRuleProfile - Azure Operator Distributed Services template deploy mapping rule profile.

func (AzureOperatorNexusArmTemplateDeployMappingRuleProfile) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type AzureOperatorNexusArmTemplateDeployMappingRuleProfile.

func (*AzureOperatorNexusArmTemplateDeployMappingRuleProfile) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type AzureOperatorNexusArmTemplateDeployMappingRuleProfile.

type AzureOperatorNexusArtifactType

type AzureOperatorNexusArtifactType string

AzureOperatorNexusArtifactType - The artifact type.

const (
	AzureOperatorNexusArtifactTypeArmTemplate AzureOperatorNexusArtifactType = "ArmTemplate"
	AzureOperatorNexusArtifactTypeImageFile   AzureOperatorNexusArtifactType = "ImageFile"
	AzureOperatorNexusArtifactTypeUnknown     AzureOperatorNexusArtifactType = "Unknown"
)

func PossibleAzureOperatorNexusArtifactTypeValues

func PossibleAzureOperatorNexusArtifactTypeValues() []AzureOperatorNexusArtifactType

PossibleAzureOperatorNexusArtifactTypeValues returns the possible values for the AzureOperatorNexusArtifactType const type.

type AzureOperatorNexusClusterNFVIDetails

type AzureOperatorNexusClusterNFVIDetails struct {
	// REQUIRED; The NFVI type.
	NfviType *NFVIType

	// The reference to the custom location.
	CustomLocationReference *ReferencedResource

	// Name of the nfvi.
	Name *string
}

AzureOperatorNexusClusterNFVIDetails - The AzureOperatorNexusCluster NFVI detail.

func (*AzureOperatorNexusClusterNFVIDetails) GetNFVIs

GetNFVIs implements the NFVIsClassification interface for type AzureOperatorNexusClusterNFVIDetails.

func (AzureOperatorNexusClusterNFVIDetails) MarshalJSON

func (a AzureOperatorNexusClusterNFVIDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureOperatorNexusClusterNFVIDetails.

func (*AzureOperatorNexusClusterNFVIDetails) UnmarshalJSON

func (a *AzureOperatorNexusClusterNFVIDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureOperatorNexusClusterNFVIDetails.

type AzureOperatorNexusImageArtifactProfile

type AzureOperatorNexusImageArtifactProfile struct {
	// The reference to artifact store.
	ArtifactStore *ReferencedResource

	// Image artifact profile.
	ImageArtifactProfile *ImageArtifactProfile
}

AzureOperatorNexusImageArtifactProfile - Azure Operator Distributed Services image artifact profile properties.

func (AzureOperatorNexusImageArtifactProfile) MarshalJSON

func (a AzureOperatorNexusImageArtifactProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureOperatorNexusImageArtifactProfile.

func (*AzureOperatorNexusImageArtifactProfile) UnmarshalJSON

func (a *AzureOperatorNexusImageArtifactProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureOperatorNexusImageArtifactProfile.

type AzureOperatorNexusImageDeployMappingRuleProfile

type AzureOperatorNexusImageDeployMappingRuleProfile struct {
	// The application enablement.
	ApplicationEnablement *ApplicationEnablement

	// The vhd mapping rule profile.
	ImageMappingRuleProfile *ImageMappingRuleProfile
}

AzureOperatorNexusImageDeployMappingRuleProfile - Azure Operator Distributed Services image deploy mapping rule profile.

func (AzureOperatorNexusImageDeployMappingRuleProfile) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type AzureOperatorNexusImageDeployMappingRuleProfile.

func (*AzureOperatorNexusImageDeployMappingRuleProfile) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type AzureOperatorNexusImageDeployMappingRuleProfile.

type AzureOperatorNexusNetworkFunctionApplication

type AzureOperatorNexusNetworkFunctionApplication struct {
	// REQUIRED; The artifact type.
	ArtifactType *AzureOperatorNexusArtifactType

	// Depends on profile definition.
	DependsOnProfile *DependsOnProfile

	// The name of the network function application.
	Name *string
}

AzureOperatorNexusNetworkFunctionApplication - Azure Operator Distributed Services network function application definition.

func (*AzureOperatorNexusNetworkFunctionApplication) GetAzureOperatorNexusNetworkFunctionApplication

func (a *AzureOperatorNexusNetworkFunctionApplication) GetAzureOperatorNexusNetworkFunctionApplication() *AzureOperatorNexusNetworkFunctionApplication

GetAzureOperatorNexusNetworkFunctionApplication implements the AzureOperatorNexusNetworkFunctionApplicationClassification interface for type AzureOperatorNexusNetworkFunctionApplication.

func (AzureOperatorNexusNetworkFunctionApplication) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type AzureOperatorNexusNetworkFunctionApplication.

func (*AzureOperatorNexusNetworkFunctionApplication) UnmarshalJSON

func (a *AzureOperatorNexusNetworkFunctionApplication) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureOperatorNexusNetworkFunctionApplication.

type AzureOperatorNexusNetworkFunctionApplicationClassification

type AzureOperatorNexusNetworkFunctionApplicationClassification interface {
	// GetAzureOperatorNexusNetworkFunctionApplication returns the AzureOperatorNexusNetworkFunctionApplication content of the underlying type.
	GetAzureOperatorNexusNetworkFunctionApplication() *AzureOperatorNexusNetworkFunctionApplication
}

AzureOperatorNexusNetworkFunctionApplicationClassification provides polymorphic access to related types. Call the interface's GetAzureOperatorNexusNetworkFunctionApplication() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureOperatorNexusNetworkFunctionApplication, *AzureOperatorNexusNetworkFunctionArmTemplateApplication, *AzureOperatorNexusNetworkFunctionImageApplication

type AzureOperatorNexusNetworkFunctionArmTemplateApplication

type AzureOperatorNexusNetworkFunctionArmTemplateApplication struct {
	// REQUIRED; The artifact type.
	ArtifactType *AzureOperatorNexusArtifactType

	// Azure Operator Distributed Services Template artifact profile.
	ArtifactProfile *AzureOperatorNexusArmTemplateArtifactProfile

	// Depends on profile definition.
	DependsOnProfile *DependsOnProfile

	// Deploy mapping rule profile.
	DeployParametersMappingRuleProfile *AzureOperatorNexusArmTemplateDeployMappingRuleProfile

	// The name of the network function application.
	Name *string
}

AzureOperatorNexusNetworkFunctionArmTemplateApplication - Azure Operator Distributed Services network function Template application definition.

func (*AzureOperatorNexusNetworkFunctionArmTemplateApplication) GetAzureOperatorNexusNetworkFunctionApplication

GetAzureOperatorNexusNetworkFunctionApplication implements the AzureOperatorNexusNetworkFunctionApplicationClassification interface for type AzureOperatorNexusNetworkFunctionArmTemplateApplication.

func (AzureOperatorNexusNetworkFunctionArmTemplateApplication) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type AzureOperatorNexusNetworkFunctionArmTemplateApplication.

func (*AzureOperatorNexusNetworkFunctionArmTemplateApplication) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type AzureOperatorNexusNetworkFunctionArmTemplateApplication.

type AzureOperatorNexusNetworkFunctionImageApplication

type AzureOperatorNexusNetworkFunctionImageApplication struct {
	// REQUIRED; The artifact type.
	ArtifactType *AzureOperatorNexusArtifactType

	// Azure Operator Distributed Services image artifact profile.
	ArtifactProfile *AzureOperatorNexusImageArtifactProfile

	// Depends on profile definition.
	DependsOnProfile *DependsOnProfile

	// Deploy mapping rule profile.
	DeployParametersMappingRuleProfile *AzureOperatorNexusImageDeployMappingRuleProfile

	// The name of the network function application.
	Name *string
}

AzureOperatorNexusNetworkFunctionImageApplication - Azure Operator Distributed Services network function image application definition.

func (*AzureOperatorNexusNetworkFunctionImageApplication) GetAzureOperatorNexusNetworkFunctionApplication

func (a *AzureOperatorNexusNetworkFunctionImageApplication) GetAzureOperatorNexusNetworkFunctionApplication() *AzureOperatorNexusNetworkFunctionApplication

GetAzureOperatorNexusNetworkFunctionApplication implements the AzureOperatorNexusNetworkFunctionApplicationClassification interface for type AzureOperatorNexusNetworkFunctionImageApplication.

func (AzureOperatorNexusNetworkFunctionImageApplication) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type AzureOperatorNexusNetworkFunctionImageApplication.

func (*AzureOperatorNexusNetworkFunctionImageApplication) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type AzureOperatorNexusNetworkFunctionImageApplication.

type AzureOperatorNexusNetworkFunctionTemplate

type AzureOperatorNexusNetworkFunctionTemplate struct {
	// REQUIRED; The network function type.
	NfviType *VirtualNetworkFunctionNFVIType

	// Network function applications.
	NetworkFunctionApplications []AzureOperatorNexusNetworkFunctionApplicationClassification
}

AzureOperatorNexusNetworkFunctionTemplate - Azure Operator Distributed Services network function template.

func (*AzureOperatorNexusNetworkFunctionTemplate) GetVirtualNetworkFunctionTemplate

func (a *AzureOperatorNexusNetworkFunctionTemplate) GetVirtualNetworkFunctionTemplate() *VirtualNetworkFunctionTemplate

GetVirtualNetworkFunctionTemplate implements the VirtualNetworkFunctionTemplateClassification interface for type AzureOperatorNexusNetworkFunctionTemplate.

func (AzureOperatorNexusNetworkFunctionTemplate) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type AzureOperatorNexusNetworkFunctionTemplate.

func (*AzureOperatorNexusNetworkFunctionTemplate) UnmarshalJSON

func (a *AzureOperatorNexusNetworkFunctionTemplate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureOperatorNexusNetworkFunctionTemplate.

type AzureStorageAccountContainerCredential

type AzureStorageAccountContainerCredential struct {
	// The storage account container name
	ContainerName *string

	// The storage account container sas uri
	ContainerSasURI *string
}

AzureStorageAccountContainerCredential - The azure storage account container credential definition.

func (AzureStorageAccountContainerCredential) MarshalJSON

func (a AzureStorageAccountContainerCredential) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureStorageAccountContainerCredential.

func (*AzureStorageAccountContainerCredential) UnmarshalJSON

func (a *AzureStorageAccountContainerCredential) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureStorageAccountContainerCredential.

type AzureStorageAccountCredential

type AzureStorageAccountCredential struct {
	// REQUIRED; The credential type.
	CredentialType *CredentialType

	// The containers that could be accessed using the current credential.
	ContainerCredentials []*AzureStorageAccountContainerCredential

	// The UTC time when credential will expire.
	Expiry *time.Time

	// The storage account Id
	StorageAccountID *string
}

AzureStorageAccountCredential - The azure storage account credential definition.

func (*AzureStorageAccountCredential) GetArtifactAccessCredential

func (a *AzureStorageAccountCredential) GetArtifactAccessCredential() *ArtifactAccessCredential

GetArtifactAccessCredential implements the ArtifactAccessCredentialClassification interface for type AzureStorageAccountCredential.

func (AzureStorageAccountCredential) MarshalJSON

func (a AzureStorageAccountCredential) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureStorageAccountCredential.

func (*AzureStorageAccountCredential) UnmarshalJSON

func (a *AzureStorageAccountCredential) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureStorageAccountCredential.

type ClientFactory

type ClientFactory struct {
	// contains filtered or unexported fields
}

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory

func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewArtifactManifestsClient

func (c *ClientFactory) NewArtifactManifestsClient() *ArtifactManifestsClient

NewArtifactManifestsClient creates a new instance of ArtifactManifestsClient.

func (*ClientFactory) NewArtifactStoresClient

func (c *ClientFactory) NewArtifactStoresClient() *ArtifactStoresClient

NewArtifactStoresClient creates a new instance of ArtifactStoresClient.

func (*ClientFactory) NewComponentsClient

func (c *ClientFactory) NewComponentsClient() *ComponentsClient

NewComponentsClient creates a new instance of ComponentsClient.

func (*ClientFactory) NewConfigurationGroupSchemasClient

func (c *ClientFactory) NewConfigurationGroupSchemasClient() *ConfigurationGroupSchemasClient

NewConfigurationGroupSchemasClient creates a new instance of ConfigurationGroupSchemasClient.

func (*ClientFactory) NewConfigurationGroupValuesClient

func (c *ClientFactory) NewConfigurationGroupValuesClient() *ConfigurationGroupValuesClient

NewConfigurationGroupValuesClient creates a new instance of ConfigurationGroupValuesClient.

func (*ClientFactory) NewNetworkFunctionDefinitionGroupsClient

func (c *ClientFactory) NewNetworkFunctionDefinitionGroupsClient() *NetworkFunctionDefinitionGroupsClient

NewNetworkFunctionDefinitionGroupsClient creates a new instance of NetworkFunctionDefinitionGroupsClient.

func (*ClientFactory) NewNetworkFunctionDefinitionVersionsClient

func (c *ClientFactory) NewNetworkFunctionDefinitionVersionsClient() *NetworkFunctionDefinitionVersionsClient

NewNetworkFunctionDefinitionVersionsClient creates a new instance of NetworkFunctionDefinitionVersionsClient.

func (*ClientFactory) NewNetworkFunctionsClient

func (c *ClientFactory) NewNetworkFunctionsClient() *NetworkFunctionsClient

NewNetworkFunctionsClient creates a new instance of NetworkFunctionsClient.

func (*ClientFactory) NewNetworkServiceDesignGroupsClient

func (c *ClientFactory) NewNetworkServiceDesignGroupsClient() *NetworkServiceDesignGroupsClient

NewNetworkServiceDesignGroupsClient creates a new instance of NetworkServiceDesignGroupsClient.

func (*ClientFactory) NewNetworkServiceDesignVersionsClient

func (c *ClientFactory) NewNetworkServiceDesignVersionsClient() *NetworkServiceDesignVersionsClient

NewNetworkServiceDesignVersionsClient creates a new instance of NetworkServiceDesignVersionsClient.

func (*ClientFactory) NewOperationsClient

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewProxyArtifactClient

func (c *ClientFactory) NewProxyArtifactClient() *ProxyArtifactClient

NewProxyArtifactClient creates a new instance of ProxyArtifactClient.

func (*ClientFactory) NewPublishersClient

func (c *ClientFactory) NewPublishersClient() *PublishersClient

NewPublishersClient creates a new instance of PublishersClient.

func (*ClientFactory) NewSiteNetworkServicesClient

func (c *ClientFactory) NewSiteNetworkServicesClient() *SiteNetworkServicesClient

NewSiteNetworkServicesClient creates a new instance of SiteNetworkServicesClient.

func (*ClientFactory) NewSitesClient

func (c *ClientFactory) NewSitesClient() *SitesClient

NewSitesClient creates a new instance of SitesClient.

type Component

type Component struct {
	// The component properties.
	Properties *ComponentProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Component - The component sub resource.

func (Component) MarshalJSON

func (c Component) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Component.

func (*Component) UnmarshalJSON

func (c *Component) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Component.

type ComponentListResult

type ComponentListResult struct {
	// A list of component resources in a networkFunction.
	Value []*Component

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string
}

ComponentListResult - Response for list component API service call.

func (ComponentListResult) MarshalJSON

func (c ComponentListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ComponentListResult.

func (*ComponentListResult) UnmarshalJSON

func (c *ComponentListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ComponentListResult.

type ComponentProperties

type ComponentProperties struct {
	// READ-ONLY; The JSON-serialized deployment profile of the component resource.
	DeploymentProfile *string

	// READ-ONLY; The deployment status of the component resource.
	DeploymentStatus *DeploymentStatusProperties

	// READ-ONLY; The provisioning state of the component resource.
	ProvisioningState *ProvisioningState
}

ComponentProperties - The component properties of the network function.

func (ComponentProperties) MarshalJSON

func (c ComponentProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ComponentProperties.

func (*ComponentProperties) UnmarshalJSON

func (c *ComponentProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ComponentProperties.

type ComponentsClient

type ComponentsClient struct {
	// contains filtered or unexported fields
}

ComponentsClient contains the methods for the Components group. Don't use this type directly, use NewComponentsClient() instead.

func NewComponentsClient

func NewComponentsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ComponentsClient, error)

NewComponentsClient creates a new instance of ComponentsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ComponentsClient) Get

func (client *ComponentsClient) Get(ctx context.Context, resourceGroupName string, networkFunctionName string, componentName string, options *ComponentsClientGetOptions) (ComponentsClientGetResponse, error)

Get - Gets information about the specified application instance resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • networkFunctionName - The name of the network function.
  • componentName - The name of the component.
  • options - ComponentsClientGetOptions contains the optional parameters for the ComponentsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ComponentGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewComponentsClient().Get(ctx, "rg", "testNf", "testComponent", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Component = armhybridnetwork.Component{
// 	Name: to.Ptr("testComponent"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/networkFunctions/components"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf/components/testComponent"),
// 	Properties: &armhybridnetwork.ComponentProperties{
// 		DeploymentProfile: to.Ptr("{\"chart\":{\"name\":\"testChartName\",\"version\":\"v1.0.0\"},\"releaseName\":\"testReleaseName\",\"targetNamespace\":\"testTargetNameSpace\",\"values\":{\".repoBase\":\"testrepo.azurecr.io/\"}}"),
// 		DeploymentStatus: &armhybridnetwork.DeploymentStatusProperties{
// 			NextExpectedUpdateAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-10T02:06:01.116Z"); return t}()),
// 			Resources: &armhybridnetwork.Resources{
// 				Deployments: []*armhybridnetwork.Deployment{
// 					{
// 						Name: to.Ptr("nginix"),
// 						Available: to.Ptr[int32](3),
// 						CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-10T02:05:01.116Z"); return t}()),
// 						Desired: to.Ptr[int32](3),
// 						Namespace: to.Ptr("core"),
// 						Ready: to.Ptr[int32](3),
// 						UpToDate: to.Ptr[int32](3),
// 				}},
// 				Pods: []*armhybridnetwork.Pod{
// 					{
// 						Name: to.Ptr("nginix"),
// 						CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-10T02:05:01.116Z"); return t}()),
// 						Desired: to.Ptr[int32](3),
// 						Events: []*armhybridnetwork.PodEvent{
// 							{
// 								Type: to.Ptr(armhybridnetwork.PodEventTypeNormal),
// 								LastSeenTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-10T02:06:01.116Z"); return t}()),
// 								Message: to.Ptr("Pulling image nginx"),
// 								Reason: to.Ptr("Pulling"),
// 						}},
// 						Namespace: to.Ptr("core"),
// 						Ready: to.Ptr[int32](3),
// 						Status: to.Ptr(armhybridnetwork.PodStatusSucceeded),
// 				}},
// 			},
// 			Status: to.Ptr(armhybridnetwork.StatusInstalling),
// 		},
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 	},
// }
Output:

func (*ComponentsClient) NewListByNetworkFunctionPager

func (client *ComponentsClient) NewListByNetworkFunctionPager(resourceGroupName string, networkFunctionName string, options *ComponentsClientListByNetworkFunctionOptions) *runtime.Pager[ComponentsClientListByNetworkFunctionResponse]

NewListByNetworkFunctionPager - Lists all the component resources in a network function.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • networkFunctionName - The name of the network function.
  • options - ComponentsClientListByNetworkFunctionOptions contains the optional parameters for the ComponentsClient.NewListByNetworkFunctionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ComponentListByNetworkFunction.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewComponentsClient().NewListByNetworkFunctionPager("rg", "testNf", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ComponentListResult = armhybridnetwork.ComponentListResult{
	// 	Value: []*armhybridnetwork.Component{
	// 		{
	// 			Name: to.Ptr("testComponent"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/networkFunctions/components"),
	// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf/components/testComponent"),
	// 			Properties: &armhybridnetwork.ComponentProperties{
	// 				DeploymentProfile: to.Ptr("{\"chart\":{\"name\":\"testChartName\",\"version\":\"v1.0.0\"},\"releaseName\":\"testReleaseName\",\"targetNamespace\":\"testTargetNameSpace\",\"values\":{\".repoBase\":\"testrepo.azurecr.io/\"}}"),
	// 				DeploymentStatus: &armhybridnetwork.DeploymentStatusProperties{
	// 					NextExpectedUpdateAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-10T02:06:01.116Z"); return t}()),
	// 					Resources: &armhybridnetwork.Resources{
	// 						Deployments: []*armhybridnetwork.Deployment{
	// 							{
	// 								Name: to.Ptr("nginix"),
	// 								Available: to.Ptr[int32](3),
	// 								CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-10T02:05:01.116Z"); return t}()),
	// 								Desired: to.Ptr[int32](3),
	// 								Namespace: to.Ptr("core"),
	// 								Ready: to.Ptr[int32](3),
	// 								UpToDate: to.Ptr[int32](3),
	// 						}},
	// 						Pods: []*armhybridnetwork.Pod{
	// 							{
	// 								Name: to.Ptr("nginix"),
	// 								CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-10T02:05:01.116Z"); return t}()),
	// 								Desired: to.Ptr[int32](3),
	// 								Events: []*armhybridnetwork.PodEvent{
	// 									{
	// 										Type: to.Ptr(armhybridnetwork.PodEventTypeNormal),
	// 										LastSeenTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-10T02:06:01.116Z"); return t}()),
	// 										Message: to.Ptr("Pulling image nginx"),
	// 										Reason: to.Ptr("Pulling"),
	// 								}},
	// 								Namespace: to.Ptr("core"),
	// 								Ready: to.Ptr[int32](3),
	// 								Status: to.Ptr(armhybridnetwork.PodStatusSucceeded),
	// 						}},
	// 					},
	// 					Status: to.Ptr(armhybridnetwork.StatusInstalling),
	// 				},
	// 				ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}
Output:

type ComponentsClientGetOptions

type ComponentsClientGetOptions struct {
}

ComponentsClientGetOptions contains the optional parameters for the ComponentsClient.Get method.

type ComponentsClientGetResponse

type ComponentsClientGetResponse struct {
	// The component sub resource.
	Component
}

ComponentsClientGetResponse contains the response from method ComponentsClient.Get.

type ComponentsClientListByNetworkFunctionOptions

type ComponentsClientListByNetworkFunctionOptions struct {
}

ComponentsClientListByNetworkFunctionOptions contains the optional parameters for the ComponentsClient.NewListByNetworkFunctionPager method.

type ComponentsClientListByNetworkFunctionResponse

type ComponentsClientListByNetworkFunctionResponse struct {
	// Response for list component API service call.
	ComponentListResult
}

ComponentsClientListByNetworkFunctionResponse contains the response from method ComponentsClient.NewListByNetworkFunctionPager.

type ConfigurationGroupSchema

type ConfigurationGroupSchema struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// Configuration group schema properties.
	Properties *ConfigurationGroupSchemaPropertiesFormat

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ConfigurationGroupSchema - Configuration group schema resource.

func (ConfigurationGroupSchema) MarshalJSON

func (c ConfigurationGroupSchema) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConfigurationGroupSchema.

func (*ConfigurationGroupSchema) UnmarshalJSON

func (c *ConfigurationGroupSchema) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationGroupSchema.

type ConfigurationGroupSchemaListResult

type ConfigurationGroupSchemaListResult struct {
	// A list of configuration group schema.
	Value []*ConfigurationGroupSchema

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string
}

ConfigurationGroupSchemaListResult - A list of configuration group schema resources.

func (ConfigurationGroupSchemaListResult) MarshalJSON

func (c ConfigurationGroupSchemaListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConfigurationGroupSchemaListResult.

func (*ConfigurationGroupSchemaListResult) UnmarshalJSON

func (c *ConfigurationGroupSchemaListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationGroupSchemaListResult.

type ConfigurationGroupSchemaPropertiesFormat

type ConfigurationGroupSchemaPropertiesFormat struct {
	// Description of what schema can contain.
	Description *string

	// Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
	SchemaDefinition *string

	// READ-ONLY; The provisioning state of the Configuration group schema resource.
	ProvisioningState *ProvisioningState

	// READ-ONLY; The configuration group schema version state.
	VersionState *VersionState
}

ConfigurationGroupSchemaPropertiesFormat - Configuration group schema properties.

func (ConfigurationGroupSchemaPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ConfigurationGroupSchemaPropertiesFormat.

func (*ConfigurationGroupSchemaPropertiesFormat) UnmarshalJSON

func (c *ConfigurationGroupSchemaPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationGroupSchemaPropertiesFormat.

type ConfigurationGroupSchemaVersionUpdateState

type ConfigurationGroupSchemaVersionUpdateState struct {
	// The configuration group schema state.
	VersionState *VersionState
}

ConfigurationGroupSchemaVersionUpdateState - Publisher configuration group schema update request definition.

func (ConfigurationGroupSchemaVersionUpdateState) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ConfigurationGroupSchemaVersionUpdateState.

func (*ConfigurationGroupSchemaVersionUpdateState) UnmarshalJSON

func (c *ConfigurationGroupSchemaVersionUpdateState) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationGroupSchemaVersionUpdateState.

type ConfigurationGroupSchemasClient

type ConfigurationGroupSchemasClient struct {
	// contains filtered or unexported fields
}

ConfigurationGroupSchemasClient contains the methods for the ConfigurationGroupSchemas group. Don't use this type directly, use NewConfigurationGroupSchemasClient() instead.

func NewConfigurationGroupSchemasClient

func NewConfigurationGroupSchemasClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ConfigurationGroupSchemasClient, error)

NewConfigurationGroupSchemasClient creates a new instance of ConfigurationGroupSchemasClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ConfigurationGroupSchemasClient) BeginCreateOrUpdate

func (client *ConfigurationGroupSchemasClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, publisherName string, configurationGroupSchemaName string, parameters ConfigurationGroupSchema, options *ConfigurationGroupSchemasClientBeginCreateOrUpdateOptions) (*runtime.Poller[ConfigurationGroupSchemasClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a configuration group schema. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • configurationGroupSchemaName - The name of the configuration group schema.
  • parameters - Parameters supplied to the create or update configuration group schema resource.
  • options - ConfigurationGroupSchemasClientBeginCreateOrUpdateOptions contains the optional parameters for the ConfigurationGroupSchemasClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationGroupSchemasClient().BeginCreateOrUpdate(ctx, "rg1", "testPublisher", "testConfigurationGroupSchema", armhybridnetwork.ConfigurationGroupSchema{
	Location: to.Ptr("westUs2"),
	Properties: &armhybridnetwork.ConfigurationGroupSchemaPropertiesFormat{
		Description:      to.Ptr("Schema with no secrets"),
		SchemaDefinition: to.Ptr("{\"type\":\"object\",\"properties\":{\"interconnect-groups\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"international-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}},\"domestic-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}}}}},\"interconnect-group-assignments\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"ssc\":{\"type\":\"string\"},\"interconnects-interconnects\":{\"type\":\"string\"}}}}},\"required\":[\"interconnect-groups\",\"interconnect-group-assignments\"]}"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ConfigurationGroupSchema = armhybridnetwork.ConfigurationGroupSchema{
// 	Name: to.Ptr("testConfigurationGroupSchema"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/configurationGroupSchemas"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/interconnectgroupsSchema"),
// 	SystemData: &armhybridnetwork.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("westUs2"),
// 	Properties: &armhybridnetwork.ConfigurationGroupSchemaPropertiesFormat{
// 		Description: to.Ptr("Schema with no secrets"),
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		SchemaDefinition: to.Ptr("{\"type\":\"object\",\"properties\":{\"interconnect-groups\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"international-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}},\"domestic-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}}}}},\"interconnect-group-assignments\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"ssc\":{\"type\":\"string\"},\"interconnects-interconnects\":{\"type\":\"string\"}}}}},\"required\":[\"interconnect-groups\",\"interconnect-group-assignments\"]}"),
// 	},
// }
Output:

func (*ConfigurationGroupSchemasClient) BeginDelete

func (client *ConfigurationGroupSchemasClient) BeginDelete(ctx context.Context, resourceGroupName string, publisherName string, configurationGroupSchemaName string, options *ConfigurationGroupSchemasClientBeginDeleteOptions) (*runtime.Poller[ConfigurationGroupSchemasClientDeleteResponse], error)

BeginDelete - Deletes a specified configuration group schema. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • configurationGroupSchemaName - The name of the configuration group schema.
  • options - ConfigurationGroupSchemasClientBeginDeleteOptions contains the optional parameters for the ConfigurationGroupSchemasClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationGroupSchemasClient().BeginDelete(ctx, "rg1", "testPublisher", "testConfigurationGroupSchema", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ConfigurationGroupSchemasClient) BeginUpdateState

BeginUpdateState - Update configuration group schema state. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • configurationGroupSchemaName - The name of the configuration group schema.
  • parameters - Parameters supplied to update the state of configuration group schema.
  • options - ConfigurationGroupSchemasClientBeginUpdateStateOptions contains the optional parameters for the ConfigurationGroupSchemasClient.BeginUpdateState method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaVersionUpdateState.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationGroupSchemasClient().BeginUpdateState(ctx, "rg1", "testPublisher", "testConfigurationGroupSchema", armhybridnetwork.ConfigurationGroupSchemaVersionUpdateState{
	VersionState: to.Ptr(armhybridnetwork.VersionStateActive),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ConfigurationGroupSchemaVersionUpdateState = armhybridnetwork.ConfigurationGroupSchemaVersionUpdateState{
// 	VersionState: to.Ptr(armhybridnetwork.VersionStateActive),
// }
Output:

func (*ConfigurationGroupSchemasClient) Get

func (client *ConfigurationGroupSchemasClient) Get(ctx context.Context, resourceGroupName string, publisherName string, configurationGroupSchemaName string, options *ConfigurationGroupSchemasClientGetOptions) (ConfigurationGroupSchemasClientGetResponse, error)

Get - Gets information about the specified configuration group schema. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • configurationGroupSchemaName - The name of the configuration group schema.
  • options - ConfigurationGroupSchemasClientGetOptions contains the optional parameters for the ConfigurationGroupSchemasClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewConfigurationGroupSchemasClient().Get(ctx, "rg1", "testPublisher", "testConfigurationGroupSchema", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ConfigurationGroupSchema = armhybridnetwork.ConfigurationGroupSchema{
// 	Name: to.Ptr("testConfigurationGroupSchema"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/configurationGroupSchemas"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/interconnectgroupsSchema"),
// 	SystemData: &armhybridnetwork.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("westUs2"),
// 	Properties: &armhybridnetwork.ConfigurationGroupSchemaPropertiesFormat{
// 		Description: to.Ptr("Schema with no secrets"),
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		SchemaDefinition: to.Ptr("{\"type\":\"object\",\"properties\":{\"interconnect-groups\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"international-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}},\"domestic-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}}}}},\"interconnect-group-assignments\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"ssc\":{\"type\":\"string\"},\"interconnects-interconnects\":{\"type\":\"string\"}}}}},\"required\":[\"interconnect-groups\",\"interconnect-group-assignments\"]}"),
// 	},
// }
Output:

func (*ConfigurationGroupSchemasClient) NewListByPublisherPager

NewListByPublisherPager - Gets information of the configuration group schemas under a publisher.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • options - ConfigurationGroupSchemasClientListByPublisherOptions contains the optional parameters for the ConfigurationGroupSchemasClient.NewListByPublisherPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaListByPublisherName.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewConfigurationGroupSchemasClient().NewListByPublisherPager("rg1", "testPublisher", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ConfigurationGroupSchemaListResult = armhybridnetwork.ConfigurationGroupSchemaListResult{
	// 	Value: []*armhybridnetwork.ConfigurationGroupSchema{
	// 		{
	// 			Name: to.Ptr("testConfigurationGroupSchema"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/publishers/configurationGroupSchemas"),
	// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/interconnectgroupsSchema"),
	// 			SystemData: &armhybridnetwork.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("westUs2"),
	// 			Properties: &armhybridnetwork.ConfigurationGroupSchemaPropertiesFormat{
	// 				Description: to.Ptr("Schema with no secrets"),
	// 				ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
	// 				SchemaDefinition: to.Ptr("{\"type\":\"object\",\"properties\":{\"interconnect-groups\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"international-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}},\"domestic-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}}}}},\"interconnect-group-assignments\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"ssc\":{\"type\":\"string\"},\"interconnects-interconnects\":{\"type\":\"string\"}}}}},\"required\":[\"interconnect-groups\",\"interconnect-group-assignments\"]}"),
	// 			},
	// 	}},
	// }
}
Output:

func (*ConfigurationGroupSchemasClient) Update

func (client *ConfigurationGroupSchemasClient) Update(ctx context.Context, resourceGroupName string, publisherName string, configurationGroupSchemaName string, parameters TagsObject, options *ConfigurationGroupSchemasClientUpdateOptions) (ConfigurationGroupSchemasClientUpdateResponse, error)

Update - Updates a configuration group schema resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • configurationGroupSchemaName - The name of the configuration group schema.
  • parameters - Parameters supplied to the create or update network service design version operation.
  • options - ConfigurationGroupSchemasClientUpdateOptions contains the optional parameters for the ConfigurationGroupSchemasClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupSchemaUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewConfigurationGroupSchemasClient().Update(ctx, "rg1", "testPublisher", "testConfigurationGroupSchema", armhybridnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ConfigurationGroupSchema = armhybridnetwork.ConfigurationGroupSchema{
// 	Name: to.Ptr("testConfigurationGroupSchema"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/configurationGroupSchemas"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/interconnectgroupsSchema"),
// 	SystemData: &armhybridnetwork.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("westUs2"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Properties: &armhybridnetwork.ConfigurationGroupSchemaPropertiesFormat{
// 		Description: to.Ptr("Schema with no secrets"),
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		SchemaDefinition: to.Ptr("{\"type\":\"object\",\"properties\":{\"interconnect-groups\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"international-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}},\"domestic-interconnects\":{\"type\":\"array\",\"item\":{\"type\":\"string\"}}}}},\"interconnect-group-assignments\":{\"type\":\"object\",\"properties\":{\"type\":\"object\",\"properties\":{\"ssc\":{\"type\":\"string\"},\"interconnects-interconnects\":{\"type\":\"string\"}}}}},\"required\":[\"interconnect-groups\",\"interconnect-group-assignments\"]}"),
// 	},
// }
Output:

type ConfigurationGroupSchemasClientBeginCreateOrUpdateOptions

type ConfigurationGroupSchemasClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ConfigurationGroupSchemasClientBeginCreateOrUpdateOptions contains the optional parameters for the ConfigurationGroupSchemasClient.BeginCreateOrUpdate method.

type ConfigurationGroupSchemasClientBeginDeleteOptions

type ConfigurationGroupSchemasClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ConfigurationGroupSchemasClientBeginDeleteOptions contains the optional parameters for the ConfigurationGroupSchemasClient.BeginDelete method.

type ConfigurationGroupSchemasClientBeginUpdateStateOptions

type ConfigurationGroupSchemasClientBeginUpdateStateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ConfigurationGroupSchemasClientBeginUpdateStateOptions contains the optional parameters for the ConfigurationGroupSchemasClient.BeginUpdateState method.

type ConfigurationGroupSchemasClientCreateOrUpdateResponse

type ConfigurationGroupSchemasClientCreateOrUpdateResponse struct {
	// Configuration group schema resource.
	ConfigurationGroupSchema
}

ConfigurationGroupSchemasClientCreateOrUpdateResponse contains the response from method ConfigurationGroupSchemasClient.BeginCreateOrUpdate.

type ConfigurationGroupSchemasClientDeleteResponse

type ConfigurationGroupSchemasClientDeleteResponse struct {
}

ConfigurationGroupSchemasClientDeleteResponse contains the response from method ConfigurationGroupSchemasClient.BeginDelete.

type ConfigurationGroupSchemasClientGetOptions

type ConfigurationGroupSchemasClientGetOptions struct {
}

ConfigurationGroupSchemasClientGetOptions contains the optional parameters for the ConfigurationGroupSchemasClient.Get method.

type ConfigurationGroupSchemasClientGetResponse

type ConfigurationGroupSchemasClientGetResponse struct {
	// Configuration group schema resource.
	ConfigurationGroupSchema
}

ConfigurationGroupSchemasClientGetResponse contains the response from method ConfigurationGroupSchemasClient.Get.

type ConfigurationGroupSchemasClientListByPublisherOptions

type ConfigurationGroupSchemasClientListByPublisherOptions struct {
}

ConfigurationGroupSchemasClientListByPublisherOptions contains the optional parameters for the ConfigurationGroupSchemasClient.NewListByPublisherPager method.

type ConfigurationGroupSchemasClientListByPublisherResponse

type ConfigurationGroupSchemasClientListByPublisherResponse struct {
	// A list of configuration group schema resources.
	ConfigurationGroupSchemaListResult
}

ConfigurationGroupSchemasClientListByPublisherResponse contains the response from method ConfigurationGroupSchemasClient.NewListByPublisherPager.

type ConfigurationGroupSchemasClientUpdateOptions

type ConfigurationGroupSchemasClientUpdateOptions struct {
}

ConfigurationGroupSchemasClientUpdateOptions contains the optional parameters for the ConfigurationGroupSchemasClient.Update method.

type ConfigurationGroupSchemasClientUpdateResponse

type ConfigurationGroupSchemasClientUpdateResponse struct {
	// Configuration group schema resource.
	ConfigurationGroupSchema
}

ConfigurationGroupSchemasClientUpdateResponse contains the response from method ConfigurationGroupSchemasClient.Update.

type ConfigurationGroupSchemasClientUpdateStateResponse

type ConfigurationGroupSchemasClientUpdateStateResponse struct {
	// Publisher configuration group schema update request definition.
	ConfigurationGroupSchemaVersionUpdateState
}

ConfigurationGroupSchemasClientUpdateStateResponse contains the response from method ConfigurationGroupSchemasClient.BeginUpdateState.

type ConfigurationGroupValue

type ConfigurationGroupValue struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// Hybrid configuration group value properties.
	Properties ConfigurationGroupValuePropertiesFormatClassification

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ConfigurationGroupValue - Hybrid configuration group value resource.

func (ConfigurationGroupValue) MarshalJSON

func (c ConfigurationGroupValue) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConfigurationGroupValue.

func (*ConfigurationGroupValue) UnmarshalJSON

func (c *ConfigurationGroupValue) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationGroupValue.

type ConfigurationGroupValueConfigurationType

type ConfigurationGroupValueConfigurationType string

ConfigurationGroupValueConfigurationType - The secret type which indicates if secret or not.

const (
	ConfigurationGroupValueConfigurationTypeOpen    ConfigurationGroupValueConfigurationType = "Open"
	ConfigurationGroupValueConfigurationTypeSecret  ConfigurationGroupValueConfigurationType = "Secret"
	ConfigurationGroupValueConfigurationTypeUnknown ConfigurationGroupValueConfigurationType = "Unknown"
)

func PossibleConfigurationGroupValueConfigurationTypeValues

func PossibleConfigurationGroupValueConfigurationTypeValues() []ConfigurationGroupValueConfigurationType

PossibleConfigurationGroupValueConfigurationTypeValues returns the possible values for the ConfigurationGroupValueConfigurationType const type.

type ConfigurationGroupValueListResult

type ConfigurationGroupValueListResult struct {
	// A list of hybrid configurationGroups.
	Value []*ConfigurationGroupValue

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string
}

ConfigurationGroupValueListResult - Response for hybrid configurationGroups API service call.

func (ConfigurationGroupValueListResult) MarshalJSON

func (c ConfigurationGroupValueListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConfigurationGroupValueListResult.

func (*ConfigurationGroupValueListResult) UnmarshalJSON

func (c *ConfigurationGroupValueListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationGroupValueListResult.

type ConfigurationGroupValuePropertiesFormat

type ConfigurationGroupValuePropertiesFormat struct {
	// REQUIRED; The value which indicates if configuration values are secrets
	ConfigurationType *ConfigurationGroupValueConfigurationType

	// The configuration group schema resource reference.
	ConfigurationGroupSchemaResourceReference DeploymentResourceIDReferenceClassification

	// READ-ONLY; The configuration group schema name.
	ConfigurationGroupSchemaName *string

	// READ-ONLY; The location of the configuration group schema offering.
	ConfigurationGroupSchemaOfferingLocation *string

	// READ-ONLY; The provisioning state of the site resource.
	ProvisioningState *ProvisioningState

	// READ-ONLY; The publisher name for the configuration group schema.
	PublisherName *string

	// READ-ONLY; The scope of the publisher.
	PublisherScope *PublisherScope
}

ConfigurationGroupValuePropertiesFormat - Hybrid configuration group value properties.

func (*ConfigurationGroupValuePropertiesFormat) GetConfigurationGroupValuePropertiesFormat

func (c *ConfigurationGroupValuePropertiesFormat) GetConfigurationGroupValuePropertiesFormat() *ConfigurationGroupValuePropertiesFormat

GetConfigurationGroupValuePropertiesFormat implements the ConfigurationGroupValuePropertiesFormatClassification interface for type ConfigurationGroupValuePropertiesFormat.

func (ConfigurationGroupValuePropertiesFormat) MarshalJSON

func (c ConfigurationGroupValuePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConfigurationGroupValuePropertiesFormat.

func (*ConfigurationGroupValuePropertiesFormat) UnmarshalJSON

func (c *ConfigurationGroupValuePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationGroupValuePropertiesFormat.

type ConfigurationGroupValuePropertiesFormatClassification

type ConfigurationGroupValuePropertiesFormatClassification interface {
	// GetConfigurationGroupValuePropertiesFormat returns the ConfigurationGroupValuePropertiesFormat content of the underlying type.
	GetConfigurationGroupValuePropertiesFormat() *ConfigurationGroupValuePropertiesFormat
}

ConfigurationGroupValuePropertiesFormatClassification provides polymorphic access to related types. Call the interface's GetConfigurationGroupValuePropertiesFormat() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ConfigurationGroupValuePropertiesFormat, *ConfigurationValueWithSecrets, *ConfigurationValueWithoutSecrets

type ConfigurationGroupValuesClient

type ConfigurationGroupValuesClient struct {
	// contains filtered or unexported fields
}

ConfigurationGroupValuesClient contains the methods for the ConfigurationGroupValues group. Don't use this type directly, use NewConfigurationGroupValuesClient() instead.

func NewConfigurationGroupValuesClient

func NewConfigurationGroupValuesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ConfigurationGroupValuesClient, error)

NewConfigurationGroupValuesClient creates a new instance of ConfigurationGroupValuesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ConfigurationGroupValuesClient) BeginCreateOrUpdate

BeginCreateOrUpdate - Creates or updates a hybrid configuration group value. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • configurationGroupValueName - The name of the configuration group value.
  • parameters - Parameters supplied to the create or update configuration group value resource.
  • options - ConfigurationGroupValuesClientBeginCreateOrUpdateOptions contains the optional parameters for the ConfigurationGroupValuesClient.BeginCreateOrUpdate method.
Example (CreateOrUpdateConfigurationGroupValue)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationGroupValuesClient().BeginCreateOrUpdate(ctx, "rg1", "testConfigurationGroupValue", armhybridnetwork.ConfigurationGroupValue{
	Location: to.Ptr("eastus"),
	Properties: &armhybridnetwork.ConfigurationValueWithoutSecrets{
		ConfigurationGroupSchemaResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
			ID:     to.Ptr("/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName"),
		},
		ConfigurationType:  to.Ptr(armhybridnetwork.ConfigurationGroupValueConfigurationTypeOpen),
		ConfigurationValue: to.Ptr("{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ConfigurationGroupValue = armhybridnetwork.ConfigurationGroupValue{
// 	Name: to.Ptr("testConfigurationGroupValue"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/configurationGroupValues"),
// 	ID: to.Ptr("/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue"),
// 	SystemData: &armhybridnetwork.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 	},
// 	Properties: &armhybridnetwork.ConfigurationValueWithoutSecrets{
// 		ConfigurationGroupSchemaName: to.Ptr("testConfigurationGroupSchemaName"),
// 		ConfigurationGroupSchemaOfferingLocation: to.Ptr("eastus"),
// 		ConfigurationGroupSchemaResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
// 			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName"),
// 		},
// 		ConfigurationType: to.Ptr(armhybridnetwork.ConfigurationGroupValueConfigurationTypeOpen),
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		PublisherName: to.Ptr("testPublisher"),
// 		PublisherScope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
// 		ConfigurationValue: to.Ptr("{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}"),
// 	},
// }
Output:

Example (CreateOrUpdateConfigurationGroupValueWithSecrets)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueCreateSecret.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationGroupValuesClient().BeginCreateOrUpdate(ctx, "rg1", "testConfigurationGroupValue", armhybridnetwork.ConfigurationGroupValue{
	Location: to.Ptr("eastus"),
	Properties: &armhybridnetwork.ConfigurationValueWithSecrets{
		ConfigurationGroupSchemaResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
			ID:     to.Ptr("/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName"),
		},
		ConfigurationType:        to.Ptr(armhybridnetwork.ConfigurationGroupValueConfigurationTypeSecret),
		SecretConfigurationValue: to.Ptr("{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ConfigurationGroupValue = armhybridnetwork.ConfigurationGroupValue{
// 	Name: to.Ptr("testConfigurationGroupValue"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/configurationGroupValues"),
// 	ID: to.Ptr("/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue"),
// 	SystemData: &armhybridnetwork.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 	},
// 	Properties: &armhybridnetwork.ConfigurationValueWithSecrets{
// 		ConfigurationGroupSchemaName: to.Ptr("testConfigurationGroupSchemaName"),
// 		ConfigurationGroupSchemaOfferingLocation: to.Ptr("eastus"),
// 		ConfigurationGroupSchemaResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
// 			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName"),
// 		},
// 		ConfigurationType: to.Ptr(armhybridnetwork.ConfigurationGroupValueConfigurationTypeSecret),
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		PublisherName: to.Ptr("testPublisher"),
// 		PublisherScope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
// 	},
// }
Output:

Example (CreateOrUpdateFirstPartyConfigurationGroupValue)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueFirstPartyCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationGroupValuesClient().BeginCreateOrUpdate(ctx, "rg1", "testConfigurationGroupValue", armhybridnetwork.ConfigurationGroupValue{
	Location: to.Ptr("eastus"),
	Properties: &armhybridnetwork.ConfigurationValueWithoutSecrets{
		ConfigurationGroupSchemaResourceReference: &armhybridnetwork.SecretDeploymentResourceReference{
			IDType: to.Ptr(armhybridnetwork.IDTypeSecret),
			ID:     to.Ptr("/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName"),
		},
		ConfigurationType:  to.Ptr(armhybridnetwork.ConfigurationGroupValueConfigurationTypeOpen),
		ConfigurationValue: to.Ptr("{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ConfigurationGroupValue = armhybridnetwork.ConfigurationGroupValue{
// 	Name: to.Ptr("testConfigurationGroupValue"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/configurationGroupValues"),
// 	ID: to.Ptr("/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue"),
// 	SystemData: &armhybridnetwork.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 	},
// 	Properties: &armhybridnetwork.ConfigurationValueWithoutSecrets{
// 		ConfigurationGroupSchemaName: to.Ptr("testConfigurationGroupSchemaName"),
// 		ConfigurationGroupSchemaOfferingLocation: to.Ptr("eastus"),
// 		ConfigurationGroupSchemaResourceReference: &armhybridnetwork.SecretDeploymentResourceReference{
// 			IDType: to.Ptr(armhybridnetwork.IDTypeSecret),
// 		},
// 		ConfigurationType: to.Ptr(armhybridnetwork.ConfigurationGroupValueConfigurationTypeOpen),
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		PublisherName: to.Ptr("testPublisher"),
// 		PublisherScope: to.Ptr(armhybridnetwork.PublisherScopePrivate),
// 		ConfigurationValue: to.Ptr("{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}"),
// 	},
// }
Output:

func (*ConfigurationGroupValuesClient) BeginDelete

BeginDelete - Deletes the specified hybrid configuration group value. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • configurationGroupValueName - The name of the configuration group value.
  • options - ConfigurationGroupValuesClientBeginDeleteOptions contains the optional parameters for the ConfigurationGroupValuesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewConfigurationGroupValuesClient().BeginDelete(ctx, "rg1", "testConfigurationGroupValue", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*ConfigurationGroupValuesClient) Get

Get - Gets information about the specified hybrid configuration group values. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • configurationGroupValueName - The name of the configuration group value.
  • options - ConfigurationGroupValuesClientGetOptions contains the optional parameters for the ConfigurationGroupValuesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewConfigurationGroupValuesClient().Get(ctx, "rg1", "testConfigurationGroupValue", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ConfigurationGroupValue = armhybridnetwork.ConfigurationGroupValue{
// 	Name: to.Ptr("testConfigurationGroupValue"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/configurationGroupValues"),
// 	ID: to.Ptr("/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue"),
// 	SystemData: &armhybridnetwork.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 	},
// 	Properties: &armhybridnetwork.ConfigurationValueWithoutSecrets{
// 		ConfigurationGroupSchemaName: to.Ptr("testConfigurationGroupSchemaName"),
// 		ConfigurationGroupSchemaOfferingLocation: to.Ptr("eastus"),
// 		ConfigurationGroupSchemaResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
// 			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName"),
// 		},
// 		ConfigurationType: to.Ptr(armhybridnetwork.ConfigurationGroupValueConfigurationTypeOpen),
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		PublisherName: to.Ptr("testPublisher"),
// 		PublisherScope: to.Ptr(armhybridnetwork.PublisherScopePrivate),
// 		ConfigurationValue: to.Ptr("{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}"),
// 	},
// }
Output:

func (*ConfigurationGroupValuesClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Lists all the hybrid network configurationGroupValues in a resource group.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - ConfigurationGroupValuesClientListByResourceGroupOptions contains the optional parameters for the ConfigurationGroupValuesClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewConfigurationGroupValuesClient().NewListByResourceGroupPager("rg1", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ConfigurationGroupValueListResult = armhybridnetwork.ConfigurationGroupValueListResult{
	// 	Value: []*armhybridnetwork.ConfigurationGroupValue{
	// 		{
	// 			Name: to.Ptr("testConfigurationGroupValue"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/configurationGroupValues"),
	// 			ID: to.Ptr("/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue"),
	// 			SystemData: &armhybridnetwork.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("westUs2"),
	// 			Properties: &armhybridnetwork.ConfigurationValueWithoutSecrets{
	// 				ConfigurationGroupSchemaName: to.Ptr("testConfigurationGroupSchemaName"),
	// 				ConfigurationGroupSchemaOfferingLocation: to.Ptr("eastus"),
	// 				ConfigurationGroupSchemaResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
	// 					IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
	// 					ID: to.Ptr("/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName"),
	// 				},
	// 				ConfigurationType: to.Ptr(armhybridnetwork.ConfigurationGroupValueConfigurationTypeOpen),
	// 				PublisherName: to.Ptr("testPublisher"),
	// 				PublisherScope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
	// 				ConfigurationValue: to.Ptr("{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}"),
	// 			},
	// 	}},
	// }
}
Output:

func (*ConfigurationGroupValuesClient) NewListBySubscriptionPager

NewListBySubscriptionPager - Lists all sites in the configuration group value in a subscription.

Generated from API version 2023-09-01

  • options - ConfigurationGroupValuesClientListBySubscriptionOptions contains the optional parameters for the ConfigurationGroupValuesClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueListBySubscription.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewConfigurationGroupValuesClient().NewListBySubscriptionPager(nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ConfigurationGroupValueListResult = armhybridnetwork.ConfigurationGroupValueListResult{
	// 	Value: []*armhybridnetwork.ConfigurationGroupValue{
	// 		{
	// 			Name: to.Ptr("testConfigurationGroupValue"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/configurationGroupValues"),
	// 			ID: to.Ptr("/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue"),
	// 			SystemData: &armhybridnetwork.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("eastus"),
	// 			Tags: map[string]*string{
	// 				"tag1": to.Ptr("value1"),
	// 				"tag2": to.Ptr("value2"),
	// 			},
	// 			Properties: &armhybridnetwork.ConfigurationValueWithoutSecrets{
	// 				ConfigurationGroupSchemaName: to.Ptr("testConfigurationGroupSchemaName"),
	// 				ConfigurationGroupSchemaOfferingLocation: to.Ptr("eastus"),
	// 				ConfigurationGroupSchemaResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
	// 					IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
	// 					ID: to.Ptr("/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName"),
	// 				},
	// 				ConfigurationType: to.Ptr(armhybridnetwork.ConfigurationGroupValueConfigurationTypeOpen),
	// 				PublisherName: to.Ptr("testPublisher"),
	// 				PublisherScope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
	// 				ConfigurationValue: to.Ptr("{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}"),
	// 			},
	// 	}},
	// }
}
Output:

func (*ConfigurationGroupValuesClient) UpdateTags

func (client *ConfigurationGroupValuesClient) UpdateTags(ctx context.Context, resourceGroupName string, configurationGroupValueName string, parameters TagsObject, options *ConfigurationGroupValuesClientUpdateTagsOptions) (ConfigurationGroupValuesClientUpdateTagsResponse, error)

UpdateTags - Updates a hybrid configuration group tags. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • configurationGroupValueName - The name of the configuration group value.
  • parameters - Parameters supplied to update configuration group values tags.
  • options - ConfigurationGroupValuesClientUpdateTagsOptions contains the optional parameters for the ConfigurationGroupValuesClient.UpdateTags method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/ConfigurationGroupValueUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewConfigurationGroupValuesClient().UpdateTags(ctx, "rg1", "testConfigurationGroupValue", armhybridnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ConfigurationGroupValue = armhybridnetwork.ConfigurationGroupValue{
// 	Name: to.Ptr("testConfigurationGroupValue"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/configurationGroupValues"),
// 	ID: to.Ptr("/subscriptions/subid/providers/Microsoft.HybridNetwork/configurationGroupValues/testConfigurationGroupValue"),
// 	SystemData: &armhybridnetwork.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Properties: &armhybridnetwork.ConfigurationValueWithoutSecrets{
// 		ConfigurationGroupSchemaName: to.Ptr("testConfigurationGroupSchemaName"),
// 		ConfigurationGroupSchemaOfferingLocation: to.Ptr("eastus"),
// 		ConfigurationGroupSchemaResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
// 			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/testRG/providers/microsoft.hybridnetwork/publishers/testPublisher/configurationGroupSchemas/testConfigurationGroupSchemaName"),
// 		},
// 		ConfigurationType: to.Ptr(armhybridnetwork.ConfigurationGroupValueConfigurationTypeOpen),
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		PublisherName: to.Ptr("testPublisher"),
// 		PublisherScope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
// 		ConfigurationValue: to.Ptr("{\"interconnect-groups\":{\"stripe-one\":{\"name\":\"Stripe one\",\"international-interconnects\":[\"france\",\"germany\"],\"domestic-interconnects\":[\"birmingham\",\"edinburgh\"]},\"stripe-two\":{\"name\":\"Stripe two\",\"international-interconnects\":[\"germany\",\"italy\"],\"domestic-interconnects\":[\"edinburgh\",\"london\"]}},\"interconnect-group-assignments\":{\"ssc-one\":{\"ssc\":\"SSC 1\",\"interconnects\":\"stripe-one\"},\"ssc-two\":{\"ssc\":\"SSC 2\",\"interconnects\":\"stripe-two\"}}}"),
// 	},
// }
Output:

type ConfigurationGroupValuesClientBeginCreateOrUpdateOptions

type ConfigurationGroupValuesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ConfigurationGroupValuesClientBeginCreateOrUpdateOptions contains the optional parameters for the ConfigurationGroupValuesClient.BeginCreateOrUpdate method.

type ConfigurationGroupValuesClientBeginDeleteOptions

type ConfigurationGroupValuesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ConfigurationGroupValuesClientBeginDeleteOptions contains the optional parameters for the ConfigurationGroupValuesClient.BeginDelete method.

type ConfigurationGroupValuesClientCreateOrUpdateResponse

type ConfigurationGroupValuesClientCreateOrUpdateResponse struct {
	// Hybrid configuration group value resource.
	ConfigurationGroupValue
}

ConfigurationGroupValuesClientCreateOrUpdateResponse contains the response from method ConfigurationGroupValuesClient.BeginCreateOrUpdate.

type ConfigurationGroupValuesClientDeleteResponse

type ConfigurationGroupValuesClientDeleteResponse struct {
}

ConfigurationGroupValuesClientDeleteResponse contains the response from method ConfigurationGroupValuesClient.BeginDelete.

type ConfigurationGroupValuesClientGetOptions

type ConfigurationGroupValuesClientGetOptions struct {
}

ConfigurationGroupValuesClientGetOptions contains the optional parameters for the ConfigurationGroupValuesClient.Get method.

type ConfigurationGroupValuesClientGetResponse

type ConfigurationGroupValuesClientGetResponse struct {
	// Hybrid configuration group value resource.
	ConfigurationGroupValue
}

ConfigurationGroupValuesClientGetResponse contains the response from method ConfigurationGroupValuesClient.Get.

type ConfigurationGroupValuesClientListByResourceGroupOptions

type ConfigurationGroupValuesClientListByResourceGroupOptions struct {
}

ConfigurationGroupValuesClientListByResourceGroupOptions contains the optional parameters for the ConfigurationGroupValuesClient.NewListByResourceGroupPager method.

type ConfigurationGroupValuesClientListByResourceGroupResponse

type ConfigurationGroupValuesClientListByResourceGroupResponse struct {
	// Response for hybrid configurationGroups API service call.
	ConfigurationGroupValueListResult
}

ConfigurationGroupValuesClientListByResourceGroupResponse contains the response from method ConfigurationGroupValuesClient.NewListByResourceGroupPager.

type ConfigurationGroupValuesClientListBySubscriptionOptions

type ConfigurationGroupValuesClientListBySubscriptionOptions struct {
}

ConfigurationGroupValuesClientListBySubscriptionOptions contains the optional parameters for the ConfigurationGroupValuesClient.NewListBySubscriptionPager method.

type ConfigurationGroupValuesClientListBySubscriptionResponse

type ConfigurationGroupValuesClientListBySubscriptionResponse struct {
	// Response for hybrid configurationGroups API service call.
	ConfigurationGroupValueListResult
}

ConfigurationGroupValuesClientListBySubscriptionResponse contains the response from method ConfigurationGroupValuesClient.NewListBySubscriptionPager.

type ConfigurationGroupValuesClientUpdateTagsOptions

type ConfigurationGroupValuesClientUpdateTagsOptions struct {
}

ConfigurationGroupValuesClientUpdateTagsOptions contains the optional parameters for the ConfigurationGroupValuesClient.UpdateTags method.

type ConfigurationGroupValuesClientUpdateTagsResponse

type ConfigurationGroupValuesClientUpdateTagsResponse struct {
	// Hybrid configuration group value resource.
	ConfigurationGroupValue
}

ConfigurationGroupValuesClientUpdateTagsResponse contains the response from method ConfigurationGroupValuesClient.UpdateTags.

type ConfigurationValueWithSecrets

type ConfigurationValueWithSecrets struct {
	// REQUIRED; The value which indicates if configuration values are secrets
	ConfigurationType *ConfigurationGroupValueConfigurationType

	// The configuration group schema resource reference.
	ConfigurationGroupSchemaResourceReference DeploymentResourceIDReferenceClassification

	// Name and value pairs that define the configuration value secrets. It can be a well formed escaped JSON string.
	SecretConfigurationValue *string

	// READ-ONLY; The configuration group schema name.
	ConfigurationGroupSchemaName *string

	// READ-ONLY; The location of the configuration group schema offering.
	ConfigurationGroupSchemaOfferingLocation *string

	// READ-ONLY; The provisioning state of the site resource.
	ProvisioningState *ProvisioningState

	// READ-ONLY; The publisher name for the configuration group schema.
	PublisherName *string

	// READ-ONLY; The scope of the publisher.
	PublisherScope *PublisherScope
}

ConfigurationValueWithSecrets - The ConfigurationValue with secrets.

func (*ConfigurationValueWithSecrets) GetConfigurationGroupValuePropertiesFormat

func (c *ConfigurationValueWithSecrets) GetConfigurationGroupValuePropertiesFormat() *ConfigurationGroupValuePropertiesFormat

GetConfigurationGroupValuePropertiesFormat implements the ConfigurationGroupValuePropertiesFormatClassification interface for type ConfigurationValueWithSecrets.

func (ConfigurationValueWithSecrets) MarshalJSON

func (c ConfigurationValueWithSecrets) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConfigurationValueWithSecrets.

func (*ConfigurationValueWithSecrets) UnmarshalJSON

func (c *ConfigurationValueWithSecrets) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationValueWithSecrets.

type ConfigurationValueWithoutSecrets

type ConfigurationValueWithoutSecrets struct {
	// REQUIRED; The value which indicates if configuration values are secrets
	ConfigurationType *ConfigurationGroupValueConfigurationType

	// The configuration group schema resource reference.
	ConfigurationGroupSchemaResourceReference DeploymentResourceIDReferenceClassification

	// Name and value pairs that define the configuration value. It can be a well formed escaped JSON string.
	ConfigurationValue *string

	// READ-ONLY; The configuration group schema name.
	ConfigurationGroupSchemaName *string

	// READ-ONLY; The location of the configuration group schema offering.
	ConfigurationGroupSchemaOfferingLocation *string

	// READ-ONLY; The provisioning state of the site resource.
	ProvisioningState *ProvisioningState

	// READ-ONLY; The publisher name for the configuration group schema.
	PublisherName *string

	// READ-ONLY; The scope of the publisher.
	PublisherScope *PublisherScope
}

ConfigurationValueWithoutSecrets - The ConfigurationValue with no secrets.

func (*ConfigurationValueWithoutSecrets) GetConfigurationGroupValuePropertiesFormat

func (c *ConfigurationValueWithoutSecrets) GetConfigurationGroupValuePropertiesFormat() *ConfigurationGroupValuePropertiesFormat

GetConfigurationGroupValuePropertiesFormat implements the ConfigurationGroupValuePropertiesFormatClassification interface for type ConfigurationValueWithoutSecrets.

func (ConfigurationValueWithoutSecrets) MarshalJSON

func (c ConfigurationValueWithoutSecrets) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConfigurationValueWithoutSecrets.

func (*ConfigurationValueWithoutSecrets) UnmarshalJSON

func (c *ConfigurationValueWithoutSecrets) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConfigurationValueWithoutSecrets.

type ContainerizedNetworkFunctionDefinitionVersion

type ContainerizedNetworkFunctionDefinitionVersion struct {
	// REQUIRED; The network function type.
	NetworkFunctionType *NetworkFunctionType

	// The deployment parameters of the network function definition version.
	DeployParameters *string

	// The network function definition version description.
	Description *string

	// Containerized network function template.
	NetworkFunctionTemplate ContainerizedNetworkFunctionTemplateClassification

	// READ-ONLY; The provisioning state of the network function definition version resource.
	ProvisioningState *ProvisioningState

	// READ-ONLY; The network function definition version state.
	VersionState *VersionState
}

ContainerizedNetworkFunctionDefinitionVersion - Containerized network function network function definition version properties.

func (*ContainerizedNetworkFunctionDefinitionVersion) GetNetworkFunctionDefinitionVersionPropertiesFormat

func (c *ContainerizedNetworkFunctionDefinitionVersion) GetNetworkFunctionDefinitionVersionPropertiesFormat() *NetworkFunctionDefinitionVersionPropertiesFormat

GetNetworkFunctionDefinitionVersionPropertiesFormat implements the NetworkFunctionDefinitionVersionPropertiesFormatClassification interface for type ContainerizedNetworkFunctionDefinitionVersion.

func (ContainerizedNetworkFunctionDefinitionVersion) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type ContainerizedNetworkFunctionDefinitionVersion.

func (*ContainerizedNetworkFunctionDefinitionVersion) UnmarshalJSON

func (c *ContainerizedNetworkFunctionDefinitionVersion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerizedNetworkFunctionDefinitionVersion.

type ContainerizedNetworkFunctionNFVIType

type ContainerizedNetworkFunctionNFVIType string

ContainerizedNetworkFunctionNFVIType - The network function type.

const (
	ContainerizedNetworkFunctionNFVITypeAzureArcKubernetes ContainerizedNetworkFunctionNFVIType = "AzureArcKubernetes"
	ContainerizedNetworkFunctionNFVITypeUnknown            ContainerizedNetworkFunctionNFVIType = "Unknown"
)

func PossibleContainerizedNetworkFunctionNFVITypeValues

func PossibleContainerizedNetworkFunctionNFVITypeValues() []ContainerizedNetworkFunctionNFVIType

PossibleContainerizedNetworkFunctionNFVITypeValues returns the possible values for the ContainerizedNetworkFunctionNFVIType const type.

type ContainerizedNetworkFunctionTemplate

type ContainerizedNetworkFunctionTemplate struct {
	// REQUIRED; The network function type.
	NfviType *ContainerizedNetworkFunctionNFVIType
}

ContainerizedNetworkFunctionTemplate - Containerized network function template.

func (*ContainerizedNetworkFunctionTemplate) GetContainerizedNetworkFunctionTemplate

func (c *ContainerizedNetworkFunctionTemplate) GetContainerizedNetworkFunctionTemplate() *ContainerizedNetworkFunctionTemplate

GetContainerizedNetworkFunctionTemplate implements the ContainerizedNetworkFunctionTemplateClassification interface for type ContainerizedNetworkFunctionTemplate.

func (ContainerizedNetworkFunctionTemplate) MarshalJSON

func (c ContainerizedNetworkFunctionTemplate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerizedNetworkFunctionTemplate.

func (*ContainerizedNetworkFunctionTemplate) UnmarshalJSON

func (c *ContainerizedNetworkFunctionTemplate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerizedNetworkFunctionTemplate.

type ContainerizedNetworkFunctionTemplateClassification

type ContainerizedNetworkFunctionTemplateClassification interface {
	// GetContainerizedNetworkFunctionTemplate returns the ContainerizedNetworkFunctionTemplate content of the underlying type.
	GetContainerizedNetworkFunctionTemplate() *ContainerizedNetworkFunctionTemplate
}

ContainerizedNetworkFunctionTemplateClassification provides polymorphic access to related types. Call the interface's GetContainerizedNetworkFunctionTemplate() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureArcKubernetesNetworkFunctionTemplate, *ContainerizedNetworkFunctionTemplate

type CreatedByType

type CreatedByType string

CreatedByType - The type of identity that created the resource.

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type CredentialType

type CredentialType string

CredentialType - The credential type.

const (
	CredentialTypeAzureContainerRegistryScopedToken CredentialType = "AzureContainerRegistryScopedToken"
	CredentialTypeAzureStorageAccountToken          CredentialType = "AzureStorageAccountToken"
	CredentialTypeUnknown                           CredentialType = "Unknown"
)

func PossibleCredentialTypeValues

func PossibleCredentialTypeValues() []CredentialType

PossibleCredentialTypeValues returns the possible values for the CredentialType const type.

type DaemonSet

type DaemonSet struct {
	// Number of available pods.
	Available *int32

	// Creation Time of daemonSet.
	CreationTime *time.Time

	// Current number of pods
	Current *int32

	// Desired number of pods
	Desired *int32

	// The name of the daemonSet.
	Name *string

	// The namespace of the daemonSet.
	Namespace *string

	// Number of Ready pods
	Ready *int32

	// Number of upto date pods
	UpToDate *int32
}

DaemonSet - Helm DaemonSet status properties.

func (DaemonSet) MarshalJSON

func (d DaemonSet) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DaemonSet.

func (*DaemonSet) UnmarshalJSON

func (d *DaemonSet) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DaemonSet.

type DependsOnProfile

type DependsOnProfile struct {
	// Application installation operation dependency.
	InstallDependsOn []*string

	// Application deletion operation dependency.
	UninstallDependsOn []*string

	// Application update operation dependency.
	UpdateDependsOn []*string
}

DependsOnProfile - Depends on profile definition.

func (DependsOnProfile) MarshalJSON

func (d DependsOnProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DependsOnProfile.

func (*DependsOnProfile) UnmarshalJSON

func (d *DependsOnProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DependsOnProfile.

type Deployment

type Deployment struct {
	// Number of available pods.
	Available *int32

	// Creation Time of deployment.
	CreationTime *time.Time

	// Desired number of pods
	Desired *int32

	// The name of the deployment.
	Name *string

	// The namespace of the deployment.
	Namespace *string

	// Number of ready pods.
	Ready *int32

	// Number of upto date pods.
	UpToDate *int32
}

Deployment - Helm Deployment status properties.

func (Deployment) MarshalJSON

func (d Deployment) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Deployment.

func (*Deployment) UnmarshalJSON

func (d *Deployment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Deployment.

type DeploymentResourceIDReference

type DeploymentResourceIDReference struct {
	// REQUIRED; The resource reference arm id type.
	IDType *IDType
}

DeploymentResourceIDReference - The azure resource reference which is used for deployment.

func (*DeploymentResourceIDReference) GetDeploymentResourceIDReference

func (d *DeploymentResourceIDReference) GetDeploymentResourceIDReference() *DeploymentResourceIDReference

GetDeploymentResourceIDReference implements the DeploymentResourceIDReferenceClassification interface for type DeploymentResourceIDReference.

func (DeploymentResourceIDReference) MarshalJSON

func (d DeploymentResourceIDReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentResourceIDReference.

func (*DeploymentResourceIDReference) UnmarshalJSON

func (d *DeploymentResourceIDReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentResourceIDReference.

type DeploymentResourceIDReferenceClassification

type DeploymentResourceIDReferenceClassification interface {
	// GetDeploymentResourceIDReference returns the DeploymentResourceIDReference content of the underlying type.
	GetDeploymentResourceIDReference() *DeploymentResourceIDReference
}

DeploymentResourceIDReferenceClassification provides polymorphic access to related types. Call the interface's GetDeploymentResourceIDReference() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *DeploymentResourceIDReference, *OpenDeploymentResourceReference, *SecretDeploymentResourceReference

type DeploymentStatusProperties

type DeploymentStatusProperties struct {
	// The next expected update of deployment status.
	NextExpectedUpdateAt *time.Time

	// The resource related to the component resource.
	Resources *Resources

	// The status of the component resource.
	Status *Status
}

DeploymentStatusProperties - The deployment status properties of the network function component.

func (DeploymentStatusProperties) MarshalJSON

func (d DeploymentStatusProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeploymentStatusProperties.

func (*DeploymentStatusProperties) UnmarshalJSON

func (d *DeploymentStatusProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeploymentStatusProperties.

type ExecuteRequestParameters

type ExecuteRequestParameters struct {
	// REQUIRED; The request metadata.
	RequestMetadata *RequestMetadata

	// REQUIRED; The endpoint of service to call.
	ServiceEndpoint *string
}

ExecuteRequestParameters - Payload for execute request post call.

func (ExecuteRequestParameters) MarshalJSON

func (e ExecuteRequestParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ExecuteRequestParameters.

func (*ExecuteRequestParameters) UnmarshalJSON

func (e *ExecuteRequestParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ExecuteRequestParameters.

type HTTPMethod

type HTTPMethod string

HTTPMethod - The http method of the request.

const (
	HTTPMethodDelete  HTTPMethod = "Delete"
	HTTPMethodGet     HTTPMethod = "Get"
	HTTPMethodPatch   HTTPMethod = "Patch"
	HTTPMethodPost    HTTPMethod = "Post"
	HTTPMethodPut     HTTPMethod = "Put"
	HTTPMethodUnknown HTTPMethod = "Unknown"
)

func PossibleHTTPMethodValues

func PossibleHTTPMethodValues() []HTTPMethod

PossibleHTTPMethodValues returns the possible values for the HTTPMethod const type.

type HelmArtifactProfile

type HelmArtifactProfile struct {
	// Helm package name.
	HelmPackageName *string

	// Helm package version range.
	HelmPackageVersionRange *string

	// The image pull secrets values path list.
	ImagePullSecretsValuesPaths []*string

	// The registry values path list.
	RegistryValuesPaths []*string
}

HelmArtifactProfile - Helm artifact profile.

func (HelmArtifactProfile) MarshalJSON

func (h HelmArtifactProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HelmArtifactProfile.

func (*HelmArtifactProfile) UnmarshalJSON

func (h *HelmArtifactProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HelmArtifactProfile.

type HelmInstallOptions

type HelmInstallOptions struct {
	// The helm deployment atomic options
	Atomic *string

	// The helm deployment timeout options
	Timeout *string

	// The helm deployment wait options
	Wait *string
}

HelmInstallOptions - The helm deployment install options

func (HelmInstallOptions) MarshalJSON

func (h HelmInstallOptions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HelmInstallOptions.

func (*HelmInstallOptions) UnmarshalJSON

func (h *HelmInstallOptions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HelmInstallOptions.

type HelmMappingRuleProfile

type HelmMappingRuleProfile struct {
	// Helm package version.
	HelmPackageVersion *string

	// The helm deployment options
	Options *HelmMappingRuleProfileOptions

	// Helm release name.
	ReleaseName *string

	// Helm release namespace.
	ReleaseNamespace *string

	// Helm release values.
	Values *string
}

HelmMappingRuleProfile - Helm mapping rule profile

func (HelmMappingRuleProfile) MarshalJSON

func (h HelmMappingRuleProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HelmMappingRuleProfile.

func (*HelmMappingRuleProfile) UnmarshalJSON

func (h *HelmMappingRuleProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HelmMappingRuleProfile.

type HelmMappingRuleProfileOptions

type HelmMappingRuleProfileOptions struct {
	// The helm deployment install options
	InstallOptions *HelmInstallOptions

	// The helm deployment upgrade options
	UpgradeOptions *HelmUpgradeOptions
}

HelmMappingRuleProfileOptions - The helm deployment options

func (HelmMappingRuleProfileOptions) MarshalJSON

func (h HelmMappingRuleProfileOptions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HelmMappingRuleProfileOptions.

func (*HelmMappingRuleProfileOptions) UnmarshalJSON

func (h *HelmMappingRuleProfileOptions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HelmMappingRuleProfileOptions.

type HelmUpgradeOptions

type HelmUpgradeOptions struct {
	// The helm deployment atomic options
	Atomic *string

	// The helm deployment timeout options
	Timeout *string

	// The helm deployment wait options
	Wait *string
}

HelmUpgradeOptions - The helm deployment install options

func (HelmUpgradeOptions) MarshalJSON

func (h HelmUpgradeOptions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HelmUpgradeOptions.

func (*HelmUpgradeOptions) UnmarshalJSON

func (h *HelmUpgradeOptions) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HelmUpgradeOptions.

type IDType

type IDType string

IDType - The resource reference arm id type.

const (
	IDTypeOpen    IDType = "Open"
	IDTypeSecret  IDType = "Secret"
	IDTypeUnknown IDType = "Unknown"
)

func PossibleIDTypeValues

func PossibleIDTypeValues() []IDType

PossibleIDTypeValues returns the possible values for the IDType const type.

type ImageArtifactProfile

type ImageArtifactProfile struct {
	// Image name.
	ImageName *string

	// Image version.
	ImageVersion *string
}

ImageArtifactProfile - Image artifact profile.

func (ImageArtifactProfile) MarshalJSON

func (i ImageArtifactProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImageArtifactProfile.

func (*ImageArtifactProfile) UnmarshalJSON

func (i *ImageArtifactProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageArtifactProfile.

type ImageMappingRuleProfile

type ImageMappingRuleProfile struct {
	// List of values.
	UserConfiguration *string
}

ImageMappingRuleProfile - Image mapping rule profile

func (ImageMappingRuleProfile) MarshalJSON

func (i ImageMappingRuleProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ImageMappingRuleProfile.

func (*ImageMappingRuleProfile) UnmarshalJSON

func (i *ImageMappingRuleProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ImageMappingRuleProfile.

type ManagedResourceGroupConfiguration

type ManagedResourceGroupConfiguration struct {
	// Managed resource group location.
	Location *string

	// Managed resource group name.
	Name *string
}

ManagedResourceGroupConfiguration - Managed resource group configuration.

func (ManagedResourceGroupConfiguration) MarshalJSON

func (m ManagedResourceGroupConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedResourceGroupConfiguration.

func (*ManagedResourceGroupConfiguration) UnmarshalJSON

func (m *ManagedResourceGroupConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedResourceGroupConfiguration.

type ManagedServiceIdentity

type ManagedServiceIdentity struct {
	// REQUIRED; Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
	Type *ManagedServiceIdentityType

	// The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM
	// resource ids in the form:
	// '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.
	// The dictionary values can be empty objects ({}) in
	// requests.
	UserAssignedIdentities map[string]*UserAssignedIdentity

	// READ-ONLY; The service principal ID of the system assigned identity. This property will only be provided for a system assigned
	// identity.
	PrincipalID *string

	// READ-ONLY; The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
	TenantID *string
}

ManagedServiceIdentity - Managed service identity (system assigned and/or user assigned identities)

func (ManagedServiceIdentity) MarshalJSON

func (m ManagedServiceIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedServiceIdentity.

func (*ManagedServiceIdentity) UnmarshalJSON

func (m *ManagedServiceIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedServiceIdentity.

type ManagedServiceIdentityType

type ManagedServiceIdentityType string

ManagedServiceIdentityType - Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

const (
	ManagedServiceIdentityTypeNone                       ManagedServiceIdentityType = "None"
	ManagedServiceIdentityTypeSystemAssigned             ManagedServiceIdentityType = "SystemAssigned"
	ManagedServiceIdentityTypeSystemAssignedUserAssigned ManagedServiceIdentityType = "SystemAssigned,UserAssigned"
	ManagedServiceIdentityTypeUserAssigned               ManagedServiceIdentityType = "UserAssigned"
)

func PossibleManagedServiceIdentityTypeValues

func PossibleManagedServiceIdentityTypeValues() []ManagedServiceIdentityType

PossibleManagedServiceIdentityTypeValues returns the possible values for the ManagedServiceIdentityType const type.

type ManifestArtifactFormat

type ManifestArtifactFormat struct {
	// The artifact name
	ArtifactName *string

	// The artifact type.
	ArtifactType *ArtifactType

	// The artifact version.
	ArtifactVersion *string
}

ManifestArtifactFormat - Manifest artifact properties.

func (ManifestArtifactFormat) MarshalJSON

func (m ManifestArtifactFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManifestArtifactFormat.

func (*ManifestArtifactFormat) UnmarshalJSON

func (m *ManifestArtifactFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManifestArtifactFormat.

type NFVIType

type NFVIType string

NFVIType - The NFVI type.

const (
	NFVITypeAzureArcKubernetes NFVIType = "AzureArcKubernetes"
	NFVITypeAzureCore          NFVIType = "AzureCore"
	NFVITypeAzureOperatorNexus NFVIType = "AzureOperatorNexus"
	NFVITypeUnknown            NFVIType = "Unknown"
)

func PossibleNFVITypeValues

func PossibleNFVITypeValues() []NFVIType

PossibleNFVITypeValues returns the possible values for the NFVIType const type.

type NFVIs

type NFVIs struct {
	// REQUIRED; The NFVI type.
	NfviType *NFVIType

	// Name of the nfvi.
	Name *string
}

NFVIs - The NFVI object.

func (*NFVIs) GetNFVIs

func (n *NFVIs) GetNFVIs() *NFVIs

GetNFVIs implements the NFVIsClassification interface for type NFVIs.

func (NFVIs) MarshalJSON

func (n NFVIs) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NFVIs.

func (*NFVIs) UnmarshalJSON

func (n *NFVIs) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NFVIs.

type NFVIsClassification

type NFVIsClassification interface {
	// GetNFVIs returns the NFVIs content of the underlying type.
	GetNFVIs() *NFVIs
}

NFVIsClassification provides polymorphic access to related types. Call the interface's GetNFVIs() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureArcK8SClusterNFVIDetails, *AzureCoreNFVIDetails, *AzureOperatorNexusClusterNFVIDetails, *NFVIs

type NSDArtifactProfile

type NSDArtifactProfile struct {
	// Artifact name.
	ArtifactName *string

	// The artifact store resource id
	ArtifactStoreReference *ReferencedResource

	// Artifact version.
	ArtifactVersion *string
}

NSDArtifactProfile - Artifact profile properties.

func (NSDArtifactProfile) MarshalJSON

func (n NSDArtifactProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NSDArtifactProfile.

func (*NSDArtifactProfile) UnmarshalJSON

func (n *NSDArtifactProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NSDArtifactProfile.

type NetworkFunction

type NetworkFunction struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// A unique read-only string that changes whenever the resource is updated.
	Etag *string

	// The managed identity of the network function.
	Identity *ManagedServiceIdentity

	// Network function properties.
	Properties NetworkFunctionPropertiesFormatClassification

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

NetworkFunction - Network function resource response.

func (NetworkFunction) MarshalJSON

func (n NetworkFunction) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkFunction.

func (*NetworkFunction) UnmarshalJSON

func (n *NetworkFunction) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkFunction.

type NetworkFunctionConfigurationType

type NetworkFunctionConfigurationType string

NetworkFunctionConfigurationType - The secret type which indicates if secret or not.

const (
	NetworkFunctionConfigurationTypeOpen    NetworkFunctionConfigurationType = "Open"
	NetworkFunctionConfigurationTypeSecret  NetworkFunctionConfigurationType = "Secret"
	NetworkFunctionConfigurationTypeUnknown NetworkFunctionConfigurationType = "Unknown"
)

func PossibleNetworkFunctionConfigurationTypeValues

func PossibleNetworkFunctionConfigurationTypeValues() []NetworkFunctionConfigurationType

PossibleNetworkFunctionConfigurationTypeValues returns the possible values for the NetworkFunctionConfigurationType const type.

type NetworkFunctionDefinitionGroup

type NetworkFunctionDefinitionGroup struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// Network function definition group properties.
	Properties *NetworkFunctionDefinitionGroupPropertiesFormat

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

NetworkFunctionDefinitionGroup - Network function definition group resource.

func (NetworkFunctionDefinitionGroup) MarshalJSON

func (n NetworkFunctionDefinitionGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkFunctionDefinitionGroup.

func (*NetworkFunctionDefinitionGroup) UnmarshalJSON

func (n *NetworkFunctionDefinitionGroup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkFunctionDefinitionGroup.

type NetworkFunctionDefinitionGroupListResult

type NetworkFunctionDefinitionGroupListResult struct {
	// A list of network function definition group.
	Value []*NetworkFunctionDefinitionGroup

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string
}

NetworkFunctionDefinitionGroupListResult - A list of network function definition group resources.

func (NetworkFunctionDefinitionGroupListResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type NetworkFunctionDefinitionGroupListResult.

func (*NetworkFunctionDefinitionGroupListResult) UnmarshalJSON

func (n *NetworkFunctionDefinitionGroupListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkFunctionDefinitionGroupListResult.

type NetworkFunctionDefinitionGroupPropertiesFormat

type NetworkFunctionDefinitionGroupPropertiesFormat struct {
	// The network function definition group description.
	Description *string

	// READ-ONLY; The provisioning state of the network function definition groups resource.
	ProvisioningState *ProvisioningState
}

NetworkFunctionDefinitionGroupPropertiesFormat - Network function definition group properties.

func (NetworkFunctionDefinitionGroupPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type NetworkFunctionDefinitionGroupPropertiesFormat.

func (*NetworkFunctionDefinitionGroupPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkFunctionDefinitionGroupPropertiesFormat.

type NetworkFunctionDefinitionGroupsClient

type NetworkFunctionDefinitionGroupsClient struct {
	// contains filtered or unexported fields
}

NetworkFunctionDefinitionGroupsClient contains the methods for the NetworkFunctionDefinitionGroups group. Don't use this type directly, use NewNetworkFunctionDefinitionGroupsClient() instead.

func NewNetworkFunctionDefinitionGroupsClient

func NewNetworkFunctionDefinitionGroupsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*NetworkFunctionDefinitionGroupsClient, error)

NewNetworkFunctionDefinitionGroupsClient creates a new instance of NetworkFunctionDefinitionGroupsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*NetworkFunctionDefinitionGroupsClient) BeginCreateOrUpdate

BeginCreateOrUpdate - Creates or updates a network function definition group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkFunctionDefinitionGroupName - The name of the network function definition group.
  • parameters - Parameters supplied to the create or update publisher network function definition group operation.
  • options - NetworkFunctionDefinitionGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the NetworkFunctionDefinitionGroupsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkFunctionDefinitionGroupsClient().BeginCreateOrUpdate(ctx, "rg", "TestPublisher", "TestNetworkFunctionDefinitionGroupName", armhybridnetwork.NetworkFunctionDefinitionGroup{
	Location: to.Ptr("eastus"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunctionDefinitionGroup = armhybridnetwork.NetworkFunctionDefinitionGroup{
// 	Name: to.Ptr("TestPublisherSkuVersion"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/rgproviders/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.NetworkFunctionDefinitionGroupPropertiesFormat{
// 	},
// }
Output:

func (*NetworkFunctionDefinitionGroupsClient) BeginDelete

func (client *NetworkFunctionDefinitionGroupsClient) BeginDelete(ctx context.Context, resourceGroupName string, publisherName string, networkFunctionDefinitionGroupName string, options *NetworkFunctionDefinitionGroupsClientBeginDeleteOptions) (*runtime.Poller[NetworkFunctionDefinitionGroupsClientDeleteResponse], error)

BeginDelete - Deletes a specified network function definition group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkFunctionDefinitionGroupName - The name of the network function definition group.
  • options - NetworkFunctionDefinitionGroupsClientBeginDeleteOptions contains the optional parameters for the NetworkFunctionDefinitionGroupsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkFunctionDefinitionGroupsClient().BeginDelete(ctx, "rg", "TestPublisher", "TestNetworkFunctionDefinitionGroupName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*NetworkFunctionDefinitionGroupsClient) Get

func (client *NetworkFunctionDefinitionGroupsClient) Get(ctx context.Context, resourceGroupName string, publisherName string, networkFunctionDefinitionGroupName string, options *NetworkFunctionDefinitionGroupsClientGetOptions) (NetworkFunctionDefinitionGroupsClientGetResponse, error)

Get - Gets information about the specified networkFunctionDefinition group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkFunctionDefinitionGroupName - The name of the network function definition group.
  • options - NetworkFunctionDefinitionGroupsClientGetOptions contains the optional parameters for the NetworkFunctionDefinitionGroupsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNetworkFunctionDefinitionGroupsClient().Get(ctx, "rg", "TestPublisher", "TestNetworkFunctionDefinitionGroupName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunctionDefinitionGroup = armhybridnetwork.NetworkFunctionDefinitionGroup{
// 	Name: to.Ptr("TestNetworkFunctionDefinitionVersion"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/rgproviders/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.NetworkFunctionDefinitionGroupPropertiesFormat{
// 		Description: to.Ptr("Test NFD group"),
// 	},
// }
Output:

func (*NetworkFunctionDefinitionGroupsClient) NewListByPublisherPager

NewListByPublisherPager - Gets information of the network function definition groups under a publisher.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • options - NetworkFunctionDefinitionGroupsClientListByPublisherOptions contains the optional parameters for the NetworkFunctionDefinitionGroupsClient.NewListByPublisherPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupsListByPublisherName.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewNetworkFunctionDefinitionGroupsClient().NewListByPublisherPager("rg", "TestPublisher", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.NetworkFunctionDefinitionGroupListResult = armhybridnetwork.NetworkFunctionDefinitionGroupListResult{
	// 	Value: []*armhybridnetwork.NetworkFunctionDefinitionGroup{
	// 		{
	// 			Name: to.Ptr("TestNetworkFunctionDefinitionVersion"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups"),
	// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/rgproviders/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName"),
	// 			Location: to.Ptr("eastus"),
	// 			Properties: &armhybridnetwork.NetworkFunctionDefinitionGroupPropertiesFormat{
	// 			},
	// 	}},
	// }
}
Output:

func (*NetworkFunctionDefinitionGroupsClient) Update

func (client *NetworkFunctionDefinitionGroupsClient) Update(ctx context.Context, resourceGroupName string, publisherName string, networkFunctionDefinitionGroupName string, parameters TagsObject, options *NetworkFunctionDefinitionGroupsClientUpdateOptions) (NetworkFunctionDefinitionGroupsClientUpdateResponse, error)

Update - Updates a network function definition group resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkFunctionDefinitionGroupName - The name of the network function definition group.
  • parameters - Parameters supplied to the create or update publisher network function definition group operation.
  • options - NetworkFunctionDefinitionGroupsClientUpdateOptions contains the optional parameters for the NetworkFunctionDefinitionGroupsClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionGroupUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNetworkFunctionDefinitionGroupsClient().Update(ctx, "rg", "TestPublisher", "TestNetworkFunctionDefinitionGroupName", armhybridnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunctionDefinitionGroup = armhybridnetwork.NetworkFunctionDefinitionGroup{
// 	Name: to.Ptr("TestPublisherSkuVersion"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/rgproviders/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName"),
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Properties: &armhybridnetwork.NetworkFunctionDefinitionGroupPropertiesFormat{
// 	},
// }
Output:

type NetworkFunctionDefinitionGroupsClientBeginCreateOrUpdateOptions

type NetworkFunctionDefinitionGroupsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

NetworkFunctionDefinitionGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the NetworkFunctionDefinitionGroupsClient.BeginCreateOrUpdate method.

type NetworkFunctionDefinitionGroupsClientBeginDeleteOptions

type NetworkFunctionDefinitionGroupsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

NetworkFunctionDefinitionGroupsClientBeginDeleteOptions contains the optional parameters for the NetworkFunctionDefinitionGroupsClient.BeginDelete method.

type NetworkFunctionDefinitionGroupsClientCreateOrUpdateResponse

type NetworkFunctionDefinitionGroupsClientCreateOrUpdateResponse struct {
	// Network function definition group resource.
	NetworkFunctionDefinitionGroup
}

NetworkFunctionDefinitionGroupsClientCreateOrUpdateResponse contains the response from method NetworkFunctionDefinitionGroupsClient.BeginCreateOrUpdate.

type NetworkFunctionDefinitionGroupsClientDeleteResponse

type NetworkFunctionDefinitionGroupsClientDeleteResponse struct {
}

NetworkFunctionDefinitionGroupsClientDeleteResponse contains the response from method NetworkFunctionDefinitionGroupsClient.BeginDelete.

type NetworkFunctionDefinitionGroupsClientGetOptions

type NetworkFunctionDefinitionGroupsClientGetOptions struct {
}

NetworkFunctionDefinitionGroupsClientGetOptions contains the optional parameters for the NetworkFunctionDefinitionGroupsClient.Get method.

type NetworkFunctionDefinitionGroupsClientGetResponse

type NetworkFunctionDefinitionGroupsClientGetResponse struct {
	// Network function definition group resource.
	NetworkFunctionDefinitionGroup
}

NetworkFunctionDefinitionGroupsClientGetResponse contains the response from method NetworkFunctionDefinitionGroupsClient.Get.

type NetworkFunctionDefinitionGroupsClientListByPublisherOptions

type NetworkFunctionDefinitionGroupsClientListByPublisherOptions struct {
}

NetworkFunctionDefinitionGroupsClientListByPublisherOptions contains the optional parameters for the NetworkFunctionDefinitionGroupsClient.NewListByPublisherPager method.

type NetworkFunctionDefinitionGroupsClientListByPublisherResponse

type NetworkFunctionDefinitionGroupsClientListByPublisherResponse struct {
	// A list of network function definition group resources.
	NetworkFunctionDefinitionGroupListResult
}

NetworkFunctionDefinitionGroupsClientListByPublisherResponse contains the response from method NetworkFunctionDefinitionGroupsClient.NewListByPublisherPager.

type NetworkFunctionDefinitionGroupsClientUpdateOptions

type NetworkFunctionDefinitionGroupsClientUpdateOptions struct {
}

NetworkFunctionDefinitionGroupsClientUpdateOptions contains the optional parameters for the NetworkFunctionDefinitionGroupsClient.Update method.

type NetworkFunctionDefinitionGroupsClientUpdateResponse

type NetworkFunctionDefinitionGroupsClientUpdateResponse struct {
	// Network function definition group resource.
	NetworkFunctionDefinitionGroup
}

NetworkFunctionDefinitionGroupsClientUpdateResponse contains the response from method NetworkFunctionDefinitionGroupsClient.Update.

type NetworkFunctionDefinitionResourceElementTemplateDetails

type NetworkFunctionDefinitionResourceElementTemplateDetails struct {
	// REQUIRED; The resource element template type.
	ResourceElementType *Type

	// The resource element template type.
	Configuration *ArmResourceDefinitionResourceElementTemplate

	// The depends on profile.
	DependsOnProfile *DependsOnProfile

	// Name of the resource element template.
	Name *string
}

NetworkFunctionDefinitionResourceElementTemplateDetails - The network function definition resource element template details.

func (*NetworkFunctionDefinitionResourceElementTemplateDetails) GetResourceElementTemplate

GetResourceElementTemplate implements the ResourceElementTemplateClassification interface for type NetworkFunctionDefinitionResourceElementTemplateDetails.

func (NetworkFunctionDefinitionResourceElementTemplateDetails) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type NetworkFunctionDefinitionResourceElementTemplateDetails.

func (*NetworkFunctionDefinitionResourceElementTemplateDetails) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkFunctionDefinitionResourceElementTemplateDetails.

type NetworkFunctionDefinitionVersion

type NetworkFunctionDefinitionVersion struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// Network function definition version properties.
	Properties NetworkFunctionDefinitionVersionPropertiesFormatClassification

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

NetworkFunctionDefinitionVersion - Network function definition version.

func (NetworkFunctionDefinitionVersion) MarshalJSON

func (n NetworkFunctionDefinitionVersion) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkFunctionDefinitionVersion.

func (*NetworkFunctionDefinitionVersion) UnmarshalJSON

func (n *NetworkFunctionDefinitionVersion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkFunctionDefinitionVersion.

type NetworkFunctionDefinitionVersionListResult

type NetworkFunctionDefinitionVersionListResult struct {
	// A list of network function definition versions.
	Value []*NetworkFunctionDefinitionVersion

	// READ-ONLY; The URI to get the next set of results.
	NextLink *string
}

NetworkFunctionDefinitionVersionListResult - A list of network function definition versions.

func (NetworkFunctionDefinitionVersionListResult) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type NetworkFunctionDefinitionVersionListResult.

func (*NetworkFunctionDefinitionVersionListResult) UnmarshalJSON

func (n *NetworkFunctionDefinitionVersionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkFunctionDefinitionVersionListResult.

type NetworkFunctionDefinitionVersionPropertiesFormat

type NetworkFunctionDefinitionVersionPropertiesFormat struct {
	// REQUIRED; The network function type.
	NetworkFunctionType *NetworkFunctionType

	// The deployment parameters of the network function definition version.
	DeployParameters *string

	// The network function definition version description.
	Description *string

	// READ-ONLY; The provisioning state of the network function definition version resource.
	ProvisioningState *ProvisioningState

	// READ-ONLY; The network function definition version state.
	VersionState *VersionState
}

NetworkFunctionDefinitionVersionPropertiesFormat - Network function definition version properties.

func (*NetworkFunctionDefinitionVersionPropertiesFormat) GetNetworkFunctionDefinitionVersionPropertiesFormat

func (n *NetworkFunctionDefinitionVersionPropertiesFormat) GetNetworkFunctionDefinitionVersionPropertiesFormat() *NetworkFunctionDefinitionVersionPropertiesFormat

GetNetworkFunctionDefinitionVersionPropertiesFormat implements the NetworkFunctionDefinitionVersionPropertiesFormatClassification interface for type NetworkFunctionDefinitionVersionPropertiesFormat.

func (NetworkFunctionDefinitionVersionPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type NetworkFunctionDefinitionVersionPropertiesFormat.

func (*NetworkFunctionDefinitionVersionPropertiesFormat) UnmarshalJSON

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkFunctionDefinitionVersionPropertiesFormat.

type NetworkFunctionDefinitionVersionPropertiesFormatClassification

type NetworkFunctionDefinitionVersionPropertiesFormatClassification interface {
	// GetNetworkFunctionDefinitionVersionPropertiesFormat returns the NetworkFunctionDefinitionVersionPropertiesFormat content of the underlying type.
	GetNetworkFunctionDefinitionVersionPropertiesFormat() *NetworkFunctionDefinitionVersionPropertiesFormat
}

NetworkFunctionDefinitionVersionPropertiesFormatClassification provides polymorphic access to related types. Call the interface's GetNetworkFunctionDefinitionVersionPropertiesFormat() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ContainerizedNetworkFunctionDefinitionVersion, *NetworkFunctionDefinitionVersionPropertiesFormat, *VirtualNetworkFunctionDefinitionVersion

type NetworkFunctionDefinitionVersionUpdateState

type NetworkFunctionDefinitionVersionUpdateState struct {
	// The network function definition version state. Only the 'Active' and 'Deprecated' states are allowed for updates. Other
	// states are used for internal state transitioning.
	VersionState *VersionState
}

NetworkFunctionDefinitionVersionUpdateState - Publisher network function definition version update request definition.

func (NetworkFunctionDefinitionVersionUpdateState) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type NetworkFunctionDefinitionVersionUpdateState.

func (*NetworkFunctionDefinitionVersionUpdateState) UnmarshalJSON

func (n *NetworkFunctionDefinitionVersionUpdateState) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkFunctionDefinitionVersionUpdateState.

type NetworkFunctionDefinitionVersionsClient

type NetworkFunctionDefinitionVersionsClient struct {
	// contains filtered or unexported fields
}

NetworkFunctionDefinitionVersionsClient contains the methods for the NetworkFunctionDefinitionVersions group. Don't use this type directly, use NewNetworkFunctionDefinitionVersionsClient() instead.

func NewNetworkFunctionDefinitionVersionsClient

func NewNetworkFunctionDefinitionVersionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*NetworkFunctionDefinitionVersionsClient, error)

NewNetworkFunctionDefinitionVersionsClient creates a new instance of NetworkFunctionDefinitionVersionsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*NetworkFunctionDefinitionVersionsClient) BeginCreateOrUpdate

func (client *NetworkFunctionDefinitionVersionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, publisherName string, networkFunctionDefinitionGroupName string, networkFunctionDefinitionVersionName string, parameters NetworkFunctionDefinitionVersion, options *NetworkFunctionDefinitionVersionsClientBeginCreateOrUpdateOptions) (*runtime.Poller[NetworkFunctionDefinitionVersionsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a network function definition version. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkFunctionDefinitionGroupName - The name of the network function definition group.
  • networkFunctionDefinitionVersionName - The name of the network function definition version. The name should conform to the SemVer 2.0.0 specification: https://semver.org/spec/v2.0.0.html.
  • parameters - Parameters supplied to the create or update network function definition version operation.
  • options - NetworkFunctionDefinitionVersionsClientBeginCreateOrUpdateOptions contains the optional parameters for the NetworkFunctionDefinitionVersionsClient.BeginCreateOrUpdate method.
Example (CreateOrUpdateANetworkFunctionDefinitionVersionResource)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkFunctionDefinitionVersionsClient().BeginCreateOrUpdate(ctx, "rg", "TestPublisher", "TestNetworkFunctionDefinitionGroupName", "1.0.0", armhybridnetwork.NetworkFunctionDefinitionVersion{
	Location: to.Ptr("eastus"),
	Properties: &armhybridnetwork.ContainerizedNetworkFunctionDefinitionVersion{
		DeployParameters:    to.Ptr("{\"type\":\"object\",\"properties\":{\"releaseName\":{\"type\":\"string\"},\"namespace\":{\"type\":\"string\"}}}"),
		NetworkFunctionType: to.Ptr(armhybridnetwork.NetworkFunctionTypeContainerizedNetworkFunction),
		VersionState:        to.Ptr(armhybridnetwork.VersionStateActive),
		NetworkFunctionTemplate: &armhybridnetwork.AzureArcKubernetesNetworkFunctionTemplate{
			NfviType: to.Ptr(armhybridnetwork.ContainerizedNetworkFunctionNFVITypeAzureArcKubernetes),
			NetworkFunctionApplications: []armhybridnetwork.AzureArcKubernetesNetworkFunctionApplicationClassification{
				&armhybridnetwork.AzureArcKubernetesHelmApplication{
					Name: to.Ptr("fedrbac"),
					DependsOnProfile: &armhybridnetwork.DependsOnProfile{
						InstallDependsOn:   []*string{},
						UninstallDependsOn: []*string{},
						UpdateDependsOn:    []*string{},
					},
					ArtifactType: to.Ptr(armhybridnetwork.AzureArcKubernetesArtifactTypeHelmPackage),
					ArtifactProfile: &armhybridnetwork.AzureArcKubernetesArtifactProfile{
						ArtifactStore: &armhybridnetwork.ReferencedResource{
							ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/testArtifactStore"),
						},
						HelmArtifactProfile: &armhybridnetwork.HelmArtifactProfile{
							HelmPackageName:         to.Ptr("fed-rbac"),
							HelmPackageVersionRange: to.Ptr("~2.1.3"),
							ImagePullSecretsValuesPaths: []*string{
								to.Ptr("global.imagePullSecrets")},
							RegistryValuesPaths: []*string{
								to.Ptr("global.registry.docker.repoPath")},
						},
					},
					DeployParametersMappingRuleProfile: &armhybridnetwork.AzureArcKubernetesDeployMappingRuleProfile{
						ApplicationEnablement: to.Ptr(armhybridnetwork.ApplicationEnablementEnabled),
						HelmMappingRuleProfile: &armhybridnetwork.HelmMappingRuleProfile{
							HelmPackageVersion: to.Ptr("2.1.3"),
							Options: &armhybridnetwork.HelmMappingRuleProfileOptions{
								InstallOptions: &armhybridnetwork.HelmInstallOptions{
									Atomic:  to.Ptr("true"),
									Timeout: to.Ptr("30"),
									Wait:    to.Ptr("waitValue"),
								},
								UpgradeOptions: &armhybridnetwork.HelmUpgradeOptions{
									Atomic:  to.Ptr("true"),
									Timeout: to.Ptr("30"),
									Wait:    to.Ptr("waitValue"),
								},
							},
							ReleaseName:      to.Ptr("{deployParameters.releaseName}"),
							ReleaseNamespace: to.Ptr("{deployParameters.namesapce}"),
							Values:           to.Ptr(""),
						},
					},
				}},
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunctionDefinitionVersion = armhybridnetwork.NetworkFunctionDefinitionVersion{
// 	Name: to.Ptr("TestVersion"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.0"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.ContainerizedNetworkFunctionDefinitionVersion{
// 		DeployParameters: to.Ptr("{\"type\":\"object\",\"properties\":{\"releaseName\":{\"type\":\"string\"},\"namespace\":{\"type\":\"string\"}}}"),
// 		NetworkFunctionType: to.Ptr(armhybridnetwork.NetworkFunctionTypeContainerizedNetworkFunction),
// 		VersionState: to.Ptr(armhybridnetwork.VersionStateActive),
// 		NetworkFunctionTemplate: &armhybridnetwork.AzureArcKubernetesNetworkFunctionTemplate{
// 			NfviType: to.Ptr(armhybridnetwork.ContainerizedNetworkFunctionNFVITypeAzureArcKubernetes),
// 			NetworkFunctionApplications: []armhybridnetwork.AzureArcKubernetesNetworkFunctionApplicationClassification{
// 				&armhybridnetwork.AzureArcKubernetesHelmApplication{
// 					Name: to.Ptr("fedrbac"),
// 					DependsOnProfile: &armhybridnetwork.DependsOnProfile{
// 						InstallDependsOn: []*string{
// 						},
// 						UninstallDependsOn: []*string{
// 						},
// 						UpdateDependsOn: []*string{
// 						},
// 					},
// 					ArtifactType: to.Ptr(armhybridnetwork.AzureArcKubernetesArtifactTypeHelmPackage),
// 					ArtifactProfile: &armhybridnetwork.AzureArcKubernetesArtifactProfile{
// 						ArtifactStore: &armhybridnetwork.ReferencedResource{
// 							ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/artifactStores/testStore"),
// 						},
// 						HelmArtifactProfile: &armhybridnetwork.HelmArtifactProfile{
// 							HelmPackageName: to.Ptr("fed-rbac"),
// 							HelmPackageVersionRange: to.Ptr("~2.1.3"),
// 							ImagePullSecretsValuesPaths: []*string{
// 								to.Ptr("global.imagePullSecrets")},
// 								RegistryValuesPaths: []*string{
// 									to.Ptr("global.registry.docker.repoPath")},
// 								},
// 							},
// 							DeployParametersMappingRuleProfile: &armhybridnetwork.AzureArcKubernetesDeployMappingRuleProfile{
// 								ApplicationEnablement: to.Ptr(armhybridnetwork.ApplicationEnablementEnabled),
// 								HelmMappingRuleProfile: &armhybridnetwork.HelmMappingRuleProfile{
// 									HelmPackageVersion: to.Ptr("2.1.3"),
// 									Options: &armhybridnetwork.HelmMappingRuleProfileOptions{
// 										InstallOptions: &armhybridnetwork.HelmInstallOptions{
// 											Atomic: to.Ptr("true"),
// 											Timeout: to.Ptr("30"),
// 											Wait: to.Ptr("waitValue"),
// 										},
// 										UpgradeOptions: &armhybridnetwork.HelmUpgradeOptions{
// 											Atomic: to.Ptr("true"),
// 											Timeout: to.Ptr("30"),
// 											Wait: to.Ptr("waitValue"),
// 										},
// 									},
// 									ReleaseName: to.Ptr("{deployParameters.releaseName}"),
// 									ReleaseNamespace: to.Ptr("{deployParameters.namesapce}"),
// 									Values: to.Ptr(""),
// 								},
// 							},
// 					}},
// 				},
// 			},
// 		}
Output:

Example (CreateOrUpdateANetworkFunctionDefinitionVersionResourceForAzureCoreVnf)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionDefinitionVersionCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkFunctionDefinitionVersionsClient().BeginCreateOrUpdate(ctx, "rg", "TestPublisher", "TestNetworkFunctionDefinitionGroupName", "1.0.0", armhybridnetwork.NetworkFunctionDefinitionVersion{
	Location: to.Ptr("eastus"),
	Properties: &armhybridnetwork.VirtualNetworkFunctionDefinitionVersion{
		Description:         to.Ptr("test NFDV for AzureCore"),
		DeployParameters:    to.Ptr("{\"virtualMachineName\":{\"type\":\"string\"},\"cpuCores\":{\"type\":\"int\"},\"memorySizeGB\":{\"type\":\"int\"},\"cloudServicesNetworkAttachment\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]},\"networkAttachments\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]}},\"storageProfile\":{\"type\":\"object\",\"properties\":{\"osDisk\":{\"type\":\"object\",\"properties\":{\"createOption\":{\"type\":\"string\"},\"deleteOption\":{\"type\":\"string\"},\"diskSizeGB\":{\"type\":\"integer\"}},\"required\":[\"diskSizeGB\"]}},\"required\":[\"osDisk\"]},\"sshPublicKeys\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"keyData\":{\"type\":\"string\"}},\"required\":[\"keyData\"]}},\"userData\":{\"type\":\"string\"},\"adminUsername\":{\"type\":\"string\"},\"bootMethod\":{\"type\":\"string\",\"default\":\"UEFI\",\"enum\":[\"UEFI\",\"BIOS\"]},\"isolateEmulatorThread\":{\"type\":\"string\"},\"virtioInterface\":{\"type\":\"string\"},\"placementHints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"hintType\":{\"type\":\"string\",\"enum\":[\"Affinity\",\"AntiAffinity\"]},\"resourceId\":{\"type\":\"string\"},\"schedulingExecution\":{\"type\":\"string\",\"enum\":[\"Soft\",\"Hard\"]},\"scope\":{\"type\":\"string\"}},\"required\":[\"hintType\",\"schedulingExecution\",\"resourceId\",\"scope\"]}}}"),
		NetworkFunctionType: to.Ptr(armhybridnetwork.NetworkFunctionTypeVirtualNetworkFunction),
		VersionState:        to.Ptr(armhybridnetwork.VersionStatePreview),
		NetworkFunctionTemplate: &armhybridnetwork.AzureCoreNetworkFunctionTemplate{
			NfviType: to.Ptr(armhybridnetwork.VirtualNetworkFunctionNFVITypeAzureCore),
			NetworkFunctionApplications: []armhybridnetwork.AzureCoreNetworkFunctionApplicationClassification{
				&armhybridnetwork.AzureCoreNetworkFunctionVhdApplication{
					Name: to.Ptr("testImageRole"),
					DependsOnProfile: &armhybridnetwork.DependsOnProfile{
						InstallDependsOn:   []*string{},
						UninstallDependsOn: []*string{},
						UpdateDependsOn:    []*string{},
					},
					ArtifactType: to.Ptr(armhybridnetwork.AzureCoreArtifactTypeVhdImageFile),
					ArtifactProfile: &armhybridnetwork.AzureCoreVhdImageArtifactProfile{
						ArtifactStore: &armhybridnetwork.ReferencedResource{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore"),
						},
						VhdArtifactProfile: &armhybridnetwork.VhdImageArtifactProfile{
							VhdName:    to.Ptr("test-image"),
							VhdVersion: to.Ptr("1-0-0"),
						},
					},
					DeployParametersMappingRuleProfile: &armhybridnetwork.AzureCoreVhdImageDeployMappingRuleProfile{
						ApplicationEnablement: to.Ptr(armhybridnetwork.ApplicationEnablementUnknown),
						VhdImageMappingRuleProfile: &armhybridnetwork.VhdImageMappingRuleProfile{
							UserConfiguration: to.Ptr(""),
						},
					},
				},
				&armhybridnetwork.AzureCoreNetworkFunctionArmTemplateApplication{
					Name: to.Ptr("testTemplateRole"),
					DependsOnProfile: &armhybridnetwork.DependsOnProfile{
						InstallDependsOn: []*string{
							to.Ptr("testImageRole")},
						UninstallDependsOn: []*string{
							to.Ptr("testImageRole")},
						UpdateDependsOn: []*string{
							to.Ptr("testImageRole")},
					},
					ArtifactType: to.Ptr(armhybridnetwork.AzureCoreArtifactTypeArmTemplate),
					ArtifactProfile: &armhybridnetwork.AzureCoreArmTemplateArtifactProfile{
						ArtifactStore: &armhybridnetwork.ReferencedResource{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore"),
						},
						TemplateArtifactProfile: &armhybridnetwork.ArmTemplateArtifactProfile{
							TemplateName:    to.Ptr("test-template"),
							TemplateVersion: to.Ptr("1.0.0"),
						},
					},
					DeployParametersMappingRuleProfile: &armhybridnetwork.AzureCoreArmTemplateDeployMappingRuleProfile{
						ApplicationEnablement: to.Ptr(armhybridnetwork.ApplicationEnablementUnknown),
						TemplateMappingRuleProfile: &armhybridnetwork.ArmTemplateMappingRuleProfile{
							TemplateParameters: to.Ptr("{\"virtualMachineName\":\"{deployParameters.virtualMachineName}\",\"cpuCores\":\"{deployParameters.cpuCores}\",\"memorySizeGB\":\"{deployParameters.memorySizeGB}\",\"cloudServicesNetworkAttachment\":\"{deployParameters.cloudServicesNetworkAttachment}\",\"networkAttachments\":\"{deployParameters.networkAttachments}\",\"sshPublicKeys\":\"{deployParameters.sshPublicKeys}\",\"storageProfile\":\"{deployParameters.storageProfile}\",\"isolateEmulatorThread\":\"{deployParameters.isolateEmulatorThread}\",\"virtioInterface\":\"{deployParameters.virtioInterface}\",\"userData\":\"{deployParameters.userData}\",\"adminUsername\":\"{deployParameters.adminUsername}\",\"bootMethod\":\"{deployParameters.bootMethod}\",\"placementHints\":\"{deployParameters.placementHints}\"}"),
						},
					},
				}},
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunctionDefinitionVersion = armhybridnetwork.NetworkFunctionDefinitionVersion{
// 	Name: to.Ptr("TestVersion"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.0"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.VirtualNetworkFunctionDefinitionVersion{
// 		Description: to.Ptr("test NFDV for AzureCore"),
// 		DeployParameters: to.Ptr("{\"virtualMachineName\":{\"type\":\"string\"},\"cpuCores\":{\"type\":\"int\"},\"memorySizeGB\":{\"type\":\"int\"},\"cloudServicesNetworkAttachment\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]},\"networkAttachments\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]}},\"storageProfile\":{\"type\":\"object\",\"properties\":{\"osDisk\":{\"type\":\"object\",\"properties\":{\"createOption\":{\"type\":\"string\"},\"deleteOption\":{\"type\":\"string\"},\"diskSizeGB\":{\"type\":\"integer\"}},\"required\":[\"diskSizeGB\"]}},\"required\":[\"osDisk\"]},\"sshPublicKeys\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"keyData\":{\"type\":\"string\"}},\"required\":[\"keyData\"]}},\"userData\":{\"type\":\"string\"},\"adminUsername\":{\"type\":\"string\"},\"bootMethod\":{\"type\":\"string\",\"default\":\"UEFI\",\"enum\":[\"UEFI\",\"BIOS\"]},\"isolateEmulatorThread\":{\"type\":\"string\"},\"virtioInterface\":{\"type\":\"string\"},\"placementHints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"hintType\":{\"type\":\"string\",\"enum\":[\"Affinity\",\"AntiAffinity\"]},\"resourceId\":{\"type\":\"string\"},\"schedulingExecution\":{\"type\":\"string\",\"enum\":[\"Soft\",\"Hard\"]},\"scope\":{\"type\":\"string\"}},\"required\":[\"hintType\",\"schedulingExecution\",\"resourceId\",\"scope\"]}}}"),
// 		NetworkFunctionType: to.Ptr(armhybridnetwork.NetworkFunctionTypeVirtualNetworkFunction),
// 		VersionState: to.Ptr(armhybridnetwork.VersionStatePreview),
// 		NetworkFunctionTemplate: &armhybridnetwork.AzureCoreNetworkFunctionTemplate{
// 			NfviType: to.Ptr(armhybridnetwork.VirtualNetworkFunctionNFVITypeAzureCore),
// 			NetworkFunctionApplications: []armhybridnetwork.AzureCoreNetworkFunctionApplicationClassification{
// 				&armhybridnetwork.AzureCoreNetworkFunctionVhdApplication{
// 					Name: to.Ptr("testImageRole"),
// 					DependsOnProfile: &armhybridnetwork.DependsOnProfile{
// 						InstallDependsOn: []*string{
// 						},
// 						UninstallDependsOn: []*string{
// 						},
// 						UpdateDependsOn: []*string{
// 						},
// 					},
// 					ArtifactType: to.Ptr(armhybridnetwork.AzureCoreArtifactTypeVhdImageFile),
// 					ArtifactProfile: &armhybridnetwork.AzureCoreVhdImageArtifactProfile{
// 						ArtifactStore: &armhybridnetwork.ReferencedResource{
// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore"),
// 						},
// 						VhdArtifactProfile: &armhybridnetwork.VhdImageArtifactProfile{
// 							VhdName: to.Ptr("test-image"),
// 							VhdVersion: to.Ptr("1-0-0"),
// 						},
// 					},
// 					DeployParametersMappingRuleProfile: &armhybridnetwork.AzureCoreVhdImageDeployMappingRuleProfile{
// 						ApplicationEnablement: to.Ptr(armhybridnetwork.ApplicationEnablementUnknown),
// 						VhdImageMappingRuleProfile: &armhybridnetwork.VhdImageMappingRuleProfile{
// 							UserConfiguration: to.Ptr(""),
// 						},
// 					},
// 				},
// 				&armhybridnetwork.AzureCoreNetworkFunctionArmTemplateApplication{
// 					Name: to.Ptr("testTemplateRole"),
// 					DependsOnProfile: &armhybridnetwork.DependsOnProfile{
// 						InstallDependsOn: []*string{
// 							to.Ptr("testImageRole")},
// 							UninstallDependsOn: []*string{
// 								to.Ptr("testImageRole")},
// 								UpdateDependsOn: []*string{
// 									to.Ptr("testImageRole")},
// 								},
// 								ArtifactType: to.Ptr(armhybridnetwork.AzureCoreArtifactTypeArmTemplate),
// 								ArtifactProfile: &armhybridnetwork.AzureCoreArmTemplateArtifactProfile{
// 									ArtifactStore: &armhybridnetwork.ReferencedResource{
// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore"),
// 									},
// 									TemplateArtifactProfile: &armhybridnetwork.ArmTemplateArtifactProfile{
// 										TemplateName: to.Ptr("test-template"),
// 										TemplateVersion: to.Ptr("1.0.0"),
// 									},
// 								},
// 								DeployParametersMappingRuleProfile: &armhybridnetwork.AzureCoreArmTemplateDeployMappingRuleProfile{
// 									ApplicationEnablement: to.Ptr(armhybridnetwork.ApplicationEnablementUnknown),
// 									TemplateMappingRuleProfile: &armhybridnetwork.ArmTemplateMappingRuleProfile{
// 										TemplateParameters: to.Ptr("{\"virtualMachineName\":\"{deployParameters.virtualMachineName}\",\"cpuCores\":\"{deployParameters.cpuCores}\",\"memorySizeGB\":\"{deployParameters.memorySizeGB}\",\"cloudServicesNetworkAttachment\":\"{deployParameters.cloudServicesNetworkAttachment}\",\"networkAttachments\":\"{deployParameters.networkAttachments}\",\"sshPublicKeys\":\"{deployParameters.sshPublicKeys}\",\"storageProfile\":\"{deployParameters.storageProfile}\",\"isolateEmulatorThread\":\"{deployParameters.isolateEmulatorThread}\",\"virtioInterface\":\"{deployParameters.virtioInterface}\",\"userData\":\"{deployParameters.userData}\",\"adminUsername\":\"{deployParameters.adminUsername}\",\"bootMethod\":\"{deployParameters.bootMethod}\",\"placementHints\":\"{deployParameters.placementHints}\"}"),
// 									},
// 								},
// 						}},
// 					},
// 				},
// 			}
Output:

Example (CreateOrUpdateANetworkFunctionDefinitionVersionResourceForAzureOperatorNexusVnf)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionDefinitionVersionCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkFunctionDefinitionVersionsClient().BeginCreateOrUpdate(ctx, "rg", "TestPublisher", "TestNetworkFunctionDefinitionGroupName", "1.0.0", armhybridnetwork.NetworkFunctionDefinitionVersion{
	Location: to.Ptr("eastus"),
	Properties: &armhybridnetwork.VirtualNetworkFunctionDefinitionVersion{
		Description:         to.Ptr("test NFDV for AzureOperatorNexus"),
		DeployParameters:    to.Ptr("{\"virtualMachineName\":{\"type\":\"string\"},\"extendedLocationName\":{\"type\":\"string\"},\"cpuCores\":{\"type\":\"int\"},\"memorySizeGB\":{\"type\":\"int\"},\"cloudServicesNetworkAttachment\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]},\"networkAttachments\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]}},\"storageProfile\":{\"type\":\"object\",\"properties\":{\"osDisk\":{\"type\":\"object\",\"properties\":{\"createOption\":{\"type\":\"string\"},\"deleteOption\":{\"type\":\"string\"},\"diskSizeGB\":{\"type\":\"integer\"}},\"required\":[\"diskSizeGB\"]}},\"required\":[\"osDisk\"]},\"sshPublicKeys\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"keyData\":{\"type\":\"string\"}},\"required\":[\"keyData\"]}},\"userData\":{\"type\":\"string\"},\"adminUsername\":{\"type\":\"string\"},\"bootMethod\":{\"type\":\"string\",\"default\":\"UEFI\",\"enum\":[\"UEFI\",\"BIOS\"]},\"isolateEmulatorThread\":{\"type\":\"string\"},\"virtioInterface\":{\"type\":\"string\"},\"placementHints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"hintType\":{\"type\":\"string\",\"enum\":[\"Affinity\",\"AntiAffinity\"]},\"resourceId\":{\"type\":\"string\"},\"schedulingExecution\":{\"type\":\"string\",\"enum\":[\"Soft\",\"Hard\"]},\"scope\":{\"type\":\"string\"}},\"required\":[\"hintType\",\"schedulingExecution\",\"resourceId\",\"scope\"]}}}"),
		NetworkFunctionType: to.Ptr(armhybridnetwork.NetworkFunctionTypeVirtualNetworkFunction),
		VersionState:        to.Ptr(armhybridnetwork.VersionStatePreview),
		NetworkFunctionTemplate: &armhybridnetwork.AzureOperatorNexusNetworkFunctionTemplate{
			NfviType: to.Ptr(armhybridnetwork.VirtualNetworkFunctionNFVITypeAzureOperatorNexus),
			NetworkFunctionApplications: []armhybridnetwork.AzureOperatorNexusNetworkFunctionApplicationClassification{
				&armhybridnetwork.AzureOperatorNexusNetworkFunctionImageApplication{
					Name: to.Ptr("testImageRole"),
					DependsOnProfile: &armhybridnetwork.DependsOnProfile{
						InstallDependsOn:   []*string{},
						UninstallDependsOn: []*string{},
						UpdateDependsOn:    []*string{},
					},
					ArtifactType: to.Ptr(armhybridnetwork.AzureOperatorNexusArtifactTypeImageFile),
					ArtifactProfile: &armhybridnetwork.AzureOperatorNexusImageArtifactProfile{
						ArtifactStore: &armhybridnetwork.ReferencedResource{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore"),
						},
						ImageArtifactProfile: &armhybridnetwork.ImageArtifactProfile{
							ImageName:    to.Ptr("test-image"),
							ImageVersion: to.Ptr("1.0.0"),
						},
					},
					DeployParametersMappingRuleProfile: &armhybridnetwork.AzureOperatorNexusImageDeployMappingRuleProfile{
						ApplicationEnablement: to.Ptr(armhybridnetwork.ApplicationEnablementUnknown),
						ImageMappingRuleProfile: &armhybridnetwork.ImageMappingRuleProfile{
							UserConfiguration: to.Ptr(""),
						},
					},
				},
				&armhybridnetwork.AzureOperatorNexusNetworkFunctionArmTemplateApplication{
					Name: to.Ptr("testTemplateRole"),
					DependsOnProfile: &armhybridnetwork.DependsOnProfile{
						InstallDependsOn: []*string{
							to.Ptr("testImageRole")},
						UninstallDependsOn: []*string{
							to.Ptr("testImageRole")},
						UpdateDependsOn: []*string{
							to.Ptr("testImageRole")},
					},
					ArtifactType: to.Ptr(armhybridnetwork.AzureOperatorNexusArtifactTypeArmTemplate),
					ArtifactProfile: &armhybridnetwork.AzureOperatorNexusArmTemplateArtifactProfile{
						ArtifactStore: &armhybridnetwork.ReferencedResource{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore"),
						},
						TemplateArtifactProfile: &armhybridnetwork.ArmTemplateArtifactProfile{
							TemplateName:    to.Ptr("test-template"),
							TemplateVersion: to.Ptr("1.0.0"),
						},
					},
					DeployParametersMappingRuleProfile: &armhybridnetwork.AzureOperatorNexusArmTemplateDeployMappingRuleProfile{
						ApplicationEnablement: to.Ptr(armhybridnetwork.ApplicationEnablementUnknown),
						TemplateMappingRuleProfile: &armhybridnetwork.ArmTemplateMappingRuleProfile{
							TemplateParameters: to.Ptr("{\"virtualMachineName\":\"{deployParameters.virtualMachineName}\",\"extendedLocationName\":\"{deployParameters.extendedLocationName}\",\"cpuCores\":\"{deployParameters.cpuCores}\",\"memorySizeGB\":\"{deployParameters.memorySizeGB}\",\"cloudServicesNetworkAttachment\":\"{deployParameters.cloudServicesNetworkAttachment}\",\"networkAttachments\":\"{deployParameters.networkAttachments}\",\"sshPublicKeys\":\"{deployParameters.sshPublicKeys}\",\"storageProfile\":\"{deployParameters.storageProfile}\",\"isolateEmulatorThread\":\"{deployParameters.isolateEmulatorThread}\",\"virtioInterface\":\"{deployParameters.virtioInterface}\",\"userData\":\"{deployParameters.userData}\",\"adminUsername\":\"{deployParameters.adminUsername}\",\"bootMethod\":\"{deployParameters.bootMethod}\",\"placementHints\":\"{deployParameters.placementHints}\"}"),
						},
					},
				}},
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunctionDefinitionVersion = armhybridnetwork.NetworkFunctionDefinitionVersion{
// 	Name: to.Ptr("TestVersion"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.0"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.VirtualNetworkFunctionDefinitionVersion{
// 		Description: to.Ptr("test NFDV for AzureOperatorNexus"),
// 		DeployParameters: to.Ptr("{\"virtualMachineName\":{\"type\":\"string\"},\"extendedLocationName\":{\"type\":\"string\"},\"cpuCores\":{\"type\":\"int\"},\"memorySizeGB\":{\"type\":\"int\"},\"cloudServicesNetworkAttachment\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]},\"networkAttachments\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]}},\"storageProfile\":{\"type\":\"object\",\"properties\":{\"osDisk\":{\"type\":\"object\",\"properties\":{\"createOption\":{\"type\":\"string\"},\"deleteOption\":{\"type\":\"string\"},\"diskSizeGB\":{\"type\":\"integer\"}},\"required\":[\"diskSizeGB\"]}},\"required\":[\"osDisk\"]},\"sshPublicKeys\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"keyData\":{\"type\":\"string\"}},\"required\":[\"keyData\"]}},\"userData\":{\"type\":\"string\"},\"adminUsername\":{\"type\":\"string\"},\"bootMethod\":{\"type\":\"string\",\"default\":\"UEFI\",\"enum\":[\"UEFI\",\"BIOS\"]},\"isolateEmulatorThread\":{\"type\":\"string\"},\"virtioInterface\":{\"type\":\"string\"},\"placementHints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"hintType\":{\"type\":\"string\",\"enum\":[\"Affinity\",\"AntiAffinity\"]},\"resourceId\":{\"type\":\"string\"},\"schedulingExecution\":{\"type\":\"string\",\"enum\":[\"Soft\",\"Hard\"]},\"scope\":{\"type\":\"string\"}},\"required\":[\"hintType\",\"schedulingExecution\",\"resourceId\",\"scope\"]}}}"),
// 		NetworkFunctionType: to.Ptr(armhybridnetwork.NetworkFunctionTypeVirtualNetworkFunction),
// 		VersionState: to.Ptr(armhybridnetwork.VersionStatePreview),
// 		NetworkFunctionTemplate: &armhybridnetwork.AzureOperatorNexusNetworkFunctionTemplate{
// 			NfviType: to.Ptr(armhybridnetwork.VirtualNetworkFunctionNFVITypeAzureOperatorNexus),
// 			NetworkFunctionApplications: []armhybridnetwork.AzureOperatorNexusNetworkFunctionApplicationClassification{
// 				&armhybridnetwork.AzureOperatorNexusNetworkFunctionImageApplication{
// 					Name: to.Ptr("testImageRole"),
// 					DependsOnProfile: &armhybridnetwork.DependsOnProfile{
// 						InstallDependsOn: []*string{
// 						},
// 						UninstallDependsOn: []*string{
// 						},
// 						UpdateDependsOn: []*string{
// 						},
// 					},
// 					ArtifactType: to.Ptr(armhybridnetwork.AzureOperatorNexusArtifactTypeImageFile),
// 					ArtifactProfile: &armhybridnetwork.AzureOperatorNexusImageArtifactProfile{
// 						ArtifactStore: &armhybridnetwork.ReferencedResource{
// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore"),
// 						},
// 						ImageArtifactProfile: &armhybridnetwork.ImageArtifactProfile{
// 							ImageName: to.Ptr("test-image"),
// 							ImageVersion: to.Ptr("1.0.0"),
// 						},
// 					},
// 					DeployParametersMappingRuleProfile: &armhybridnetwork.AzureOperatorNexusImageDeployMappingRuleProfile{
// 						ApplicationEnablement: to.Ptr(armhybridnetwork.ApplicationEnablementUnknown),
// 						ImageMappingRuleProfile: &armhybridnetwork.ImageMappingRuleProfile{
// 							UserConfiguration: to.Ptr(""),
// 						},
// 					},
// 				},
// 				&armhybridnetwork.AzureOperatorNexusNetworkFunctionArmTemplateApplication{
// 					Name: to.Ptr("testTemplateRole"),
// 					DependsOnProfile: &armhybridnetwork.DependsOnProfile{
// 						InstallDependsOn: []*string{
// 							to.Ptr("testImageRole")},
// 							UninstallDependsOn: []*string{
// 								to.Ptr("testImageRole")},
// 								UpdateDependsOn: []*string{
// 									to.Ptr("testImageRole")},
// 								},
// 								ArtifactType: to.Ptr(armhybridnetwork.AzureOperatorNexusArtifactTypeArmTemplate),
// 								ArtifactProfile: &armhybridnetwork.AzureOperatorNexusArmTemplateArtifactProfile{
// 									ArtifactStore: &armhybridnetwork.ReferencedResource{
// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore"),
// 									},
// 									TemplateArtifactProfile: &armhybridnetwork.ArmTemplateArtifactProfile{
// 										TemplateName: to.Ptr("test-template"),
// 										TemplateVersion: to.Ptr("1.0.0"),
// 									},
// 								},
// 								DeployParametersMappingRuleProfile: &armhybridnetwork.AzureOperatorNexusArmTemplateDeployMappingRuleProfile{
// 									ApplicationEnablement: to.Ptr(armhybridnetwork.ApplicationEnablementUnknown),
// 									TemplateMappingRuleProfile: &armhybridnetwork.ArmTemplateMappingRuleProfile{
// 										TemplateParameters: to.Ptr("{\"virtualMachineName\":\"{deployParameters.virtualMachineName}\",\"extendedLocationName\":\"{deployParameters.extendedLocationName}\",\"cpuCores\":\"{deployParameters.cpuCores}\",\"memorySizeGB\":\"{deployParameters.memorySizeGB}\",\"cloudServicesNetworkAttachment\":\"{deployParameters.cloudServicesNetworkAttachment}\",\"networkAttachments\":\"{deployParameters.networkAttachments}\",\"sshPublicKeys\":\"{deployParameters.sshPublicKeys}\",\"storageProfile\":\"{deployParameters.storageProfile}\",\"isolateEmulatorThread\":\"{deployParameters.isolateEmulatorThread}\",\"virtioInterface\":\"{deployParameters.virtioInterface}\",\"userData\":\"{deployParameters.userData}\",\"adminUsername\":\"{deployParameters.adminUsername}\",\"bootMethod\":\"{deployParameters.bootMethod}\",\"placementHints\":\"{deployParameters.placementHints}\"}"),
// 									},
// 								},
// 						}},
// 					},
// 				},
// 			}
Output:

func (*NetworkFunctionDefinitionVersionsClient) BeginDelete

func (client *NetworkFunctionDefinitionVersionsClient) BeginDelete(ctx context.Context, resourceGroupName string, publisherName string, networkFunctionDefinitionGroupName string, networkFunctionDefinitionVersionName string, options *NetworkFunctionDefinitionVersionsClientBeginDeleteOptions) (*runtime.Poller[NetworkFunctionDefinitionVersionsClientDeleteResponse], error)

BeginDelete - Deletes the specified network function definition version. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkFunctionDefinitionGroupName - The name of the network function definition group.
  • networkFunctionDefinitionVersionName - The name of the network function definition version. The name should conform to the SemVer 2.0.0 specification: https://semver.org/spec/v2.0.0.html.
  • options - NetworkFunctionDefinitionVersionsClientBeginDeleteOptions contains the optional parameters for the NetworkFunctionDefinitionVersionsClient.BeginDelete method.
Example (DeleteANetworkFunctionDefinitionVersion)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkFunctionDefinitionVersionsClient().BeginDelete(ctx, "rg", "TestPublisher", "TestNetworkFunctionDefinitionGroupName", "1.0.0", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

Example (DeleteANetworkFunctionDefinitionVersionForAzureCoreVnf)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionDefinitionVersionDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkFunctionDefinitionVersionsClient().BeginDelete(ctx, "rg", "TestPublisher", "TestNetworkFunctionDefinitionGroupName", "1.0.0", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

Example (DeleteANetworkFunctionDefinitionVersionForAzureOperatorNexusVnf)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionDefinitionVersionDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkFunctionDefinitionVersionsClient().BeginDelete(ctx, "rg", "TestPublisher", "TestNetworkFunctionDefinitionGroupName", "1.0.0", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*NetworkFunctionDefinitionVersionsClient) BeginUpdateState

func (client *NetworkFunctionDefinitionVersionsClient) BeginUpdateState(ctx context.Context, resourceGroupName string, publisherName string, networkFunctionDefinitionGroupName string, networkFunctionDefinitionVersionName string, parameters NetworkFunctionDefinitionVersionUpdateState, options *NetworkFunctionDefinitionVersionsClientBeginUpdateStateOptions) (*runtime.Poller[NetworkFunctionDefinitionVersionsClientUpdateStateResponse], error)

BeginUpdateState - Update network function definition version state. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkFunctionDefinitionGroupName - The name of the network function definition group.
  • networkFunctionDefinitionVersionName - The name of the network function definition version. The name should conform to the SemVer 2.0.0 specification: https://semver.org/spec/v2.0.0.html.
  • parameters - Parameters supplied to update the state of network function definition version.
  • options - NetworkFunctionDefinitionVersionsClientBeginUpdateStateOptions contains the optional parameters for the NetworkFunctionDefinitionVersionsClient.BeginUpdateState method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionUpdateState.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkFunctionDefinitionVersionsClient().BeginUpdateState(ctx, "rg", "TestPublisher", "TestSkuGroup", "1.0.0", armhybridnetwork.NetworkFunctionDefinitionVersionUpdateState{
	VersionState: to.Ptr(armhybridnetwork.VersionStateActive),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunctionDefinitionVersionUpdateState = armhybridnetwork.NetworkFunctionDefinitionVersionUpdateState{
// 	VersionState: to.Ptr(armhybridnetwork.VersionStateActive),
// }
Output:

func (*NetworkFunctionDefinitionVersionsClient) Get

func (client *NetworkFunctionDefinitionVersionsClient) Get(ctx context.Context, resourceGroupName string, publisherName string, networkFunctionDefinitionGroupName string, networkFunctionDefinitionVersionName string, options *NetworkFunctionDefinitionVersionsClientGetOptions) (NetworkFunctionDefinitionVersionsClientGetResponse, error)

Get - Gets information about a network function definition version. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkFunctionDefinitionGroupName - The name of the network function definition group.
  • networkFunctionDefinitionVersionName - The name of the network function definition version. The name should conform to the SemVer 2.0.0 specification: https://semver.org/spec/v2.0.0.html.
  • options - NetworkFunctionDefinitionVersionsClientGetOptions contains the optional parameters for the NetworkFunctionDefinitionVersionsClient.Get method.
Example (GetANetworkFunctionDefinitionVersionResource)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNetworkFunctionDefinitionVersionsClient().Get(ctx, "rg", "TestPublisher", "TestNetworkFunctionDefinitionGroupName", "1.0.0", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunctionDefinitionVersion = armhybridnetwork.NetworkFunctionDefinitionVersion{
// 	Name: to.Ptr("TestVersion"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.0"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.ContainerizedNetworkFunctionDefinitionVersion{
// 		DeployParameters: to.Ptr("{\"releaseName\":{\"type\":\"string\"},\"namespace\":{\"type\":\"string\"}}"),
// 		NetworkFunctionType: to.Ptr(armhybridnetwork.NetworkFunctionTypeContainerizedNetworkFunction),
// 		VersionState: to.Ptr(armhybridnetwork.VersionStateActive),
// 		NetworkFunctionTemplate: &armhybridnetwork.AzureArcKubernetesNetworkFunctionTemplate{
// 			NfviType: to.Ptr(armhybridnetwork.ContainerizedNetworkFunctionNFVITypeAzureArcKubernetes),
// 			NetworkFunctionApplications: []armhybridnetwork.AzureArcKubernetesNetworkFunctionApplicationClassification{
// 				&armhybridnetwork.AzureArcKubernetesHelmApplication{
// 					Name: to.Ptr("fedrbac"),
// 					DependsOnProfile: &armhybridnetwork.DependsOnProfile{
// 						InstallDependsOn: []*string{
// 						},
// 						UninstallDependsOn: []*string{
// 						},
// 						UpdateDependsOn: []*string{
// 						},
// 					},
// 					ArtifactType: to.Ptr(armhybridnetwork.AzureArcKubernetesArtifactTypeHelmPackage),
// 					ArtifactProfile: &armhybridnetwork.AzureArcKubernetesArtifactProfile{
// 						ArtifactStore: &armhybridnetwork.ReferencedResource{
// 							ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/testArtifactStore"),
// 						},
// 						HelmArtifactProfile: &armhybridnetwork.HelmArtifactProfile{
// 							HelmPackageName: to.Ptr("fed-rbac"),
// 							HelmPackageVersionRange: to.Ptr("~2.1.3"),
// 							ImagePullSecretsValuesPaths: []*string{
// 								to.Ptr("global.imagePullSecrets")},
// 								RegistryValuesPaths: []*string{
// 									to.Ptr("global.registry.docker.repoPath")},
// 								},
// 							},
// 							DeployParametersMappingRuleProfile: &armhybridnetwork.AzureArcKubernetesDeployMappingRuleProfile{
// 								ApplicationEnablement: to.Ptr(armhybridnetwork.ApplicationEnablementEnabled),
// 								HelmMappingRuleProfile: &armhybridnetwork.HelmMappingRuleProfile{
// 									HelmPackageVersion: to.Ptr("2.1.3"),
// 									ReleaseName: to.Ptr("{deployParameters.releaseName}"),
// 									ReleaseNamespace: to.Ptr("{deployParameters.namesapce}"),
// 									Values: to.Ptr(""),
// 								},
// 							},
// 					}},
// 				},
// 			},
// 		}
Output:

Example (GetNetworkFunctionDefinitionVersionResourceForAzureCoreVnf)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionDefinitionVersionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNetworkFunctionDefinitionVersionsClient().Get(ctx, "rg", "TestPublisher", "TestNetworkFunctionDefinitionGroupName", "1.0.0", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunctionDefinitionVersion = armhybridnetwork.NetworkFunctionDefinitionVersion{
// 	Name: to.Ptr("TestVersion"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.0"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.VirtualNetworkFunctionDefinitionVersion{
// 		Description: to.Ptr("test NFDV for AzureCore"),
// 		DeployParameters: to.Ptr("{\"virtualMachineName\":{\"type\":\"string\"},\"cpuCores\":{\"type\":\"int\"},\"memorySizeGB\":{\"type\":\"int\"},\"cloudServicesNetworkAttachment\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]},\"networkAttachments\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]}},\"storageProfile\":{\"type\":\"object\",\"properties\":{\"osDisk\":{\"type\":\"object\",\"properties\":{\"createOption\":{\"type\":\"string\"},\"deleteOption\":{\"type\":\"string\"},\"diskSizeGB\":{\"type\":\"integer\"}},\"required\":[\"diskSizeGB\"]}},\"required\":[\"osDisk\"]},\"sshPublicKeys\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"keyData\":{\"type\":\"string\"}},\"required\":[\"keyData\"]}},\"userData\":{\"type\":\"string\"},\"adminUsername\":{\"type\":\"string\"},\"bootMethod\":{\"type\":\"string\",\"default\":\"UEFI\",\"enum\":[\"UEFI\",\"BIOS\"]},\"isolateEmulatorThread\":{\"type\":\"string\"},\"virtioInterface\":{\"type\":\"string\"},\"placementHints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"hintType\":{\"type\":\"string\",\"enum\":[\"Affinity\",\"AntiAffinity\"]},\"resourceId\":{\"type\":\"string\"},\"schedulingExecution\":{\"type\":\"string\",\"enum\":[\"Soft\",\"Hard\"]},\"scope\":{\"type\":\"string\"}},\"required\":[\"hintType\",\"schedulingExecution\",\"resourceId\",\"scope\"]}}}"),
// 		NetworkFunctionType: to.Ptr(armhybridnetwork.NetworkFunctionTypeVirtualNetworkFunction),
// 		VersionState: to.Ptr(armhybridnetwork.VersionStatePreview),
// 		NetworkFunctionTemplate: &armhybridnetwork.AzureCoreNetworkFunctionTemplate{
// 			NfviType: to.Ptr(armhybridnetwork.VirtualNetworkFunctionNFVITypeAzureCore),
// 			NetworkFunctionApplications: []armhybridnetwork.AzureCoreNetworkFunctionApplicationClassification{
// 				&armhybridnetwork.AzureCoreNetworkFunctionVhdApplication{
// 					Name: to.Ptr("testImageRole"),
// 					DependsOnProfile: &armhybridnetwork.DependsOnProfile{
// 						InstallDependsOn: []*string{
// 						},
// 						UninstallDependsOn: []*string{
// 						},
// 						UpdateDependsOn: []*string{
// 						},
// 					},
// 					ArtifactType: to.Ptr(armhybridnetwork.AzureCoreArtifactTypeVhdImageFile),
// 					ArtifactProfile: &armhybridnetwork.AzureCoreVhdImageArtifactProfile{
// 						ArtifactStore: &armhybridnetwork.ReferencedResource{
// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore"),
// 						},
// 						VhdArtifactProfile: &armhybridnetwork.VhdImageArtifactProfile{
// 							VhdName: to.Ptr("test-image"),
// 							VhdVersion: to.Ptr("1-0-0"),
// 						},
// 					},
// 					DeployParametersMappingRuleProfile: &armhybridnetwork.AzureCoreVhdImageDeployMappingRuleProfile{
// 						ApplicationEnablement: to.Ptr(armhybridnetwork.ApplicationEnablementUnknown),
// 						VhdImageMappingRuleProfile: &armhybridnetwork.VhdImageMappingRuleProfile{
// 							UserConfiguration: to.Ptr(""),
// 						},
// 					},
// 				},
// 				&armhybridnetwork.AzureCoreNetworkFunctionArmTemplateApplication{
// 					Name: to.Ptr("testTemplateRole"),
// 					DependsOnProfile: &armhybridnetwork.DependsOnProfile{
// 						InstallDependsOn: []*string{
// 							to.Ptr("testImageRole")},
// 							UninstallDependsOn: []*string{
// 								to.Ptr("testImageRole")},
// 								UpdateDependsOn: []*string{
// 									to.Ptr("testImageRole")},
// 								},
// 								ArtifactType: to.Ptr(armhybridnetwork.AzureCoreArtifactTypeArmTemplate),
// 								ArtifactProfile: &armhybridnetwork.AzureCoreArmTemplateArtifactProfile{
// 									ArtifactStore: &armhybridnetwork.ReferencedResource{
// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore"),
// 									},
// 									TemplateArtifactProfile: &armhybridnetwork.ArmTemplateArtifactProfile{
// 										TemplateName: to.Ptr("test-template"),
// 										TemplateVersion: to.Ptr("1.0.0"),
// 									},
// 								},
// 								DeployParametersMappingRuleProfile: &armhybridnetwork.AzureCoreArmTemplateDeployMappingRuleProfile{
// 									ApplicationEnablement: to.Ptr(armhybridnetwork.ApplicationEnablementUnknown),
// 									TemplateMappingRuleProfile: &armhybridnetwork.ArmTemplateMappingRuleProfile{
// 										TemplateParameters: to.Ptr("{\"virtualMachineName\":\"{deployParameters.virtualMachineName}\",\"cpuCores\":\"{deployParameters.cpuCores}\",\"memorySizeGB\":\"{deployParameters.memorySizeGB}\",\"cloudServicesNetworkAttachment\":\"{deployParameters.cloudServicesNetworkAttachment}\",\"networkAttachments\":\"{deployParameters.networkAttachments}\",\"sshPublicKeys\":\"{deployParameters.sshPublicKeys}\",\"storageProfile\":\"{deployParameters.storageProfile}\",\"isolateEmulatorThread\":\"{deployParameters.isolateEmulatorThread}\",\"virtioInterface\":\"{deployParameters.virtioInterface}\",\"userData\":\"{deployParameters.userData}\",\"adminUsername\":\"{deployParameters.adminUsername}\",\"bootMethod\":\"{deployParameters.bootMethod}\",\"placementHints\":\"{deployParameters.placementHints}\"}"),
// 									},
// 								},
// 						}},
// 					},
// 				},
// 			}
Output:

Example (GetNetworkFunctionDefinitionVersionResourceForAzureOperatorNexusVnf)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionDefinitionVersionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNetworkFunctionDefinitionVersionsClient().Get(ctx, "rg", "TestPublisher", "TestNetworkFunctionDefinitionGroupName", "1.0.0", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunctionDefinitionVersion = armhybridnetwork.NetworkFunctionDefinitionVersion{
// 	Name: to.Ptr("TestVersion"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.0"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.VirtualNetworkFunctionDefinitionVersion{
// 		Description: to.Ptr("test NFDV for AzureOperatorNexus"),
// 		DeployParameters: to.Ptr("{\"virtualMachineName\":{\"type\":\"string\"},\"extendedLocationName\":{\"type\":\"string\"},\"cpuCores\":{\"type\":\"int\"},\"memorySizeGB\":{\"type\":\"int\"},\"cloudServicesNetworkAttachment\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]},\"networkAttachments\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"networkAttachmentName\":{\"type\":\"string\"},\"attachedNetworkId\":{\"type\":\"string\"},\"ipAllocationMethod\":{\"type\":\"string\"},\"ipv4Address\":{\"type\":\"string\"},\"ipv6Address\":{\"type\":\"string\"},\"defaultGateway\":{\"type\":\"string\"}},\"required\":[\"attachedNetworkId\",\"ipAllocationMethod\"]}},\"storageProfile\":{\"type\":\"object\",\"properties\":{\"osDisk\":{\"type\":\"object\",\"properties\":{\"createOption\":{\"type\":\"string\"},\"deleteOption\":{\"type\":\"string\"},\"diskSizeGB\":{\"type\":\"integer\"}},\"required\":[\"diskSizeGB\"]}},\"required\":[\"osDisk\"]},\"sshPublicKeys\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"keyData\":{\"type\":\"string\"}},\"required\":[\"keyData\"]}},\"userData\":{\"type\":\"string\"},\"adminUsername\":{\"type\":\"string\"},\"bootMethod\":{\"type\":\"string\",\"default\":\"UEFI\",\"enum\":[\"UEFI\",\"BIOS\"]},\"isolateEmulatorThread\":{\"type\":\"string\"},\"virtioInterface\":{\"type\":\"string\"},\"placementHints\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"hintType\":{\"type\":\"string\",\"enum\":[\"Affinity\",\"AntiAffinity\"]},\"resourceId\":{\"type\":\"string\"},\"schedulingExecution\":{\"type\":\"string\",\"enum\":[\"Soft\",\"Hard\"]},\"scope\":{\"type\":\"string\"}},\"required\":[\"hintType\",\"schedulingExecution\",\"resourceId\",\"scope\"]}}}"),
// 		NetworkFunctionType: to.Ptr(armhybridnetwork.NetworkFunctionTypeVirtualNetworkFunction),
// 		VersionState: to.Ptr(armhybridnetwork.VersionStatePreview),
// 		NetworkFunctionTemplate: &armhybridnetwork.AzureOperatorNexusNetworkFunctionTemplate{
// 			NfviType: to.Ptr(armhybridnetwork.VirtualNetworkFunctionNFVITypeAzureOperatorNexus),
// 			NetworkFunctionApplications: []armhybridnetwork.AzureOperatorNexusNetworkFunctionApplicationClassification{
// 				&armhybridnetwork.AzureOperatorNexusNetworkFunctionImageApplication{
// 					Name: to.Ptr("testImageRole"),
// 					DependsOnProfile: &armhybridnetwork.DependsOnProfile{
// 						InstallDependsOn: []*string{
// 						},
// 						UninstallDependsOn: []*string{
// 						},
// 						UpdateDependsOn: []*string{
// 						},
// 					},
// 					ArtifactType: to.Ptr(armhybridnetwork.AzureOperatorNexusArtifactTypeImageFile),
// 					ArtifactProfile: &armhybridnetwork.AzureOperatorNexusImageArtifactProfile{
// 						ArtifactStore: &armhybridnetwork.ReferencedResource{
// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore"),
// 						},
// 						ImageArtifactProfile: &armhybridnetwork.ImageArtifactProfile{
// 							ImageName: to.Ptr("test-image"),
// 							ImageVersion: to.Ptr("1.0.0"),
// 						},
// 					},
// 					DeployParametersMappingRuleProfile: &armhybridnetwork.AzureOperatorNexusImageDeployMappingRuleProfile{
// 						ApplicationEnablement: to.Ptr(armhybridnetwork.ApplicationEnablementUnknown),
// 						ImageMappingRuleProfile: &armhybridnetwork.ImageMappingRuleProfile{
// 							UserConfiguration: to.Ptr(""),
// 						},
// 					},
// 				},
// 				&armhybridnetwork.AzureOperatorNexusNetworkFunctionArmTemplateApplication{
// 					Name: to.Ptr("testTemplateRole"),
// 					DependsOnProfile: &armhybridnetwork.DependsOnProfile{
// 						InstallDependsOn: []*string{
// 							to.Ptr("testImageRole")},
// 							UninstallDependsOn: []*string{
// 								to.Ptr("testImageRole")},
// 								UpdateDependsOn: []*string{
// 									to.Ptr("testImageRole")},
// 								},
// 								ArtifactType: to.Ptr(armhybridnetwork.AzureOperatorNexusArtifactTypeArmTemplate),
// 								ArtifactProfile: &armhybridnetwork.AzureOperatorNexusArmTemplateArtifactProfile{
// 									ArtifactStore: &armhybridnetwork.ReferencedResource{
// 										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/TestArtifactStore"),
// 									},
// 									TemplateArtifactProfile: &armhybridnetwork.ArmTemplateArtifactProfile{
// 										TemplateName: to.Ptr("test-template"),
// 										TemplateVersion: to.Ptr("1.0.0"),
// 									},
// 								},
// 								DeployParametersMappingRuleProfile: &armhybridnetwork.AzureOperatorNexusArmTemplateDeployMappingRuleProfile{
// 									ApplicationEnablement: to.Ptr(armhybridnetwork.ApplicationEnablementUnknown),
// 									TemplateMappingRuleProfile: &armhybridnetwork.ArmTemplateMappingRuleProfile{
// 										TemplateParameters: to.Ptr("{\"virtualMachineName\":\"{deployParameters.virtualMachineName}\",\"extendedLocationName\":\"{deployParameters.extendedLocationName}\",\"cpuCores\":\"{deployParameters.cpuCores}\",\"memorySizeGB\":\"{deployParameters.memorySizeGB}\",\"cloudServicesNetworkAttachment\":\"{deployParameters.cloudServicesNetworkAttachment}\",\"networkAttachments\":\"{deployParameters.networkAttachments}\",\"sshPublicKeys\":\"{deployParameters.sshPublicKeys}\",\"storageProfile\":\"{deployParameters.storageProfile}\",\"isolateEmulatorThread\":\"{deployParameters.isolateEmulatorThread}\",\"virtioInterface\":\"{deployParameters.virtioInterface}\",\"userData\":\"{deployParameters.userData}\",\"adminUsername\":\"{deployParameters.adminUsername}\",\"bootMethod\":\"{deployParameters.bootMethod}\",\"placementHints\":\"{deployParameters.placementHints}\"}"),
// 									},
// 								},
// 						}},
// 					},
// 				},
// 			}
Output:

func (*NetworkFunctionDefinitionVersionsClient) NewListByNetworkFunctionDefinitionGroupPager

NewListByNetworkFunctionDefinitionGroupPager - Gets information about a list of network function definition versions under a network function definition group.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkFunctionDefinitionGroupName - The name of the network function definition group.
  • options - NetworkFunctionDefinitionVersionsClientListByNetworkFunctionDefinitionGroupOptions contains the optional parameters for the NetworkFunctionDefinitionVersionsClient.NewListByNetworkFunctionDefinitionGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionListByNetworkFunctionDefinitionGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewNetworkFunctionDefinitionVersionsClient().NewListByNetworkFunctionDefinitionGroupPager("rg", "TestPublisher", "TestNetworkFunctionDefinitionGroupNameName", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.NetworkFunctionDefinitionVersionListResult = armhybridnetwork.NetworkFunctionDefinitionVersionListResult{
	// 	Value: []*armhybridnetwork.NetworkFunctionDefinitionVersion{
	// 		{
	// 			Name: to.Ptr("networkFunctionDefinitionVersionName"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/publishers/publisherskugroups/publisherskuversions"),
	// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/publisherskuGroups/networkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/TestVersion"),
	// 			Location: to.Ptr("eastus"),
	// 			Properties: &armhybridnetwork.ContainerizedNetworkFunctionDefinitionVersion{
	// 				DeployParameters: to.Ptr("{\"releaseName\":{\"type\":\"string\"},\"namespace\":{\"type\":\"string\"}}"),
	// 				NetworkFunctionType: to.Ptr(armhybridnetwork.NetworkFunctionTypeContainerizedNetworkFunction),
	// 				VersionState: to.Ptr(armhybridnetwork.VersionStateActive),
	// 				NetworkFunctionTemplate: &armhybridnetwork.AzureArcKubernetesNetworkFunctionTemplate{
	// 					NfviType: to.Ptr(armhybridnetwork.ContainerizedNetworkFunctionNFVITypeAzureArcKubernetes),
	// 					NetworkFunctionApplications: []armhybridnetwork.AzureArcKubernetesNetworkFunctionApplicationClassification{
	// 						&armhybridnetwork.AzureArcKubernetesHelmApplication{
	// 							Name: to.Ptr("fedrbac"),
	// 							DependsOnProfile: &armhybridnetwork.DependsOnProfile{
	// 								InstallDependsOn: []*string{
	// 								},
	// 								UninstallDependsOn: []*string{
	// 								},
	// 								UpdateDependsOn: []*string{
	// 								},
	// 							},
	// 							ArtifactType: to.Ptr(armhybridnetwork.AzureArcKubernetesArtifactTypeHelmPackage),
	// 							ArtifactProfile: &armhybridnetwork.AzureArcKubernetesArtifactProfile{
	// 								ArtifactStore: &armhybridnetwork.ReferencedResource{
	// 									ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/testArtifactStore"),
	// 								},
	// 								HelmArtifactProfile: &armhybridnetwork.HelmArtifactProfile{
	// 									HelmPackageName: to.Ptr("fed-rbac"),
	// 									HelmPackageVersionRange: to.Ptr("~2.1.3"),
	// 									ImagePullSecretsValuesPaths: []*string{
	// 										to.Ptr("global.imagePullSecrets")},
	// 										RegistryValuesPaths: []*string{
	// 											to.Ptr("global.registry.docker.repoPath")},
	// 										},
	// 									},
	// 									DeployParametersMappingRuleProfile: &armhybridnetwork.AzureArcKubernetesDeployMappingRuleProfile{
	// 										ApplicationEnablement: to.Ptr(armhybridnetwork.ApplicationEnablementEnabled),
	// 										HelmMappingRuleProfile: &armhybridnetwork.HelmMappingRuleProfile{
	// 											HelmPackageVersion: to.Ptr("2.1.3"),
	// 											Options: &armhybridnetwork.HelmMappingRuleProfileOptions{
	// 												InstallOptions: &armhybridnetwork.HelmInstallOptions{
	// 													Atomic: to.Ptr("true"),
	// 													Timeout: to.Ptr("30"),
	// 													Wait: to.Ptr("waitValue"),
	// 												},
	// 												UpgradeOptions: &armhybridnetwork.HelmUpgradeOptions{
	// 													Atomic: to.Ptr("true"),
	// 													Timeout: to.Ptr("30"),
	// 													Wait: to.Ptr("waitValue"),
	// 												},
	// 											},
	// 											ReleaseName: to.Ptr("{deployParameters.releaseName}"),
	// 											ReleaseNamespace: to.Ptr("{deployParameters.namesapce}"),
	// 											Values: to.Ptr(""),
	// 										},
	// 									},
	// 							}},
	// 						},
	// 					},
	// 			}},
	// 		}
}
Output:

func (*NetworkFunctionDefinitionVersionsClient) Update

func (client *NetworkFunctionDefinitionVersionsClient) Update(ctx context.Context, resourceGroupName string, publisherName string, networkFunctionDefinitionGroupName string, networkFunctionDefinitionVersionName string, parameters TagsObject, options *NetworkFunctionDefinitionVersionsClientUpdateOptions) (NetworkFunctionDefinitionVersionsClientUpdateResponse, error)

Update - Updates a network function definition version resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkFunctionDefinitionGroupName - The name of the network function definition group.
  • networkFunctionDefinitionVersionName - The name of the network function definition version. The name should conform to the SemVer 2.0.0 specification: https://semver.org/spec/v2.0.0.html.
  • parameters - Parameters supplied to the create or update network function definition version operation.
  • options - NetworkFunctionDefinitionVersionsClientUpdateOptions contains the optional parameters for the NetworkFunctionDefinitionVersionsClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDefinitionVersionUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNetworkFunctionDefinitionVersionsClient().Update(ctx, "rg", "TestPublisher", "TestNetworkFunctionDefinitionGroupName", "1.0.0", armhybridnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunctionDefinitionVersion = armhybridnetwork.NetworkFunctionDefinitionVersion{
// 	Name: to.Ptr("TestVersion"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/networkFunctionDefinitionGroups/networkFunctionDefinitionVersions"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkFunctionDefinitionGroups/TestNetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.0"),
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Properties: &armhybridnetwork.ContainerizedNetworkFunctionDefinitionVersion{
// 		DeployParameters: to.Ptr("{\"releaseName\":{\"type\":\"string\"},\"namespace\":{\"type\":\"string\"}}"),
// 		NetworkFunctionType: to.Ptr(armhybridnetwork.NetworkFunctionTypeContainerizedNetworkFunction),
// 		VersionState: to.Ptr(armhybridnetwork.VersionStateActive),
// 		NetworkFunctionTemplate: &armhybridnetwork.AzureArcKubernetesNetworkFunctionTemplate{
// 			NfviType: to.Ptr(armhybridnetwork.ContainerizedNetworkFunctionNFVITypeAzureArcKubernetes),
// 			NetworkFunctionApplications: []armhybridnetwork.AzureArcKubernetesNetworkFunctionApplicationClassification{
// 				&armhybridnetwork.AzureArcKubernetesHelmApplication{
// 					Name: to.Ptr("fedrbac"),
// 					DependsOnProfile: &armhybridnetwork.DependsOnProfile{
// 						InstallDependsOn: []*string{
// 						},
// 						UninstallDependsOn: []*string{
// 						},
// 						UpdateDependsOn: []*string{
// 						},
// 					},
// 					ArtifactType: to.Ptr(armhybridnetwork.AzureArcKubernetesArtifactTypeHelmPackage),
// 					ArtifactProfile: &armhybridnetwork.AzureArcKubernetesArtifactProfile{
// 						ArtifactStore: &armhybridnetwork.ReferencedResource{
// 							ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/microsoft.hybridnetwork/publishers/TestPublisher/artifactStores/testArtifactStore"),
// 						},
// 						HelmArtifactProfile: &armhybridnetwork.HelmArtifactProfile{
// 							HelmPackageName: to.Ptr("fed-rbac"),
// 							HelmPackageVersionRange: to.Ptr("~2.1.3"),
// 							ImagePullSecretsValuesPaths: []*string{
// 								to.Ptr("global.imagePullSecrets")},
// 								RegistryValuesPaths: []*string{
// 									to.Ptr("global.registry.docker.repoPath")},
// 								},
// 							},
// 							DeployParametersMappingRuleProfile: &armhybridnetwork.AzureArcKubernetesDeployMappingRuleProfile{
// 								ApplicationEnablement: to.Ptr(armhybridnetwork.ApplicationEnablementEnabled),
// 								HelmMappingRuleProfile: &armhybridnetwork.HelmMappingRuleProfile{
// 									HelmPackageVersion: to.Ptr("2.1.3"),
// 									ReleaseName: to.Ptr("{deployParameters.releaseName}"),
// 									ReleaseNamespace: to.Ptr("{deployParameters.namesapce}"),
// 									Values: to.Ptr(""),
// 								},
// 							},
// 					}},
// 				},
// 			},
// 		}
Output:

type NetworkFunctionDefinitionVersionsClientBeginCreateOrUpdateOptions

type NetworkFunctionDefinitionVersionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

NetworkFunctionDefinitionVersionsClientBeginCreateOrUpdateOptions contains the optional parameters for the NetworkFunctionDefinitionVersionsClient.BeginCreateOrUpdate method.

type NetworkFunctionDefinitionVersionsClientBeginDeleteOptions

type NetworkFunctionDefinitionVersionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

NetworkFunctionDefinitionVersionsClientBeginDeleteOptions contains the optional parameters for the NetworkFunctionDefinitionVersionsClient.BeginDelete method.

type NetworkFunctionDefinitionVersionsClientBeginUpdateStateOptions

type NetworkFunctionDefinitionVersionsClientBeginUpdateStateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

NetworkFunctionDefinitionVersionsClientBeginUpdateStateOptions contains the optional parameters for the NetworkFunctionDefinitionVersionsClient.BeginUpdateState method.

type NetworkFunctionDefinitionVersionsClientCreateOrUpdateResponse

type NetworkFunctionDefinitionVersionsClientCreateOrUpdateResponse struct {
	// Network function definition version.
	NetworkFunctionDefinitionVersion
}

NetworkFunctionDefinitionVersionsClientCreateOrUpdateResponse contains the response from method NetworkFunctionDefinitionVersionsClient.BeginCreateOrUpdate.

type NetworkFunctionDefinitionVersionsClientDeleteResponse

type NetworkFunctionDefinitionVersionsClientDeleteResponse struct {
}

NetworkFunctionDefinitionVersionsClientDeleteResponse contains the response from method NetworkFunctionDefinitionVersionsClient.BeginDelete.

type NetworkFunctionDefinitionVersionsClientGetOptions

type NetworkFunctionDefinitionVersionsClientGetOptions struct {
}

NetworkFunctionDefinitionVersionsClientGetOptions contains the optional parameters for the NetworkFunctionDefinitionVersionsClient.Get method.

type NetworkFunctionDefinitionVersionsClientGetResponse

type NetworkFunctionDefinitionVersionsClientGetResponse struct {
	// Network function definition version.
	NetworkFunctionDefinitionVersion
}

NetworkFunctionDefinitionVersionsClientGetResponse contains the response from method NetworkFunctionDefinitionVersionsClient.Get.

type NetworkFunctionDefinitionVersionsClientListByNetworkFunctionDefinitionGroupOptions

type NetworkFunctionDefinitionVersionsClientListByNetworkFunctionDefinitionGroupOptions struct {
}

NetworkFunctionDefinitionVersionsClientListByNetworkFunctionDefinitionGroupOptions contains the optional parameters for the NetworkFunctionDefinitionVersionsClient.NewListByNetworkFunctionDefinitionGroupPager method.

type NetworkFunctionDefinitionVersionsClientListByNetworkFunctionDefinitionGroupResponse

type NetworkFunctionDefinitionVersionsClientListByNetworkFunctionDefinitionGroupResponse struct {
	// A list of network function definition versions.
	NetworkFunctionDefinitionVersionListResult
}

NetworkFunctionDefinitionVersionsClientListByNetworkFunctionDefinitionGroupResponse contains the response from method NetworkFunctionDefinitionVersionsClient.NewListByNetworkFunctionDefinitionGroupPager.

type NetworkFunctionDefinitionVersionsClientUpdateOptions

type NetworkFunctionDefinitionVersionsClientUpdateOptions struct {
}

NetworkFunctionDefinitionVersionsClientUpdateOptions contains the optional parameters for the NetworkFunctionDefinitionVersionsClient.Update method.

type NetworkFunctionDefinitionVersionsClientUpdateResponse

type NetworkFunctionDefinitionVersionsClientUpdateResponse struct {
	// Network function definition version.
	NetworkFunctionDefinitionVersion
}

NetworkFunctionDefinitionVersionsClientUpdateResponse contains the response from method NetworkFunctionDefinitionVersionsClient.Update.

type NetworkFunctionDefinitionVersionsClientUpdateStateResponse

type NetworkFunctionDefinitionVersionsClientUpdateStateResponse struct {
	// Publisher network function definition version update request definition.
	NetworkFunctionDefinitionVersionUpdateState
}

NetworkFunctionDefinitionVersionsClientUpdateStateResponse contains the response from method NetworkFunctionDefinitionVersionsClient.BeginUpdateState.

type NetworkFunctionListResult

type NetworkFunctionListResult struct {
	// A list of network function resources in a subscription or resource group.
	Value []*NetworkFunction

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string
}

NetworkFunctionListResult - Response for network function API service call.

func (NetworkFunctionListResult) MarshalJSON

func (n NetworkFunctionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkFunctionListResult.

func (*NetworkFunctionListResult) UnmarshalJSON

func (n *NetworkFunctionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkFunctionListResult.

type NetworkFunctionPropertiesFormat

type NetworkFunctionPropertiesFormat struct {
	// REQUIRED; The value which indicates if NF values are secrets
	ConfigurationType *NetworkFunctionConfigurationType

	// Indicates if software updates are allowed during deployment.
	AllowSoftwareUpdate *bool

	// The network function definition version resource reference.
	NetworkFunctionDefinitionVersionResourceReference DeploymentResourceIDReferenceClassification

	// The nfviId for the network function.
	NfviID *string

	// The nfvi type for the network function.
	NfviType *NFVIType

	// The role configuration override values from the user.
	RoleOverrideValues []*string

	// READ-ONLY; The network function definition group name for the network function.
	NetworkFunctionDefinitionGroupName *string

	// READ-ONLY; The location of the network function definition offering.
	NetworkFunctionDefinitionOfferingLocation *string

	// READ-ONLY; The network function definition version for the network function.
	NetworkFunctionDefinitionVersion *string

	// READ-ONLY; The provisioning state of the network function resource.
	ProvisioningState *ProvisioningState

	// READ-ONLY; The publisher name for the network function.
	PublisherName *string

	// READ-ONLY; The scope of the publisher.
	PublisherScope *PublisherScope
}

NetworkFunctionPropertiesFormat - Network function properties.

func (*NetworkFunctionPropertiesFormat) GetNetworkFunctionPropertiesFormat

func (n *NetworkFunctionPropertiesFormat) GetNetworkFunctionPropertiesFormat() *NetworkFunctionPropertiesFormat

GetNetworkFunctionPropertiesFormat implements the NetworkFunctionPropertiesFormatClassification interface for type NetworkFunctionPropertiesFormat.

func (NetworkFunctionPropertiesFormat) MarshalJSON

func (n NetworkFunctionPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkFunctionPropertiesFormat.

func (*NetworkFunctionPropertiesFormat) UnmarshalJSON

func (n *NetworkFunctionPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkFunctionPropertiesFormat.

type NetworkFunctionPropertiesFormatClassification

type NetworkFunctionPropertiesFormatClassification interface {
	// GetNetworkFunctionPropertiesFormat returns the NetworkFunctionPropertiesFormat content of the underlying type.
	GetNetworkFunctionPropertiesFormat() *NetworkFunctionPropertiesFormat
}

NetworkFunctionPropertiesFormatClassification provides polymorphic access to related types. Call the interface's GetNetworkFunctionPropertiesFormat() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *NetworkFunctionPropertiesFormat, *NetworkFunctionValueWithSecrets, *NetworkFunctionValueWithoutSecrets

type NetworkFunctionType

type NetworkFunctionType string

NetworkFunctionType - The network function type.

const (
	NetworkFunctionTypeContainerizedNetworkFunction NetworkFunctionType = "ContainerizedNetworkFunction"
	NetworkFunctionTypeUnknown                      NetworkFunctionType = "Unknown"
	NetworkFunctionTypeVirtualNetworkFunction       NetworkFunctionType = "VirtualNetworkFunction"
)

func PossibleNetworkFunctionTypeValues

func PossibleNetworkFunctionTypeValues() []NetworkFunctionType

PossibleNetworkFunctionTypeValues returns the possible values for the NetworkFunctionType const type.

type NetworkFunctionValueWithSecrets

type NetworkFunctionValueWithSecrets struct {
	// REQUIRED; The value which indicates if NF values are secrets
	ConfigurationType *NetworkFunctionConfigurationType

	// Indicates if software updates are allowed during deployment.
	AllowSoftwareUpdate *bool

	// The network function definition version resource reference.
	NetworkFunctionDefinitionVersionResourceReference DeploymentResourceIDReferenceClassification

	// The nfviId for the network function.
	NfviID *string

	// The nfvi type for the network function.
	NfviType *NFVIType

	// The role configuration override values from the user.
	RoleOverrideValues []*string

	// The JSON-serialized secret deployment values from the user. This contains secrets like passwords,keys etc
	SecretDeploymentValues *string

	// READ-ONLY; The network function definition group name for the network function.
	NetworkFunctionDefinitionGroupName *string

	// READ-ONLY; The location of the network function definition offering.
	NetworkFunctionDefinitionOfferingLocation *string

	// READ-ONLY; The network function definition version for the network function.
	NetworkFunctionDefinitionVersion *string

	// READ-ONLY; The provisioning state of the network function resource.
	ProvisioningState *ProvisioningState

	// READ-ONLY; The publisher name for the network function.
	PublisherName *string

	// READ-ONLY; The scope of the publisher.
	PublisherScope *PublisherScope
}

NetworkFunctionValueWithSecrets - NetworkFunction with secrets.

func (*NetworkFunctionValueWithSecrets) GetNetworkFunctionPropertiesFormat

func (n *NetworkFunctionValueWithSecrets) GetNetworkFunctionPropertiesFormat() *NetworkFunctionPropertiesFormat

GetNetworkFunctionPropertiesFormat implements the NetworkFunctionPropertiesFormatClassification interface for type NetworkFunctionValueWithSecrets.

func (NetworkFunctionValueWithSecrets) MarshalJSON

func (n NetworkFunctionValueWithSecrets) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkFunctionValueWithSecrets.

func (*NetworkFunctionValueWithSecrets) UnmarshalJSON

func (n *NetworkFunctionValueWithSecrets) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkFunctionValueWithSecrets.

type NetworkFunctionValueWithoutSecrets

type NetworkFunctionValueWithoutSecrets struct {
	// REQUIRED; The value which indicates if NF values are secrets
	ConfigurationType *NetworkFunctionConfigurationType

	// Indicates if software updates are allowed during deployment.
	AllowSoftwareUpdate *bool

	// The JSON-serialized deployment values from the user.
	DeploymentValues *string

	// The network function definition version resource reference.
	NetworkFunctionDefinitionVersionResourceReference DeploymentResourceIDReferenceClassification

	// The nfviId for the network function.
	NfviID *string

	// The nfvi type for the network function.
	NfviType *NFVIType

	// The role configuration override values from the user.
	RoleOverrideValues []*string

	// READ-ONLY; The network function definition group name for the network function.
	NetworkFunctionDefinitionGroupName *string

	// READ-ONLY; The location of the network function definition offering.
	NetworkFunctionDefinitionOfferingLocation *string

	// READ-ONLY; The network function definition version for the network function.
	NetworkFunctionDefinitionVersion *string

	// READ-ONLY; The provisioning state of the network function resource.
	ProvisioningState *ProvisioningState

	// READ-ONLY; The publisher name for the network function.
	PublisherName *string

	// READ-ONLY; The scope of the publisher.
	PublisherScope *PublisherScope
}

NetworkFunctionValueWithoutSecrets - NetworkFunction with no secrets.

func (*NetworkFunctionValueWithoutSecrets) GetNetworkFunctionPropertiesFormat

func (n *NetworkFunctionValueWithoutSecrets) GetNetworkFunctionPropertiesFormat() *NetworkFunctionPropertiesFormat

GetNetworkFunctionPropertiesFormat implements the NetworkFunctionPropertiesFormatClassification interface for type NetworkFunctionValueWithoutSecrets.

func (NetworkFunctionValueWithoutSecrets) MarshalJSON

func (n NetworkFunctionValueWithoutSecrets) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkFunctionValueWithoutSecrets.

func (*NetworkFunctionValueWithoutSecrets) UnmarshalJSON

func (n *NetworkFunctionValueWithoutSecrets) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkFunctionValueWithoutSecrets.

type NetworkFunctionsClient

type NetworkFunctionsClient struct {
	// contains filtered or unexported fields
}

NetworkFunctionsClient contains the methods for the NetworkFunctions group. Don't use this type directly, use NewNetworkFunctionsClient() instead.

func NewNetworkFunctionsClient

func NewNetworkFunctionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*NetworkFunctionsClient, error)

NewNetworkFunctionsClient creates a new instance of NetworkFunctionsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*NetworkFunctionsClient) BeginCreateOrUpdate

func (client *NetworkFunctionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, networkFunctionName string, parameters NetworkFunction, options *NetworkFunctionsClientBeginCreateOrUpdateOptions) (*runtime.Poller[NetworkFunctionsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a network function resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • networkFunctionName - Resource name for the network function resource.
  • parameters - Parameters supplied in the body to the create or update network function operation.
  • options - NetworkFunctionsClientBeginCreateOrUpdateOptions contains the optional parameters for the NetworkFunctionsClient.BeginCreateOrUpdate method.
Example (CreateFirstPartyNetworkFunctionResource)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionFirstPartyCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkFunctionsClient().BeginCreateOrUpdate(ctx, "rg", "testNf", armhybridnetwork.NetworkFunction{
	Location: to.Ptr("eastus"),
	Properties: &armhybridnetwork.NetworkFunctionValueWithoutSecrets{
		AllowSoftwareUpdate: to.Ptr(false),
		ConfigurationType:   to.Ptr(armhybridnetwork.NetworkFunctionConfigurationTypeOpen),
		NetworkFunctionDefinitionVersionResourceReference: &armhybridnetwork.SecretDeploymentResourceReference{
			IDType: to.Ptr(armhybridnetwork.IDTypeSecret),
			ID:     to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1"),
		},
		NfviID:   to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation"),
		NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureArcKubernetes),
		RoleOverrideValues: []*string{
			to.Ptr("{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}"),
			to.Ptr("{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}")},
		DeploymentValues: to.Ptr("{\"releaseName\":\"testReleaseName\",\"namespace\":\"testNamespace\"}"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunction = armhybridnetwork.NetworkFunction{
// 	Name: to.Ptr("testNf"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/networkFunctions"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.NetworkFunctionValueWithoutSecrets{
// 		AllowSoftwareUpdate: to.Ptr(false),
// 		ConfigurationType: to.Ptr(armhybridnetwork.NetworkFunctionConfigurationTypeOpen),
// 		NetworkFunctionDefinitionGroupName: to.Ptr("testnetworkFunctionDefinitionGroupName"),
// 		NetworkFunctionDefinitionOfferingLocation: to.Ptr("eastus"),
// 		NetworkFunctionDefinitionVersion: to.Ptr("1.0.1"),
// 		NetworkFunctionDefinitionVersionResourceReference: &armhybridnetwork.SecretDeploymentResourceReference{
// 			IDType: to.Ptr(armhybridnetwork.IDTypeSecret),
// 		},
// 		NfviID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation"),
// 		NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureArcKubernetes),
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		PublisherName: to.Ptr("testVendor"),
// 		PublisherScope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
// 		RoleOverrideValues: []*string{
// 			to.Ptr("{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}"),
// 			to.Ptr("{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}")},
// 			DeploymentValues: to.Ptr("{\"releaseName\":\"testReleaseName\",\"namespace\":\"testNamespace\"}"),
// 		},
// 	}
Output:

Example (CreateNetworkFunctionResource)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkFunctionsClient().BeginCreateOrUpdate(ctx, "rg", "testNf", armhybridnetwork.NetworkFunction{
	Location: to.Ptr("eastus"),
	Properties: &armhybridnetwork.NetworkFunctionValueWithoutSecrets{
		AllowSoftwareUpdate: to.Ptr(false),
		ConfigurationType:   to.Ptr(armhybridnetwork.NetworkFunctionConfigurationTypeOpen),
		NetworkFunctionDefinitionVersionResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
			ID:     to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1"),
		},
		NfviID:   to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation"),
		NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureArcKubernetes),
		RoleOverrideValues: []*string{
			to.Ptr("{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}"),
			to.Ptr("{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}")},
		DeploymentValues: to.Ptr("{\"releaseName\":\"testReleaseName\",\"namespace\":\"testNamespace\"}"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunction = armhybridnetwork.NetworkFunction{
// 	Name: to.Ptr("testNf"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/networkFunctions"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.NetworkFunctionValueWithoutSecrets{
// 		AllowSoftwareUpdate: to.Ptr(false),
// 		ConfigurationType: to.Ptr(armhybridnetwork.NetworkFunctionConfigurationTypeOpen),
// 		NetworkFunctionDefinitionGroupName: to.Ptr("testnetworkFunctionDefinitionGroupName"),
// 		NetworkFunctionDefinitionOfferingLocation: to.Ptr("eastus"),
// 		NetworkFunctionDefinitionVersion: to.Ptr("1.0.1"),
// 		NetworkFunctionDefinitionVersionResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
// 			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1"),
// 		},
// 		NfviID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation"),
// 		NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureArcKubernetes),
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		PublisherName: to.Ptr("testVendor"),
// 		PublisherScope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
// 		RoleOverrideValues: []*string{
// 			to.Ptr("{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}"),
// 			to.Ptr("{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}")},
// 			DeploymentValues: to.Ptr("{\"releaseName\":\"testReleaseName\",\"namespace\":\"testNamespace\"}"),
// 		},
// 	}
Output:

Example (CreateNetworkFunctionResourceWithSecrets)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionCreateSecret.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkFunctionsClient().BeginCreateOrUpdate(ctx, "rg", "testNf", armhybridnetwork.NetworkFunction{
	Location: to.Ptr("eastus"),
	Properties: &armhybridnetwork.NetworkFunctionValueWithSecrets{
		AllowSoftwareUpdate: to.Ptr(false),
		ConfigurationType:   to.Ptr(armhybridnetwork.NetworkFunctionConfigurationTypeSecret),
		NetworkFunctionDefinitionVersionResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
			ID:     to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1"),
		},
		NfviID:   to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation"),
		NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureArcKubernetes),
		RoleOverrideValues: []*string{
			to.Ptr("{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}"),
			to.Ptr("{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}")},
		SecretDeploymentValues: to.Ptr("{\"adminPassword\":\"password1\",\"userPassword\":\"password2\"}"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunction = armhybridnetwork.NetworkFunction{
// 	Name: to.Ptr("testNf"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/networkFunctions"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.NetworkFunctionValueWithSecrets{
// 		AllowSoftwareUpdate: to.Ptr(false),
// 		ConfigurationType: to.Ptr(armhybridnetwork.NetworkFunctionConfigurationTypeSecret),
// 		NetworkFunctionDefinitionGroupName: to.Ptr("testnetworkFunctionDefinitionGroupName"),
// 		NetworkFunctionDefinitionOfferingLocation: to.Ptr("eastus"),
// 		NetworkFunctionDefinitionVersion: to.Ptr("1.0.1"),
// 		NetworkFunctionDefinitionVersionResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
// 			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1"),
// 		},
// 		NfviID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation"),
// 		NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureArcKubernetes),
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		PublisherName: to.Ptr("testVendor"),
// 		PublisherScope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
// 		RoleOverrideValues: []*string{
// 			to.Ptr("{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}"),
// 			to.Ptr("{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}")},
// 		},
// 	}
Output:

Example (CreateVirtualNetworkFunctionResourceOnAzureCore)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkFunctionsClient().BeginCreateOrUpdate(ctx, "rg", "testNf", armhybridnetwork.NetworkFunction{
	Location: to.Ptr("eastus"),
	Properties: &armhybridnetwork.NetworkFunctionValueWithoutSecrets{
		AllowSoftwareUpdate: to.Ptr(false),
		ConfigurationType:   to.Ptr(armhybridnetwork.NetworkFunctionConfigurationTypeOpen),
		NetworkFunctionDefinitionVersionResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
			ID:     to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1"),
		},
		NfviID:           to.Ptr("/subscriptions/subid/resourceGroups/testResourceGroup"),
		NfviType:         to.Ptr(armhybridnetwork.NFVITypeAzureCore),
		DeploymentValues: to.Ptr("{\"virtualMachineName\":\"test-VM\",\"cpuCores\":4,\"memorySizeGB\":8,\"cloudServicesNetworkAttachment\":{\"attachedNetworkId\":\"test-csnet\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-cs-vlan\"},\"networkAttachments\":[{\"attachedNetworkId\":\"test-l3vlan\",\"defaultGateway\":\"True\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-vlan\"}],\"sshPublicKeys\":[{\"keyData\":\"ssh-rsa CMIIIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA0TqlveKKlc2MFvEmuXJiLGBsY1t4ML4uiRADGSZlnc+7Ugv3h+MCjkkwOKiOdsNo8k4KSBIG5GcQfKYOOd17AJvqCL6cGQbaLuqv0a64jeDm8oO8/xN/IM0oKw7rMr/2oAJOgIsfeXPkRxWWic9AVIS++H5Qi2r7bUFX+cqFsyUCAwEBBQ==\"}],\"storageProfile\":{\"osDisk\":{\"createOption\":\"Ephemeral\",\"deleteOption\":\"Delete\",\"diskSizeGB\":10}},\"userData\":\"testUserData\",\"adminUsername\":\"testUser\",\"virtioInterface\":\"Transitional\",\"isolateEmulatorThread\":\"False\",\"bootMethod\":\"BIOS\",\"placementHints\":[]}"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunction = armhybridnetwork.NetworkFunction{
// 	Name: to.Ptr("testNf"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/networkFunctions"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.NetworkFunctionValueWithoutSecrets{
// 		AllowSoftwareUpdate: to.Ptr(false),
// 		ConfigurationType: to.Ptr(armhybridnetwork.NetworkFunctionConfigurationTypeOpen),
// 		NetworkFunctionDefinitionGroupName: to.Ptr("TestNetworkFunctionDefinitionGroupName"),
// 		NetworkFunctionDefinitionOfferingLocation: to.Ptr("eastus"),
// 		NetworkFunctionDefinitionVersion: to.Ptr("1.0.0"),
// 		NetworkFunctionDefinitionVersionResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
// 			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1"),
// 		},
// 		NfviID: to.Ptr("/subscriptions/subid/resourceGroups/testResourceGroup"),
// 		NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureCore),
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		PublisherName: to.Ptr("TestPublisher"),
// 		PublisherScope: to.Ptr(armhybridnetwork.PublisherScopePrivate),
// 		DeploymentValues: to.Ptr("{\"virtualMachineName\":\"test-VM\",\"cpuCores\":4,\"memorySizeGB\":8,\"cloudServicesNetworkAttachment\":{\"attachedNetworkId\":\"test-csnet\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-cs-vlan\"},\"networkAttachments\":[{\"attachedNetworkId\":\"test-l3vlan\",\"defaultGateway\":\"True\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-vlan\"}],\"sshPublicKeys\":[{\"keyData\":\"ssh-rsa CMIIIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA0TqlveKKlc2MFvEmuXJiLGBsY1t4ML4uiRADGSZlnc+7Ugv3h+MCjkkwOKiOdsNo8k4KSBIG5GcQfKYOOd17AJvqCL6cGQbaLuqv0a64jeDm8oO8/xN/IM0oKw7rMr/2oAJOgIsfeXPkRxWWic9AVIS++H5Qi2r7bUFX+cqFsyUCAwEBBQ==\"}],\"storageProfile\":{\"osDisk\":{\"createOption\":\"Ephemeral\",\"deleteOption\":\"Delete\",\"diskSizeGB\":10}},\"userData\":\"testUserData\",\"adminUsername\":\"testUser\",\"virtioInterface\":\"Transitional\",\"isolateEmulatorThread\":\"False\",\"bootMethod\":\"BIOS\",\"placementHints\":[]}"),
// 	},
// }
Output:

Example (CreateVirtualNetworkFunctionResourceOnAzureOperatorNexus)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkFunctionsClient().BeginCreateOrUpdate(ctx, "rg", "testNf", armhybridnetwork.NetworkFunction{
	Location: to.Ptr("eastus"),
	Properties: &armhybridnetwork.NetworkFunctionValueWithoutSecrets{
		AllowSoftwareUpdate: to.Ptr(false),
		ConfigurationType:   to.Ptr(armhybridnetwork.NetworkFunctionConfigurationTypeOpen),
		NetworkFunctionDefinitionVersionResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
			ID:     to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1"),
		},
		NfviID:           to.Ptr("/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation"),
		NfviType:         to.Ptr(armhybridnetwork.NFVITypeAzureOperatorNexus),
		DeploymentValues: to.Ptr("{\"virtualMachineName\":\"test-VM\",\"extendedLocationName\":\"test-cluster\",\"cpuCores\":4,\"memorySizeGB\":8,\"cloudServicesNetworkAttachment\":{\"attachedNetworkId\":\"test-csnet\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-cs-vlan\"},\"networkAttachments\":[{\"attachedNetworkId\":\"test-l3vlan\",\"defaultGateway\":\"True\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-vlan\"}],\"sshPublicKeys\":[{\"keyData\":\"ssh-rsa CMIIIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA0TqlveKKlc2MFvEmuXJiLGBsY1t4ML4uiRADGSZlnc+7Ugv3h+MCjkkwOKiOdsNo8k4KSBIG5GcQfKYOOd17AJvqCL6cGQbaLuqv0a64jeDm8oO8/xN/IM0oKw7rMr/2oAJOgIsfeXPkRxWWic9AVIS++H5Qi2r7bUFX+cqFsyUCAwEBBQ==\"}],\"storageProfile\":{\"osDisk\":{\"createOption\":\"Ephemeral\",\"deleteOption\":\"Delete\",\"diskSizeGB\":10}},\"userData\":\"testUserData\",\"adminUsername\":\"testUser\",\"virtioInterface\":\"Transitional\",\"isolateEmulatorThread\":\"False\",\"bootMethod\":\"BIOS\",\"placementHints\":[]}"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunction = armhybridnetwork.NetworkFunction{
// 	Name: to.Ptr("testNf"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/networkFunctions"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.NetworkFunctionValueWithoutSecrets{
// 		AllowSoftwareUpdate: to.Ptr(false),
// 		ConfigurationType: to.Ptr(armhybridnetwork.NetworkFunctionConfigurationTypeOpen),
// 		NetworkFunctionDefinitionGroupName: to.Ptr("TestNetworkFunctionDefinitionGroupName"),
// 		NetworkFunctionDefinitionOfferingLocation: to.Ptr("eastus"),
// 		NetworkFunctionDefinitionVersion: to.Ptr("1.0.0"),
// 		NetworkFunctionDefinitionVersionResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
// 			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1"),
// 		},
// 		NfviID: to.Ptr("/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation"),
// 		NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureOperatorNexus),
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		PublisherName: to.Ptr("TestPublisher"),
// 		PublisherScope: to.Ptr(armhybridnetwork.PublisherScopePrivate),
// 		DeploymentValues: to.Ptr("{\"virtualMachineName\":\"test-VM\",\"extendedLocationName\":\"test-cluster\",\"cpuCores\":4,\"memorySizeGB\":8,\"cloudServicesNetworkAttachment\":{\"attachedNetworkId\":\"test-csnet\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-cs-vlan\"},\"networkAttachments\":[{\"attachedNetworkId\":\"test-l3vlan\",\"defaultGateway\":\"True\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-vlan\"}],\"sshPublicKeys\":[{\"keyData\":\"ssh-rsa CMIIIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA0TqlveKKlc2MFvEmuXJiLGBsY1t4ML4uiRADGSZlnc+7Ugv3h+MCjkkwOKiOdsNo8k4KSBIG5GcQfKYOOd17AJvqCL6cGQbaLuqv0a64jeDm8oO8/xN/IM0oKw7rMr/2oAJOgIsfeXPkRxWWic9AVIS++H5Qi2r7bUFX+cqFsyUCAwEBBQ==\"}],\"storageProfile\":{\"osDisk\":{\"createOption\":\"Ephemeral\",\"deleteOption\":\"Delete\",\"diskSizeGB\":10}},\"userData\":\"testUserData\",\"adminUsername\":\"testUser\",\"virtioInterface\":\"Transitional\",\"isolateEmulatorThread\":\"False\",\"bootMethod\":\"BIOS\",\"placementHints\":[]}"),
// 	},
// }
Output:

func (*NetworkFunctionsClient) BeginDelete

func (client *NetworkFunctionsClient) BeginDelete(ctx context.Context, resourceGroupName string, networkFunctionName string, options *NetworkFunctionsClientBeginDeleteOptions) (*runtime.Poller[NetworkFunctionsClientDeleteResponse], error)

BeginDelete - Deletes the specified network function resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • networkFunctionName - The name of the network function.
  • options - NetworkFunctionsClientBeginDeleteOptions contains the optional parameters for the NetworkFunctionsClient.BeginDelete method.
Example (DeleteNetworkFunctionResource)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkFunctionsClient().BeginDelete(ctx, "rg", "testNf", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

Example (DeleteVirtualNetworkFunctionResourceOnAzureCore)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkFunctionsClient().BeginDelete(ctx, "rg", "testNf", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

Example (DeleteVirtualNetworkFunctionResourceOnAzureOperatorNexus)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkFunctionsClient().BeginDelete(ctx, "rg", "testNf", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*NetworkFunctionsClient) BeginExecuteRequest

BeginExecuteRequest - Execute a request to services on a containerized network function. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • networkFunctionName - The name of the network function.
  • parameters - Payload for execute request post call.
  • options - NetworkFunctionsClientBeginExecuteRequestOptions contains the optional parameters for the NetworkFunctionsClient.BeginExecuteRequest method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionsExecuteRequest.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkFunctionsClient().BeginExecuteRequest(ctx, "rg", "testNetworkfunction", armhybridnetwork.ExecuteRequestParameters{
	RequestMetadata: &armhybridnetwork.RequestMetadata{
		APIVersion:     to.Ptr("apiVersionQueryString"),
		HTTPMethod:     to.Ptr(armhybridnetwork.HTTPMethodPost),
		RelativePath:   to.Ptr("/simProfiles/testSimProfile"),
		SerializedBody: to.Ptr("{\"subscriptionProfile\":\"ChantestSubscription15\",\"permanentKey\":\"00112233445566778899AABBCCDDEEFF\",\"opcOperatorCode\":\"63bfa50ee6523365ff14c1f45f88737d\",\"staticIpAddresses\":{\"internet\":{\"ipv4Addr\":\"198.51.100.1\",\"ipv6Prefix\":\"2001:db8:abcd:12::0/64\"},\"another_network\":{\"ipv6Prefix\":\"2001:111:cdef:22::0/64\"}}}"),
	},
	ServiceEndpoint: to.Ptr("serviceEndpoint"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*NetworkFunctionsClient) Get

func (client *NetworkFunctionsClient) Get(ctx context.Context, resourceGroupName string, networkFunctionName string, options *NetworkFunctionsClientGetOptions) (NetworkFunctionsClientGetResponse, error)

Get - Gets information about the specified network function resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • networkFunctionName - The name of the network function resource.
  • options - NetworkFunctionsClientGetOptions contains the optional parameters for the NetworkFunctionsClient.Get method.
Example (GetNetworkFunctionResource)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNetworkFunctionsClient().Get(ctx, "rg", "testNf", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunction = armhybridnetwork.NetworkFunction{
// 	Name: to.Ptr("testNf"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/networkFunctions"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.NetworkFunctionValueWithoutSecrets{
// 		AllowSoftwareUpdate: to.Ptr(false),
// 		ConfigurationType: to.Ptr(armhybridnetwork.NetworkFunctionConfigurationTypeOpen),
// 		NetworkFunctionDefinitionGroupName: to.Ptr("testnetworkFunctionDefinitionGroupName"),
// 		NetworkFunctionDefinitionOfferingLocation: to.Ptr("eastus"),
// 		NetworkFunctionDefinitionVersion: to.Ptr("1.0.1"),
// 		NetworkFunctionDefinitionVersionResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
// 			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1"),
// 		},
// 		NfviID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation"),
// 		NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureArcKubernetes),
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		PublisherName: to.Ptr("testVendor"),
// 		PublisherScope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
// 		RoleOverrideValues: []*string{
// 			to.Ptr("{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}"),
// 			to.Ptr("{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}")},
// 			DeploymentValues: to.Ptr("{\"releaseName\":\"testReleaseName\",\"namespace\":\"testNamespace\"}"),
// 		},
// 	}
Output:

Example (GetVirtualNetworkFunctionResourceOnAzureCore)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureCore/VirtualNetworkFunctionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNetworkFunctionsClient().Get(ctx, "rg", "testNf", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunction = armhybridnetwork.NetworkFunction{
// 	Name: to.Ptr("testNf"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/networkFunctions"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.NetworkFunctionValueWithoutSecrets{
// 		AllowSoftwareUpdate: to.Ptr(false),
// 		ConfigurationType: to.Ptr(armhybridnetwork.NetworkFunctionConfigurationTypeOpen),
// 		NetworkFunctionDefinitionGroupName: to.Ptr("TestNetworkFunctionDefinitionGroupName"),
// 		NetworkFunctionDefinitionOfferingLocation: to.Ptr("eastus"),
// 		NetworkFunctionDefinitionVersion: to.Ptr("1.0.0"),
// 		NfviID: to.Ptr("/subscriptions/subid/resourceGroups/testResourceGroup"),
// 		NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureCore),
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		PublisherName: to.Ptr("TestPublisher"),
// 		PublisherScope: to.Ptr(armhybridnetwork.PublisherScopePrivate),
// 		DeploymentValues: to.Ptr("{\"virtualMachineName\":\"test-VM\",\"cpuCores\":4,\"memorySizeGB\":8,\"cloudServicesNetworkAttachment\":{\"attachedNetworkId\":\"test-csnet\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-cs-vlan\"},\"networkAttachments\":[{\"attachedNetworkId\":\"test-l3vlan\",\"defaultGateway\":\"True\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-vlan\"}],\"sshPublicKeys\":[{\"keyData\":\"ssh-rsa CMIIIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA0TqlveKKlc2MFvEmuXJiLGBsY1t4ML4uiRADGSZlnc+7Ugv3h+MCjkkwOKiOdsNo8k4KSBIG5GcQfKYOOd17AJvqCL6cGQbaLuqv0a64jeDm8oO8/xN/IM0oKw7rMr/2oAJOgIsfeXPkRxWWic9AVIS++H5Qi2r7bUFX+cqFsyUCAwEBBQ==\"}],\"storageProfile\":{\"osDisk\":{\"createOption\":\"Ephemeral\",\"deleteOption\":\"Delete\",\"diskSizeGB\":10}},\"userData\":\"testUserData\",\"adminUsername\":\"testUser\",\"virtioInterface\":\"Transitional\",\"isolateEmulatorThread\":\"False\",\"bootMethod\":\"BIOS\",\"placementHints\":[]}"),
// 	},
// }
Output:

Example (GetVirtualNetworkFunctionResourceOnAzureOperatorNexus)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/AzureOperatorNexus/VirtualNetworkFunctionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNetworkFunctionsClient().Get(ctx, "rg", "testNf", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunction = armhybridnetwork.NetworkFunction{
// 	Name: to.Ptr("testNf"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/networkFunctions"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.NetworkFunctionValueWithoutSecrets{
// 		AllowSoftwareUpdate: to.Ptr(false),
// 		ConfigurationType: to.Ptr(armhybridnetwork.NetworkFunctionConfigurationTypeOpen),
// 		NetworkFunctionDefinitionGroupName: to.Ptr("TestNetworkFunctionDefinitionGroupName"),
// 		NetworkFunctionDefinitionOfferingLocation: to.Ptr("eastus"),
// 		NetworkFunctionDefinitionVersion: to.Ptr("1.0.0"),
// 		NfviID: to.Ptr("/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation"),
// 		NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureOperatorNexus),
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		PublisherName: to.Ptr("TestPublisher"),
// 		PublisherScope: to.Ptr(armhybridnetwork.PublisherScopePrivate),
// 		DeploymentValues: to.Ptr("{\"virtualMachineName\":\"test-VM\",\"extendedLocationName\":\"test-cluster\",\"cpuCores\":4,\"memorySizeGB\":8,\"cloudServicesNetworkAttachment\":{\"attachedNetworkId\":\"test-csnet\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-cs-vlan\"},\"networkAttachments\":[{\"attachedNetworkId\":\"test-l3vlan\",\"defaultGateway\":\"True\",\"ipAllocationMethod\":\"Dynamic\",\"networkAttachmentName\":\"test-vlan\"}],\"sshPublicKeys\":[{\"keyData\":\"ssh-rsa CMIIIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA0TqlveKKlc2MFvEmuXJiLGBsY1t4ML4uiRADGSZlnc+7Ugv3h+MCjkkwOKiOdsNo8k4KSBIG5GcQfKYOOd17AJvqCL6cGQbaLuqv0a64jeDm8oO8/xN/IM0oKw7rMr/2oAJOgIsfeXPkRxWWic9AVIS++H5Qi2r7bUFX+cqFsyUCAwEBBQ==\"}],\"storageProfile\":{\"osDisk\":{\"createOption\":\"Ephemeral\",\"deleteOption\":\"Delete\",\"diskSizeGB\":10}},\"userData\":\"testUserData\",\"adminUsername\":\"testUser\",\"virtioInterface\":\"Transitional\",\"isolateEmulatorThread\":\"False\",\"bootMethod\":\"BIOS\",\"placementHints\":[]}"),
// 	},
// }
Output:

func (*NetworkFunctionsClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Lists all the network function resources in a resource group.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - NetworkFunctionsClientListByResourceGroupOptions contains the optional parameters for the NetworkFunctionsClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewNetworkFunctionsClient().NewListByResourceGroupPager("rg", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.NetworkFunctionListResult = armhybridnetwork.NetworkFunctionListResult{
	// 	Value: []*armhybridnetwork.NetworkFunction{
	// 		{
	// 			Name: to.Ptr("testNf"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/networkFunctions"),
	// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf"),
	// 			Location: to.Ptr("eastus"),
	// 			Properties: &armhybridnetwork.NetworkFunctionValueWithoutSecrets{
	// 				AllowSoftwareUpdate: to.Ptr(false),
	// 				ConfigurationType: to.Ptr(armhybridnetwork.NetworkFunctionConfigurationTypeOpen),
	// 				NetworkFunctionDefinitionGroupName: to.Ptr("testnetworkFunctionDefinitionGroupName"),
	// 				NetworkFunctionDefinitionOfferingLocation: to.Ptr("eastus"),
	// 				NetworkFunctionDefinitionVersion: to.Ptr("1.0.1"),
	// 				NetworkFunctionDefinitionVersionResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
	// 					IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
	// 					ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1"),
	// 				},
	// 				NfviID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation"),
	// 				NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureArcKubernetes),
	// 				ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
	// 				PublisherName: to.Ptr("testVendor"),
	// 				PublisherScope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
	// 				RoleOverrideValues: []*string{
	// 					to.Ptr("{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}"),
	// 					to.Ptr("{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}")},
	// 					DeploymentValues: to.Ptr("{\"releaseName\":\"testReleaseName\",\"namespace\":\"testNamespace\"}"),
	// 				},
	// 		}},
	// 	}
}
Output:

func (*NetworkFunctionsClient) NewListBySubscriptionPager

NewListBySubscriptionPager - Lists all the network functions in a subscription.

Generated from API version 2023-09-01

  • options - NetworkFunctionsClientListBySubscriptionOptions contains the optional parameters for the NetworkFunctionsClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionListBySubscription.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewNetworkFunctionsClient().NewListBySubscriptionPager(nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.NetworkFunctionListResult = armhybridnetwork.NetworkFunctionListResult{
	// 	Value: []*armhybridnetwork.NetworkFunction{
	// 		{
	// 			Name: to.Ptr("testNf"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/networkFunctions"),
	// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf"),
	// 			Location: to.Ptr("eastus"),
	// 			Properties: &armhybridnetwork.NetworkFunctionValueWithoutSecrets{
	// 				AllowSoftwareUpdate: to.Ptr(false),
	// 				ConfigurationType: to.Ptr(armhybridnetwork.NetworkFunctionConfigurationTypeOpen),
	// 				NetworkFunctionDefinitionGroupName: to.Ptr("testnetworkFunctionDefinitionGroupName"),
	// 				NetworkFunctionDefinitionOfferingLocation: to.Ptr("eastus"),
	// 				NetworkFunctionDefinitionVersion: to.Ptr("1.0.1"),
	// 				NetworkFunctionDefinitionVersionResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
	// 					IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
	// 					ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1"),
	// 				},
	// 				NfviID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation"),
	// 				NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureArcKubernetes),
	// 				ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
	// 				PublisherName: to.Ptr("testVendor"),
	// 				PublisherScope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
	// 				RoleOverrideValues: []*string{
	// 					to.Ptr("{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}"),
	// 					to.Ptr("{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}")},
	// 					DeploymentValues: to.Ptr("{\"releaseName\":\"testReleaseName\",\"namespace\":\"testNamespace\"}"),
	// 				},
	// 		}},
	// 	}
}
Output:

func (*NetworkFunctionsClient) UpdateTags

func (client *NetworkFunctionsClient) UpdateTags(ctx context.Context, resourceGroupName string, networkFunctionName string, parameters TagsObject, options *NetworkFunctionsClientUpdateTagsOptions) (NetworkFunctionsClientUpdateTagsResponse, error)

UpdateTags - Updates the tags for the network function resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • networkFunctionName - Resource name for the network function resource.
  • parameters - Parameters supplied to the update network function tags operation.
  • options - NetworkFunctionsClientUpdateTagsOptions contains the optional parameters for the NetworkFunctionsClient.UpdateTags method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkFunctionUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNetworkFunctionsClient().UpdateTags(ctx, "rg", "testNf", armhybridnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkFunction = armhybridnetwork.NetworkFunction{
// 	Name: to.Ptr("testNf"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/networkFunctions"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/networkFunctions/testNf"),
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Properties: &armhybridnetwork.NetworkFunctionValueWithoutSecrets{
// 		AllowSoftwareUpdate: to.Ptr(false),
// 		ConfigurationType: to.Ptr(armhybridnetwork.NetworkFunctionConfigurationTypeOpen),
// 		NetworkFunctionDefinitionGroupName: to.Ptr("testnetworkFunctionDefinitionGroupName"),
// 		NetworkFunctionDefinitionOfferingLocation: to.Ptr("eastus"),
// 		NetworkFunctionDefinitionVersion: to.Ptr("1.0.1"),
// 		NetworkFunctionDefinitionVersionResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
// 			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testVendor/networkFunctionDefinitionGroups/testnetworkFunctionDefinitionGroupName/networkFunctionDefinitionVersions/1.0.1"),
// 		},
// 		NfviID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation"),
// 		NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureArcKubernetes),
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		PublisherName: to.Ptr("testVendor"),
// 		PublisherScope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
// 		RoleOverrideValues: []*string{
// 			to.Ptr("{\"name\":\"testRoleOne\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\"}}}"),
// 			to.Ptr("{\"name\":\"testRoleTwo\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"releaseName\":\"overrideReleaseName\",\"releaseNamespace\":\"overrideNamespace\",\"values\":\"{\\\"roleTwoParam\\\":\\\"roleTwoOverrideValue\\\"}\"}}}")},
// 			DeploymentValues: to.Ptr("{\"releaseName\":\"testReleaseName\",\"namespace\":\"testNamespace\"}"),
// 		},
// 	}
Output:

type NetworkFunctionsClientBeginCreateOrUpdateOptions

type NetworkFunctionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

NetworkFunctionsClientBeginCreateOrUpdateOptions contains the optional parameters for the NetworkFunctionsClient.BeginCreateOrUpdate method.

type NetworkFunctionsClientBeginDeleteOptions

type NetworkFunctionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

NetworkFunctionsClientBeginDeleteOptions contains the optional parameters for the NetworkFunctionsClient.BeginDelete method.

type NetworkFunctionsClientBeginExecuteRequestOptions

type NetworkFunctionsClientBeginExecuteRequestOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

NetworkFunctionsClientBeginExecuteRequestOptions contains the optional parameters for the NetworkFunctionsClient.BeginExecuteRequest method.

type NetworkFunctionsClientCreateOrUpdateResponse

type NetworkFunctionsClientCreateOrUpdateResponse struct {
	// Network function resource response.
	NetworkFunction
}

NetworkFunctionsClientCreateOrUpdateResponse contains the response from method NetworkFunctionsClient.BeginCreateOrUpdate.

type NetworkFunctionsClientDeleteResponse

type NetworkFunctionsClientDeleteResponse struct {
}

NetworkFunctionsClientDeleteResponse contains the response from method NetworkFunctionsClient.BeginDelete.

type NetworkFunctionsClientExecuteRequestResponse

type NetworkFunctionsClientExecuteRequestResponse struct {
}

NetworkFunctionsClientExecuteRequestResponse contains the response from method NetworkFunctionsClient.BeginExecuteRequest.

type NetworkFunctionsClientGetOptions

type NetworkFunctionsClientGetOptions struct {
}

NetworkFunctionsClientGetOptions contains the optional parameters for the NetworkFunctionsClient.Get method.

type NetworkFunctionsClientGetResponse

type NetworkFunctionsClientGetResponse struct {
	// Network function resource response.
	NetworkFunction
}

NetworkFunctionsClientGetResponse contains the response from method NetworkFunctionsClient.Get.

type NetworkFunctionsClientListByResourceGroupOptions

type NetworkFunctionsClientListByResourceGroupOptions struct {
}

NetworkFunctionsClientListByResourceGroupOptions contains the optional parameters for the NetworkFunctionsClient.NewListByResourceGroupPager method.

type NetworkFunctionsClientListByResourceGroupResponse

type NetworkFunctionsClientListByResourceGroupResponse struct {
	// Response for network function API service call.
	NetworkFunctionListResult
}

NetworkFunctionsClientListByResourceGroupResponse contains the response from method NetworkFunctionsClient.NewListByResourceGroupPager.

type NetworkFunctionsClientListBySubscriptionOptions

type NetworkFunctionsClientListBySubscriptionOptions struct {
}

NetworkFunctionsClientListBySubscriptionOptions contains the optional parameters for the NetworkFunctionsClient.NewListBySubscriptionPager method.

type NetworkFunctionsClientListBySubscriptionResponse

type NetworkFunctionsClientListBySubscriptionResponse struct {
	// Response for network function API service call.
	NetworkFunctionListResult
}

NetworkFunctionsClientListBySubscriptionResponse contains the response from method NetworkFunctionsClient.NewListBySubscriptionPager.

type NetworkFunctionsClientUpdateTagsOptions

type NetworkFunctionsClientUpdateTagsOptions struct {
}

NetworkFunctionsClientUpdateTagsOptions contains the optional parameters for the NetworkFunctionsClient.UpdateTags method.

type NetworkFunctionsClientUpdateTagsResponse

type NetworkFunctionsClientUpdateTagsResponse struct {
	// Network function resource response.
	NetworkFunction
}

NetworkFunctionsClientUpdateTagsResponse contains the response from method NetworkFunctionsClient.UpdateTags.

type NetworkServiceDesignGroup

type NetworkServiceDesignGroup struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// network service design group properties.
	Properties *NetworkServiceDesignGroupPropertiesFormat

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

NetworkServiceDesignGroup - network service design group resource.

func (NetworkServiceDesignGroup) MarshalJSON

func (n NetworkServiceDesignGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkServiceDesignGroup.

func (*NetworkServiceDesignGroup) UnmarshalJSON

func (n *NetworkServiceDesignGroup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkServiceDesignGroup.

type NetworkServiceDesignGroupListResult

type NetworkServiceDesignGroupListResult struct {
	// A list of network service design group.
	Value []*NetworkServiceDesignGroup

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string
}

NetworkServiceDesignGroupListResult - A list of network service design group resources.

func (NetworkServiceDesignGroupListResult) MarshalJSON

func (n NetworkServiceDesignGroupListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkServiceDesignGroupListResult.

func (*NetworkServiceDesignGroupListResult) UnmarshalJSON

func (n *NetworkServiceDesignGroupListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkServiceDesignGroupListResult.

type NetworkServiceDesignGroupPropertiesFormat

type NetworkServiceDesignGroupPropertiesFormat struct {
	// The network service design group description.
	Description *string

	// READ-ONLY; The provisioning state of the network service design groups resource.
	ProvisioningState *ProvisioningState
}

NetworkServiceDesignGroupPropertiesFormat - network service design group properties.

func (NetworkServiceDesignGroupPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type NetworkServiceDesignGroupPropertiesFormat.

func (*NetworkServiceDesignGroupPropertiesFormat) UnmarshalJSON

func (n *NetworkServiceDesignGroupPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkServiceDesignGroupPropertiesFormat.

type NetworkServiceDesignGroupsClient

type NetworkServiceDesignGroupsClient struct {
	// contains filtered or unexported fields
}

NetworkServiceDesignGroupsClient contains the methods for the NetworkServiceDesignGroups group. Don't use this type directly, use NewNetworkServiceDesignGroupsClient() instead.

func NewNetworkServiceDesignGroupsClient

func NewNetworkServiceDesignGroupsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*NetworkServiceDesignGroupsClient, error)

NewNetworkServiceDesignGroupsClient creates a new instance of NetworkServiceDesignGroupsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*NetworkServiceDesignGroupsClient) BeginCreateOrUpdate

BeginCreateOrUpdate - Creates or updates a network service design group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkServiceDesignGroupName - The name of the network service design group.
  • parameters - Parameters supplied to the create or update publisher network service design group operation.
  • options - NetworkServiceDesignGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the NetworkServiceDesignGroupsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkServiceDesignGroupsClient().BeginCreateOrUpdate(ctx, "rg", "TestPublisher", "TestNetworkServiceDesignGroupName", armhybridnetwork.NetworkServiceDesignGroup{
	Location: to.Ptr("eastus"),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkServiceDesignGroup = armhybridnetwork.NetworkServiceDesignGroup{
// 	Name: to.Ptr("TestNetworkServiceDesignGroupName"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/networkServiceDesignGroups"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/rgproviders/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.NetworkServiceDesignGroupPropertiesFormat{
// 		Description: to.Ptr("Test NSD group"),
// 	},
// }
Output:

func (*NetworkServiceDesignGroupsClient) BeginDelete

func (client *NetworkServiceDesignGroupsClient) BeginDelete(ctx context.Context, resourceGroupName string, publisherName string, networkServiceDesignGroupName string, options *NetworkServiceDesignGroupsClientBeginDeleteOptions) (*runtime.Poller[NetworkServiceDesignGroupsClientDeleteResponse], error)

BeginDelete - Deletes a specified network service design group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkServiceDesignGroupName - The name of the network service design group.
  • options - NetworkServiceDesignGroupsClientBeginDeleteOptions contains the optional parameters for the NetworkServiceDesignGroupsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkServiceDesignGroupsClient().BeginDelete(ctx, "rg", "TestPublisher", "TestNetworkServiceDesignGroupName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*NetworkServiceDesignGroupsClient) Get

func (client *NetworkServiceDesignGroupsClient) Get(ctx context.Context, resourceGroupName string, publisherName string, networkServiceDesignGroupName string, options *NetworkServiceDesignGroupsClientGetOptions) (NetworkServiceDesignGroupsClientGetResponse, error)

Get - Gets information about the specified networkServiceDesign group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkServiceDesignGroupName - The name of the network service design group.
  • options - NetworkServiceDesignGroupsClientGetOptions contains the optional parameters for the NetworkServiceDesignGroupsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNetworkServiceDesignGroupsClient().Get(ctx, "rg", "TestPublisher", "TestNetworkServiceDesignGroupName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkServiceDesignGroup = armhybridnetwork.NetworkServiceDesignGroup{
// 	Name: to.Ptr("TestNetworkServiceDesignGroupName"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/networkServiceDesignGroups"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.NetworkServiceDesignGroupPropertiesFormat{
// 		Description: to.Ptr("Test NSD group"),
// 	},
// }
Output:

func (*NetworkServiceDesignGroupsClient) NewListByPublisherPager

NewListByPublisherPager - Gets information of the network service design groups under a publisher.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • options - NetworkServiceDesignGroupsClientListByPublisherOptions contains the optional parameters for the NetworkServiceDesignGroupsClient.NewListByPublisherPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupsListByPublisherName.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewNetworkServiceDesignGroupsClient().NewListByPublisherPager("rg", "TestPublisher", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.NetworkServiceDesignGroupListResult = armhybridnetwork.NetworkServiceDesignGroupListResult{
	// 	Value: []*armhybridnetwork.NetworkServiceDesignGroup{
	// 		{
	// 			Name: to.Ptr("TestNetworkServiceDesignGroupName"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/publishers/networkServiceDesignGroups"),
	// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName"),
	// 			Location: to.Ptr("eastus"),
	// 			Properties: &armhybridnetwork.NetworkServiceDesignGroupPropertiesFormat{
	// 				Description: to.Ptr("Test NSD group"),
	// 			},
	// 	}},
	// }
}
Output:

func (*NetworkServiceDesignGroupsClient) Update

func (client *NetworkServiceDesignGroupsClient) Update(ctx context.Context, resourceGroupName string, publisherName string, networkServiceDesignGroupName string, parameters TagsObject, options *NetworkServiceDesignGroupsClientUpdateOptions) (NetworkServiceDesignGroupsClientUpdateResponse, error)

Update - Updates a network service design groups resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkServiceDesignGroupName - The name of the network service design group.
  • parameters - Parameters supplied to the create or update publisher network service design group operation.
  • options - NetworkServiceDesignGroupsClientUpdateOptions contains the optional parameters for the NetworkServiceDesignGroupsClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignGroupUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNetworkServiceDesignGroupsClient().Update(ctx, "rg", "TestPublisher", "TestNetworkServiceDesignGroupName", armhybridnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkServiceDesignGroup = armhybridnetwork.NetworkServiceDesignGroup{
// 	Name: to.Ptr("TestNetworkServiceDesignGroupName"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/networkServiceDesignGroups"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName"),
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Properties: &armhybridnetwork.NetworkServiceDesignGroupPropertiesFormat{
// 		Description: to.Ptr("Test NSD group"),
// 	},
// }
Output:

type NetworkServiceDesignGroupsClientBeginCreateOrUpdateOptions

type NetworkServiceDesignGroupsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

NetworkServiceDesignGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the NetworkServiceDesignGroupsClient.BeginCreateOrUpdate method.

type NetworkServiceDesignGroupsClientBeginDeleteOptions

type NetworkServiceDesignGroupsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

NetworkServiceDesignGroupsClientBeginDeleteOptions contains the optional parameters for the NetworkServiceDesignGroupsClient.BeginDelete method.

type NetworkServiceDesignGroupsClientCreateOrUpdateResponse

type NetworkServiceDesignGroupsClientCreateOrUpdateResponse struct {
	// network service design group resource.
	NetworkServiceDesignGroup
}

NetworkServiceDesignGroupsClientCreateOrUpdateResponse contains the response from method NetworkServiceDesignGroupsClient.BeginCreateOrUpdate.

type NetworkServiceDesignGroupsClientDeleteResponse

type NetworkServiceDesignGroupsClientDeleteResponse struct {
}

NetworkServiceDesignGroupsClientDeleteResponse contains the response from method NetworkServiceDesignGroupsClient.BeginDelete.

type NetworkServiceDesignGroupsClientGetOptions

type NetworkServiceDesignGroupsClientGetOptions struct {
}

NetworkServiceDesignGroupsClientGetOptions contains the optional parameters for the NetworkServiceDesignGroupsClient.Get method.

type NetworkServiceDesignGroupsClientGetResponse

type NetworkServiceDesignGroupsClientGetResponse struct {
	// network service design group resource.
	NetworkServiceDesignGroup
}

NetworkServiceDesignGroupsClientGetResponse contains the response from method NetworkServiceDesignGroupsClient.Get.

type NetworkServiceDesignGroupsClientListByPublisherOptions

type NetworkServiceDesignGroupsClientListByPublisherOptions struct {
}

NetworkServiceDesignGroupsClientListByPublisherOptions contains the optional parameters for the NetworkServiceDesignGroupsClient.NewListByPublisherPager method.

type NetworkServiceDesignGroupsClientListByPublisherResponse

type NetworkServiceDesignGroupsClientListByPublisherResponse struct {
	// A list of network service design group resources.
	NetworkServiceDesignGroupListResult
}

NetworkServiceDesignGroupsClientListByPublisherResponse contains the response from method NetworkServiceDesignGroupsClient.NewListByPublisherPager.

type NetworkServiceDesignGroupsClientUpdateOptions

type NetworkServiceDesignGroupsClientUpdateOptions struct {
}

NetworkServiceDesignGroupsClientUpdateOptions contains the optional parameters for the NetworkServiceDesignGroupsClient.Update method.

type NetworkServiceDesignGroupsClientUpdateResponse

type NetworkServiceDesignGroupsClientUpdateResponse struct {
	// network service design group resource.
	NetworkServiceDesignGroup
}

NetworkServiceDesignGroupsClientUpdateResponse contains the response from method NetworkServiceDesignGroupsClient.Update.

type NetworkServiceDesignVersion

type NetworkServiceDesignVersion struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// network service design version properties.
	Properties *NetworkServiceDesignVersionPropertiesFormat

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

NetworkServiceDesignVersion - network service design version.

func (NetworkServiceDesignVersion) MarshalJSON

func (n NetworkServiceDesignVersion) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkServiceDesignVersion.

func (*NetworkServiceDesignVersion) UnmarshalJSON

func (n *NetworkServiceDesignVersion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkServiceDesignVersion.

type NetworkServiceDesignVersionListResult

type NetworkServiceDesignVersionListResult struct {
	// A list of network service design versions.
	Value []*NetworkServiceDesignVersion

	// READ-ONLY; The URI to get the next set of results.
	NextLink *string
}

NetworkServiceDesignVersionListResult - A list of network service design versions.

func (NetworkServiceDesignVersionListResult) MarshalJSON

func (n NetworkServiceDesignVersionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkServiceDesignVersionListResult.

func (*NetworkServiceDesignVersionListResult) UnmarshalJSON

func (n *NetworkServiceDesignVersionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkServiceDesignVersionListResult.

type NetworkServiceDesignVersionPropertiesFormat

type NetworkServiceDesignVersionPropertiesFormat struct {
	// The configuration schemas to used to define the values.
	ConfigurationGroupSchemaReferences map[string]*ReferencedResource

	// The network service design version description.
	Description *string

	// The nfvis from the site.
	NfvisFromSite map[string]*NfviDetails

	// List of resource element template
	ResourceElementTemplates []ResourceElementTemplateClassification

	// READ-ONLY; The provisioning state of the network service design version resource.
	ProvisioningState *ProvisioningState

	// READ-ONLY; The network service design version state.
	VersionState *VersionState
}

NetworkServiceDesignVersionPropertiesFormat - network service design version properties.

func (NetworkServiceDesignVersionPropertiesFormat) MarshalJSON

MarshalJSON implements the json.Marshaller interface for type NetworkServiceDesignVersionPropertiesFormat.

func (*NetworkServiceDesignVersionPropertiesFormat) UnmarshalJSON

func (n *NetworkServiceDesignVersionPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkServiceDesignVersionPropertiesFormat.

type NetworkServiceDesignVersionUpdateState

type NetworkServiceDesignVersionUpdateState struct {
	// The network service design version state.
	VersionState *VersionState
}

NetworkServiceDesignVersionUpdateState - Publisher network service design version update request definition.

func (NetworkServiceDesignVersionUpdateState) MarshalJSON

func (n NetworkServiceDesignVersionUpdateState) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkServiceDesignVersionUpdateState.

func (*NetworkServiceDesignVersionUpdateState) UnmarshalJSON

func (n *NetworkServiceDesignVersionUpdateState) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkServiceDesignVersionUpdateState.

type NetworkServiceDesignVersionsClient

type NetworkServiceDesignVersionsClient struct {
	// contains filtered or unexported fields
}

NetworkServiceDesignVersionsClient contains the methods for the NetworkServiceDesignVersions group. Don't use this type directly, use NewNetworkServiceDesignVersionsClient() instead.

func NewNetworkServiceDesignVersionsClient

func NewNetworkServiceDesignVersionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*NetworkServiceDesignVersionsClient, error)

NewNetworkServiceDesignVersionsClient creates a new instance of NetworkServiceDesignVersionsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*NetworkServiceDesignVersionsClient) BeginCreateOrUpdate

func (client *NetworkServiceDesignVersionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, publisherName string, networkServiceDesignGroupName string, networkServiceDesignVersionName string, parameters NetworkServiceDesignVersion, options *NetworkServiceDesignVersionsClientBeginCreateOrUpdateOptions) (*runtime.Poller[NetworkServiceDesignVersionsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a network service design version. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkServiceDesignGroupName - The name of the network service design group.
  • networkServiceDesignVersionName - The name of the network service design version. The name should conform to the SemVer 2.0.0 specification: https://semver.org/spec/v2.0.0.html.
  • parameters - Parameters supplied to the create or update network service design version operation.
  • options - NetworkServiceDesignVersionsClientBeginCreateOrUpdateOptions contains the optional parameters for the NetworkServiceDesignVersionsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkServiceDesignVersionsClient().BeginCreateOrUpdate(ctx, "rg", "TestPublisher", "TestNetworkServiceDesignGroupName", "1.0.0", armhybridnetwork.NetworkServiceDesignVersion{
	Location: to.Ptr("eastus"),
	Properties: &armhybridnetwork.NetworkServiceDesignVersionPropertiesFormat{
		ConfigurationGroupSchemaReferences: map[string]*armhybridnetwork.ReferencedResource{
			"MyVM_Configuration": {
				ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/publishers/contosoGroup/networkServiceDesignGroups/NSD_contoso/configurationGroupSchemas/MyVM_Configuration_Schema"),
			},
		},
		ResourceElementTemplates: []armhybridnetwork.ResourceElementTemplateClassification{
			&armhybridnetwork.ArmResourceDefinitionResourceElementTemplateDetails{
				Name:                to.Ptr("MyVM"),
				ResourceElementType: to.Ptr(armhybridnetwork.TypeArmResourceDefinition),
				DependsOnProfile: &armhybridnetwork.DependsOnProfile{
					InstallDependsOn: []*string{},
				},
				Configuration: &armhybridnetwork.ArmResourceDefinitionResourceElementTemplate{
					ArtifactProfile: &armhybridnetwork.NSDArtifactProfile{
						ArtifactName: to.Ptr("MyVMArmTemplate"),
						ArtifactStoreReference: &armhybridnetwork.ReferencedResource{
							ID: to.Ptr("/subscriptions/subid/providers/Microsoft.HybridNetwork/publishers/contosoGroup/artifactStoreReference/store1"),
						},
						ArtifactVersion: to.Ptr("1.0.0"),
					},
					ParameterValues: to.Ptr("{\"publisherName\":\"{configurationparameters('MyVM_Configuration').publisherName}\",\"skuGroupName\":\"{configurationparameters('MyVM_Configuration').skuGroupName}\",\"skuVersion\":\"{configurationparameters('MyVM_Configuration').skuVersion}\",\"skuOfferingLocation\":\"{configurationparameters('MyVM_Configuration').skuOfferingLocation}\",\"nfviType\":\"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviType}\",\"nfviId\":\"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviId}\",\"allowSoftwareUpdates\":\"{configurationparameters('MyVM_Configuration').allowSoftwareUpdates}\",\"virtualNetworkName\":\"{configurationparameters('MyVM_Configuration').vnetName}\",\"subnetName\":\"{configurationparameters('MyVM_Configuration').subnetName}\",\"subnetAddressPrefix\":\"{configurationparameters('MyVM_Configuration').subnetAddressPrefix}\",\"managedResourceGroup\":\"{configurationparameters('SNSSelf').managedResourceGroupName}\",\"adminPassword\":\"{secretparameters('MyVM_Configuration').adminPassword}\"}"),
					TemplateType:    to.Ptr(armhybridnetwork.TemplateTypeArmTemplate),
				},
			}},
		VersionState: to.Ptr(armhybridnetwork.VersionStateActive),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkServiceDesignVersion = armhybridnetwork.NetworkServiceDesignVersion{
// 	Name: to.Ptr("TestVersion"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/networkServiceDesignGroups/networkServiceDesignVersions"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.0"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.NetworkServiceDesignVersionPropertiesFormat{
// 		ConfigurationGroupSchemaReferences: map[string]*armhybridnetwork.ReferencedResource{
// 			"MyVM_Configuration": &armhybridnetwork.ReferencedResource{
// 				ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/publishers/contosoGroup/networkServiceDesignGroups/NSD_contoso/configurationGroupSchemas/MyVM_Configuration_Schema"),
// 			},
// 		},
// 		ResourceElementTemplates: []armhybridnetwork.ResourceElementTemplateClassification{
// 			&armhybridnetwork.ArmResourceDefinitionResourceElementTemplateDetails{
// 				Name: to.Ptr("MyVM"),
// 				ResourceElementType: to.Ptr(armhybridnetwork.TypeArmResourceDefinition),
// 				DependsOnProfile: &armhybridnetwork.DependsOnProfile{
// 					InstallDependsOn: []*string{
// 					},
// 				},
// 				Configuration: &armhybridnetwork.ArmResourceDefinitionResourceElementTemplate{
// 					ArtifactProfile: &armhybridnetwork.NSDArtifactProfile{
// 						ArtifactName: to.Ptr("MyVMArmTemplate"),
// 						ArtifactStoreReference: &armhybridnetwork.ReferencedResource{
// 							ID: to.Ptr("/subscriptions/subid/providers/Microsoft.HybridNetwork/publishers/contosoGroup/artifactStoreReference/store1"),
// 						},
// 						ArtifactVersion: to.Ptr("1.0.0"),
// 					},
// 					ParameterValues: to.Ptr("{\"publisherName\":\"{configurationparameters('MyVM_Configuration').publisherName}\",\"skuGroupName\":\"{configurationparameters('MyVM_Configuration').skuGroupName}\",\"skuVersion\":\"{configurationparameters('MyVM_Configuration').skuVersion}\",\"skuOfferingLocation\":\"{configurationparameters('MyVM_Configuration').skuOfferingLocation}\",\"nfviType\":\"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviType}\",\"nfviId\":\"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviId}\",\"allowSoftwareUpdates\":\"{configurationparameters('MyVM_Configuration').allowSoftwareUpdates}\",\"virtualNetworkName\":\"{configurationparameters('MyVM_Configuration').vnetName}\",\"subnetName\":\"{configurationparameters('MyVM_Configuration').subnetName}\",\"subnetAddressPrefix\":\"{configurationparameters('MyVM_Configuration').subnetAddressPrefix}\",\"managedResourceGroup\":\"{configurationparameters('SNSSelf').managedResourceGroupName}\",\"adminPassword\":\"{secretparameters('MyVM_Configuration').adminPassword}\"}"),
// 					TemplateType: to.Ptr(armhybridnetwork.TemplateTypeArmTemplate),
// 				},
// 		}},
// 		VersionState: to.Ptr(armhybridnetwork.VersionStateActive),
// 	},
// }
Output:

func (*NetworkServiceDesignVersionsClient) BeginDelete

func (client *NetworkServiceDesignVersionsClient) BeginDelete(ctx context.Context, resourceGroupName string, publisherName string, networkServiceDesignGroupName string, networkServiceDesignVersionName string, options *NetworkServiceDesignVersionsClientBeginDeleteOptions) (*runtime.Poller[NetworkServiceDesignVersionsClientDeleteResponse], error)

BeginDelete - Deletes the specified network service design version. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkServiceDesignGroupName - The name of the network service design group.
  • networkServiceDesignVersionName - The name of the network service design version. The name should conform to the SemVer 2.0.0 specification: https://semver.org/spec/v2.0.0.html.
  • options - NetworkServiceDesignVersionsClientBeginDeleteOptions contains the optional parameters for the NetworkServiceDesignVersionsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkServiceDesignVersionsClient().BeginDelete(ctx, "rg", "TestPublisher", "TestNetworkServiceDesignGroupName", "1.0.0", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*NetworkServiceDesignVersionsClient) BeginUpdateState

func (client *NetworkServiceDesignVersionsClient) BeginUpdateState(ctx context.Context, resourceGroupName string, publisherName string, networkServiceDesignGroupName string, networkServiceDesignVersionName string, parameters NetworkServiceDesignVersionUpdateState, options *NetworkServiceDesignVersionsClientBeginUpdateStateOptions) (*runtime.Poller[NetworkServiceDesignVersionsClientUpdateStateResponse], error)

BeginUpdateState - Update network service design version state. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkServiceDesignGroupName - The name of the network service design group.
  • networkServiceDesignVersionName - The name of the network service design version. The name should conform to the SemVer 2.0.0 specification: https://semver.org/spec/v2.0.0.html.
  • parameters - Parameters supplied to update the state of network service design version.
  • options - NetworkServiceDesignVersionsClientBeginUpdateStateOptions contains the optional parameters for the NetworkServiceDesignVersionsClient.BeginUpdateState method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionUpdateState.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkServiceDesignVersionsClient().BeginUpdateState(ctx, "rg", "TestPublisher", "TestNetworkServiceDesignGroupName", "1.0.0", armhybridnetwork.NetworkServiceDesignVersionUpdateState{
	VersionState: to.Ptr(armhybridnetwork.VersionStateActive),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkServiceDesignVersionUpdateState = armhybridnetwork.NetworkServiceDesignVersionUpdateState{
// 	VersionState: to.Ptr(armhybridnetwork.VersionStateActive),
// }
Output:

func (*NetworkServiceDesignVersionsClient) Get

func (client *NetworkServiceDesignVersionsClient) Get(ctx context.Context, resourceGroupName string, publisherName string, networkServiceDesignGroupName string, networkServiceDesignVersionName string, options *NetworkServiceDesignVersionsClientGetOptions) (NetworkServiceDesignVersionsClientGetResponse, error)

Get - Gets information about a network service design version. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkServiceDesignGroupName - The name of the network service design group.
  • networkServiceDesignVersionName - The name of the network service design version. The name should conform to the SemVer 2.0.0 specification: https://semver.org/spec/v2.0.0.html.
  • options - NetworkServiceDesignVersionsClientGetOptions contains the optional parameters for the NetworkServiceDesignVersionsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNetworkServiceDesignVersionsClient().Get(ctx, "rg", "TestPublisher", "TestNetworkServiceDesignGroupName", "1.0.0", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkServiceDesignVersion = armhybridnetwork.NetworkServiceDesignVersion{
// 	Name: to.Ptr("TestVersion"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/networkServiceDesignGroups/networkServiceDesignVersions"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.0"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.NetworkServiceDesignVersionPropertiesFormat{
// 		ConfigurationGroupSchemaReferences: map[string]*armhybridnetwork.ReferencedResource{
// 			"MyVM_Configuration": &armhybridnetwork.ReferencedResource{
// 				ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/publishers/contosoGroup/networkServiceDesignGroups/NSD_contoso/configurationGroupSchemas/MyVM_Configuration_Schema"),
// 			},
// 		},
// 		NfvisFromSite: map[string]*armhybridnetwork.NfviDetails{
// 			"nfvi1": &armhybridnetwork.NfviDetails{
// 				Name: to.Ptr("{configurationparameter('MyVM_Configuration').nfviNameFromSite}"),
// 				Type: to.Ptr("AzureCore"),
// 			},
// 		},
// 		ResourceElementTemplates: []armhybridnetwork.ResourceElementTemplateClassification{
// 			&armhybridnetwork.ArmResourceDefinitionResourceElementTemplateDetails{
// 				Name: to.Ptr("MyVM"),
// 				ResourceElementType: to.Ptr(armhybridnetwork.TypeArmResourceDefinition),
// 				DependsOnProfile: &armhybridnetwork.DependsOnProfile{
// 					InstallDependsOn: []*string{
// 					},
// 				},
// 				Configuration: &armhybridnetwork.ArmResourceDefinitionResourceElementTemplate{
// 					ArtifactProfile: &armhybridnetwork.NSDArtifactProfile{
// 						ArtifactName: to.Ptr("MyVMArmTemplate"),
// 						ArtifactStoreReference: &armhybridnetwork.ReferencedResource{
// 							ID: to.Ptr("/subscriptions/subid/providers/Microsoft.HybridNetwork/publishers/contosoGroup/ArtifactStore/store1"),
// 						},
// 						ArtifactVersion: to.Ptr("1.0.0"),
// 					},
// 					ParameterValues: to.Ptr("{\"publisherName\":\"{configurationparameters('MyVM_Configuration').publisherName}\",\"skuGroupName\":\"{configurationparameters('MyVM_Configuration').skuGroupName}\",\"skuVersion\":\"{configurationparameters('MyVM_Configuration').skuVersion}\",\"skuOfferingLocation\":\"{configurationparameters('MyVM_Configuration').skuOfferingLocation}\",\"nfviType\":\"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviType}\",\"nfviId\":\"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviId}\",\"allowSoftwareUpdates\":\"{configurationparameters('MyVM_Configuration').allowSoftwareUpdates}\",\"virtualNetworkName\":\"{configurationparameters('MyVM_Configuration').vnetName}\",\"subnetName\":\"{configurationparameters('MyVM_Configuration').subnetName}\",\"subnetAddressPrefix\":\"{configurationparameters('MyVM_Configuration').subnetAddressPrefix}\",\"managedResourceGroup\":\"{configurationparameters('SNSSelf').managedResourceGroupName}\",\"adminPassword\":\"{secretparameters('MyVM_Configuration').adminPassword}\"}"),
// 					TemplateType: to.Ptr(armhybridnetwork.TemplateTypeArmTemplate),
// 				},
// 		}},
// 		VersionState: to.Ptr(armhybridnetwork.VersionStateActive),
// 	},
// }
Output:

func (*NetworkServiceDesignVersionsClient) NewListByNetworkServiceDesignGroupPager

func (client *NetworkServiceDesignVersionsClient) NewListByNetworkServiceDesignGroupPager(resourceGroupName string, publisherName string, networkServiceDesignGroupName string, options *NetworkServiceDesignVersionsClientListByNetworkServiceDesignGroupOptions) *runtime.Pager[NetworkServiceDesignVersionsClientListByNetworkServiceDesignGroupResponse]

NewListByNetworkServiceDesignGroupPager - Gets information about a list of network service design versions under a network service design group.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkServiceDesignGroupName - The name of the network service design group.
  • options - NetworkServiceDesignVersionsClientListByNetworkServiceDesignGroupOptions contains the optional parameters for the NetworkServiceDesignVersionsClient.NewListByNetworkServiceDesignGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionListByNetworkServiceDesignGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewNetworkServiceDesignVersionsClient().NewListByNetworkServiceDesignGroupPager("rg", "TestPublisher", "TestNetworkServiceDesignGroupName", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.NetworkServiceDesignVersionListResult = armhybridnetwork.NetworkServiceDesignVersionListResult{
	// 	Value: []*armhybridnetwork.NetworkServiceDesignVersion{
	// 		{
	// 			Name: to.Ptr("TestVersion"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/publishers/networkServiceDesignGroups/networkServiceDesignVersions"),
	// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.0"),
	// 			Location: to.Ptr("eastus"),
	// 			Properties: &armhybridnetwork.NetworkServiceDesignVersionPropertiesFormat{
	// 				ConfigurationGroupSchemaReferences: map[string]*armhybridnetwork.ReferencedResource{
	// 					"MyVM_Configuration": &armhybridnetwork.ReferencedResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/publishers/contosoGroup/networkServiceDesignGroups/NSD_contoso/configurationGroupSchemas/MyVM_Configuration_Schema"),
	// 					},
	// 				},
	// 				ResourceElementTemplates: []armhybridnetwork.ResourceElementTemplateClassification{
	// 					&armhybridnetwork.ArmResourceDefinitionResourceElementTemplateDetails{
	// 						Name: to.Ptr("MyVM"),
	// 						ResourceElementType: to.Ptr(armhybridnetwork.TypeArmResourceDefinition),
	// 						DependsOnProfile: &armhybridnetwork.DependsOnProfile{
	// 							InstallDependsOn: []*string{
	// 							},
	// 						},
	// 						Configuration: &armhybridnetwork.ArmResourceDefinitionResourceElementTemplate{
	// 							ArtifactProfile: &armhybridnetwork.NSDArtifactProfile{
	// 								ArtifactName: to.Ptr("MyVMArmTemplate"),
	// 								ArtifactStoreReference: &armhybridnetwork.ReferencedResource{
	// 									ID: to.Ptr("/subscriptions/subid/providers/Microsoft.HybridNetwork/publishers/contosoGroup/ArtifactStore/store1"),
	// 								},
	// 								ArtifactVersion: to.Ptr("1.0.0"),
	// 							},
	// 							ParameterValues: to.Ptr("\"publisherName\": \"{configurationparameters('MyVM_Configuration').publisherName}\",\r\n                \"skuGroupName\": \"{configurationparameters('MyVM_Configuration').skuGroupName}\",\r\n                \"skuVersion\": \"{configurationparameters('MyVM_Configuration').skuVersion}\",\r\n                \"skuOfferingLocation\": \"{configurationparameters('MyVM_Configuration').skuOfferingLocation}\",\r\n                \"nfviType\": \"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviType}\",\r\n                \"nfviId\": \"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviId}\",\r\n                \"allowSoftwareUpdates\": \"{configurationparameters('MyVM_Configuration').allowSoftwareUpdates}\",\r\n                \"virtualNetworkName\": \"{configurationparameters('MyVM_Configuration').vnetName}\",\r\n                \"subnetName\": \"{configurationparameters('MyVM_Configuration').subnetName}\",\r\n                \"subnetAddressPrefix\": \"{configurationparameters('MyVM_Configuration').subnetAddressPrefix}\",\r\n                \"managedResourceGroup\": \"{configurationparameters('SNSSelf').managedResourceGroupName}\"\r\n  "),
	// 							TemplateType: to.Ptr(armhybridnetwork.TemplateTypeArmTemplate),
	// 						},
	// 				}},
	// 				VersionState: to.Ptr(armhybridnetwork.VersionStateActive),
	// 			},
	// 	}},
	// }
}
Output:

func (*NetworkServiceDesignVersionsClient) Update

func (client *NetworkServiceDesignVersionsClient) Update(ctx context.Context, resourceGroupName string, publisherName string, networkServiceDesignGroupName string, networkServiceDesignVersionName string, parameters TagsObject, options *NetworkServiceDesignVersionsClientUpdateOptions) (NetworkServiceDesignVersionsClientUpdateResponse, error)

Update - Updates a network service design version resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • networkServiceDesignGroupName - The name of the network service design group.
  • networkServiceDesignVersionName - The name of the network service design version. The name should conform to the SemVer 2.0.0 specification: https://semver.org/spec/v2.0.0.html.
  • parameters - Parameters supplied to the create or update network service design version operation.
  • options - NetworkServiceDesignVersionsClientUpdateOptions contains the optional parameters for the NetworkServiceDesignVersionsClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/NetworkServiceDesignVersionUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewNetworkServiceDesignVersionsClient().Update(ctx, "rg", "TestPublisher", "TestNetworkServiceDesignGroupName", "1.0.0", armhybridnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.NetworkServiceDesignVersion = armhybridnetwork.NetworkServiceDesignVersion{
// 	Name: to.Ptr("TestVersion"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/networkServiceDesignGroups/networkServiceDesignVersions"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.0"),
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Properties: &armhybridnetwork.NetworkServiceDesignVersionPropertiesFormat{
// 		ConfigurationGroupSchemaReferences: map[string]*armhybridnetwork.ReferencedResource{
// 			"MyVM_Configuration": &armhybridnetwork.ReferencedResource{
// 				ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/publishers/contosoGroup/networkServiceDesignGroups/NSD_contoso/configurationGroupSchemas/MyVM_Configuration_Schema"),
// 			},
// 		},
// 		ResourceElementTemplates: []armhybridnetwork.ResourceElementTemplateClassification{
// 			&armhybridnetwork.ArmResourceDefinitionResourceElementTemplateDetails{
// 				Name: to.Ptr("MyVM"),
// 				ResourceElementType: to.Ptr(armhybridnetwork.TypeArmResourceDefinition),
// 				DependsOnProfile: &armhybridnetwork.DependsOnProfile{
// 					InstallDependsOn: []*string{
// 					},
// 				},
// 				Configuration: &armhybridnetwork.ArmResourceDefinitionResourceElementTemplate{
// 					ArtifactProfile: &armhybridnetwork.NSDArtifactProfile{
// 						ArtifactName: to.Ptr("MyVMArmTemplate"),
// 						ArtifactStoreReference: &armhybridnetwork.ReferencedResource{
// 							ID: to.Ptr("/subscriptions/subid/providers/Microsoft.HybridNetwork/publishers/contosoGroup/ArtifactStore/store1"),
// 						},
// 						ArtifactVersion: to.Ptr("1.0.0"),
// 					},
// 					ParameterValues: to.Ptr("\"publisherName\": \"{configurationparameters('MyVM_Configuration').publisherName}\",\r\n                \"skuGroupName\": \"{configurationparameters('MyVM_Configuration').skuGroupName}\",\r\n                \"skuVersion\": \"{configurationparameters('MyVM_Configuration').skuVersion}\",\r\n                \"skuOfferingLocation\": \"{configurationparameters('MyVM_Configuration').skuOfferingLocation}\",\r\n                \"nfviType\": \"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviType}\",\r\n                \"nfviId\": \"{nfvis().nfvisFromSitePerNfviType.AzureCore.nfviAlias1.nfviId}\",\r\n                \"allowSoftwareUpdates\": \"{configurationparameters('MyVM_Configuration').allowSoftwareUpdates}\",\r\n                \"virtualNetworkName\": \"{configurationparameters('MyVM_Configuration').vnetName}\",\r\n                \"subnetName\": \"{configurationparameters('MyVM_Configuration').subnetName}\",\r\n                \"subnetAddressPrefix\": \"{configurationparameters('MyVM_Configuration').subnetAddressPrefix}\",\r\n                \"managedResourceGroup\": \"{configurationparameters('SNSSelf').managedResourceGroupName}\"\r\n  "),
// 					TemplateType: to.Ptr(armhybridnetwork.TemplateTypeArmTemplate),
// 				},
// 		}},
// 		VersionState: to.Ptr(armhybridnetwork.VersionStateActive),
// 	},
// }
Output:

type NetworkServiceDesignVersionsClientBeginCreateOrUpdateOptions

type NetworkServiceDesignVersionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

NetworkServiceDesignVersionsClientBeginCreateOrUpdateOptions contains the optional parameters for the NetworkServiceDesignVersionsClient.BeginCreateOrUpdate method.

type NetworkServiceDesignVersionsClientBeginDeleteOptions

type NetworkServiceDesignVersionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

NetworkServiceDesignVersionsClientBeginDeleteOptions contains the optional parameters for the NetworkServiceDesignVersionsClient.BeginDelete method.

type NetworkServiceDesignVersionsClientBeginUpdateStateOptions

type NetworkServiceDesignVersionsClientBeginUpdateStateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

NetworkServiceDesignVersionsClientBeginUpdateStateOptions contains the optional parameters for the NetworkServiceDesignVersionsClient.BeginUpdateState method.

type NetworkServiceDesignVersionsClientCreateOrUpdateResponse

type NetworkServiceDesignVersionsClientCreateOrUpdateResponse struct {
	// network service design version.
	NetworkServiceDesignVersion
}

NetworkServiceDesignVersionsClientCreateOrUpdateResponse contains the response from method NetworkServiceDesignVersionsClient.BeginCreateOrUpdate.

type NetworkServiceDesignVersionsClientDeleteResponse

type NetworkServiceDesignVersionsClientDeleteResponse struct {
}

NetworkServiceDesignVersionsClientDeleteResponse contains the response from method NetworkServiceDesignVersionsClient.BeginDelete.

type NetworkServiceDesignVersionsClientGetOptions

type NetworkServiceDesignVersionsClientGetOptions struct {
}

NetworkServiceDesignVersionsClientGetOptions contains the optional parameters for the NetworkServiceDesignVersionsClient.Get method.

type NetworkServiceDesignVersionsClientGetResponse

type NetworkServiceDesignVersionsClientGetResponse struct {
	// network service design version.
	NetworkServiceDesignVersion
}

NetworkServiceDesignVersionsClientGetResponse contains the response from method NetworkServiceDesignVersionsClient.Get.

type NetworkServiceDesignVersionsClientListByNetworkServiceDesignGroupOptions

type NetworkServiceDesignVersionsClientListByNetworkServiceDesignGroupOptions struct {
}

NetworkServiceDesignVersionsClientListByNetworkServiceDesignGroupOptions contains the optional parameters for the NetworkServiceDesignVersionsClient.NewListByNetworkServiceDesignGroupPager method.

type NetworkServiceDesignVersionsClientListByNetworkServiceDesignGroupResponse

type NetworkServiceDesignVersionsClientListByNetworkServiceDesignGroupResponse struct {
	// A list of network service design versions.
	NetworkServiceDesignVersionListResult
}

NetworkServiceDesignVersionsClientListByNetworkServiceDesignGroupResponse contains the response from method NetworkServiceDesignVersionsClient.NewListByNetworkServiceDesignGroupPager.

type NetworkServiceDesignVersionsClientUpdateOptions

type NetworkServiceDesignVersionsClientUpdateOptions struct {
}

NetworkServiceDesignVersionsClientUpdateOptions contains the optional parameters for the NetworkServiceDesignVersionsClient.Update method.

type NetworkServiceDesignVersionsClientUpdateResponse

type NetworkServiceDesignVersionsClientUpdateResponse struct {
	// network service design version.
	NetworkServiceDesignVersion
}

NetworkServiceDesignVersionsClientUpdateResponse contains the response from method NetworkServiceDesignVersionsClient.Update.

type NetworkServiceDesignVersionsClientUpdateStateResponse

type NetworkServiceDesignVersionsClientUpdateStateResponse struct {
	// Publisher network service design version update request definition.
	NetworkServiceDesignVersionUpdateState
}

NetworkServiceDesignVersionsClientUpdateStateResponse contains the response from method NetworkServiceDesignVersionsClient.BeginUpdateState.

type NfviDetails

type NfviDetails struct {
	// The nfvi name.
	Name *string

	// The nfvi type.
	Type *string
}

NfviDetails - The nfvi details.

func (NfviDetails) MarshalJSON

func (n NfviDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NfviDetails.

func (*NfviDetails) UnmarshalJSON

func (n *NfviDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NfviDetails.

type OpenDeploymentResourceReference

type OpenDeploymentResourceReference struct {
	// REQUIRED; The resource reference arm id type.
	IDType *IDType

	// Resource ID.
	ID *string
}

OpenDeploymentResourceReference - Non secret deployment resource id reference.

func (*OpenDeploymentResourceReference) GetDeploymentResourceIDReference

func (o *OpenDeploymentResourceReference) GetDeploymentResourceIDReference() *DeploymentResourceIDReference

GetDeploymentResourceIDReference implements the DeploymentResourceIDReferenceClassification interface for type OpenDeploymentResourceReference.

func (OpenDeploymentResourceReference) MarshalJSON

func (o OpenDeploymentResourceReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OpenDeploymentResourceReference.

func (*OpenDeploymentResourceReference) UnmarshalJSON

func (o *OpenDeploymentResourceReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OpenDeploymentResourceReference.

type Operation

type Operation struct {
	// Localized display information for this particular operation.
	Display *OperationDisplay

	// READ-ONLY; Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
	ActionType *ActionType

	// READ-ONLY; Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane
	// operations.
	IsDataAction *bool

	// READ-ONLY; The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write",
	// "Microsoft.Compute/virtualMachines/capture/action"
	Name *string

	// READ-ONLY; The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default
	// value is "user,system"
	Origin *Origin
}

Operation - Details of a REST API operation, returned from the Resource Provider Operations API

func (Operation) MarshalJSON

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Operation.

func (*Operation) UnmarshalJSON

func (o *Operation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Operation.

type OperationDisplay

type OperationDisplay struct {
	// READ-ONLY; The short, localized friendly description of the operation; suitable for tool tips and detailed views.
	Description *string

	// READ-ONLY; The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual
	// Machine", "Restart Virtual Machine".
	Operation *string

	// READ-ONLY; The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft
	// Compute".
	Provider *string

	// READ-ONLY; The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job
	// Schedule Collections".
	Resource *string
}

OperationDisplay - Localized display information for this particular operation.

func (OperationDisplay) MarshalJSON

func (o OperationDisplay) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationDisplay.

func (*OperationDisplay) UnmarshalJSON

func (o *OperationDisplay) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.

type OperationListResult

type OperationListResult struct {
	// READ-ONLY; URL to get the next set of operation list results (if there are any).
	NextLink *string

	// READ-ONLY; List of operations supported by the resource provider
	Value []*Operation
}

OperationListResult - A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

func (OperationListResult) MarshalJSON

func (o OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

func (*OperationListResult) UnmarshalJSON

func (o *OperationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationListResult.

type OperationsClient

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationsClient) NewListPager

NewListPager - Gets a list of the operations.

Generated from API version 2023-09-01

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/GetOperations.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewOperationsClient().NewListPager(nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.OperationListResult = armhybridnetwork.OperationListResult{
	// 	Value: []*armhybridnetwork.Operation{
	// 		{
	// 			Name: to.Ptr("Microsoft.HybridNetwork/NetworkFunctions/read"),
	// 			Display: &armhybridnetwork.OperationDisplay{
	// 				Description: to.Ptr("Gets Nf"),
	// 				Operation: to.Ptr("Get Nf"),
	// 				Provider: to.Ptr("Microsoft Hybrid Network"),
	// 				Resource: to.Ptr("Nf"),
	// 			},
	// 	}},
	// }
}
Output:

type OperationsClientListOptions

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListResponse

type OperationsClientListResponse struct {
	// A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
	OperationListResult
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

type Origin

type Origin string

Origin - The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

const (
	OriginSystem     Origin = "system"
	OriginUser       Origin = "user"
	OriginUserSystem Origin = "user,system"
)

func PossibleOriginValues

func PossibleOriginValues() []Origin

PossibleOriginValues returns the possible values for the Origin const type.

type Pod

type Pod struct {
	// Creation Time of Pod.
	CreationTime *time.Time

	// Desired number of containers
	Desired *int32

	// Last 5 Pod events.
	Events []*PodEvent

	// The name of the Pod.
	Name *string

	// The namespace of the Pod.
	Namespace *string

	// Number of ready containers.
	Ready *int32

	// The status of a pod.
	Status *PodStatus
}

Pod - Helm Pod status properties.

func (Pod) MarshalJSON

func (p Pod) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Pod.

func (*Pod) UnmarshalJSON

func (p *Pod) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Pod.

type PodEvent

type PodEvent struct {
	// Event Last seen.
	LastSeenTime *time.Time

	// Event message.
	Message *string

	// Event reason.
	Reason *string

	// The type of pod event.
	Type *PodEventType
}

PodEvent - Pod Event properties.

func (PodEvent) MarshalJSON

func (p PodEvent) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PodEvent.

func (*PodEvent) UnmarshalJSON

func (p *PodEvent) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PodEvent.

type PodEventType

type PodEventType string

PodEventType - The type of pod event.

const (
	PodEventTypeNormal  PodEventType = "Normal"
	PodEventTypeWarning PodEventType = "Warning"
)

func PossiblePodEventTypeValues

func PossiblePodEventTypeValues() []PodEventType

PossiblePodEventTypeValues returns the possible values for the PodEventType const type.

type PodStatus

type PodStatus string

PodStatus - The status of a Pod.

const (
	PodStatusFailed      PodStatus = "Failed"
	PodStatusNotReady    PodStatus = "NotReady"
	PodStatusPending     PodStatus = "Pending"
	PodStatusRunning     PodStatus = "Running"
	PodStatusSucceeded   PodStatus = "Succeeded"
	PodStatusTerminating PodStatus = "Terminating"
	PodStatusUnknown     PodStatus = "Unknown"
)

func PossiblePodStatusValues

func PossiblePodStatusValues() []PodStatus

PossiblePodStatusValues returns the possible values for the PodStatus const type.

type ProvisioningState

type ProvisioningState string

ProvisioningState - The current provisioning state.

const (
	ProvisioningStateAccepted   ProvisioningState = "Accepted"
	ProvisioningStateCanceled   ProvisioningState = "Canceled"
	ProvisioningStateConverging ProvisioningState = "Converging"
	ProvisioningStateDeleted    ProvisioningState = "Deleted"
	ProvisioningStateDeleting   ProvisioningState = "Deleting"
	ProvisioningStateFailed     ProvisioningState = "Failed"
	ProvisioningStateSucceeded  ProvisioningState = "Succeeded"
	ProvisioningStateUnknown    ProvisioningState = "Unknown"
)

func PossibleProvisioningStateValues

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type ProxyArtifactClient

type ProxyArtifactClient struct {
	// contains filtered or unexported fields
}

ProxyArtifactClient contains the methods for the ProxyArtifact group. Don't use this type directly, use NewProxyArtifactClient() instead.

func NewProxyArtifactClient

func NewProxyArtifactClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ProxyArtifactClient, error)

NewProxyArtifactClient creates a new instance of ProxyArtifactClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ProxyArtifactClient) BeginUpdateState

func (client *ProxyArtifactClient) BeginUpdateState(ctx context.Context, resourceGroupName string, publisherName string, artifactStoreName string, artifactName string, artifactVersionName string, parameters ArtifactChangeState, options *ProxyArtifactClientBeginUpdateStateOptions) (*runtime.Poller[ProxyArtifactClientUpdateStateResponse], error)

BeginUpdateState - Change artifact state defined in artifact store. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • artifactStoreName - The name of the artifact store.
  • artifactName - The name of the artifact.
  • artifactVersionName - The name of the artifact version.
  • parameters - Parameters supplied to update the state of artifact manifest.
  • options - ProxyArtifactClientBeginUpdateStateOptions contains the optional parameters for the ProxyArtifactClient.BeginUpdateState method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PureProxyArtifact/ArtifactChangeState.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewProxyArtifactClient().BeginUpdateState(ctx, "TestResourceGroup", "TestPublisher", "TestArtifactStoreName", "fedrbac", "1.0.0", armhybridnetwork.ArtifactChangeState{
	Properties: &armhybridnetwork.ArtifactChangeStateProperties{
		ArtifactState: to.Ptr(armhybridnetwork.ArtifactStateDeprecated),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ProxyArtifactVersionsListOverview = armhybridnetwork.ProxyArtifactVersionsListOverview{
// 	Name: to.Ptr("fedrbac"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers/artifactStores/artifactVersions"),
// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/TestResourceGroup/providers/Microsoft.HybridNetwork/publishers/TestPublisher/artifactStores/TestArtifactStore/artifactVersions/1.0.0"),
// 	Properties: &armhybridnetwork.ProxyArtifactOverviewPropertiesValue{
// 		ArtifactState: to.Ptr(armhybridnetwork.ArtifactStateDeprecated),
// 		ArtifactType: to.Ptr(armhybridnetwork.ArtifactTypeOCIArtifact),
// 		ArtifactVersion: to.Ptr("1.0.0"),
// 	},
// }
Output:

func (*ProxyArtifactClient) NewGetPager

func (client *ProxyArtifactClient) NewGetPager(resourceGroupName string, publisherName string, artifactStoreName string, artifactName string, options *ProxyArtifactClientGetOptions) *runtime.Pager[ProxyArtifactClientGetResponse]

NewGetPager - Get a Artifact overview information.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • artifactStoreName - The name of the artifact store.
  • artifactName - The name of the artifact.
  • options - ProxyArtifactClientGetOptions contains the optional parameters for the ProxyArtifactClient.NewGetPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PureProxyArtifact/ArtifactGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewProxyArtifactClient().NewGetPager("TestResourceGroup", "TestPublisher", "TestArtifactStoreName", "fedrbac", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ProxyArtifactVersionsOverviewListResult = armhybridnetwork.ProxyArtifactVersionsOverviewListResult{
	// 	Value: []*armhybridnetwork.ProxyArtifactVersionsListOverview{
	// 		{
	// 			Name: to.Ptr("fedrbac"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/publishers/artifactStores/artifactVersions"),
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/TestResourceGroup/providers/Microsoft.HybridNetwork/publishers/TestPublisher/artifactStores/TestArtifactStore/artifactVersions"),
	// 			Properties: &armhybridnetwork.ProxyArtifactOverviewPropertiesValue{
	// 				ArtifactState: to.Ptr(armhybridnetwork.ArtifactStateDeprecated),
	// 				ArtifactType: to.Ptr(armhybridnetwork.ArtifactTypeOCIArtifact),
	// 				ArtifactVersion: to.Ptr("1.0.0"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("fedrbac"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/publishers/artifactStores/artifactVersions"),
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/TestResourceGroup/providers/Microsoft.HybridNetwork/publishers/TestPublisher/artifactStores/TestArtifactStore/artifactVersions"),
	// 			Properties: &armhybridnetwork.ProxyArtifactOverviewPropertiesValue{
	// 				ArtifactState: to.Ptr(armhybridnetwork.ArtifactStateActive),
	// 				ArtifactType: to.Ptr(armhybridnetwork.ArtifactTypeOCIArtifact),
	// 				ArtifactVersion: to.Ptr("2.0.0"),
	// 			},
	// 	}},
	// }
}
Output:

func (*ProxyArtifactClient) NewListPager

func (client *ProxyArtifactClient) NewListPager(resourceGroupName string, publisherName string, artifactStoreName string, options *ProxyArtifactClientListOptions) *runtime.Pager[ProxyArtifactClientListResponse]

NewListPager - Lists all the available artifacts in the parent Artifact Store.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • artifactStoreName - The name of the artifact store.
  • options - ProxyArtifactClientListOptions contains the optional parameters for the ProxyArtifactClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PureProxyArtifact/ArtifactList.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewProxyArtifactClient().NewListPager("TestResourceGroup", "TestPublisher", "TestArtifactStoreName", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ProxyArtifactOverviewListResult = armhybridnetwork.ProxyArtifactOverviewListResult{
	// 	Value: []*armhybridnetwork.ProxyArtifactListOverview{
	// 		{
	// 			Name: to.Ptr("fedrbac1"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/publishers/artifactStores/artifactVersions"),
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/TestResourceGroup/providers/Microsoft.HybridNetwork/publishers/TestPublisher/artifactStores/TestArtifactStore/artifactVersions"),
	// 		},
	// 		{
	// 			Name: to.Ptr("fedrbac2"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/publishers/artifactStores/artifactVersions"),
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/TestResourceGroup/providers/Microsoft.HybridNetwork/publishers/TestPublisher/artifactStores/TestArtifactStore/artifactVersions"),
	// 	}},
	// }
}
Output:

type ProxyArtifactClientBeginUpdateStateOptions

type ProxyArtifactClientBeginUpdateStateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ProxyArtifactClientBeginUpdateStateOptions contains the optional parameters for the ProxyArtifactClient.BeginUpdateState method.

type ProxyArtifactClientGetOptions

type ProxyArtifactClientGetOptions struct {
}

ProxyArtifactClientGetOptions contains the optional parameters for the ProxyArtifactClient.NewGetPager method.

type ProxyArtifactClientGetResponse

type ProxyArtifactClientGetResponse struct {
	// The proxy artifact list result.
	ProxyArtifactVersionsOverviewListResult
}

ProxyArtifactClientGetResponse contains the response from method ProxyArtifactClient.NewGetPager.

type ProxyArtifactClientListOptions

type ProxyArtifactClientListOptions struct {
}

ProxyArtifactClientListOptions contains the optional parameters for the ProxyArtifactClient.NewListPager method.

type ProxyArtifactClientListResponse

type ProxyArtifactClientListResponse struct {
	// The proxy artifact list result.
	ProxyArtifactOverviewListResult
}

ProxyArtifactClientListResponse contains the response from method ProxyArtifactClient.NewListPager.

type ProxyArtifactClientUpdateStateResponse

type ProxyArtifactClientUpdateStateResponse struct {
	// The proxy artifact overview.
	ProxyArtifactVersionsListOverview
}

ProxyArtifactClientUpdateStateResponse contains the response from method ProxyArtifactClient.BeginUpdateState.

type ProxyArtifactListOverview

type ProxyArtifactListOverview struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ProxyArtifactListOverview - The proxy artifact overview.

func (ProxyArtifactListOverview) MarshalJSON

func (p ProxyArtifactListOverview) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProxyArtifactListOverview.

func (*ProxyArtifactListOverview) UnmarshalJSON

func (p *ProxyArtifactListOverview) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProxyArtifactListOverview.

type ProxyArtifactOverviewListResult

type ProxyArtifactOverviewListResult struct {
	// A list of available proxy artifacts.
	Value []*ProxyArtifactListOverview

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string
}

ProxyArtifactOverviewListResult - The proxy artifact list result.

func (ProxyArtifactOverviewListResult) MarshalJSON

func (p ProxyArtifactOverviewListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProxyArtifactOverviewListResult.

func (*ProxyArtifactOverviewListResult) UnmarshalJSON

func (p *ProxyArtifactOverviewListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProxyArtifactOverviewListResult.

type ProxyArtifactOverviewPropertiesValue

type ProxyArtifactOverviewPropertiesValue struct {
	// The artifact state
	ArtifactState *ArtifactState

	// The artifact type.
	ArtifactType *ArtifactType

	// The artifact version.
	ArtifactVersion *string
}

func (ProxyArtifactOverviewPropertiesValue) MarshalJSON

func (p ProxyArtifactOverviewPropertiesValue) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProxyArtifactOverviewPropertiesValue.

func (*ProxyArtifactOverviewPropertiesValue) UnmarshalJSON

func (p *ProxyArtifactOverviewPropertiesValue) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProxyArtifactOverviewPropertiesValue.

type ProxyArtifactVersionsListOverview

type ProxyArtifactVersionsListOverview struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Proxy Artifact overview properties.
	Properties *ProxyArtifactOverviewPropertiesValue

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ProxyArtifactVersionsListOverview - The proxy artifact overview.

func (ProxyArtifactVersionsListOverview) MarshalJSON

func (p ProxyArtifactVersionsListOverview) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProxyArtifactVersionsListOverview.

func (*ProxyArtifactVersionsListOverview) UnmarshalJSON

func (p *ProxyArtifactVersionsListOverview) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProxyArtifactVersionsListOverview.

type ProxyArtifactVersionsOverviewListResult

type ProxyArtifactVersionsOverviewListResult struct {
	// A list of available proxy artifacts.
	Value []*ProxyArtifactVersionsListOverview

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string
}

ProxyArtifactVersionsOverviewListResult - The proxy artifact list result.

func (ProxyArtifactVersionsOverviewListResult) MarshalJSON

func (p ProxyArtifactVersionsOverviewListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProxyArtifactVersionsOverviewListResult.

func (*ProxyArtifactVersionsOverviewListResult) UnmarshalJSON

func (p *ProxyArtifactVersionsOverviewListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProxyArtifactVersionsOverviewListResult.

type Publisher

type Publisher struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// The managed identity of the publisher, if configured.
	Identity *ManagedServiceIdentity

	// Publisher properties.
	Properties *PublisherPropertiesFormat

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Publisher - publisher resource.

func (Publisher) MarshalJSON

func (p Publisher) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Publisher.

func (*Publisher) UnmarshalJSON

func (p *Publisher) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Publisher.

type PublisherListResult

type PublisherListResult struct {
	// A list of publishers.
	Value []*Publisher

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string
}

PublisherListResult - A list of publishers.

func (PublisherListResult) MarshalJSON

func (p PublisherListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PublisherListResult.

func (*PublisherListResult) UnmarshalJSON

func (p *PublisherListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PublisherListResult.

type PublisherPropertiesFormat

type PublisherPropertiesFormat struct {
	// The publisher scope.
	Scope *PublisherScope

	// READ-ONLY; The provisioning state of the publisher resource.
	ProvisioningState *ProvisioningState
}

PublisherPropertiesFormat - publisher properties.

func (PublisherPropertiesFormat) MarshalJSON

func (p PublisherPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PublisherPropertiesFormat.

func (*PublisherPropertiesFormat) UnmarshalJSON

func (p *PublisherPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PublisherPropertiesFormat.

type PublisherScope

type PublisherScope string

PublisherScope - Publisher Scope.

const (
	PublisherScopePrivate PublisherScope = "Private"
	PublisherScopeUnknown PublisherScope = "Unknown"
)

func PossiblePublisherScopeValues

func PossiblePublisherScopeValues() []PublisherScope

PossiblePublisherScopeValues returns the possible values for the PublisherScope const type.

type PublishersClient

type PublishersClient struct {
	// contains filtered or unexported fields
}

PublishersClient contains the methods for the Publishers group. Don't use this type directly, use NewPublishersClient() instead.

func NewPublishersClient

func NewPublishersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PublishersClient, error)

NewPublishersClient creates a new instance of PublishersClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PublishersClient) BeginCreateOrUpdate

func (client *PublishersClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, publisherName string, options *PublishersClientBeginCreateOrUpdateOptions) (*runtime.Poller[PublishersClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a publisher. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • options - PublishersClientBeginCreateOrUpdateOptions contains the optional parameters for the PublishersClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPublishersClient().BeginCreateOrUpdate(ctx, "rg", "TestPublisher", &armhybridnetwork.PublishersClientBeginCreateOrUpdateOptions{Parameters: &armhybridnetwork.Publisher{
	Location: to.Ptr("eastus"),
	Properties: &armhybridnetwork.PublisherPropertiesFormat{
		Scope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
	},
},
})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Publisher = armhybridnetwork.Publisher{
// 	Name: to.Ptr("TestPublisher"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.PublisherPropertiesFormat{
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		Scope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
// 	},
// }
Output:

func (*PublishersClient) BeginDelete

func (client *PublishersClient) BeginDelete(ctx context.Context, resourceGroupName string, publisherName string, options *PublishersClientBeginDeleteOptions) (*runtime.Poller[PublishersClientDeleteResponse], error)

BeginDelete - Deletes the specified publisher. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • options - PublishersClientBeginDeleteOptions contains the optional parameters for the PublishersClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPublishersClient().BeginDelete(ctx, "rg", "TestPublisher", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*PublishersClient) Get

func (client *PublishersClient) Get(ctx context.Context, resourceGroupName string, publisherName string, options *PublishersClientGetOptions) (PublishersClientGetResponse, error)

Get - Gets information about the specified publisher. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • options - PublishersClientGetOptions contains the optional parameters for the PublishersClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPublishersClient().Get(ctx, "rg", "TestPublisher", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Publisher = armhybridnetwork.Publisher{
// 	Name: to.Ptr("TestPublisher"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher"),
// 	Location: to.Ptr("eastus"),
// 	Properties: &armhybridnetwork.PublisherPropertiesFormat{
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		Scope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
// 	},
// }
Output:

func (*PublishersClient) NewListByResourceGroupPager

func (client *PublishersClient) NewListByResourceGroupPager(resourceGroupName string, options *PublishersClientListByResourceGroupOptions) *runtime.Pager[PublishersClientListByResourceGroupResponse]

NewListByResourceGroupPager - Lists all the publishers in a resource group.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - PublishersClientListByResourceGroupOptions contains the optional parameters for the PublishersClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPublishersClient().NewListByResourceGroupPager("rg", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.PublisherListResult = armhybridnetwork.PublisherListResult{
	// 	Value: []*armhybridnetwork.Publisher{
	// 		{
	// 			Name: to.Ptr("TestPublisher"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/publishers"),
	// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher"),
	// 			Location: to.Ptr("eastus"),
	// 			Properties: &armhybridnetwork.PublisherPropertiesFormat{
	// 				ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
	// 				Scope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("TestPublisher2"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/publishers"),
	// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher2"),
	// 			Location: to.Ptr("eastus"),
	// 			Properties: &armhybridnetwork.PublisherPropertiesFormat{
	// 				ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
	// 				Scope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
	// 			},
	// 	}},
	// }
}
Output:

func (*PublishersClient) NewListBySubscriptionPager

NewListBySubscriptionPager - Lists all the publishers in a subscription.

Generated from API version 2023-09-01

  • options - PublishersClientListBySubscriptionOptions contains the optional parameters for the PublishersClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherListBySubscription.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPublishersClient().NewListBySubscriptionPager(nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.PublisherListResult = armhybridnetwork.PublisherListResult{
	// 	Value: []*armhybridnetwork.Publisher{
	// 		{
	// 			Name: to.Ptr("TestPublisher"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/publishers"),
	// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher"),
	// 			Location: to.Ptr("eastus"),
	// 			Properties: &armhybridnetwork.PublisherPropertiesFormat{
	// 				ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
	// 				Scope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("TestPublisher2"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/publishers"),
	// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher2"),
	// 			Location: to.Ptr("eastus"),
	// 			Properties: &armhybridnetwork.PublisherPropertiesFormat{
	// 				ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
	// 				Scope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
	// 			},
	// 	}},
	// }
}
Output:

func (*PublishersClient) Update

func (client *PublishersClient) Update(ctx context.Context, resourceGroupName string, publisherName string, options *PublishersClientUpdateOptions) (PublishersClientUpdateResponse, error)

Update - Update a publisher resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • publisherName - The name of the publisher.
  • options - PublishersClientUpdateOptions contains the optional parameters for the PublishersClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/PublisherUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPublishersClient().Update(ctx, "rg", "TestPublisher", &armhybridnetwork.PublishersClientUpdateOptions{Parameters: &armhybridnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
},
})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Publisher = armhybridnetwork.Publisher{
// 	Name: to.Ptr("TestPublisher"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/publishers"),
// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher"),
// 	Location: to.Ptr("eastus"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Properties: &armhybridnetwork.PublisherPropertiesFormat{
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		Scope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
// 	},
// }
Output:

type PublishersClientBeginCreateOrUpdateOptions

type PublishersClientBeginCreateOrUpdateOptions struct {
	// Parameters supplied to the create publisher operation.
	Parameters *Publisher

	// Resumes the LRO from the provided token.
	ResumeToken string
}

PublishersClientBeginCreateOrUpdateOptions contains the optional parameters for the PublishersClient.BeginCreateOrUpdate method.

type PublishersClientBeginDeleteOptions

type PublishersClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PublishersClientBeginDeleteOptions contains the optional parameters for the PublishersClient.BeginDelete method.

type PublishersClientCreateOrUpdateResponse

type PublishersClientCreateOrUpdateResponse struct {
	// publisher resource.
	Publisher
}

PublishersClientCreateOrUpdateResponse contains the response from method PublishersClient.BeginCreateOrUpdate.

type PublishersClientDeleteResponse

type PublishersClientDeleteResponse struct {
}

PublishersClientDeleteResponse contains the response from method PublishersClient.BeginDelete.

type PublishersClientGetOptions

type PublishersClientGetOptions struct {
}

PublishersClientGetOptions contains the optional parameters for the PublishersClient.Get method.

type PublishersClientGetResponse

type PublishersClientGetResponse struct {
	// publisher resource.
	Publisher
}

PublishersClientGetResponse contains the response from method PublishersClient.Get.

type PublishersClientListByResourceGroupOptions

type PublishersClientListByResourceGroupOptions struct {
}

PublishersClientListByResourceGroupOptions contains the optional parameters for the PublishersClient.NewListByResourceGroupPager method.

type PublishersClientListByResourceGroupResponse

type PublishersClientListByResourceGroupResponse struct {
	// A list of publishers.
	PublisherListResult
}

PublishersClientListByResourceGroupResponse contains the response from method PublishersClient.NewListByResourceGroupPager.

type PublishersClientListBySubscriptionOptions

type PublishersClientListBySubscriptionOptions struct {
}

PublishersClientListBySubscriptionOptions contains the optional parameters for the PublishersClient.NewListBySubscriptionPager method.

type PublishersClientListBySubscriptionResponse

type PublishersClientListBySubscriptionResponse struct {
	// A list of publishers.
	PublisherListResult
}

PublishersClientListBySubscriptionResponse contains the response from method PublishersClient.NewListBySubscriptionPager.

type PublishersClientUpdateOptions

type PublishersClientUpdateOptions struct {
	// Parameters supplied to the create publisher operation.
	Parameters *TagsObject
}

PublishersClientUpdateOptions contains the optional parameters for the PublishersClient.Update method.

type PublishersClientUpdateResponse

type PublishersClientUpdateResponse struct {
	// publisher resource.
	Publisher
}

PublishersClientUpdateResponse contains the response from method PublishersClient.Update.

type ReferencedResource

type ReferencedResource struct {
	// Resource ID.
	ID *string
}

ReferencedResource - Reference to another resource.

func (ReferencedResource) MarshalJSON

func (r ReferencedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReferencedResource.

func (*ReferencedResource) UnmarshalJSON

func (r *ReferencedResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReferencedResource.

type ReplicaSet

type ReplicaSet struct {
	// Creation Time of replicaSet.
	CreationTime *time.Time

	// Number of current pods.
	Current *int32

	// Desired number of pods
	Desired *int32

	// The name of the replicaSet.
	Name *string

	// The namespace of the replicaSet.
	Namespace *string

	// Number of ready pods.
	Ready *int32
}

ReplicaSet - Helm ReplicaSet status properties.

func (ReplicaSet) MarshalJSON

func (r ReplicaSet) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ReplicaSet.

func (*ReplicaSet) UnmarshalJSON

func (r *ReplicaSet) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ReplicaSet.

type RequestMetadata

type RequestMetadata struct {
	// REQUIRED; The http method of the request.
	HTTPMethod *HTTPMethod

	// REQUIRED; The relative path of the request.
	RelativePath *string

	// REQUIRED; The serialized body of the request.
	SerializedBody *string

	// The api version of the request.
	APIVersion *string
}

RequestMetadata - Request metadata of execute request post call payload.

func (RequestMetadata) MarshalJSON

func (r RequestMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RequestMetadata.

func (*RequestMetadata) UnmarshalJSON

func (r *RequestMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RequestMetadata.

type ResourceElementTemplate

type ResourceElementTemplate struct {
	// REQUIRED; The resource element template type.
	ResourceElementType *Type

	// The depends on profile.
	DependsOnProfile *DependsOnProfile

	// Name of the resource element template.
	Name *string
}

ResourceElementTemplate - The resource element template object.

func (*ResourceElementTemplate) GetResourceElementTemplate

func (r *ResourceElementTemplate) GetResourceElementTemplate() *ResourceElementTemplate

GetResourceElementTemplate implements the ResourceElementTemplateClassification interface for type ResourceElementTemplate.

func (ResourceElementTemplate) MarshalJSON

func (r ResourceElementTemplate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceElementTemplate.

func (*ResourceElementTemplate) UnmarshalJSON

func (r *ResourceElementTemplate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceElementTemplate.

type ResourceElementTemplateClassification

type ResourceElementTemplateClassification interface {
	// GetResourceElementTemplate returns the ResourceElementTemplate content of the underlying type.
	GetResourceElementTemplate() *ResourceElementTemplate
}

ResourceElementTemplateClassification provides polymorphic access to related types. Call the interface's GetResourceElementTemplate() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ArmResourceDefinitionResourceElementTemplateDetails, *NetworkFunctionDefinitionResourceElementTemplateDetails, *ResourceElementTemplate

type Resources

type Resources struct {
	// Daemonsets related to component resource.
	DaemonSets []*DaemonSet

	// Deployments that are related to component resource.
	Deployments []*Deployment

	// Pods related to component resource.
	Pods []*Pod

	// Replica sets related to component resource.
	ReplicaSets []*ReplicaSet

	// Stateful sets related to component resource.
	StatefulSets []*StatefulSet
}

Resources - The resources of the network function component.

func (Resources) MarshalJSON

func (r Resources) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Resources.

func (*Resources) UnmarshalJSON

func (r *Resources) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Resources.

type SKU

type SKU struct {
	// REQUIRED; Name of this Sku
	Name *SKUName

	// READ-ONLY; The SKU tier based on the SKU name.
	Tier *SKUTier
}

SKU - Sku, to be associated with a SiteNetworkService.

func (SKU) MarshalJSON

func (s SKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKU.

func (*SKU) UnmarshalJSON

func (s *SKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SKU.

type SKUName

type SKUName string

SKUName - Name of this Sku

const (
	SKUNameBasic    SKUName = "Basic"
	SKUNameStandard SKUName = "Standard"
)

func PossibleSKUNameValues

func PossibleSKUNameValues() []SKUName

PossibleSKUNameValues returns the possible values for the SKUName const type.

type SKUTier

type SKUTier string

SKUTier - The SKU tier based on the SKU name.

const (
	SKUTierBasic    SKUTier = "Basic"
	SKUTierStandard SKUTier = "Standard"
)

func PossibleSKUTierValues

func PossibleSKUTierValues() []SKUTier

PossibleSKUTierValues returns the possible values for the SKUTier const type.

type SecretDeploymentResourceReference

type SecretDeploymentResourceReference struct {
	// REQUIRED; The resource reference arm id type.
	IDType *IDType

	// Resource ID.
	ID *string
}

SecretDeploymentResourceReference - Secret deployment resource id reference.

func (*SecretDeploymentResourceReference) GetDeploymentResourceIDReference

func (s *SecretDeploymentResourceReference) GetDeploymentResourceIDReference() *DeploymentResourceIDReference

GetDeploymentResourceIDReference implements the DeploymentResourceIDReferenceClassification interface for type SecretDeploymentResourceReference.

func (SecretDeploymentResourceReference) MarshalJSON

func (s SecretDeploymentResourceReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecretDeploymentResourceReference.

func (*SecretDeploymentResourceReference) UnmarshalJSON

func (s *SecretDeploymentResourceReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecretDeploymentResourceReference.

type Site

type Site struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// Site properties.
	Properties *SitePropertiesFormat

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Site resource.

func (Site) MarshalJSON

func (s Site) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Site.

func (*Site) UnmarshalJSON

func (s *Site) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Site.

type SiteListResult

type SiteListResult struct {
	// A list of sites in a resource group.
	Value []*Site

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string
}

SiteListResult - Response for sites API service call.

func (SiteListResult) MarshalJSON

func (s SiteListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SiteListResult.

func (*SiteListResult) UnmarshalJSON

func (s *SiteListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SiteListResult.

type SiteNetworkService

type SiteNetworkService struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// The managed identity of the Site network service, if configured.
	Identity *ManagedServiceIdentity

	// Site network service properties.
	Properties *SiteNetworkServicePropertiesFormat

	// Sku of the site network service.
	SKU *SKU

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SiteNetworkService - Site network service resource.

func (SiteNetworkService) MarshalJSON

func (s SiteNetworkService) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SiteNetworkService.

func (*SiteNetworkService) UnmarshalJSON

func (s *SiteNetworkService) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SiteNetworkService.

type SiteNetworkServiceListResult

type SiteNetworkServiceListResult struct {
	// A list of site network services in a resource group.
	Value []*SiteNetworkService

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string
}

SiteNetworkServiceListResult - Response for site network services API service call.

func (SiteNetworkServiceListResult) MarshalJSON

func (s SiteNetworkServiceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SiteNetworkServiceListResult.

func (*SiteNetworkServiceListResult) UnmarshalJSON

func (s *SiteNetworkServiceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SiteNetworkServiceListResult.

type SiteNetworkServicePropertiesFormat

type SiteNetworkServicePropertiesFormat struct {
	// The goal state of the site network service resource. This has references to the configuration group value objects that
	// describe the desired state of the site network service.
	DesiredStateConfigurationGroupValueReferences map[string]*ReferencedResource

	// Managed resource group configuration.
	ManagedResourceGroupConfiguration *ManagedResourceGroupConfiguration

	// The network service design version resource reference.
	NetworkServiceDesignVersionResourceReference DeploymentResourceIDReferenceClassification

	// The site details
	SiteReference *ReferencedResource

	// READ-ONLY; The last state of the site network service resource.
	LastStateConfigurationGroupValueReferences map[string]*ReferencedResource

	// READ-ONLY; The network service design version for the site network service.
	LastStateNetworkServiceDesignVersionName *string

	// READ-ONLY; The network service design group name for the site network service.
	NetworkServiceDesignGroupName *string

	// READ-ONLY; The network service design version for the site network service.
	NetworkServiceDesignVersionName *string

	// READ-ONLY; The location of the network service design offering.
	NetworkServiceDesignVersionOfferingLocation *string

	// READ-ONLY; The provisioning state of the site network service resource.
	ProvisioningState *ProvisioningState

	// READ-ONLY; The publisher name for the site network service.
	PublisherName *string

	// READ-ONLY; The scope of the publisher.
	PublisherScope *PublisherScope
}

SiteNetworkServicePropertiesFormat - Site network service properties.

func (SiteNetworkServicePropertiesFormat) MarshalJSON

func (s SiteNetworkServicePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SiteNetworkServicePropertiesFormat.

func (*SiteNetworkServicePropertiesFormat) UnmarshalJSON

func (s *SiteNetworkServicePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SiteNetworkServicePropertiesFormat.

type SiteNetworkServicesClient

type SiteNetworkServicesClient struct {
	// contains filtered or unexported fields
}

SiteNetworkServicesClient contains the methods for the SiteNetworkServices group. Don't use this type directly, use NewSiteNetworkServicesClient() instead.

func NewSiteNetworkServicesClient

func NewSiteNetworkServicesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SiteNetworkServicesClient, error)

NewSiteNetworkServicesClient creates a new instance of SiteNetworkServicesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SiteNetworkServicesClient) BeginCreateOrUpdate

BeginCreateOrUpdate - Creates or updates a network site. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • siteNetworkServiceName - The name of the site network service.
  • parameters - Parameters supplied to the create or update site network service operation.
  • options - SiteNetworkServicesClientBeginCreateOrUpdateOptions contains the optional parameters for the SiteNetworkServicesClient.BeginCreateOrUpdate method.
Example (CreateFirstPartySiteNetworkService)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceFirstPartyCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSiteNetworkServicesClient().BeginCreateOrUpdate(ctx, "rg1", "testSiteNetworkServiceName", armhybridnetwork.SiteNetworkService{
	Location: to.Ptr("westUs2"),
	Properties: &armhybridnetwork.SiteNetworkServicePropertiesFormat{
		DesiredStateConfigurationGroupValueReferences: map[string]*armhybridnetwork.ReferencedResource{
			"MyVM_Configuration": {
				ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1"),
			},
		},
		NetworkServiceDesignVersionResourceReference: &armhybridnetwork.SecretDeploymentResourceReference{
			IDType: to.Ptr(armhybridnetwork.IDTypeSecret),
			ID:     to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.0"),
		},
		SiteReference: &armhybridnetwork.ReferencedResource{
			ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite"),
		},
	},
	SKU: &armhybridnetwork.SKU{
		Name: to.Ptr(armhybridnetwork.SKUNameStandard),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.SiteNetworkService = armhybridnetwork.SiteNetworkService{
// 	Name: to.Ptr("testSiteNetworkServiceName"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/siteNetworkServices"),
// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName"),
// 	SystemData: &armhybridnetwork.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("westUs2"),
// 	Properties: &armhybridnetwork.SiteNetworkServicePropertiesFormat{
// 		DesiredStateConfigurationGroupValueReferences: map[string]*armhybridnetwork.ReferencedResource{
// 			"MyVM_Configuration": &armhybridnetwork.ReferencedResource{
// 				ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1"),
// 			},
// 		},
// 		NetworkServiceDesignGroupName: to.Ptr("testNetworkServiceDesignGroupName"),
// 		NetworkServiceDesignVersionName: to.Ptr("1.0.1"),
// 		NetworkServiceDesignVersionOfferingLocation: to.Ptr("eastus"),
// 		NetworkServiceDesignVersionResourceReference: &armhybridnetwork.SecretDeploymentResourceReference{
// 			IDType: to.Ptr(armhybridnetwork.IDTypeSecret),
// 		},
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		PublisherName: to.Ptr("testPublisher"),
// 		PublisherScope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
// 		SiteReference: &armhybridnetwork.ReferencedResource{
// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite"),
// 		},
// 	},
// 	SKU: &armhybridnetwork.SKU{
// 		Name: to.Ptr(armhybridnetwork.SKUNameStandard),
// 		Tier: to.Ptr(armhybridnetwork.SKUTierStandard),
// 	},
// }
Output:

Example (CreateSiteNetworkService)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSiteNetworkServicesClient().BeginCreateOrUpdate(ctx, "rg1", "testSiteNetworkServiceName", armhybridnetwork.SiteNetworkService{
	Location: to.Ptr("westUs2"),
	Properties: &armhybridnetwork.SiteNetworkServicePropertiesFormat{
		DesiredStateConfigurationGroupValueReferences: map[string]*armhybridnetwork.ReferencedResource{
			"MyVM_Configuration": {
				ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1"),
			},
		},
		NetworkServiceDesignVersionResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
			ID:     to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher/networkServiceDesignGroups/TestNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.0"),
		},
		SiteReference: &armhybridnetwork.ReferencedResource{
			ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite"),
		},
	},
	SKU: &armhybridnetwork.SKU{
		Name: to.Ptr(armhybridnetwork.SKUNameStandard),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.SiteNetworkService = armhybridnetwork.SiteNetworkService{
// 	Name: to.Ptr("testSiteNetworkServiceName"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/siteNetworkServices"),
// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName"),
// 	SystemData: &armhybridnetwork.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("westUs2"),
// 	Properties: &armhybridnetwork.SiteNetworkServicePropertiesFormat{
// 		DesiredStateConfigurationGroupValueReferences: map[string]*armhybridnetwork.ReferencedResource{
// 			"MyVM_Configuration": &armhybridnetwork.ReferencedResource{
// 				ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1"),
// 			},
// 		},
// 		NetworkServiceDesignGroupName: to.Ptr("testNetworkServiceDesignGroupName"),
// 		NetworkServiceDesignVersionName: to.Ptr("1.0.1"),
// 		NetworkServiceDesignVersionOfferingLocation: to.Ptr("eastus"),
// 		NetworkServiceDesignVersionResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
// 			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testPublisher/networkServiceDesignGroups/testNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.1"),
// 		},
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		PublisherName: to.Ptr("testPublisher"),
// 		PublisherScope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
// 		SiteReference: &armhybridnetwork.ReferencedResource{
// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite"),
// 		},
// 	},
// 	SKU: &armhybridnetwork.SKU{
// 		Name: to.Ptr(armhybridnetwork.SKUNameStandard),
// 		Tier: to.Ptr(armhybridnetwork.SKUTierStandard),
// 	},
// }
Output:

func (*SiteNetworkServicesClient) BeginDelete

func (client *SiteNetworkServicesClient) BeginDelete(ctx context.Context, resourceGroupName string, siteNetworkServiceName string, options *SiteNetworkServicesClientBeginDeleteOptions) (*runtime.Poller[SiteNetworkServicesClientDeleteResponse], error)

BeginDelete - Deletes the specified site network service. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • siteNetworkServiceName - The name of the site network service.
  • options - SiteNetworkServicesClientBeginDeleteOptions contains the optional parameters for the SiteNetworkServicesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSiteNetworkServicesClient().BeginDelete(ctx, "rg1", "testSiteNetworkServiceName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*SiteNetworkServicesClient) Get

func (client *SiteNetworkServicesClient) Get(ctx context.Context, resourceGroupName string, siteNetworkServiceName string, options *SiteNetworkServicesClientGetOptions) (SiteNetworkServicesClientGetResponse, error)

Get - Gets information about the specified site network service. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • siteNetworkServiceName - The name of the site network service.
  • options - SiteNetworkServicesClientGetOptions contains the optional parameters for the SiteNetworkServicesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewSiteNetworkServicesClient().Get(ctx, "rg1", "testSiteNetworkServiceName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.SiteNetworkService = armhybridnetwork.SiteNetworkService{
// 	Name: to.Ptr("testSiteNetworkServiceName"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/siteNetworkServices"),
// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName"),
// 	SystemData: &armhybridnetwork.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("westUs2"),
// 	Properties: &armhybridnetwork.SiteNetworkServicePropertiesFormat{
// 		DesiredStateConfigurationGroupValueReferences: map[string]*armhybridnetwork.ReferencedResource{
// 			"MyVM_Configuration": &armhybridnetwork.ReferencedResource{
// 				ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1"),
// 			},
// 		},
// 		NetworkServiceDesignGroupName: to.Ptr("testNetworkServiceDesignGroupName"),
// 		NetworkServiceDesignVersionName: to.Ptr("1.0.1"),
// 		NetworkServiceDesignVersionOfferingLocation: to.Ptr("eastus"),
// 		NetworkServiceDesignVersionResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
// 			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testPublisher/networkServiceDesignGroups/testNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.1"),
// 		},
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		PublisherName: to.Ptr("testPublisher"),
// 		PublisherScope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
// 		SiteReference: &armhybridnetwork.ReferencedResource{
// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite"),
// 		},
// 	},
// 	SKU: &armhybridnetwork.SKU{
// 		Name: to.Ptr(armhybridnetwork.SKUNameStandard),
// 		Tier: to.Ptr(armhybridnetwork.SKUTierStandard),
// 	},
// }
Output:

func (*SiteNetworkServicesClient) NewListByResourceGroupPager

NewListByResourceGroupPager - Lists all site network services.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - SiteNetworkServicesClientListByResourceGroupOptions contains the optional parameters for the SiteNetworkServicesClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewSiteNetworkServicesClient().NewListByResourceGroupPager("rg1", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.SiteNetworkServiceListResult = armhybridnetwork.SiteNetworkServiceListResult{
	// 	Value: []*armhybridnetwork.SiteNetworkService{
	// 		{
	// 			Name: to.Ptr("testSiteNetworkServiceName"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/siteNetworkServices"),
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName"),
	// 			SystemData: &armhybridnetwork.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("westUs2"),
	// 			Properties: &armhybridnetwork.SiteNetworkServicePropertiesFormat{
	// 				DesiredStateConfigurationGroupValueReferences: map[string]*armhybridnetwork.ReferencedResource{
	// 					"MyVM_Configuration": &armhybridnetwork.ReferencedResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1"),
	// 					},
	// 				},
	// 				NetworkServiceDesignGroupName: to.Ptr("testNetworkServiceDesignGroupName"),
	// 				NetworkServiceDesignVersionName: to.Ptr("1.0.1"),
	// 				NetworkServiceDesignVersionOfferingLocation: to.Ptr("eastus"),
	// 				NetworkServiceDesignVersionResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
	// 					IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
	// 					ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testPublisher/networkServiceDesignGroups/testNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.1"),
	// 				},
	// 				ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
	// 				PublisherName: to.Ptr("testPublisher"),
	// 				PublisherScope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
	// 				SiteReference: &armhybridnetwork.ReferencedResource{
	// 					ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite"),
	// 				},
	// 			},
	// 			SKU: &armhybridnetwork.SKU{
	// 				Name: to.Ptr(armhybridnetwork.SKUNameStandard),
	// 				Tier: to.Ptr(armhybridnetwork.SKUTierStandard),
	// 			},
	// 	}},
	// }
}
Output:

func (*SiteNetworkServicesClient) NewListBySubscriptionPager

NewListBySubscriptionPager - Lists all sites in the network service in a subscription.

Generated from API version 2023-09-01

  • options - SiteNetworkServicesClientListBySubscriptionOptions contains the optional parameters for the SiteNetworkServicesClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceListBySubscription.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewSiteNetworkServicesClient().NewListBySubscriptionPager(nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.SiteNetworkServiceListResult = armhybridnetwork.SiteNetworkServiceListResult{
	// 	Value: []*armhybridnetwork.SiteNetworkService{
	// 		{
	// 			Name: to.Ptr("testSiteNetworkServiceName"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/siteNetworkServices"),
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName"),
	// 			SystemData: &armhybridnetwork.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("westUs2"),
	// 			Properties: &armhybridnetwork.SiteNetworkServicePropertiesFormat{
	// 				DesiredStateConfigurationGroupValueReferences: map[string]*armhybridnetwork.ReferencedResource{
	// 					"MyVM_Configuration": &armhybridnetwork.ReferencedResource{
	// 						ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1"),
	// 					},
	// 				},
	// 				NetworkServiceDesignGroupName: to.Ptr("testNetworkServiceDesignGroupName"),
	// 				NetworkServiceDesignVersionName: to.Ptr("1.0.1"),
	// 				NetworkServiceDesignVersionOfferingLocation: to.Ptr("eastus"),
	// 				NetworkServiceDesignVersionResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
	// 					IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
	// 					ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testPublisher/networkServiceDesignGroups/testNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.1"),
	// 				},
	// 				ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
	// 				PublisherName: to.Ptr("testPublisher"),
	// 				PublisherScope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
	// 				SiteReference: &armhybridnetwork.ReferencedResource{
	// 					ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite"),
	// 				},
	// 			},
	// 			SKU: &armhybridnetwork.SKU{
	// 				Name: to.Ptr(armhybridnetwork.SKUNameStandard),
	// 				Tier: to.Ptr(armhybridnetwork.SKUTierStandard),
	// 			},
	// 	}},
	// }
}
Output:

func (*SiteNetworkServicesClient) UpdateTags

func (client *SiteNetworkServicesClient) UpdateTags(ctx context.Context, resourceGroupName string, siteNetworkServiceName string, parameters TagsObject, options *SiteNetworkServicesClientUpdateTagsOptions) (SiteNetworkServicesClientUpdateTagsResponse, error)

UpdateTags - Updates a site update tags. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • siteNetworkServiceName - The name of the site network service.
  • parameters - Parameters supplied to update network site tags.
  • options - SiteNetworkServicesClientUpdateTagsOptions contains the optional parameters for the SiteNetworkServicesClient.UpdateTags method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteNetworkServiceUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewSiteNetworkServicesClient().UpdateTags(ctx, "rg1", "testSiteNetworkServiceName", armhybridnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.SiteNetworkService = armhybridnetwork.SiteNetworkService{
// 	Name: to.Ptr("testSiteNetworkServiceName"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/siteNetworkServices"),
// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/siteNetworkServices/testSiteNetworkServiceName"),
// 	SystemData: &armhybridnetwork.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("westUs2"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Properties: &armhybridnetwork.SiteNetworkServicePropertiesFormat{
// 		DesiredStateConfigurationGroupValueReferences: map[string]*armhybridnetwork.ReferencedResource{
// 			"MyVM_Configuration": &armhybridnetwork.ReferencedResource{
// 				ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/configurationgroupvalues/MyVM_Configuration1"),
// 			},
// 		},
// 		NetworkServiceDesignGroupName: to.Ptr("testNetworkServiceDesignGroupName"),
// 		NetworkServiceDesignVersionName: to.Ptr("1.0.1"),
// 		NetworkServiceDesignVersionOfferingLocation: to.Ptr("eastus"),
// 		NetworkServiceDesignVersionResourceReference: &armhybridnetwork.OpenDeploymentResourceReference{
// 			IDType: to.Ptr(armhybridnetwork.IDTypeOpen),
// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/testPublisher/networkServiceDesignGroups/testNetworkServiceDesignGroupName/networkServiceDesignVersions/1.0.1"),
// 		},
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 		PublisherName: to.Ptr("testPublisher"),
// 		PublisherScope: to.Ptr(armhybridnetwork.PublisherScope("Public")),
// 		SiteReference: &armhybridnetwork.ReferencedResource{
// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/contosorg1/providers/microsoft.hybridnetwork/sites/testSite"),
// 		},
// 	},
// 	SKU: &armhybridnetwork.SKU{
// 		Name: to.Ptr(armhybridnetwork.SKUNameStandard),
// 		Tier: to.Ptr(armhybridnetwork.SKUTierStandard),
// 	},
// }
Output:

type SiteNetworkServicesClientBeginCreateOrUpdateOptions

type SiteNetworkServicesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SiteNetworkServicesClientBeginCreateOrUpdateOptions contains the optional parameters for the SiteNetworkServicesClient.BeginCreateOrUpdate method.

type SiteNetworkServicesClientBeginDeleteOptions

type SiteNetworkServicesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SiteNetworkServicesClientBeginDeleteOptions contains the optional parameters for the SiteNetworkServicesClient.BeginDelete method.

type SiteNetworkServicesClientCreateOrUpdateResponse

type SiteNetworkServicesClientCreateOrUpdateResponse struct {
	// Site network service resource.
	SiteNetworkService
}

SiteNetworkServicesClientCreateOrUpdateResponse contains the response from method SiteNetworkServicesClient.BeginCreateOrUpdate.

type SiteNetworkServicesClientDeleteResponse

type SiteNetworkServicesClientDeleteResponse struct {
}

SiteNetworkServicesClientDeleteResponse contains the response from method SiteNetworkServicesClient.BeginDelete.

type SiteNetworkServicesClientGetOptions

type SiteNetworkServicesClientGetOptions struct {
}

SiteNetworkServicesClientGetOptions contains the optional parameters for the SiteNetworkServicesClient.Get method.

type SiteNetworkServicesClientGetResponse

type SiteNetworkServicesClientGetResponse struct {
	// Site network service resource.
	SiteNetworkService
}

SiteNetworkServicesClientGetResponse contains the response from method SiteNetworkServicesClient.Get.

type SiteNetworkServicesClientListByResourceGroupOptions

type SiteNetworkServicesClientListByResourceGroupOptions struct {
}

SiteNetworkServicesClientListByResourceGroupOptions contains the optional parameters for the SiteNetworkServicesClient.NewListByResourceGroupPager method.

type SiteNetworkServicesClientListByResourceGroupResponse

type SiteNetworkServicesClientListByResourceGroupResponse struct {
	// Response for site network services API service call.
	SiteNetworkServiceListResult
}

SiteNetworkServicesClientListByResourceGroupResponse contains the response from method SiteNetworkServicesClient.NewListByResourceGroupPager.

type SiteNetworkServicesClientListBySubscriptionOptions

type SiteNetworkServicesClientListBySubscriptionOptions struct {
}

SiteNetworkServicesClientListBySubscriptionOptions contains the optional parameters for the SiteNetworkServicesClient.NewListBySubscriptionPager method.

type SiteNetworkServicesClientListBySubscriptionResponse

type SiteNetworkServicesClientListBySubscriptionResponse struct {
	// Response for site network services API service call.
	SiteNetworkServiceListResult
}

SiteNetworkServicesClientListBySubscriptionResponse contains the response from method SiteNetworkServicesClient.NewListBySubscriptionPager.

type SiteNetworkServicesClientUpdateTagsOptions

type SiteNetworkServicesClientUpdateTagsOptions struct {
}

SiteNetworkServicesClientUpdateTagsOptions contains the optional parameters for the SiteNetworkServicesClient.UpdateTags method.

type SiteNetworkServicesClientUpdateTagsResponse

type SiteNetworkServicesClientUpdateTagsResponse struct {
	// Site network service resource.
	SiteNetworkService
}

SiteNetworkServicesClientUpdateTagsResponse contains the response from method SiteNetworkServicesClient.UpdateTags.

type SitePropertiesFormat

type SitePropertiesFormat struct {
	// List of NFVIs
	Nfvis []NFVIsClassification

	// READ-ONLY; The provisioning state of the site resource. TODO: Confirm if this is needed.
	ProvisioningState *ProvisioningState

	// READ-ONLY; The list of site network services on the site.
	SiteNetworkServiceReferences []*ReferencedResource
}

SitePropertiesFormat - Site properties.

func (SitePropertiesFormat) MarshalJSON

func (s SitePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SitePropertiesFormat.

func (*SitePropertiesFormat) UnmarshalJSON

func (s *SitePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SitePropertiesFormat.

type SitesClient

type SitesClient struct {
	// contains filtered or unexported fields
}

SitesClient contains the methods for the Sites group. Don't use this type directly, use NewSitesClient() instead.

func NewSitesClient

func NewSitesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SitesClient, error)

NewSitesClient creates a new instance of SitesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SitesClient) BeginCreateOrUpdate

func (client *SitesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, siteName string, parameters Site, options *SitesClientBeginCreateOrUpdateOptions) (*runtime.Poller[SitesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a network site. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • siteName - The name of the network service site.
  • parameters - Parameters supplied to the create or update network site operation.
  • options - SitesClientBeginCreateOrUpdateOptions contains the optional parameters for the SitesClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteCreate.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSitesClient().BeginCreateOrUpdate(ctx, "rg1", "testSite", armhybridnetwork.Site{
	Location: to.Ptr("westUs2"),
	Properties: &armhybridnetwork.SitePropertiesFormat{
		Nfvis: []armhybridnetwork.NFVIsClassification{
			&armhybridnetwork.AzureCoreNFVIDetails{
				Name:     to.Ptr("nfvi1"),
				NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureCore),
				Location: to.Ptr("westUs2"),
			},
			&armhybridnetwork.AzureArcK8SClusterNFVIDetails{
				Name:     to.Ptr("nfvi2"),
				NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureArcKubernetes),
				CustomLocationReference: &armhybridnetwork.ReferencedResource{
					ID: to.Ptr("/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation1"),
				},
			},
			&armhybridnetwork.AzureOperatorNexusClusterNFVIDetails{
				Name:     to.Ptr("nfvi3"),
				NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureOperatorNexus),
				CustomLocationReference: &armhybridnetwork.ReferencedResource{
					ID: to.Ptr("/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation2"),
				},
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Site = armhybridnetwork.Site{
// 	Name: to.Ptr("testSite"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/sites"),
// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/sites/testSite"),
// 	SystemData: &armhybridnetwork.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("westUs2"),
// 	Properties: &armhybridnetwork.SitePropertiesFormat{
// 		Nfvis: []armhybridnetwork.NFVIsClassification{
// 			&armhybridnetwork.AzureCoreNFVIDetails{
// 				Name: to.Ptr("nfvi1"),
// 				NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureCore),
// 				Location: to.Ptr("westUs2"),
// 			},
// 			&armhybridnetwork.AzureArcK8SClusterNFVIDetails{
// 				Name: to.Ptr("nfvi2"),
// 				NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureArcKubernetes),
// 				CustomLocationReference: &armhybridnetwork.ReferencedResource{
// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation1"),
// 				},
// 			},
// 			&armhybridnetwork.AzureOperatorNexusClusterNFVIDetails{
// 				Name: to.Ptr("nfvi3"),
// 				NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureOperatorNexus),
// 				CustomLocationReference: &armhybridnetwork.ReferencedResource{
// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation2"),
// 				},
// 		}},
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 	},
// }
Output:

func (*SitesClient) BeginDelete

func (client *SitesClient) BeginDelete(ctx context.Context, resourceGroupName string, siteName string, options *SitesClientBeginDeleteOptions) (*runtime.Poller[SitesClientDeleteResponse], error)

BeginDelete - Deletes the specified network site. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • siteName - The name of the network service site.
  • options - SitesClientBeginDeleteOptions contains the optional parameters for the SitesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteDelete.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSitesClient().BeginDelete(ctx, "rg1", "testSite", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
Output:

func (*SitesClient) Get

func (client *SitesClient) Get(ctx context.Context, resourceGroupName string, siteName string, options *SitesClientGetOptions) (SitesClientGetResponse, error)

Get - Gets information about the specified network site. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • siteName - The name of the network service site.
  • options - SitesClientGetOptions contains the optional parameters for the SitesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteGet.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewSitesClient().Get(ctx, "rg1", "testSite", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Site = armhybridnetwork.Site{
// 	Name: to.Ptr("testSite"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/sites"),
// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/sites/testSite"),
// 	SystemData: &armhybridnetwork.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("westUs2"),
// 	Properties: &armhybridnetwork.SitePropertiesFormat{
// 		Nfvis: []armhybridnetwork.NFVIsClassification{
// 			&armhybridnetwork.AzureCoreNFVIDetails{
// 				Name: to.Ptr("nfvi1"),
// 				NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureCore),
// 				Location: to.Ptr("westUs2"),
// 			},
// 			&armhybridnetwork.AzureArcK8SClusterNFVIDetails{
// 				Name: to.Ptr("nfvi2"),
// 				NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureArcKubernetes),
// 				CustomLocationReference: &armhybridnetwork.ReferencedResource{
// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation1"),
// 				},
// 			},
// 			&armhybridnetwork.AzureOperatorNexusClusterNFVIDetails{
// 				Name: to.Ptr("nfvi3"),
// 				NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureOperatorNexus),
// 				CustomLocationReference: &armhybridnetwork.ReferencedResource{
// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/testResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/testCustomLocation2"),
// 				},
// 		}},
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 	},
// }
Output:

func (*SitesClient) NewListByResourceGroupPager

func (client *SitesClient) NewListByResourceGroupPager(resourceGroupName string, options *SitesClientListByResourceGroupOptions) *runtime.Pager[SitesClientListByResourceGroupResponse]

NewListByResourceGroupPager - Lists all sites in the network service.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - SitesClientListByResourceGroupOptions contains the optional parameters for the SitesClient.NewListByResourceGroupPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteListByResourceGroup.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewSitesClient().NewListByResourceGroupPager("rg1", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.SiteListResult = armhybridnetwork.SiteListResult{
	// 	Value: []*armhybridnetwork.Site{
	// 		{
	// 			Name: to.Ptr("testSite"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/orchestrators/sites"),
	// 			ID: to.Ptr("subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/sites/testSite"),
	// 			SystemData: &armhybridnetwork.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("westUs2"),
	// 			Properties: &armhybridnetwork.SitePropertiesFormat{
	// 				Nfvis: []armhybridnetwork.NFVIsClassification{
	// 					&armhybridnetwork.AzureCoreNFVIDetails{
	// 						Name: to.Ptr("azureWestUs2"),
	// 						NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureCore),
	// 						Location: to.Ptr("westUs2"),
	// 				}},
	// 			},
	// 	}},
	// }
}
Output:

func (*SitesClient) NewListBySubscriptionPager

NewListBySubscriptionPager - Lists all sites in the network service in a subscription.

Generated from API version 2023-09-01

  • options - SitesClientListBySubscriptionOptions contains the optional parameters for the SitesClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteListBySubscription.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewSitesClient().NewListBySubscriptionPager(nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.SiteListResult = armhybridnetwork.SiteListResult{
	// 	Value: []*armhybridnetwork.Site{
	// 		{
	// 			Name: to.Ptr("testSite"),
	// 			Type: to.Ptr("Microsoft.HybridNetwork/sites"),
	// 			ID: to.Ptr("subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/sites/testSite"),
	// 			SystemData: &armhybridnetwork.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("westUs2"),
	// 			Properties: &armhybridnetwork.SitePropertiesFormat{
	// 				Nfvis: []armhybridnetwork.NFVIsClassification{
	// 					&armhybridnetwork.AzureCoreNFVIDetails{
	// 						Name: to.Ptr("azureWestUs2"),
	// 						NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureCore),
	// 						Location: to.Ptr("westUs2"),
	// 				}},
	// 				ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}
Output:

func (*SitesClient) UpdateTags

func (client *SitesClient) UpdateTags(ctx context.Context, resourceGroupName string, siteName string, parameters TagsObject, options *SitesClientUpdateTagsOptions) (SitesClientUpdateTagsResponse, error)

UpdateTags - Updates a site update tags. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-09-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • siteName - The name of the network service site.
  • parameters - Parameters supplied to update network site tags.
  • options - SitesClientUpdateTagsOptions contains the optional parameters for the SitesClient.UpdateTags method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/db9788dde7a0c2c0d82e4fdf5f7b4de3843937e3/specification/hybridnetwork/resource-manager/Microsoft.HybridNetwork/stable/2023-09-01/examples/SiteUpdateTags.json

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhybridnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewSitesClient().UpdateTags(ctx, "rg1", "testSite", armhybridnetwork.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Site = armhybridnetwork.Site{
// 	Name: to.Ptr("testSite"),
// 	Type: to.Ptr("Microsoft.HybridNetwork/sites"),
// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/sites/testSite"),
// 	SystemData: &armhybridnetwork.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armhybridnetwork.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("westUs2"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Properties: &armhybridnetwork.SitePropertiesFormat{
// 		Nfvis: []armhybridnetwork.NFVIsClassification{
// 			&armhybridnetwork.AzureCoreNFVIDetails{
// 				Name: to.Ptr("azureWestUs2"),
// 				NfviType: to.Ptr(armhybridnetwork.NFVITypeAzureCore),
// 				Location: to.Ptr("westUs2"),
// 		}},
// 		ProvisioningState: to.Ptr(armhybridnetwork.ProvisioningStateSucceeded),
// 	},
// }
Output:

type SitesClientBeginCreateOrUpdateOptions

type SitesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SitesClientBeginCreateOrUpdateOptions contains the optional parameters for the SitesClient.BeginCreateOrUpdate method.

type SitesClientBeginDeleteOptions

type SitesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SitesClientBeginDeleteOptions contains the optional parameters for the SitesClient.BeginDelete method.

type SitesClientCreateOrUpdateResponse

type SitesClientCreateOrUpdateResponse struct {
	// Site resource.
	Site
}

SitesClientCreateOrUpdateResponse contains the response from method SitesClient.BeginCreateOrUpdate.

type SitesClientDeleteResponse

type SitesClientDeleteResponse struct {
}

SitesClientDeleteResponse contains the response from method SitesClient.BeginDelete.

type SitesClientGetOptions

type SitesClientGetOptions struct {
}

SitesClientGetOptions contains the optional parameters for the SitesClient.Get method.

type SitesClientGetResponse

type SitesClientGetResponse struct {
	// Site resource.
	Site
}

SitesClientGetResponse contains the response from method SitesClient.Get.

type SitesClientListByResourceGroupOptions

type SitesClientListByResourceGroupOptions struct {
}

SitesClientListByResourceGroupOptions contains the optional parameters for the SitesClient.NewListByResourceGroupPager method.

type SitesClientListByResourceGroupResponse

type SitesClientListByResourceGroupResponse struct {
	// Response for sites API service call.
	SiteListResult
}

SitesClientListByResourceGroupResponse contains the response from method SitesClient.NewListByResourceGroupPager.

type SitesClientListBySubscriptionOptions

type SitesClientListBySubscriptionOptions struct {
}

SitesClientListBySubscriptionOptions contains the optional parameters for the SitesClient.NewListBySubscriptionPager method.

type SitesClientListBySubscriptionResponse

type SitesClientListBySubscriptionResponse struct {
	// Response for sites API service call.
	SiteListResult
}

SitesClientListBySubscriptionResponse contains the response from method SitesClient.NewListBySubscriptionPager.

type SitesClientUpdateTagsOptions

type SitesClientUpdateTagsOptions struct {
}

SitesClientUpdateTagsOptions contains the optional parameters for the SitesClient.UpdateTags method.

type SitesClientUpdateTagsResponse

type SitesClientUpdateTagsResponse struct {
	// Site resource.
	Site
}

SitesClientUpdateTagsResponse contains the response from method SitesClient.UpdateTags.

type StatefulSet

type StatefulSet struct {
	// Creation Time of statefulset.
	CreationTime *time.Time

	// Desired number of pods
	Desired *int32

	// The name of the statefulset.
	Name *string

	// The namespace of the statefulset.
	Namespace *string

	// Number of ready pods.
	Ready *int32
}

StatefulSet - Helm StatefulSet status properties.

func (StatefulSet) MarshalJSON

func (s StatefulSet) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StatefulSet.

func (*StatefulSet) UnmarshalJSON

func (s *StatefulSet) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StatefulSet.

type Status

type Status string

Status - The component resource deployment status.

const (
	StatusDeployed        Status = "Deployed"
	StatusDownloading     Status = "Downloading"
	StatusFailed          Status = "Failed"
	StatusInstalling      Status = "Installing"
	StatusPendingInstall  Status = "Pending-Install"
	StatusPendingRollback Status = "Pending-Rollback"
	StatusPendingUpgrade  Status = "Pending-Upgrade"
	StatusReinstalling    Status = "Reinstalling"
	StatusRollingback     Status = "Rollingback"
	StatusSuperseded      Status = "Superseded"
	StatusUninstalled     Status = "Uninstalled"
	StatusUninstalling    Status = "Uninstalling"
	StatusUnknown         Status = "Unknown"
	StatusUpgrading       Status = "Upgrading"
)

func PossibleStatusValues

func PossibleStatusValues() []Status

PossibleStatusValues returns the possible values for the Status const type.

type SystemData

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time

	// The identity that created the resource.
	CreatedBy *string

	// The type of identity that created the resource.
	CreatedByType *CreatedByType

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time

	// The identity that last modified the resource.
	LastModifiedBy *string

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON

func (s SystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type TagsObject

type TagsObject struct {
	// Resource tags.
	Tags map[string]*string
}

TagsObject - Tags object for patch operations.

func (TagsObject) MarshalJSON

func (t TagsObject) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TagsObject.

func (*TagsObject) UnmarshalJSON

func (t *TagsObject) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TagsObject.

type TemplateType

type TemplateType string

TemplateType - The template type.

const (
	TemplateTypeArmTemplate TemplateType = "ArmTemplate"
	TemplateTypeUnknown     TemplateType = "Unknown"
)

func PossibleTemplateTypeValues

func PossibleTemplateTypeValues() []TemplateType

PossibleTemplateTypeValues returns the possible values for the TemplateType const type.

type Type

type Type string

Type - The resource element template type.

const (
	TypeArmResourceDefinition     Type = "ArmResourceDefinition"
	TypeNetworkFunctionDefinition Type = "NetworkFunctionDefinition"
	TypeUnknown                   Type = "Unknown"
)

func PossibleTypeValues

func PossibleTypeValues() []Type

PossibleTypeValues returns the possible values for the Type const type.

type UserAssignedIdentity

type UserAssignedIdentity struct {
	// READ-ONLY; The client ID of the assigned identity.
	ClientID *string

	// READ-ONLY; The principal ID of the assigned identity.
	PrincipalID *string
}

UserAssignedIdentity - User assigned identity properties

func (UserAssignedIdentity) MarshalJSON

func (u UserAssignedIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserAssignedIdentity.

func (*UserAssignedIdentity) UnmarshalJSON

func (u *UserAssignedIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserAssignedIdentity.

type VersionState

type VersionState string

VersionState - The configuration group schema state.

const (
	VersionStateActive           VersionState = "Active"
	VersionStateDeprecated       VersionState = "Deprecated"
	VersionStatePreview          VersionState = "Preview"
	VersionStateUnknown          VersionState = "Unknown"
	VersionStateValidating       VersionState = "Validating"
	VersionStateValidationFailed VersionState = "ValidationFailed"
)

func PossibleVersionStateValues

func PossibleVersionStateValues() []VersionState

PossibleVersionStateValues returns the possible values for the VersionState const type.

type VhdImageArtifactProfile

type VhdImageArtifactProfile struct {
	// Vhd name.
	VhdName *string

	// Vhd version.
	VhdVersion *string
}

VhdImageArtifactProfile - Vhd artifact profile.

func (VhdImageArtifactProfile) MarshalJSON

func (v VhdImageArtifactProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VhdImageArtifactProfile.

func (*VhdImageArtifactProfile) UnmarshalJSON

func (v *VhdImageArtifactProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VhdImageArtifactProfile.

type VhdImageMappingRuleProfile

type VhdImageMappingRuleProfile struct {
	// List of values.
	UserConfiguration *string
}

VhdImageMappingRuleProfile - Vhd mapping rule profile

func (VhdImageMappingRuleProfile) MarshalJSON

func (v VhdImageMappingRuleProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VhdImageMappingRuleProfile.

func (*VhdImageMappingRuleProfile) UnmarshalJSON

func (v *VhdImageMappingRuleProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VhdImageMappingRuleProfile.

type VirtualNetworkFunctionDefinitionVersion

type VirtualNetworkFunctionDefinitionVersion struct {
	// REQUIRED; The network function type.
	NetworkFunctionType *NetworkFunctionType

	// The deployment parameters of the network function definition version.
	DeployParameters *string

	// The network function definition version description.
	Description *string

	// Virtual network function template.
	NetworkFunctionTemplate VirtualNetworkFunctionTemplateClassification

	// READ-ONLY; The provisioning state of the network function definition version resource.
	ProvisioningState *ProvisioningState

	// READ-ONLY; The network function definition version state.
	VersionState *VersionState
}

VirtualNetworkFunctionDefinitionVersion - Virtual network function network function definition version properties.

func (*VirtualNetworkFunctionDefinitionVersion) GetNetworkFunctionDefinitionVersionPropertiesFormat

func (v *VirtualNetworkFunctionDefinitionVersion) GetNetworkFunctionDefinitionVersionPropertiesFormat() *NetworkFunctionDefinitionVersionPropertiesFormat

GetNetworkFunctionDefinitionVersionPropertiesFormat implements the NetworkFunctionDefinitionVersionPropertiesFormatClassification interface for type VirtualNetworkFunctionDefinitionVersion.

func (VirtualNetworkFunctionDefinitionVersion) MarshalJSON

func (v VirtualNetworkFunctionDefinitionVersion) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkFunctionDefinitionVersion.

func (*VirtualNetworkFunctionDefinitionVersion) UnmarshalJSON

func (v *VirtualNetworkFunctionDefinitionVersion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkFunctionDefinitionVersion.

type VirtualNetworkFunctionNFVIType

type VirtualNetworkFunctionNFVIType string

VirtualNetworkFunctionNFVIType - The network function type.

const (
	VirtualNetworkFunctionNFVITypeAzureCore          VirtualNetworkFunctionNFVIType = "AzureCore"
	VirtualNetworkFunctionNFVITypeAzureOperatorNexus VirtualNetworkFunctionNFVIType = "AzureOperatorNexus"
	VirtualNetworkFunctionNFVITypeUnknown            VirtualNetworkFunctionNFVIType = "Unknown"
)

func PossibleVirtualNetworkFunctionNFVITypeValues

func PossibleVirtualNetworkFunctionNFVITypeValues() []VirtualNetworkFunctionNFVIType

PossibleVirtualNetworkFunctionNFVITypeValues returns the possible values for the VirtualNetworkFunctionNFVIType const type.

type VirtualNetworkFunctionTemplate

type VirtualNetworkFunctionTemplate struct {
	// REQUIRED; The network function type.
	NfviType *VirtualNetworkFunctionNFVIType
}

VirtualNetworkFunctionTemplate - Virtual network function template.

func (*VirtualNetworkFunctionTemplate) GetVirtualNetworkFunctionTemplate

func (v *VirtualNetworkFunctionTemplate) GetVirtualNetworkFunctionTemplate() *VirtualNetworkFunctionTemplate

GetVirtualNetworkFunctionTemplate implements the VirtualNetworkFunctionTemplateClassification interface for type VirtualNetworkFunctionTemplate.

func (VirtualNetworkFunctionTemplate) MarshalJSON

func (v VirtualNetworkFunctionTemplate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VirtualNetworkFunctionTemplate.

func (*VirtualNetworkFunctionTemplate) UnmarshalJSON

func (v *VirtualNetworkFunctionTemplate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VirtualNetworkFunctionTemplate.

type VirtualNetworkFunctionTemplateClassification

type VirtualNetworkFunctionTemplateClassification interface {
	// GetVirtualNetworkFunctionTemplate returns the VirtualNetworkFunctionTemplate content of the underlying type.
	GetVirtualNetworkFunctionTemplate() *VirtualNetworkFunctionTemplate
}

VirtualNetworkFunctionTemplateClassification provides polymorphic access to related types. Call the interface's GetVirtualNetworkFunctionTemplate() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureCoreNetworkFunctionTemplate, *AzureOperatorNexusNetworkFunctionTemplate, *VirtualNetworkFunctionTemplate

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL