armextendedlocation

package module
v1.2.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: 3

README

Azure Extended Location Module for Go

PkgGoDev

The armextendedlocation module provides operations for working with Azure Extended Location.

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 Extended Location module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/extendedlocation/armextendedlocation

Authorization

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

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 Extended Location 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 ClientFactory added in v1.1.0 

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 added in v1.1.0 

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) NewCustomLocationsClient added in v1.1.0 

func (c *ClientFactory) NewCustomLocationsClient() *CustomLocationsClient

NewCustomLocationsClient creates a new instance of CustomLocationsClient.

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 CustomLocation 

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

	// Identity for the resource.
	Identity *Identity

	// The set of properties specific to a Custom Location
	Properties *CustomLocationProperties

	// 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; Metadata pertaining to creation and last modification of the resource
	SystemData *SystemData

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

CustomLocation - Custom Locations definition.

func (CustomLocation) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomLocation.

func (*CustomLocation) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomLocation.

type CustomLocationListResult 

type CustomLocationListResult struct {
	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string

	// READ-ONLY; The list of Custom Locations.
	Value []*CustomLocation
}

CustomLocationListResult - The List Custom Locations operation response.

func (CustomLocationListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomLocationListResult.

func (*CustomLocationListResult) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomLocationListResult.

type CustomLocationOperation 

type CustomLocationOperation struct {
	// Describes the properties of a Custom Locations Operation Value Display.
	Display *CustomLocationOperationValueDisplay

	// READ-ONLY; Is this Operation a data plane operation
	IsDataAction *bool

	// READ-ONLY; The name of the compute operation.
	Name *string

	// READ-ONLY; The origin of the compute operation.
	Origin *string
}

CustomLocationOperation - Custom Locations operation.

func (CustomLocationOperation) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type CustomLocationOperation.

func (*CustomLocationOperation) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomLocationOperation.

type CustomLocationOperationValueDisplay 

type CustomLocationOperationValueDisplay struct {
	// READ-ONLY; The description of the operation.
	Description *string

	// READ-ONLY; The display name of the compute operation.
	Operation *string

	// READ-ONLY; The resource provider for the operation.
	Provider *string

	// READ-ONLY; The display name of the resource the operation applies to.
	Resource *string
}

CustomLocationOperationValueDisplay - Describes the properties of a Custom Locations Operation Value Display.

func (CustomLocationOperationValueDisplay) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type CustomLocationOperationValueDisplay.

func (*CustomLocationOperationValueDisplay) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomLocationOperationValueDisplay.

type CustomLocationOperationsList 

type CustomLocationOperationsList struct {
	// REQUIRED; Array of customLocationOperation
	Value []*CustomLocationOperation

	// Next page of operations.
	NextLink *string
}

CustomLocationOperationsList - Lists of Custom Locations operations.

func (CustomLocationOperationsList) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomLocationOperationsList.

func (*CustomLocationOperationsList) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomLocationOperationsList.

type CustomLocationProperties 

type CustomLocationProperties struct {
	// This is optional input that contains the authentication that should be used to generate the namespace.
	Authentication *CustomLocationPropertiesAuthentication

	// Contains the reference to the add-on that contains charts to deploy CRDs and operators.
	ClusterExtensionIDs []*string

	// Display name for the Custom Locations location.
	DisplayName *string

	// Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions.
	HostResourceID *string

	// Type of host the Custom Locations is referencing (Kubernetes, etc…).
	HostType *HostType

	// Kubernetes namespace that will be created on the specified cluster.
	Namespace *string

	// Provisioning State for the Custom Location.
	ProvisioningState *string
}

CustomLocationProperties - Properties for a custom location.

func (CustomLocationProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CustomLocationProperties.

func (*CustomLocationProperties) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomLocationProperties.

type CustomLocationPropertiesAuthentication 

type CustomLocationPropertiesAuthentication struct {
	// The type of the Custom Locations authentication
	Type *string

	// The kubeconfig value.
	Value *string
}

CustomLocationPropertiesAuthentication - This is optional input that contains the authentication that should be used to generate the namespace.

func (CustomLocationPropertiesAuthentication) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type CustomLocationPropertiesAuthentication.

func (*CustomLocationPropertiesAuthentication) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CustomLocationPropertiesAuthentication.

type CustomLocationsClient 

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

CustomLocationsClient contains the methods for the CustomLocations group. Don't use this type directly, use NewCustomLocationsClient() instead.

func NewCustomLocationsClient 

func NewCustomLocationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*CustomLocationsClient, error)

NewCustomLocationsClient creates a new instance of CustomLocationsClient 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 (*CustomLocationsClient) BeginCreateOrUpdate 

func (client *CustomLocationsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, resourceName string, parameters CustomLocation, options *CustomLocationsClientBeginCreateOrUpdateOptions) (*runtime.Poller[CustomLocationsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a Custom Location in the specified Subscription and Resource Group If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • resourceName - Custom Locations name.
  • parameters - Parameters supplied to create or update a Custom Location.
  • options - CustomLocationsClientBeginCreateOrUpdateOptions contains the optional parameters for the CustomLocationsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/extendedlocation/resource-manager/Microsoft.ExtendedLocation/stable/2021-08-15/examples/CustomLocationsCreate_Update.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/extendedlocation/armextendedlocation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armextendedlocation.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewCustomLocationsClient().BeginCreateOrUpdate(ctx, "testresourcegroup", "customLocation01", armextendedlocation.CustomLocation{
		Location: to.Ptr("West US"),
		Identity: &armextendedlocation.Identity{
			Type: to.Ptr(armextendedlocation.ResourceIdentityTypeSystemAssigned),
		},
		Properties: &armextendedlocation.CustomLocationProperties{
			Authentication: &armextendedlocation.CustomLocationPropertiesAuthentication{
				Type:  to.Ptr("KubeConfig"),
				Value: to.Ptr("<base64 KubeConfig>"),
			},
			ClusterExtensionIDs: []*string{
				to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedCluster/someCluster/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension")},
			DisplayName:    to.Ptr("customLocationLocation01"),
			HostResourceID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01"),
			Namespace:      to.Ptr("namespace01"),
		},
	}, 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.CustomLocation = armextendedlocation.CustomLocation{
	// 	Name: to.Ptr("customLocation01"),
	// 	Type: to.Ptr("Microsoft.ExtendedLocation/customLocations"),
	// 	ID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/customLocation01"),
	// 	Location: to.Ptr("West US"),
	// 	Identity: &armextendedlocation.Identity{
	// 		Type: to.Ptr(armextendedlocation.ResourceIdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("11111111-1111-1111-1111-111111111111"),
	// 		TenantID: to.Ptr("111111-1111-1111-1111-111111111111"),
	// 	},
	// 	Properties: &armextendedlocation.CustomLocationProperties{
	// 		Authentication: &armextendedlocation.CustomLocationPropertiesAuthentication{
	// 			Type: to.Ptr("KubeConfig"),
	// 		},
	// 		ClusterExtensionIDs: []*string{
	// 			to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension")},
	// 			DisplayName: to.Ptr("customLocationLocation01"),
	// 			HostResourceID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01"),
	// 			Namespace: to.Ptr("namespace01"),
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 		},
	// 		SystemData: &armextendedlocation.SystemData{
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T18:53:29.092Z"); return t}()),
	// 			CreatedBy: to.Ptr("string"),
	// 			CreatedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T18:53:29.092Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("string"),
	// 			LastModifiedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
	// 		},
	// 	}
}

Output:

func (*CustomLocationsClient) BeginDelete 

func (client *CustomLocationsClient) BeginDelete(ctx context.Context, resourceGroupName string, resourceName string, options *CustomLocationsClientBeginDeleteOptions) (*runtime.Poller[CustomLocationsClientDeleteResponse], error)

BeginDelete - Deletes the Custom Location with the specified Resource Name, Resource Group, and Subscription Id. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • resourceName - Custom Locations name.
  • options - CustomLocationsClientBeginDeleteOptions contains the optional parameters for the CustomLocationsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/extendedlocation/resource-manager/Microsoft.ExtendedLocation/stable/2021-08-15/examples/CustomLocationsDelete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/extendedlocation/armextendedlocation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armextendedlocation.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewCustomLocationsClient().BeginDelete(ctx, "testresourcegroup", "customLocation01", 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 (*CustomLocationsClient) Get 

func (client *CustomLocationsClient) Get(ctx context.Context, resourceGroupName string, resourceName string, options *CustomLocationsClientGetOptions) (CustomLocationsClientGetResponse, error)

Get - Gets the details of the customLocation with a specified resource group and name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • resourceName - Custom Locations name.
  • options - CustomLocationsClientGetOptions contains the optional parameters for the CustomLocationsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/extendedlocation/resource-manager/Microsoft.ExtendedLocation/stable/2021-08-15/examples/CustomLocationsGet.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/extendedlocation/armextendedlocation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armextendedlocation.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCustomLocationsClient().Get(ctx, "testresourcegroup", "customLocation01", 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.CustomLocation = armextendedlocation.CustomLocation{
	// 	Name: to.Ptr("customLocation01"),
	// 	Type: to.Ptr("Microsoft.ExtendedLocation/customLocations"),
	// 	ID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/customLocation01"),
	// 	Location: to.Ptr("West US"),
	// 	Identity: &armextendedlocation.Identity{
	// 		Type: to.Ptr(armextendedlocation.ResourceIdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("11111111-1111-1111-1111-111111111111"),
	// 		TenantID: to.Ptr("111111-1111-1111-1111-111111111111"),
	// 	},
	// 	Properties: &armextendedlocation.CustomLocationProperties{
	// 		Authentication: &armextendedlocation.CustomLocationPropertiesAuthentication{
	// 			Type: to.Ptr("KubeConfig"),
	// 		},
	// 		ClusterExtensionIDs: []*string{
	// 			to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension")},
	// 			DisplayName: to.Ptr("customLocationLocation01"),
	// 			HostResourceID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01"),
	// 			Namespace: to.Ptr("namespace01"),
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 		},
	// 		SystemData: &armextendedlocation.SystemData{
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-24T18:53:29.092Z"); return t}()),
	// 			CreatedBy: to.Ptr("string"),
	// 			CreatedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-24T18:53:29.092Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("string"),
	// 			LastModifiedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
	// 		},
	// 	}
}

Output:

func (*CustomLocationsClient) NewListByResourceGroupPager added in v0.4.0 

func (client *CustomLocationsClient) NewListByResourceGroupPager(resourceGroupName string, options *CustomLocationsClientListByResourceGroupOptions) *runtime.Pager[CustomLocationsClientListByResourceGroupResponse]

NewListByResourceGroupPager - Gets a list of Custom Locations in the specified subscription and resource group. The operation returns properties of each Custom Location.

Generated from API version 2021-08-15

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/extendedlocation/resource-manager/Microsoft.ExtendedLocation/stable/2021-08-15/examples/CustomLocationsListByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/extendedlocation/armextendedlocation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armextendedlocation.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewCustomLocationsClient().NewListByResourceGroupPager("testresourcegroup", 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.CustomLocationListResult = armextendedlocation.CustomLocationListResult{
		// 	Value: []*armextendedlocation.CustomLocation{
		// 		{
		// 			Name: to.Ptr("customLocation01"),
		// 			Type: to.Ptr("Microsoft.ExtendedLocation/customLocations"),
		// 			ID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ExtendedLocation/"),
		// 			Location: to.Ptr("West US"),
		// 			Identity: &armextendedlocation.Identity{
		// 				Type: to.Ptr(armextendedlocation.ResourceIdentityTypeSystemAssigned),
		// 				PrincipalID: to.Ptr("11111111-1111-1111-1111-111111111111"),
		// 				TenantID: to.Ptr("111111-1111-1111-1111-111111111111"),
		// 			},
		// 			Properties: &armextendedlocation.CustomLocationProperties{
		// 				Authentication: &armextendedlocation.CustomLocationPropertiesAuthentication{
		// 					Type: to.Ptr("KubeConfig"),
		// 				},
		// 				ClusterExtensionIDs: []*string{
		// 					to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension")},
		// 					DisplayName: to.Ptr("customLocationLocation01"),
		// 					HostResourceID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01"),
		// 					Namespace: to.Ptr("namespace01"),
		// 					ProvisioningState: to.Ptr("Succeeded"),
		// 				},
		// 				SystemData: &armextendedlocation.SystemData{
		// 					CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T18:53:29.092Z"); return t}()),
		// 					CreatedBy: to.Ptr("string"),
		// 					CreatedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
		// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T18:53:29.092Z"); return t}()),
		// 					LastModifiedBy: to.Ptr("string"),
		// 					LastModifiedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("customLocation02"),
		// 				Type: to.Ptr("Microsoft.ExtendedLocation/customLocations"),
		// 				ID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ExtendedLocation/"),
		// 				Location: to.Ptr("West US"),
		// 				Identity: &armextendedlocation.Identity{
		// 					Type: to.Ptr(armextendedlocation.ResourceIdentityTypeSystemAssigned),
		// 					PrincipalID: to.Ptr("11111111-1111-1111-1111-111111111111"),
		// 					TenantID: to.Ptr("111111-1111-1111-1111-111111111111"),
		// 				},
		// 				Properties: &armextendedlocation.CustomLocationProperties{
		// 					Authentication: &armextendedlocation.CustomLocationPropertiesAuthentication{
		// 						Type: to.Ptr("KubeConfig"),
		// 					},
		// 					ClusterExtensionIDs: []*string{
		// 						to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster02/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension")},
		// 						DisplayName: to.Ptr("customLocationLocation02"),
		// 						HostResourceID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster02"),
		// 						Namespace: to.Ptr("namespace02"),
		// 						ProvisioningState: to.Ptr("Succeeded"),
		// 					},
		// 					SystemData: &armextendedlocation.SystemData{
		// 						CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-24T18:53:29.092Z"); return t}()),
		// 						CreatedBy: to.Ptr("string"),
		// 						CreatedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
		// 						LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-24T18:53:29.092Z"); return t}()),
		// 						LastModifiedBy: to.Ptr("string"),
		// 						LastModifiedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
		// 					},
		// 			}},
		// 		}
	}
}

Output:

func (*CustomLocationsClient) NewListBySubscriptionPager added in v0.4.0 

func (client *CustomLocationsClient) NewListBySubscriptionPager(options *CustomLocationsClientListBySubscriptionOptions) *runtime.Pager[CustomLocationsClientListBySubscriptionResponse]

NewListBySubscriptionPager - Gets a list of Custom Locations in the specified subscription. The operation returns properties of each Custom Location

Generated from API version 2021-08-15

  • options - CustomLocationsClientListBySubscriptionOptions contains the optional parameters for the CustomLocationsClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/extendedlocation/resource-manager/Microsoft.ExtendedLocation/stable/2021-08-15/examples/CustomLocationsListBySubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/extendedlocation/armextendedlocation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armextendedlocation.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewCustomLocationsClient().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.CustomLocationListResult = armextendedlocation.CustomLocationListResult{
		// 	Value: []*armextendedlocation.CustomLocation{
		// 		{
		// 			Name: to.Ptr("customLocation01"),
		// 			Type: to.Ptr("Microsoft.ExtendedLocation/customLocations"),
		// 			ID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ExtendedLocation/"),
		// 			Location: to.Ptr("West US"),
		// 			Identity: &armextendedlocation.Identity{
		// 				Type: to.Ptr(armextendedlocation.ResourceIdentityTypeSystemAssigned),
		// 				PrincipalID: to.Ptr("11111111-1111-1111-1111-111111111111"),
		// 				TenantID: to.Ptr("111111-1111-1111-1111-111111111111"),
		// 			},
		// 			Properties: &armextendedlocation.CustomLocationProperties{
		// 				Authentication: &armextendedlocation.CustomLocationPropertiesAuthentication{
		// 					Type: to.Ptr("KubeConfig"),
		// 				},
		// 				ClusterExtensionIDs: []*string{
		// 					to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension")},
		// 					DisplayName: to.Ptr("customLocationLocation01"),
		// 					HostResourceID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01"),
		// 					Namespace: to.Ptr("namespace01"),
		// 					ProvisioningState: to.Ptr("Succeeded"),
		// 				},
		// 				SystemData: &armextendedlocation.SystemData{
		// 					CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T18:53:29.092Z"); return t}()),
		// 					CreatedBy: to.Ptr("string"),
		// 					CreatedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
		// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T18:53:29.092Z"); return t}()),
		// 					LastModifiedBy: to.Ptr("string"),
		// 					LastModifiedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("customLocation02"),
		// 				Type: to.Ptr("Microsoft.ExtendedLocation/customLocations"),
		// 				ID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ExtendedLocation/"),
		// 				Location: to.Ptr("West US"),
		// 				Identity: &armextendedlocation.Identity{
		// 					Type: to.Ptr(armextendedlocation.ResourceIdentityTypeSystemAssigned),
		// 					PrincipalID: to.Ptr("11111111-1111-1111-1111-111111111111"),
		// 					TenantID: to.Ptr("111111-1111-1111-1111-111111111111"),
		// 				},
		// 				Properties: &armextendedlocation.CustomLocationProperties{
		// 					Authentication: &armextendedlocation.CustomLocationPropertiesAuthentication{
		// 						Type: to.Ptr("KubeConfig"),
		// 					},
		// 					ClusterExtensionIDs: []*string{
		// 						to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster02/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension")},
		// 						DisplayName: to.Ptr("customLocationLocation02"),
		// 						HostResourceID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster02"),
		// 						Namespace: to.Ptr("namespace02"),
		// 						ProvisioningState: to.Ptr("Succeeded"),
		// 					},
		// 					SystemData: &armextendedlocation.SystemData{
		// 						CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-24T18:53:29.092Z"); return t}()),
		// 						CreatedBy: to.Ptr("string"),
		// 						CreatedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
		// 						LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-24T18:53:29.092Z"); return t}()),
		// 						LastModifiedBy: to.Ptr("string"),
		// 						LastModifiedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
		// 					},
		// 			}},
		// 		}
	}
}

Output:

func (*CustomLocationsClient) NewListEnabledResourceTypesPager added in v0.4.0 

func (client *CustomLocationsClient) NewListEnabledResourceTypesPager(resourceGroupName string, resourceName string, options *CustomLocationsClientListEnabledResourceTypesOptions) *runtime.Pager[CustomLocationsClientListEnabledResourceTypesResponse]

NewListEnabledResourceTypesPager - Gets the list of the Enabled Resource Types.

Generated from API version 2021-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • resourceName - Custom Locations name.
  • options - CustomLocationsClientListEnabledResourceTypesOptions contains the optional parameters for the CustomLocationsClient.NewListEnabledResourceTypesPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/extendedlocation/resource-manager/Microsoft.ExtendedLocation/stable/2021-08-15/examples/CustomLocationsListEnabledResourceTypes.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/extendedlocation/armextendedlocation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armextendedlocation.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewCustomLocationsClient().NewListEnabledResourceTypesPager("testresourcegroup", "customLocation01", 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.EnabledResourceTypesListResult = armextendedlocation.EnabledResourceTypesListResult{
		// 	Value: []*armextendedlocation.EnabledResourceType{
		// 		{
		// 			Name: to.Ptr("d016ecf26dae90594806aca3c1a6326c668357037f68103587edf2e657824737"),
		// 			Type: to.Ptr("Microsoft.ExtendedLocation/customLocations/enabledResourceTypes"),
		// 			ID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/customLocation01/enabledResourceTypes/d016ecf26dae90594806aca3c1a6326c668357037f68103587edf2e657824737"),
		// 			Properties: &armextendedlocation.EnabledResourceTypeProperties{
		// 				ClusterExtensionID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/cldfe2econnectedcluster/providers/Microsoft.KubernetesConfiguration/extensions/vmware-extension"),
		// 				ExtensionType: to.Ptr("arc-vmware"),
		// 				TypesMetadata: []*armextendedlocation.EnabledResourceTypePropertiesTypesMetadataItem{
		// 					{
		// 						APIVersion: to.Ptr("2020-01-01-preview"),
		// 						ResourceProviderNamespace: to.Ptr("Microsoft.VMware"),
		// 						ResourceType: to.Ptr("virtualMachines"),
		// 					},
		// 					{
		// 						APIVersion: to.Ptr("2020-01-22-preview"),
		// 						ResourceProviderNamespace: to.Ptr("Microsoft.VMware"),
		// 						ResourceType: to.Ptr("virtualmachines"),
		// 				}},
		// 			},
		// 			SystemData: &armextendedlocation.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T18:53:29.092Z"); return t}()),
		// 				CreatedBy: to.Ptr("string"),
		// 				CreatedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-24T18:53:29.092Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("string"),
		// 				LastModifiedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("266e9d31e5be6be1e919574e25780d5783586d502f0b2cc422e0a228a34e00a6"),
		// 			Type: to.Ptr("Microsoft.ExtendedLocation/customLocations/enabledResourceTypes"),
		// 			ID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/customLocation01/enabledResourceTypes/266e9d31e5be6be1e919574e25780d5783586d502f0b2cc422e0a228a34e00a6"),
		// 			Properties: &armextendedlocation.EnabledResourceTypeProperties{
		// 				ClusterExtensionID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/cldfe2econnectedcluster/providers/Microsoft.KubernetesConfiguration/extensions/cassandra-extension"),
		// 				ExtensionType: to.Ptr("cassandradatacentersoperator"),
		// 				TypesMetadata: []*armextendedlocation.EnabledResourceTypePropertiesTypesMetadataItem{
		// 					{
		// 						APIVersion: to.Ptr("2020-01-01-preview"),
		// 						ResourceProviderNamespace: to.Ptr("Microsoft.Cassandra"),
		// 						ResourceType: to.Ptr("cassandraDataCenters"),
		// 					},
		// 					{
		// 						APIVersion: to.Ptr("2020-01-22-preview"),
		// 						ResourceProviderNamespace: to.Ptr("Microsoft.Cassandra"),
		// 						ResourceType: to.Ptr("cassandrabackups"),
		// 				}},
		// 			},
		// 			SystemData: &armextendedlocation.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-24T18:53:29.092Z"); return t}()),
		// 				CreatedBy: to.Ptr("string"),
		// 				CreatedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-24T18:53:29.092Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("string"),
		// 				LastModifiedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
		// 			},
		// 	}},
		// }
	}
}

Output:

func (*CustomLocationsClient) NewListOperationsPager added in v0.4.0 

func (client *CustomLocationsClient) NewListOperationsPager(options *CustomLocationsClientListOperationsOptions) *runtime.Pager[CustomLocationsClientListOperationsResponse]

NewListOperationsPager - Lists all available Custom Locations operations.

Generated from API version 2021-08-15

  • options - CustomLocationsClientListOperationsOptions contains the optional parameters for the CustomLocationsClient.NewListOperationsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/extendedlocation/resource-manager/Microsoft.ExtendedLocation/stable/2021-08-15/examples/CustomLocationsListOperations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/extendedlocation/armextendedlocation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armextendedlocation.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewCustomLocationsClient().NewListOperationsPager(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.CustomLocationOperationsList = armextendedlocation.CustomLocationOperationsList{
		// 	Value: []*armextendedlocation.CustomLocationOperation{
		// 		{
		// 			Name: to.Ptr("Microsoft.ExtendedLocation/operations/read"),
		// 			Display: &armextendedlocation.CustomLocationOperationValueDisplay{
		// 				Description: to.Ptr("Gets list of Available Operations for Custom Locations"),
		// 				Operation: to.Ptr("List Available Operations for Custom Locations"),
		// 				Provider: to.Ptr("Microsoft.ExtendedLocation"),
		// 				Resource: to.Ptr("Operations"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 			Origin: to.Ptr("user,system"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.ExtendedLocation/register/action"),
		// 			Display: &armextendedlocation.CustomLocationOperationValueDisplay{
		// 				Description: to.Ptr("Registers the subscription for Custom Location resource provider and enables the creation of Custom Location."),
		// 				Operation: to.Ptr("Registers the Custom Location Resource Provider"),
		// 				Provider: to.Ptr("Microsoft.ExtendedLocation"),
		// 				Resource: to.Ptr("Custom Locations Resource Provider"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 			Origin: to.Ptr("user,system"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.ExtendedLocation/unregister/action"),
		// 			Display: &armextendedlocation.CustomLocationOperationValueDisplay{
		// 				Description: to.Ptr("UnRegisters the subscription for Custom Location resource provider and disables the creation of Custom Location."),
		// 				Operation: to.Ptr("UnRegisters the Custom Location Resource Provider"),
		// 				Provider: to.Ptr("Microsoft.ExtendedLocation"),
		// 				Resource: to.Ptr("Custom Locations Resource Provider"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 			Origin: to.Ptr("user,system"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.ExtendedLocation/customLocations/read"),
		// 			Display: &armextendedlocation.CustomLocationOperationValueDisplay{
		// 				Description: to.Ptr("Gets an Custom Location resource"),
		// 				Operation: to.Ptr("Get Custom Location"),
		// 				Provider: to.Ptr("Microsoft.ExtendedLocation"),
		// 				Resource: to.Ptr("Custom Locations"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 			Origin: to.Ptr("user,system"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.ExtendedLocation/customLocations/write"),
		// 			Display: &armextendedlocation.CustomLocationOperationValueDisplay{
		// 				Description: to.Ptr("Creates or Updates Custom Location resource"),
		// 				Operation: to.Ptr("Create or Update Custom Location"),
		// 				Provider: to.Ptr("Microsoft.ExtendedLocation"),
		// 				Resource: to.Ptr("Custom Locations"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 			Origin: to.Ptr("user,system"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.ExtendedLocation/customLocations/deploy/action"),
		// 			Display: &armextendedlocation.CustomLocationOperationValueDisplay{
		// 				Description: to.Ptr("Deploy permissions to a Custom Location resource"),
		// 				Operation: to.Ptr("Deploy permissions to Custom Location"),
		// 				Provider: to.Ptr("Microsoft.ExtendedLocation"),
		// 				Resource: to.Ptr("Custom Locations"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 			Origin: to.Ptr("user,system"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.ExtendedLocation/customLocations/delete"),
		// 			Display: &armextendedlocation.CustomLocationOperationValueDisplay{
		// 				Description: to.Ptr("Deletes Custom Location resource"),
		// 				Operation: to.Ptr("Delete Custom Location"),
		// 				Provider: to.Ptr("Microsoft.ExtendedLocation"),
		// 				Resource: to.Ptr("Custom Locations"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 			Origin: to.Ptr("user,system"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.ExtendedLocation/customLocations/enabledresourcetypes/read"),
		// 			Display: &armextendedlocation.CustomLocationOperationValueDisplay{
		// 				Description: to.Ptr("Gets EnabledResourceTypes for a Custom Location resource"),
		// 				Operation: to.Ptr("Get EnabledResourceTypes for Custom Location"),
		// 				Provider: to.Ptr("Microsoft.ExtendedLocation"),
		// 				Resource: to.Ptr("Custom Locations"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 			Origin: to.Ptr("user,system"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.ExtendedLocation/locations/operationsstatus/read"),
		// 			Display: &armextendedlocation.CustomLocationOperationValueDisplay{
		// 				Description: to.Ptr("Get result of Custom Location operation"),
		// 				Operation: to.Ptr("Get status of Custom Location operation"),
		// 				Provider: to.Ptr("Microsoft.ExtendedLocation"),
		// 				Resource: to.Ptr("Custom Location Operation Status"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 			Origin: to.Ptr("user,system"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.ExtendedLocation/locations/operationresults/read"),
		// 			Display: &armextendedlocation.CustomLocationOperationValueDisplay{
		// 				Description: to.Ptr("Get result of Custom Location operation"),
		// 				Operation: to.Ptr("Get the status of Custom Location operation"),
		// 				Provider: to.Ptr("Microsoft.ExtendedLocation"),
		// 				Resource: to.Ptr("Custom Location Operation Result"),
		// 			},
		// 			IsDataAction: to.Ptr(false),
		// 			Origin: to.Ptr("user,system"),
		// 	}},
		// }
	}
}

Output:

func (*CustomLocationsClient) Update 

func (client *CustomLocationsClient) Update(ctx context.Context, resourceGroupName string, resourceName string, parameters PatchableCustomLocations, options *CustomLocationsClientUpdateOptions) (CustomLocationsClientUpdateResponse, error)

Update - Updates a Custom Location with the specified Resource Name in the specified Resource Group and Subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2021-08-15

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • resourceName - Custom Locations name.
  • parameters - The updatable fields of an existing Custom Location.
  • options - CustomLocationsClientUpdateOptions contains the optional parameters for the CustomLocationsClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/extendedlocation/resource-manager/Microsoft.ExtendedLocation/stable/2021-08-15/examples/CustomLocationsPatch.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/extendedlocation/armextendedlocation"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armextendedlocation.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCustomLocationsClient().Update(ctx, "testresourcegroup", "customLocation01", armextendedlocation.PatchableCustomLocations{
		Identity: &armextendedlocation.Identity{
			Type: to.Ptr(armextendedlocation.ResourceIdentityTypeSystemAssigned),
		},
		Properties: &armextendedlocation.CustomLocationProperties{
			ClusterExtensionIDs: []*string{
				to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension"),
				to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/barExtension")},
		},
		Tags: map[string]*string{
			"archv3": to.Ptr(""),
			"tier":   to.Ptr("testing"),
		},
	}, 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.CustomLocation = armextendedlocation.CustomLocation{
	// 	Name: to.Ptr("customLocation01"),
	// 	Type: to.Ptr("Microsoft.ExtendedLocation/customLocations"),
	// 	ID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/customLocation01"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"archv3": to.Ptr(""),
	// 		"tier": to.Ptr("testing"),
	// 	},
	// 	Identity: &armextendedlocation.Identity{
	// 		Type: to.Ptr(armextendedlocation.ResourceIdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("11111111-1111-1111-1111-111111111111"),
	// 		TenantID: to.Ptr("111111-1111-1111-1111-111111111111"),
	// 	},
	// 	Properties: &armextendedlocation.CustomLocationProperties{
	// 		Authentication: &armextendedlocation.CustomLocationPropertiesAuthentication{
	// 			Type: to.Ptr("KubeConfig"),
	// 		},
	// 		ClusterExtensionIDs: []*string{
	// 			to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/fooExtension"),
	// 			to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01/Microsoft.KubernetesConfiguration/clusterExtensions/barExtension")},
	// 			DisplayName: to.Ptr("customLocationLocation01"),
	// 			HostResourceID: to.Ptr("/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ContainerService/managedClusters/cluster01"),
	// 			Namespace: to.Ptr("namespace01"),
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 		},
	// 		SystemData: &armextendedlocation.SystemData{
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-24T18:53:29.092Z"); return t}()),
	// 			CreatedBy: to.Ptr("string"),
	// 			CreatedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-24T18:53:29.092Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("string"),
	// 			LastModifiedByType: to.Ptr(armextendedlocation.CreatedByTypeApplication),
	// 		},
	// 	}
}

Output:

type CustomLocationsClientBeginCreateOrUpdateOptions added in v0.2.0 

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

CustomLocationsClientBeginCreateOrUpdateOptions contains the optional parameters for the CustomLocationsClient.BeginCreateOrUpdate method.

type CustomLocationsClientBeginDeleteOptions added in v0.2.0 

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

CustomLocationsClientBeginDeleteOptions contains the optional parameters for the CustomLocationsClient.BeginDelete method.

type CustomLocationsClientCreateOrUpdateResponse added in v0.2.0 

type CustomLocationsClientCreateOrUpdateResponse struct {
	// Custom Locations definition.
	CustomLocation
}

CustomLocationsClientCreateOrUpdateResponse contains the response from method CustomLocationsClient.BeginCreateOrUpdate.

type CustomLocationsClientDeleteResponse added in v0.2.0 

type CustomLocationsClientDeleteResponse struct {
}

CustomLocationsClientDeleteResponse contains the response from method CustomLocationsClient.BeginDelete.

type CustomLocationsClientGetOptions added in v0.2.0 

type CustomLocationsClientGetOptions struct {
}

CustomLocationsClientGetOptions contains the optional parameters for the CustomLocationsClient.Get method.

type CustomLocationsClientGetResponse added in v0.2.0 

type CustomLocationsClientGetResponse struct {
	// Custom Locations definition.
	CustomLocation
}

CustomLocationsClientGetResponse contains the response from method CustomLocationsClient.Get.

type CustomLocationsClientListByResourceGroupOptions added in v0.2.0 

type CustomLocationsClientListByResourceGroupOptions struct {
}

CustomLocationsClientListByResourceGroupOptions contains the optional parameters for the CustomLocationsClient.NewListByResourceGroupPager method.

type CustomLocationsClientListByResourceGroupResponse added in v0.2.0 

type CustomLocationsClientListByResourceGroupResponse struct {
	// The List Custom Locations operation response.
	CustomLocationListResult
}

CustomLocationsClientListByResourceGroupResponse contains the response from method CustomLocationsClient.NewListByResourceGroupPager.

type CustomLocationsClientListBySubscriptionOptions added in v0.2.0 

type CustomLocationsClientListBySubscriptionOptions struct {
}

CustomLocationsClientListBySubscriptionOptions contains the optional parameters for the CustomLocationsClient.NewListBySubscriptionPager method.

type CustomLocationsClientListBySubscriptionResponse added in v0.2.0 

type CustomLocationsClientListBySubscriptionResponse struct {
	// The List Custom Locations operation response.
	CustomLocationListResult
}

CustomLocationsClientListBySubscriptionResponse contains the response from method CustomLocationsClient.NewListBySubscriptionPager.

type CustomLocationsClientListEnabledResourceTypesOptions added in v0.2.0 

type CustomLocationsClientListEnabledResourceTypesOptions struct {
}

CustomLocationsClientListEnabledResourceTypesOptions contains the optional parameters for the CustomLocationsClient.NewListEnabledResourceTypesPager method.

type CustomLocationsClientListEnabledResourceTypesResponse added in v0.2.0 

type CustomLocationsClientListEnabledResourceTypesResponse struct {
	// List of EnabledResourceTypes definition.
	EnabledResourceTypesListResult
}

CustomLocationsClientListEnabledResourceTypesResponse contains the response from method CustomLocationsClient.NewListEnabledResourceTypesPager.

type CustomLocationsClientListOperationsOptions added in v0.2.0 

type CustomLocationsClientListOperationsOptions struct {
}

CustomLocationsClientListOperationsOptions contains the optional parameters for the CustomLocationsClient.NewListOperationsPager method.

type CustomLocationsClientListOperationsResponse added in v0.2.0 

type CustomLocationsClientListOperationsResponse struct {
	// Lists of Custom Locations operations.
	CustomLocationOperationsList
}

CustomLocationsClientListOperationsResponse contains the response from method CustomLocationsClient.NewListOperationsPager.

type CustomLocationsClientUpdateOptions added in v0.2.0 

type CustomLocationsClientUpdateOptions struct {
}

CustomLocationsClientUpdateOptions contains the optional parameters for the CustomLocationsClient.Update method.

type CustomLocationsClientUpdateResponse added in v0.2.0 

type CustomLocationsClientUpdateResponse struct {
	// Custom Locations definition.
	CustomLocation
}

CustomLocationsClientUpdateResponse contains the response from method CustomLocationsClient.Update.

type EnabledResourceType 

type EnabledResourceType struct {
	// The set of properties for EnabledResourceType specific to a Custom Location
	Properties *EnabledResourceTypeProperties

	// 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; Metadata pertaining to creation and last modification of the resource
	SystemData *SystemData

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

EnabledResourceType definition.

func (EnabledResourceType) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EnabledResourceType.

func (*EnabledResourceType) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EnabledResourceType.

type EnabledResourceTypeProperties 

type EnabledResourceTypeProperties struct {
	// Cluster Extension ID
	ClusterExtensionID *string

	// Cluster Extension Type
	ExtensionType *string

	// Metadata of the Resource Type
	TypesMetadata []*EnabledResourceTypePropertiesTypesMetadataItem
}

EnabledResourceTypeProperties - Properties for EnabledResourceType of a custom location.

func (EnabledResourceTypeProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EnabledResourceTypeProperties.

func (*EnabledResourceTypeProperties) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EnabledResourceTypeProperties.

type EnabledResourceTypePropertiesTypesMetadataItem 

type EnabledResourceTypePropertiesTypesMetadataItem struct {
	// Api Version of Resource Type
	APIVersion *string

	// Resource Provider Namespace of Resource Type
	ResourceProviderNamespace *string

	// Resource Type
	ResourceType *string
}

EnabledResourceTypePropertiesTypesMetadataItem - Metadata of the Resource Type.

func (EnabledResourceTypePropertiesTypesMetadataItem) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type EnabledResourceTypePropertiesTypesMetadataItem.

func (*EnabledResourceTypePropertiesTypesMetadataItem) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EnabledResourceTypePropertiesTypesMetadataItem.

type EnabledResourceTypesListResult 

type EnabledResourceTypesListResult struct {
	// READ-ONLY; The URL to use for getting the next set of results.
	NextLink *string

	// READ-ONLY; The list of EnabledResourceTypes available for a customLocation.
	Value []*EnabledResourceType
}

EnabledResourceTypesListResult - List of EnabledResourceTypes definition.

func (EnabledResourceTypesListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EnabledResourceTypesListResult.

func (*EnabledResourceTypesListResult) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EnabledResourceTypesListResult.

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info any

	// READ-ONLY; The additional info type.
	Type *string
}

ErrorAdditionalInfo - The resource management error additional info.

func (ErrorAdditionalInfo) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type ErrorAdditionalInfo.

func (*ErrorAdditionalInfo) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorAdditionalInfo.

type ErrorDetail 

type ErrorDetail struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo

	// READ-ONLY; The error code.
	Code *string

	// READ-ONLY; The error details.
	Details []*ErrorDetail

	// READ-ONLY; The error message.
	Message *string

	// READ-ONLY; The error target.
	Target *string
}

ErrorDetail - The error detail.

func (ErrorDetail) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

func (*ErrorDetail) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorDetail.

type ErrorResponse 

type ErrorResponse struct {
	// The error object.
	Error *ErrorDetail
}

ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

func (ErrorResponse) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

type HostType 

type HostType string

HostType - Type of host the Custom Locations is referencing (Kubernetes, etc…). 

const (
	HostTypeKubernetes HostType = "Kubernetes"
)

func PossibleHostTypeValues 

func PossibleHostTypeValues() []HostType

PossibleHostTypeValues returns the possible values for the HostType const type.

type Identity 

type Identity struct {
	// The identity type.
	Type *ResourceIdentityType

	// READ-ONLY; The principal ID of resource identity.
	PrincipalID *string

	// READ-ONLY; The tenant ID of resource.
	TenantID *string
}

Identity for the resource.

func (Identity) MarshalJSON added in v1.1.0 

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

MarshalJSON implements the json.Marshaller interface for type Identity.

func (*Identity) UnmarshalJSON added in v1.1.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Identity.

type PatchableCustomLocations 

type PatchableCustomLocations struct {
	// Identity for the resource.
	Identity *Identity

	// The Custom Locations patchable properties.
	Properties *CustomLocationProperties

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

PatchableCustomLocations - The Custom Locations patchable resource definition.

func (PatchableCustomLocations) MarshalJSON 

func (p PatchableCustomLocations) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PatchableCustomLocations.

func (*PatchableCustomLocations) UnmarshalJSON added in v1.1.0 

func (p *PatchableCustomLocations) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PatchableCustomLocations.

type ProxyResource 

type ProxyResource 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; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ProxyResource - The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

func (ProxyResource) MarshalJSON added in v1.1.0 

func (p ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProxyResource.

func (*ProxyResource) UnmarshalJSON added in v1.1.0 

func (p *ProxyResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProxyResource.

type Resource 

type Resource 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; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Resource.

func (*Resource) UnmarshalJSON added in v1.1.0 

func (r *Resource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Resource.

type ResourceIdentityType 

type ResourceIdentityType string

ResourceIdentityType - The identity type. 

const (
	ResourceIdentityTypeNone           ResourceIdentityType = "None"
	ResourceIdentityTypeSystemAssigned ResourceIdentityType = "SystemAssigned"
)

func PossibleResourceIdentityTypeValues 

func PossibleResourceIdentityTypeValues() []ResourceIdentityType

PossibleResourceIdentityTypeValues returns the possible values for the ResourceIdentityType 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 TrackedResource 

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

	// 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; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

TrackedResource - The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON 

func (t TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

func (*TrackedResource) UnmarshalJSON added in v1.1.0 

func (t *TrackedResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrackedResource.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.