armhardwaresecuritymodules

package module
v2.0.0-...-45adee8 Latest Latest
Warning

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

 Go to latest Published: Dec 1, 2024 License: MIT Imports: 16 Imported by: 0

README

Azure Dedicated HSM Module for Go

The armhardwaresecuritymodules module provides operations for working with Azure Dedicated HSM.

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 Dedicated HSM module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hardwaresecuritymodules/armhardwaresecuritymodules/v2

Authorization

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

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 Dedicated HSM 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 APIEntityReference 

type APIEntityReference struct {
	// The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/…
	ResourceID *string
}

APIEntityReference - The API entity reference.

func (APIEntityReference) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type APIEntityReference.

func (*APIEntityReference) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type APIEntityReference.

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 ActivationState 

type ActivationState string

ActivationState - State of security domain activation 

const (
	ActivationStateActive       ActivationState = "Active"
	ActivationStateFailed       ActivationState = "Failed"
	ActivationStateNotActivated ActivationState = "NotActivated"
	ActivationStateNotDefined   ActivationState = "NotDefined"
	ActivationStateUnknown      ActivationState = "Unknown"
)

func PossibleActivationStateValues 

func PossibleActivationStateValues() []ActivationState

PossibleActivationStateValues returns the possible values for the ActivationState const type.

type AutoGeneratedDomainNameLabelScope 

type AutoGeneratedDomainNameLabelScope string

AutoGeneratedDomainNameLabelScope - The Cloud HSM Cluster's auto-generated Domain Name Label Scope 

const (
	AutoGeneratedDomainNameLabelScopeNoReuse            AutoGeneratedDomainNameLabelScope = "NoReuse"
	AutoGeneratedDomainNameLabelScopeResourceGroupReuse AutoGeneratedDomainNameLabelScope = "ResourceGroupReuse"
	AutoGeneratedDomainNameLabelScopeSubscriptionReuse  AutoGeneratedDomainNameLabelScope = "SubscriptionReuse"
	AutoGeneratedDomainNameLabelScopeTenantReuse        AutoGeneratedDomainNameLabelScope = "TenantReuse"
)

func PossibleAutoGeneratedDomainNameLabelScopeValues 

func PossibleAutoGeneratedDomainNameLabelScopeValues() []AutoGeneratedDomainNameLabelScope

PossibleAutoGeneratedDomainNameLabelScopeValues returns the possible values for the AutoGeneratedDomainNameLabelScope const type.

type BackupRequestProperties 

type BackupRequestProperties struct {
	// REQUIRED; The Azure blob storage container Uri which contains the backup
	AzureStorageBlobContainerURI *string

	// The SAS token pointing to an Azure blob storage container. This property is reserved for Azure Backup Service.
	Token *string
}

BackupRequestProperties - Backup properties

func (BackupRequestProperties) MarshalJSON 

func (b BackupRequestProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackupRequestProperties.

func (*BackupRequestProperties) UnmarshalJSON 

func (b *BackupRequestProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupRequestProperties.

type BackupRestoreBaseResultProperties 

type BackupRestoreBaseResultProperties struct {
	// Error encountered, if any, during the backup/restore operation.
	Error *ErrorDetail

	// Identifier for the backup/restore operation.
	JobID *string

	// The status details of backup/restore operation
	StatusDetails *string

	// READ-ONLY; The end time of the backup/restore operation in UTC
	EndTime *time.Time

	// READ-ONLY; The start time of the backup/restore operation in UTC
	StartTime *time.Time

	// READ-ONLY; Status of the backup/restore operation
	Status *BackupRestoreOperationStatus
}

BackupRestoreBaseResultProperties - Backup and Restore operation common properties

func (BackupRestoreBaseResultProperties) MarshalJSON 

func (b BackupRestoreBaseResultProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackupRestoreBaseResultProperties.

func (*BackupRestoreBaseResultProperties) UnmarshalJSON 

func (b *BackupRestoreBaseResultProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupRestoreBaseResultProperties.

type BackupRestoreOperationStatus 

type BackupRestoreOperationStatus string

BackupRestoreOperationStatus - Status of the backup/restore operation 

const (
	BackupRestoreOperationStatusCancelled  BackupRestoreOperationStatus = "Cancelled"
	BackupRestoreOperationStatusFailed     BackupRestoreOperationStatus = "Failed"
	BackupRestoreOperationStatusInProgress BackupRestoreOperationStatus = "InProgress"
	BackupRestoreOperationStatusSucceeded  BackupRestoreOperationStatus = "Succeeded"
)

func PossibleBackupRestoreOperationStatusValues 

func PossibleBackupRestoreOperationStatusValues() []BackupRestoreOperationStatus

PossibleBackupRestoreOperationStatusValues returns the possible values for the BackupRestoreOperationStatus const type.

type BackupRestoreRequestBaseProperties 

type BackupRestoreRequestBaseProperties struct {
	// REQUIRED; The Azure blob storage container Uri which contains the backup
	AzureStorageBlobContainerURI *string

	// The SAS token pointing to an Azure blob storage container. This property is reserved for Azure Backup Service.
	Token *string
}

BackupRestoreRequestBaseProperties - Backup and Restore Common properties

func (BackupRestoreRequestBaseProperties) MarshalJSON 

func (b BackupRestoreRequestBaseProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackupRestoreRequestBaseProperties.

func (*BackupRestoreRequestBaseProperties) UnmarshalJSON 

func (b *BackupRestoreRequestBaseProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupRestoreRequestBaseProperties.

type BackupResult 

type BackupResult struct {
	// Properties of the Cloud HSM Cluster
	Properties *BackupResultProperties
}

BackupResult - Backup operation Result

func (BackupResult) MarshalJSON 

func (b BackupResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackupResult.

func (*BackupResult) UnmarshalJSON 

func (b *BackupResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupResult.

type BackupResultProperties 

type BackupResultProperties struct {
	// The Azure blob storage container Uri which contains the backup
	AzureStorageBlobContainerURI *string

	// The ID of the backup.
	BackupID *string

	// Error encountered, if any, during the backup/restore operation.
	Error *ErrorDetail

	// Identifier for the backup/restore operation.
	JobID *string

	// The status details of backup/restore operation
	StatusDetails *string

	// READ-ONLY; The end time of the backup/restore operation in UTC
	EndTime *time.Time

	// READ-ONLY; The start time of the backup/restore operation in UTC
	StartTime *time.Time

	// READ-ONLY; Status of the backup/restore operation
	Status *BackupRestoreOperationStatus
}

BackupResultProperties - Properties of the Cloud HSM Cluster

func (BackupResultProperties) MarshalJSON 

func (b BackupResultProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BackupResultProperties.

func (*BackupResultProperties) UnmarshalJSON 

func (b *BackupResultProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BackupResultProperties.

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. The value must be an UUID.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewCloudHsmClusterBackupStatusClient 

func (c *ClientFactory) NewCloudHsmClusterBackupStatusClient() *CloudHsmClusterBackupStatusClient

NewCloudHsmClusterBackupStatusClient creates a new instance of CloudHsmClusterBackupStatusClient.

func (*ClientFactory) NewCloudHsmClusterPrivateEndpointConnectionsClient 

func (c *ClientFactory) NewCloudHsmClusterPrivateEndpointConnectionsClient() *CloudHsmClusterPrivateEndpointConnectionsClient

NewCloudHsmClusterPrivateEndpointConnectionsClient creates a new instance of CloudHsmClusterPrivateEndpointConnectionsClient.

func (*ClientFactory) NewCloudHsmClusterPrivateLinkResourcesClient 

func (c *ClientFactory) NewCloudHsmClusterPrivateLinkResourcesClient() *CloudHsmClusterPrivateLinkResourcesClient

NewCloudHsmClusterPrivateLinkResourcesClient creates a new instance of CloudHsmClusterPrivateLinkResourcesClient.

func (*ClientFactory) NewCloudHsmClusterRestoreStatusClient 

func (c *ClientFactory) NewCloudHsmClusterRestoreStatusClient() *CloudHsmClusterRestoreStatusClient

NewCloudHsmClusterRestoreStatusClient creates a new instance of CloudHsmClusterRestoreStatusClient.

func (*ClientFactory) NewCloudHsmClustersClient 

func (c *ClientFactory) NewCloudHsmClustersClient() *CloudHsmClustersClient

NewCloudHsmClustersClient creates a new instance of CloudHsmClustersClient.

func (*ClientFactory) NewDedicatedHsmClient 

func (c *ClientFactory) NewDedicatedHsmClient() *DedicatedHsmClient

NewDedicatedHsmClient creates a new instance of DedicatedHsmClient.

func (*ClientFactory) NewOperationsClient 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewPrivateEndpointConnectionsClient 

func (c *ClientFactory) NewPrivateEndpointConnectionsClient() *PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient.

type CloudHsmCluster 

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

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

	// Properties of the Cloud HSM Cluster
	Properties *CloudHsmClusterProperties

	// SKU details
	SKU *CloudHsmClusterSKU

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

	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/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
}

CloudHsmCluster - Resource information with extended details.

func (CloudHsmCluster) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CloudHsmCluster.

func (*CloudHsmCluster) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CloudHsmCluster.

type CloudHsmClusterBackupStatusClient 

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

CloudHsmClusterBackupStatusClient contains the methods for the CloudHsmClusterBackupStatus group. Don't use this type directly, use NewCloudHsmClusterBackupStatusClient() instead.

func NewCloudHsmClusterBackupStatusClient 

func NewCloudHsmClusterBackupStatusClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*CloudHsmClusterBackupStatusClient, error)

NewCloudHsmClusterBackupStatusClient creates a new instance of CloudHsmClusterBackupStatusClient with the specified values.

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

func (*CloudHsmClusterBackupStatusClient) Get 

func (client *CloudHsmClusterBackupStatusClient) Get(ctx context.Context, resourceGroupName string, cloudHsmClusterName string, jobID string, options *CloudHsmClusterBackupStatusClientGetOptions) (CloudHsmClusterBackupStatusClientGetResponse, error)

Get - Gets the backup operation status of the specified Cloud HSM Cluster If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • cloudHsmClusterName - The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
  • jobID - The id returned as part of the backup request
  • options - CloudHsmClusterBackupStatusClientGetOptions contains the optional parameters for the CloudHsmClusterBackupStatusClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/CloudHsmCluster_Backup_Pending_MaximumSet_Gen.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewCloudHsmClusterBackupStatusClient().Get(ctx, "rgcloudhsm", "chsm1", "572a45927fc240e1ac075de27371680b", 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.BackupResult = armhardwaresecuritymodules.BackupResult{
// 	Properties: &armhardwaresecuritymodules.BackupResultProperties{
// 		EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
// 		JobID: to.Ptr("572a45927fc240e1ac075de27371680b"),
// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
// 		Status: to.Ptr(armhardwaresecuritymodules.BackupRestoreOperationStatusInProgress),
// 		StatusDetails: to.Ptr("Backup operation is in progress"),
// 		AzureStorageBlobContainerURI: to.Ptr("https://myaccount.blob.core.windows.net/sascontainer/sasContainer"),
// 	},
// }

Output:

type CloudHsmClusterBackupStatusClientGetOptions 

type CloudHsmClusterBackupStatusClientGetOptions struct {
}

CloudHsmClusterBackupStatusClientGetOptions contains the optional parameters for the CloudHsmClusterBackupStatusClient.Get method.

type CloudHsmClusterBackupStatusClientGetResponse 

type CloudHsmClusterBackupStatusClientGetResponse struct {
	// Backup operation Result
	BackupResult

	// Location contains the information returned from the Location header response.
	Location *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

CloudHsmClusterBackupStatusClientGetResponse contains the response from method CloudHsmClusterBackupStatusClient.Get.

type CloudHsmClusterListResult 

type CloudHsmClusterListResult struct {
	// The URL to get the next set of Cloud HSM Clusters.
	NextLink *string

	// The list of Cloud HSM Clusters.
	Value []*CloudHsmCluster
}

CloudHsmClusterListResult - List of Cloud HSM Clusters

func (CloudHsmClusterListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CloudHsmClusterListResult.

func (*CloudHsmClusterListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CloudHsmClusterListResult.

type CloudHsmClusterPatchParameters 

type CloudHsmClusterPatchParameters struct {
	// Managed service identity (system assigned and/or user assigned identities)
	Identity *ManagedServiceIdentity

	// The Cloud HSM Cluster's tags
	Tags map[string]*string
}

CloudHsmClusterPatchParameters - Patchable properties of the Cloud HSM Cluster

func (CloudHsmClusterPatchParameters) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CloudHsmClusterPatchParameters.

func (*CloudHsmClusterPatchParameters) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CloudHsmClusterPatchParameters.

type CloudHsmClusterPrivateEndpointConnectionsClient 

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

CloudHsmClusterPrivateEndpointConnectionsClient contains the methods for the CloudHsmClusterPrivateEndpointConnections group. Don't use this type directly, use NewCloudHsmClusterPrivateEndpointConnectionsClient() instead.

func NewCloudHsmClusterPrivateEndpointConnectionsClient 

func NewCloudHsmClusterPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*CloudHsmClusterPrivateEndpointConnectionsClient, error)

NewCloudHsmClusterPrivateEndpointConnectionsClient creates a new instance of CloudHsmClusterPrivateEndpointConnectionsClient with the specified values.

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

func (*CloudHsmClusterPrivateEndpointConnectionsClient) BeginDelete 

func (client *CloudHsmClusterPrivateEndpointConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, cloudHsmClusterName string, peConnectionName string, options *CloudHsmClusterPrivateEndpointConnectionsClientBeginDeleteOptions) (*runtime.Poller[CloudHsmClusterPrivateEndpointConnectionsClientDeleteResponse], error)

BeginDelete - Deletes the private endpoint connection for the Cloud Hsm Cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • cloudHsmClusterName - The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
  • peConnectionName - Name of the private endpoint connection associated with the Cloud HSM Cluster.
  • options - CloudHsmClusterPrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the CloudHsmClusterPrivateEndpointConnectionsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/CloudHsmClusterPrivateEndpointConnection_Delete_MaximumSet_Gen.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewCloudHsmClusterPrivateEndpointConnectionsClient().BeginDelete(ctx, "rgcloudhsm", "chsm1", "sample-pec", 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 (*CloudHsmClusterPrivateEndpointConnectionsClient) Create 

func (client *CloudHsmClusterPrivateEndpointConnectionsClient) Create(ctx context.Context, resourceGroupName string, cloudHsmClusterName string, peConnectionName string, properties PrivateEndpointConnection, options *CloudHsmClusterPrivateEndpointConnectionsClientCreateOptions) (CloudHsmClusterPrivateEndpointConnectionsClientCreateResponse, error)

Create - Creates or updates the private endpoint connection for the Cloud Hsm Cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • cloudHsmClusterName - The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
  • peConnectionName - Name of the private endpoint connection associated with the Cloud HSM Cluster.
  • properties - Parameters of the PrivateEndpointConnection
  • options - CloudHsmClusterPrivateEndpointConnectionsClientCreateOptions contains the optional parameters for the CloudHsmClusterPrivateEndpointConnectionsClient.Create method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/CloudHsmClusterPrivateEndpointConnection_Create_MaximumSet_Gen.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewCloudHsmClusterPrivateEndpointConnectionsClient().Create(ctx, "rgcloudhsm", "chsm1", "sample-pec", armhardwaresecuritymodules.PrivateEndpointConnection{
	Properties: &armhardwaresecuritymodules.PrivateEndpointConnectionProperties{
		PrivateLinkServiceConnectionState: &armhardwaresecuritymodules.PrivateLinkServiceConnectionState{
			Description: to.Ptr("My name is Joe and I'm approving this."),
			Status:      to.Ptr(armhardwaresecuritymodules.PrivateEndpointServiceConnectionStatusApproved),
		},
	},
}, 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.PrivateEndpointConnection = armhardwaresecuritymodules.PrivateEndpointConnection{
// 	Name: to.Ptr("sample-pec"),
// 	Type: to.Ptr("Microsoft.HardwareSecurityModules/cloudHsmClusters/privateEndpointConnections"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1/privateEndpointConnections/sample-pec"),
// 	SystemData: &armhardwaresecuritymodules.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
// 		CreatedBy: to.Ptr("User1"),
// 		CreatedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("User2"),
// 		LastModifiedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
// 	},
// 	Properties: &armhardwaresecuritymodules.PrivateEndpointConnectionProperties{
// 		PrivateEndpoint: &armhardwaresecuritymodules.PrivateEndpoint{
// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.Network/privateEndpoints/sample-pec"),
// 		},
// 		PrivateLinkServiceConnectionState: &armhardwaresecuritymodules.PrivateLinkServiceConnectionState{
// 			Description: to.Ptr("My name is Joe and I'm approving this."),
// 			ActionsRequired: to.Ptr("None"),
// 			Status: to.Ptr(armhardwaresecuritymodules.PrivateEndpointServiceConnectionStatusApproved),
// 		},
// 		ProvisioningState: to.Ptr(armhardwaresecuritymodules.PrivateEndpointConnectionProvisioningStateSucceeded),
// 	},
// }

Output:

func (*CloudHsmClusterPrivateEndpointConnectionsClient) Get 

func (client *CloudHsmClusterPrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, cloudHsmClusterName string, peConnectionName string, options *CloudHsmClusterPrivateEndpointConnectionsClientGetOptions) (CloudHsmClusterPrivateEndpointConnectionsClientGetResponse, error)

Get - Gets the private endpoint connection for the Cloud Hsm Cluster. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • cloudHsmClusterName - The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
  • peConnectionName - Name of the private endpoint connection associated with the Cloud HSM Cluster.
  • options - CloudHsmClusterPrivateEndpointConnectionsClientGetOptions contains the optional parameters for the CloudHsmClusterPrivateEndpointConnectionsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/CloudHsmClusterPrivateEndpointConnection_Get_MaximumSet_Gen.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewCloudHsmClusterPrivateEndpointConnectionsClient().Get(ctx, "rgcloudhsm", "chsm1", "sample-pec", 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.PrivateEndpointConnection = armhardwaresecuritymodules.PrivateEndpointConnection{
// 	Name: to.Ptr("sample-pec"),
// 	Type: to.Ptr("Microsoft.HardwareSecurityModules/cloudHsmClusters/privateEndpointConnections"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1/privateEndpointConnections/sample-pec"),
// 	SystemData: &armhardwaresecuritymodules.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
// 		CreatedBy: to.Ptr("User1"),
// 		CreatedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("User2"),
// 		LastModifiedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
// 	},
// 	Properties: &armhardwaresecuritymodules.PrivateEndpointConnectionProperties{
// 		PrivateEndpoint: &armhardwaresecuritymodules.PrivateEndpoint{
// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pec"),
// 		},
// 		PrivateLinkServiceConnectionState: &armhardwaresecuritymodules.PrivateLinkServiceConnectionState{
// 			Description: to.Ptr("This was automatically approved by user1234@contoso.com"),
// 			ActionsRequired: to.Ptr("None"),
// 			Status: to.Ptr(armhardwaresecuritymodules.PrivateEndpointServiceConnectionStatusApproved),
// 		},
// 		ProvisioningState: to.Ptr(armhardwaresecuritymodules.PrivateEndpointConnectionProvisioningStateSucceeded),
// 	},
// }

Output:

type CloudHsmClusterPrivateEndpointConnectionsClientBeginDeleteOptions 

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

CloudHsmClusterPrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the CloudHsmClusterPrivateEndpointConnectionsClient.BeginDelete method.

type CloudHsmClusterPrivateEndpointConnectionsClientCreateOptions 

type CloudHsmClusterPrivateEndpointConnectionsClientCreateOptions struct {
}

CloudHsmClusterPrivateEndpointConnectionsClientCreateOptions contains the optional parameters for the CloudHsmClusterPrivateEndpointConnectionsClient.Create method.

type CloudHsmClusterPrivateEndpointConnectionsClientCreateResponse 

type CloudHsmClusterPrivateEndpointConnectionsClientCreateResponse struct {
	// The private endpoint connection resource.
	PrivateEndpointConnection
}

CloudHsmClusterPrivateEndpointConnectionsClientCreateResponse contains the response from method CloudHsmClusterPrivateEndpointConnectionsClient.Create.

type CloudHsmClusterPrivateEndpointConnectionsClientDeleteResponse 

type CloudHsmClusterPrivateEndpointConnectionsClientDeleteResponse struct {
}

CloudHsmClusterPrivateEndpointConnectionsClientDeleteResponse contains the response from method CloudHsmClusterPrivateEndpointConnectionsClient.BeginDelete.

type CloudHsmClusterPrivateEndpointConnectionsClientGetOptions 

type CloudHsmClusterPrivateEndpointConnectionsClientGetOptions struct {
}

CloudHsmClusterPrivateEndpointConnectionsClientGetOptions contains the optional parameters for the CloudHsmClusterPrivateEndpointConnectionsClient.Get method.

type CloudHsmClusterPrivateEndpointConnectionsClientGetResponse 

type CloudHsmClusterPrivateEndpointConnectionsClientGetResponse struct {
	// The private endpoint connection resource.
	PrivateEndpointConnection
}

CloudHsmClusterPrivateEndpointConnectionsClientGetResponse contains the response from method CloudHsmClusterPrivateEndpointConnectionsClient.Get.

type CloudHsmClusterPrivateLinkResourcesClient 

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

CloudHsmClusterPrivateLinkResourcesClient contains the methods for the CloudHsmClusterPrivateLinkResources group. Don't use this type directly, use NewCloudHsmClusterPrivateLinkResourcesClient() instead.

func NewCloudHsmClusterPrivateLinkResourcesClient 

func NewCloudHsmClusterPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*CloudHsmClusterPrivateLinkResourcesClient, error)

NewCloudHsmClusterPrivateLinkResourcesClient creates a new instance of CloudHsmClusterPrivateLinkResourcesClient with the specified values.

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

func (*CloudHsmClusterPrivateLinkResourcesClient) NewListByCloudHsmClusterPager 

func (client *CloudHsmClusterPrivateLinkResourcesClient) NewListByCloudHsmClusterPager(resourceGroupName string, cloudHsmClusterName string, options *CloudHsmClusterPrivateLinkResourcesClientListByCloudHsmClusterOptions) *runtime.Pager[CloudHsmClusterPrivateLinkResourcesClientListByCloudHsmClusterResponse]

NewListByCloudHsmClusterPager - Gets the private link resources supported for the Cloud Hsm Cluster.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • cloudHsmClusterName - The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
  • options - CloudHsmClusterPrivateLinkResourcesClientListByCloudHsmClusterOptions contains the optional parameters for the CloudHsmClusterPrivateLinkResourcesClient.NewListByCloudHsmClusterPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/CloudHsmClusterPrivateLinkResource_ListByCloudHsmCluster_MaximumSet_Gen.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewCloudHsmClusterPrivateLinkResourcesClient().NewListByCloudHsmClusterPager("rgcloudhsm", "chsm1", 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.PrivateLinkResourceListResult = armhardwaresecuritymodules.PrivateLinkResourceListResult{
	// 	Value: []*armhardwaresecuritymodules.PrivateLinkResource{
	// 		{
	// 			Name: to.Ptr("sample-pls"),
	// 			Type: to.Ptr("Microsoft.HardwareSecurityModules/cloudHsmClusters/privateLinkResources"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1/privateLinkResources/sample-pls"),
	// 			Properties: &armhardwaresecuritymodules.PrivateLinkResourceProperties{
	// 				GroupID: to.Ptr("cloudHsm"),
	// 				RequiredMembers: []*string{
	// 					to.Ptr("hsm1"),
	// 					to.Ptr("hsm2"),
	// 					to.Ptr("hsm3")},
	// 					RequiredZoneNames: []*string{
	// 						to.Ptr("privatelink.cloudhsm.azure-int.net")},
	// 					},
	// 			}},
	// 		}
}

Output:

type CloudHsmClusterPrivateLinkResourcesClientListByCloudHsmClusterOptions 

type CloudHsmClusterPrivateLinkResourcesClientListByCloudHsmClusterOptions struct {
}

CloudHsmClusterPrivateLinkResourcesClientListByCloudHsmClusterOptions contains the optional parameters for the CloudHsmClusterPrivateLinkResourcesClient.NewListByCloudHsmClusterPager method.

type CloudHsmClusterPrivateLinkResourcesClientListByCloudHsmClusterResponse 

type CloudHsmClusterPrivateLinkResourcesClientListByCloudHsmClusterResponse struct {
	// A list of private link resources.
	PrivateLinkResourceListResult
}

CloudHsmClusterPrivateLinkResourcesClientListByCloudHsmClusterResponse contains the response from method CloudHsmClusterPrivateLinkResourcesClient.NewListByCloudHsmClusterPager.

type CloudHsmClusterProperties 

type CloudHsmClusterProperties struct {
	// The Cloud HSM Cluster's auto-generated Domain Name Label Scope
	AutoGeneratedDomainNameLabelScope *AutoGeneratedDomainNameLabelScope

	// The Cloud HSM Cluster public network access
	PublicNetworkAccess *PublicNetworkAccess

	// READ-ONLY; State of security domain activation
	ActivationState *ActivationState

	// READ-ONLY; An array of Cloud HSM Cluster's HSMs
	Hsms []*CloudHsmProperties

	// READ-ONLY; List of private endpoint connection resources
	PrivateEndpointConnections []*PrivateEndpointConnection

	// READ-ONLY; The Cloud HSM Cluster's provisioningState
	ProvisioningState *ProvisioningState

	// READ-ONLY; Cloud HSM Cluster status message
	StatusMessage *string
}

CloudHsmClusterProperties - Properties of a Cloud HSM Cluster.

func (CloudHsmClusterProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CloudHsmClusterProperties.

func (*CloudHsmClusterProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CloudHsmClusterProperties.

type CloudHsmClusterResource 

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

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

	// SKU details
	SKU *CloudHsmClusterSKU

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

	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/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
}

CloudHsmClusterResource - Cloud HSM Cluster Resource

func (CloudHsmClusterResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CloudHsmClusterResource.

func (*CloudHsmClusterResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CloudHsmClusterResource.

type CloudHsmClusterRestoreStatusClient 

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

CloudHsmClusterRestoreStatusClient contains the methods for the CloudHsmClusterRestoreStatus group. Don't use this type directly, use NewCloudHsmClusterRestoreStatusClient() instead.

func NewCloudHsmClusterRestoreStatusClient 

func NewCloudHsmClusterRestoreStatusClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*CloudHsmClusterRestoreStatusClient, error)

NewCloudHsmClusterRestoreStatusClient creates a new instance of CloudHsmClusterRestoreStatusClient with the specified values.

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

func (*CloudHsmClusterRestoreStatusClient) Get 

func (client *CloudHsmClusterRestoreStatusClient) Get(ctx context.Context, resourceGroupName string, cloudHsmClusterName string, jobID string, options *CloudHsmClusterRestoreStatusClientGetOptions) (CloudHsmClusterRestoreStatusClientGetResponse, error)

Get - Gets the restore operation status of the specified Cloud HSM Cluster If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • cloudHsmClusterName - The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
  • jobID - The id returned as part of the backup request
  • options - CloudHsmClusterRestoreStatusClientGetOptions contains the optional parameters for the CloudHsmClusterRestoreStatusClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/CloudHsmCluster_Restore_Pending_MaximumSet_Gen.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewCloudHsmClusterRestoreStatusClient().Get(ctx, "rgcloudhsm", "chsm1", "572a45927fc240e1ac075de27371680b", 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.RestoreResult = armhardwaresecuritymodules.RestoreResult{
// 	Properties: &armhardwaresecuritymodules.BackupRestoreBaseResultProperties{
// 		EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
// 		JobID: to.Ptr("572a45927fc240e1ac075de27371680b"),
// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
// 		Status: to.Ptr(armhardwaresecuritymodules.BackupRestoreOperationStatusInProgress),
// 		StatusDetails: to.Ptr("Restore operation is in progress"),
// 	},
// }

Output:

type CloudHsmClusterRestoreStatusClientGetOptions 

type CloudHsmClusterRestoreStatusClientGetOptions struct {
}

CloudHsmClusterRestoreStatusClientGetOptions contains the optional parameters for the CloudHsmClusterRestoreStatusClient.Get method.

type CloudHsmClusterRestoreStatusClientGetResponse 

type CloudHsmClusterRestoreStatusClientGetResponse struct {
	// Restore operation properties
	RestoreResult

	// Location contains the information returned from the Location header response.
	Location *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

CloudHsmClusterRestoreStatusClientGetResponse contains the response from method CloudHsmClusterRestoreStatusClient.Get.

type CloudHsmClusterSKU 

type CloudHsmClusterSKU struct {
	// REQUIRED; Sku family of the Cloud HSM Cluster
	Family *CloudHsmClusterSKUFamily

	// REQUIRED; Sku name of the Cloud HSM Cluster
	Name *CloudHsmClusterSKUName

	// Sku capacity
	Capacity *int32
}

CloudHsmClusterSKU - Cloud Hsm Cluster SKU information

func (CloudHsmClusterSKU) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CloudHsmClusterSKU.

func (*CloudHsmClusterSKU) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CloudHsmClusterSKU.

type CloudHsmClusterSKUFamily 

type CloudHsmClusterSKUFamily string

CloudHsmClusterSKUFamily - Sku family of the Cloud HSM Cluster 

const (
	CloudHsmClusterSKUFamilyB CloudHsmClusterSKUFamily = "B"
)

func PossibleCloudHsmClusterSKUFamilyValues 

func PossibleCloudHsmClusterSKUFamilyValues() []CloudHsmClusterSKUFamily

PossibleCloudHsmClusterSKUFamilyValues returns the possible values for the CloudHsmClusterSKUFamily const type.

type CloudHsmClusterSKUName 

type CloudHsmClusterSKUName string

CloudHsmClusterSKUName - Sku name of the Cloud HSM Cluster 

const (
	CloudHsmClusterSKUNameStandardB1  CloudHsmClusterSKUName = "Standard_B1"
	CloudHsmClusterSKUNameStandardB10 CloudHsmClusterSKUName = "Standard B10"
)

func PossibleCloudHsmClusterSKUNameValues 

func PossibleCloudHsmClusterSKUNameValues() []CloudHsmClusterSKUName

PossibleCloudHsmClusterSKUNameValues returns the possible values for the CloudHsmClusterSKUName const type.

type CloudHsmClustersClient 

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

CloudHsmClustersClient contains the methods for the CloudHsmClusters group. Don't use this type directly, use NewCloudHsmClustersClient() instead.

func NewCloudHsmClustersClient 

func NewCloudHsmClustersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*CloudHsmClustersClient, error)

NewCloudHsmClustersClient creates a new instance of CloudHsmClustersClient with the specified values.

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

func (*CloudHsmClustersClient) BeginBackup 

func (client *CloudHsmClustersClient) BeginBackup(ctx context.Context, resourceGroupName string, cloudHsmClusterName string, options *CloudHsmClustersClientBeginBackupOptions) (*runtime.Poller[CloudHsmClustersClientBackupResponse], error)

BeginBackup - Create a backup of the Cloud HSM Cluster in the specified subscription If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • cloudHsmClusterName - The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
  • options - CloudHsmClustersClientBeginBackupOptions contains the optional parameters for the CloudHsmClustersClient.BeginBackup method.

func (*CloudHsmClustersClient) BeginCreateOrUpdate 

func (client *CloudHsmClustersClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, cloudHsmClusterName string, body CloudHsmCluster, options *CloudHsmClustersClientBeginCreateOrUpdateOptions) (*runtime.Poller[CloudHsmClustersClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or Update a Cloud HSM Cluster in the specified subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • cloudHsmClusterName - The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
  • body - Parameters to create Cloud HSM Cluster
  • options - CloudHsmClustersClientBeginCreateOrUpdateOptions contains the optional parameters for the CloudHsmClustersClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/CloudHsmCluster_CreateOrUpdate_MaximumSet_Gen.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewCloudHsmClustersClient().BeginCreateOrUpdate(ctx, "rgcloudhsm", "chsm1", armhardwaresecuritymodules.CloudHsmCluster{
	Location: to.Ptr("eastus2"),
	Tags: map[string]*string{
		"Dept":        to.Ptr("hsm"),
		"Environment": to.Ptr("dogfood"),
	},
	Identity: &armhardwaresecuritymodules.ManagedServiceIdentity{
		Type: to.Ptr(armhardwaresecuritymodules.ManagedServiceIdentityTypeUserAssigned),
		UserAssignedIdentities: map[string]*armhardwaresecuritymodules.UserAssignedIdentity{
			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-1": {},
		},
	},
	SKU: &armhardwaresecuritymodules.CloudHsmClusterSKU{
		Name:   to.Ptr(armhardwaresecuritymodules.CloudHsmClusterSKUNameStandardB1),
		Family: to.Ptr(armhardwaresecuritymodules.CloudHsmClusterSKUFamilyB),
	},
	Properties: &armhardwaresecuritymodules.CloudHsmClusterProperties{
		PublicNetworkAccess: to.Ptr(armhardwaresecuritymodules.PublicNetworkAccessDisabled),
	},
}, 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.CloudHsmCluster = armhardwaresecuritymodules.CloudHsmCluster{
// 	Name: to.Ptr("chsm1"),
// 	Type: to.Ptr("Microsoft.HardwareSecurityModules/cloudHsmClusters"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1"),
// 	SystemData: &armhardwaresecuritymodules.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
// 		CreatedBy: to.Ptr("CHsmUser1"),
// 		CreatedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("CHsmUser2"),
// 		LastModifiedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("eastus2"),
// 	Tags: map[string]*string{
// 		"Dept": to.Ptr("hsm"),
// 		"Environment": to.Ptr("dogfood"),
// 	},
// 	Identity: &armhardwaresecuritymodules.ManagedServiceIdentity{
// 		Type: to.Ptr(armhardwaresecuritymodules.ManagedServiceIdentityTypeUserAssigned),
// 		UserAssignedIdentities: map[string]*armhardwaresecuritymodules.UserAssignedIdentity{
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-1": &armhardwaresecuritymodules.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 			},
// 		},
// 	},
// 	SKU: &armhardwaresecuritymodules.CloudHsmClusterSKU{
// 		Name: to.Ptr(armhardwaresecuritymodules.CloudHsmClusterSKUNameStandardB1),
// 		Family: to.Ptr(armhardwaresecuritymodules.CloudHsmClusterSKUFamilyB),
// 	},
// 	Properties: &armhardwaresecuritymodules.CloudHsmClusterProperties{
// 		ActivationState: to.Ptr(armhardwaresecuritymodules.ActivationState("null")),
// 		AutoGeneratedDomainNameLabelScope: to.Ptr(armhardwaresecuritymodules.AutoGeneratedDomainNameLabelScopeTenantReuse),
// 		ProvisioningState: to.Ptr(armhardwaresecuritymodules.ProvisioningStateSucceeded),
// 		PublicNetworkAccess: to.Ptr(armhardwaresecuritymodules.PublicNetworkAccessDisabled),
// 		StatusMessage: to.Ptr("This is a status message"),
// 	},
// }

Output:

func (*CloudHsmClustersClient) BeginDelete 

func (client *CloudHsmClustersClient) BeginDelete(ctx context.Context, resourceGroupName string, cloudHsmClusterName string, options *CloudHsmClustersClientBeginDeleteOptions) (*runtime.Poller[CloudHsmClustersClientDeleteResponse], error)

BeginDelete - Deletes the specified Cloud HSM Cluster If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • cloudHsmClusterName - The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
  • options - CloudHsmClustersClientBeginDeleteOptions contains the optional parameters for the CloudHsmClustersClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/CloudHsmCluster_Delete_MaximumSet_Gen.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewCloudHsmClustersClient().BeginDelete(ctx, "rgcloudhsm", "chsm1", 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 (*CloudHsmClustersClient) BeginRestore 

func (client *CloudHsmClustersClient) BeginRestore(ctx context.Context, resourceGroupName string, cloudHsmClusterName string, restoreRequestProperties RestoreRequestProperties, options *CloudHsmClustersClientBeginRestoreOptions) (*runtime.Poller[CloudHsmClustersClientRestoreResponse], error)

BeginRestore - Restores all key materials of a specified Cloud HSM Cluster If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • cloudHsmClusterName - The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
  • restoreRequestProperties - Restore Operation Required properties
  • options - CloudHsmClustersClientBeginRestoreOptions contains the optional parameters for the CloudHsmClustersClient.BeginRestore method.

func (*CloudHsmClustersClient) BeginUpdate 

func (client *CloudHsmClustersClient) BeginUpdate(ctx context.Context, resourceGroupName string, cloudHsmClusterName string, body CloudHsmClusterPatchParameters, options *CloudHsmClustersClientBeginUpdateOptions) (*runtime.Poller[CloudHsmClustersClientUpdateResponse], error)

BeginUpdate - Update a Cloud HSM Cluster in the specified subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • cloudHsmClusterName - The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
  • body - Parameters to create Cloud HSM Cluster
  • options - CloudHsmClustersClientBeginUpdateOptions contains the optional parameters for the CloudHsmClustersClient.BeginUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/CloudHsmCluster_Update_MaximumSet_Gen.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewCloudHsmClustersClient().BeginUpdate(ctx, "rgcloudhsm", "chsm1", armhardwaresecuritymodules.CloudHsmClusterPatchParameters{
	Identity: &armhardwaresecuritymodules.ManagedServiceIdentity{
		Type: to.Ptr(armhardwaresecuritymodules.ManagedServiceIdentityTypeUserAssigned),
		UserAssignedIdentities: map[string]*armhardwaresecuritymodules.UserAssignedIdentity{
			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-1": {},
		},
	},
	Tags: map[string]*string{
		"Dept":        to.Ptr("hsm"),
		"Environment": to.Ptr("dogfood"),
		"Slice":       to.Ptr("A"),
	},
}, 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.CloudHsmCluster = armhardwaresecuritymodules.CloudHsmCluster{
// 	Name: to.Ptr("chsm1"),
// 	Type: to.Ptr("Microsoft.HardwareSecurityModules/cloudHsmClusters"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1"),
// 	SystemData: &armhardwaresecuritymodules.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
// 		CreatedBy: to.Ptr("CHsmUser1"),
// 		CreatedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("CHsmUser2"),
// 		LastModifiedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("eastus2"),
// 	Tags: map[string]*string{
// 		"Dept": to.Ptr("hsm"),
// 		"Environment": to.Ptr("dogfood"),
// 		"Slice": to.Ptr("A"),
// 	},
// 	Identity: &armhardwaresecuritymodules.ManagedServiceIdentity{
// 		Type: to.Ptr(armhardwaresecuritymodules.ManagedServiceIdentityTypeUserAssigned),
// 		UserAssignedIdentities: map[string]*armhardwaresecuritymodules.UserAssignedIdentity{
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-1": &armhardwaresecuritymodules.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 			},
// 		},
// 	},
// 	SKU: &armhardwaresecuritymodules.CloudHsmClusterSKU{
// 		Name: to.Ptr(armhardwaresecuritymodules.CloudHsmClusterSKUNameStandardB1),
// 		Family: to.Ptr(armhardwaresecuritymodules.CloudHsmClusterSKUFamilyB),
// 	},
// 	Properties: &armhardwaresecuritymodules.CloudHsmClusterProperties{
// 		ActivationState: to.Ptr(armhardwaresecuritymodules.ActivationState("null")),
// 		AutoGeneratedDomainNameLabelScope: to.Ptr(armhardwaresecuritymodules.AutoGeneratedDomainNameLabelScopeTenantReuse),
// 		ProvisioningState: to.Ptr(armhardwaresecuritymodules.ProvisioningStateSucceeded),
// 		PublicNetworkAccess: to.Ptr(armhardwaresecuritymodules.PublicNetworkAccessDisabled),
// 		StatusMessage: to.Ptr("This is a status message"),
// 	},
// }

Output:

func (*CloudHsmClustersClient) BeginValidateBackupProperties 

func (client *CloudHsmClustersClient) BeginValidateBackupProperties(ctx context.Context, resourceGroupName string, cloudHsmClusterName string, options *CloudHsmClustersClientBeginValidateBackupPropertiesOptions) (*runtime.Poller[CloudHsmClustersClientValidateBackupPropertiesResponse], error)

BeginValidateBackupProperties - Pre Backup operation to validate whether the customer can perform a backup on the Cloud HSM Cluster resource in the specified subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • cloudHsmClusterName - The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
  • options - CloudHsmClustersClientBeginValidateBackupPropertiesOptions contains the optional parameters for the CloudHsmClustersClient.BeginValidateBackupProperties method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/CloudHsmCluster_CreateOrValidate_Backup_MaximumSet_Gen.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewCloudHsmClustersClient().BeginValidateBackupProperties(ctx, "rgcloudhsm", "chsm1", &armhardwaresecuritymodules.CloudHsmClustersClientBeginValidateBackupPropertiesOptions{BackupRequestProperties: 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.BackupResult = armhardwaresecuritymodules.BackupResult{
// 	Properties: &armhardwaresecuritymodules.BackupResultProperties{
// 		EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
// 		JobID: to.Ptr("572a45927fc240e1ac075de27371680b"),
// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
// 		Status: to.Ptr(armhardwaresecuritymodules.BackupRestoreOperationStatusInProgress),
// 		StatusDetails: to.Ptr("Backup operation is in progress"),
// 		AzureStorageBlobContainerURI: to.Ptr("https://myaccount.blob.core.windows.net/sascontainer/sasContainer"),
// 	},
// }

Output:

func (*CloudHsmClustersClient) BeginValidateRestoreProperties 

func (client *CloudHsmClustersClient) BeginValidateRestoreProperties(ctx context.Context, resourceGroupName string, cloudHsmClusterName string, options *CloudHsmClustersClientBeginValidateRestorePropertiesOptions) (*runtime.Poller[CloudHsmClustersClientValidateRestorePropertiesResponse], error)

BeginValidateRestoreProperties - Queued validating pre restore operation If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • cloudHsmClusterName - The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
  • options - CloudHsmClustersClientBeginValidateRestorePropertiesOptions contains the optional parameters for the CloudHsmClustersClient.BeginValidateRestoreProperties method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/CloudHsmCluster_RequestOrValidate_Restore_MaximumSet_Gen.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewCloudHsmClustersClient().BeginValidateRestoreProperties(ctx, "rgcloudhsm", "chsm1", &armhardwaresecuritymodules.CloudHsmClustersClientBeginValidateRestorePropertiesOptions{RestoreRequestProperties: &armhardwaresecuritymodules.RestoreRequestProperties{
	AzureStorageBlobContainerURI: to.Ptr("https://myaccount.blob.core.windows.net/sascontainer/sasContainer"),
	BackupID:                     to.Ptr("backupId"),
},
})
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.RestoreResult = armhardwaresecuritymodules.RestoreResult{
// 	Properties: &armhardwaresecuritymodules.BackupRestoreBaseResultProperties{
// 		EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
// 		JobID: to.Ptr("572a45927fc240e1ac075de27371680b"),
// 		StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
// 		Status: to.Ptr(armhardwaresecuritymodules.BackupRestoreOperationStatusInProgress),
// 		StatusDetails: to.Ptr("Restore operation is in progress"),
// 	},
// }

Output:

func (*CloudHsmClustersClient) Get 

func (client *CloudHsmClustersClient) Get(ctx context.Context, resourceGroupName string, cloudHsmClusterName string, options *CloudHsmClustersClientGetOptions) (CloudHsmClustersClientGetResponse, error)

Get - Gets the specified Cloud HSM Cluster If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • cloudHsmClusterName - The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
  • options - CloudHsmClustersClientGetOptions contains the optional parameters for the CloudHsmClustersClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/CloudHsmCluster_Get_MaximumSet_Gen.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewCloudHsmClustersClient().Get(ctx, "rgcloudhsm", "chsm1", 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.CloudHsmCluster = armhardwaresecuritymodules.CloudHsmCluster{
// 	Name: to.Ptr("chsm1"),
// 	Type: to.Ptr("Microsoft.HardwareSecurityModules/cloudHsmClusters"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1"),
// 	SystemData: &armhardwaresecuritymodules.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
// 		CreatedBy: to.Ptr("CHsmUser1"),
// 		CreatedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("CHsmUser2"),
// 		LastModifiedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("eastus2"),
// 	Tags: map[string]*string{
// 		"Dept": to.Ptr("hsm"),
// 		"Environment": to.Ptr("dogfood"),
// 	},
// 	Identity: &armhardwaresecuritymodules.ManagedServiceIdentity{
// 		Type: to.Ptr(armhardwaresecuritymodules.ManagedServiceIdentityTypeUserAssigned),
// 		UserAssignedIdentities: map[string]*armhardwaresecuritymodules.UserAssignedIdentity{
// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-1": &armhardwaresecuritymodules.UserAssignedIdentity{
// 				ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
// 			},
// 		},
// 	},
// 	SKU: &armhardwaresecuritymodules.CloudHsmClusterSKU{
// 		Name: to.Ptr(armhardwaresecuritymodules.CloudHsmClusterSKUNameStandardB1),
// 		Family: to.Ptr(armhardwaresecuritymodules.CloudHsmClusterSKUFamilyB),
// 	},
// 	Properties: &armhardwaresecuritymodules.CloudHsmClusterProperties{
// 		ActivationState: to.Ptr(armhardwaresecuritymodules.ActivationState("null")),
// 		AutoGeneratedDomainNameLabelScope: to.Ptr(armhardwaresecuritymodules.AutoGeneratedDomainNameLabelScopeTenantReuse),
// 		ProvisioningState: to.Ptr(armhardwaresecuritymodules.ProvisioningStateSucceeded),
// 		PublicNetworkAccess: to.Ptr(armhardwaresecuritymodules.PublicNetworkAccessDisabled),
// 		StatusMessage: to.Ptr("This is a status message"),
// 	},
// }

Output:

func (*CloudHsmClustersClient) NewListByResourceGroupPager 

func (client *CloudHsmClustersClient) NewListByResourceGroupPager(resourceGroupName string, options *CloudHsmClustersClientListByResourceGroupOptions) *runtime.Pager[CloudHsmClustersClientListByResourceGroupResponse]

NewListByResourceGroupPager - The List operation gets information about the Cloud HSM Clusters associated with the subscription and within the specified resource group.

Generated from API version 2024-06-30-preview

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

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/CloudHsmCluster_ListByResourceGroup_MaximumSet_Gen.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewCloudHsmClustersClient().NewListByResourceGroupPager("rgcloudhsm", &armhardwaresecuritymodules.CloudHsmClustersClientListByResourceGroupOptions{Skiptoken: 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.CloudHsmClusterListResult = armhardwaresecuritymodules.CloudHsmClusterListResult{
	// 	Value: []*armhardwaresecuritymodules.CloudHsmCluster{
	// 		{
	// 			Name: to.Ptr("chsm1"),
	// 			Type: to.Ptr("Microsoft.HardwareSecurityModules/cloudHsmClusters"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1"),
	// 			SystemData: &armhardwaresecuritymodules.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("CHsmUser1"),
	// 				CreatedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("CHsmUser2"),
	// 				LastModifiedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("eastus2"),
	// 			Tags: map[string]*string{
	// 				"Dept": to.Ptr("hsm"),
	// 				"Environment": to.Ptr("dogfood"),
	// 			},
	// 			Identity: &armhardwaresecuritymodules.ManagedServiceIdentity{
	// 				Type: to.Ptr(armhardwaresecuritymodules.ManagedServiceIdentityTypeUserAssigned),
	// 				UserAssignedIdentities: map[string]*armhardwaresecuritymodules.UserAssignedIdentity{
	// 					"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-1": &armhardwaresecuritymodules.UserAssignedIdentity{
	// 						ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 						PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 					},
	// 				},
	// 			},
	// 			SKU: &armhardwaresecuritymodules.CloudHsmClusterSKU{
	// 				Name: to.Ptr(armhardwaresecuritymodules.CloudHsmClusterSKUNameStandardB1),
	// 				Family: to.Ptr(armhardwaresecuritymodules.CloudHsmClusterSKUFamilyB),
	// 			},
	// 			Properties: &armhardwaresecuritymodules.CloudHsmClusterProperties{
	// 				ActivationState: to.Ptr(armhardwaresecuritymodules.ActivationState("null")),
	// 				AutoGeneratedDomainNameLabelScope: to.Ptr(armhardwaresecuritymodules.AutoGeneratedDomainNameLabelScopeTenantReuse),
	// 				ProvisioningState: to.Ptr(armhardwaresecuritymodules.ProvisioningStateSucceeded),
	// 				PublicNetworkAccess: to.Ptr(armhardwaresecuritymodules.PublicNetworkAccessDisabled),
	// 				StatusMessage: to.Ptr("This is a status message"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("chsm2"),
	// 			Type: to.Ptr("Microsoft.HardwareSecurityModules/cloudHsmClusters"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm2"),
	// 			SystemData: &armhardwaresecuritymodules.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("CHsmUser1"),
	// 				CreatedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("CHsmUser2"),
	// 				LastModifiedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("eastus2"),
	// 			Tags: map[string]*string{
	// 				"Dept": to.Ptr("hsm"),
	// 				"Environment": to.Ptr("dogfood"),
	// 			},
	// 			Identity: &armhardwaresecuritymodules.ManagedServiceIdentity{
	// 				Type: to.Ptr(armhardwaresecuritymodules.ManagedServiceIdentityTypeUserAssigned),
	// 				UserAssignedIdentities: map[string]*armhardwaresecuritymodules.UserAssignedIdentity{
	// 					"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-2": &armhardwaresecuritymodules.UserAssignedIdentity{
	// 						ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 						PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 					},
	// 				},
	// 			},
	// 			SKU: &armhardwaresecuritymodules.CloudHsmClusterSKU{
	// 				Name: to.Ptr(armhardwaresecuritymodules.CloudHsmClusterSKUNameStandardB1),
	// 				Family: to.Ptr(armhardwaresecuritymodules.CloudHsmClusterSKUFamilyB),
	// 			},
	// 			Properties: &armhardwaresecuritymodules.CloudHsmClusterProperties{
	// 				ActivationState: to.Ptr(armhardwaresecuritymodules.ActivationState("null")),
	// 				AutoGeneratedDomainNameLabelScope: to.Ptr(armhardwaresecuritymodules.AutoGeneratedDomainNameLabelScopeTenantReuse),
	// 				ProvisioningState: to.Ptr(armhardwaresecuritymodules.ProvisioningStateSucceeded),
	// 				PublicNetworkAccess: to.Ptr(armhardwaresecuritymodules.PublicNetworkAccessDisabled),
	// 			},
	// 	}},
	// }
}

Output:

func (*CloudHsmClustersClient) NewListBySubscriptionPager 

func (client *CloudHsmClustersClient) NewListBySubscriptionPager(options *CloudHsmClustersClientListBySubscriptionOptions) *runtime.Pager[CloudHsmClustersClientListBySubscriptionResponse]

NewListBySubscriptionPager - The List operation gets information about the Cloud HSM Clusters associated with the subscription.

Generated from API version 2024-06-30-preview

  • options - CloudHsmClustersClientListBySubscriptionOptions contains the optional parameters for the CloudHsmClustersClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/CloudHsmCluster_ListBySubscription_MaximumSet_Gen.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewCloudHsmClustersClient().NewListBySubscriptionPager(&armhardwaresecuritymodules.CloudHsmClustersClientListBySubscriptionOptions{Skiptoken: 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.CloudHsmClusterListResult = armhardwaresecuritymodules.CloudHsmClusterListResult{
	// 	Value: []*armhardwaresecuritymodules.CloudHsmCluster{
	// 		{
	// 			Name: to.Ptr("chsm1"),
	// 			Type: to.Ptr("Microsoft.HardwareSecurityModules/cloudHsmClusters"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1"),
	// 			SystemData: &armhardwaresecuritymodules.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("CHsmUser1"),
	// 				CreatedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("CHsmUser2"),
	// 				LastModifiedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("eastus2"),
	// 			Tags: map[string]*string{
	// 				"Dept": to.Ptr("hsm"),
	// 				"Environment": to.Ptr("dogfood"),
	// 			},
	// 			Identity: &armhardwaresecuritymodules.ManagedServiceIdentity{
	// 				Type: to.Ptr(armhardwaresecuritymodules.ManagedServiceIdentityTypeUserAssigned),
	// 				UserAssignedIdentities: map[string]*armhardwaresecuritymodules.UserAssignedIdentity{
	// 					"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-1": &armhardwaresecuritymodules.UserAssignedIdentity{
	// 					},
	// 				},
	// 			},
	// 			SKU: &armhardwaresecuritymodules.CloudHsmClusterSKU{
	// 				Name: to.Ptr(armhardwaresecuritymodules.CloudHsmClusterSKUNameStandardB1),
	// 				Family: to.Ptr(armhardwaresecuritymodules.CloudHsmClusterSKUFamilyB),
	// 			},
	// 			Properties: &armhardwaresecuritymodules.CloudHsmClusterProperties{
	// 				ActivationState: to.Ptr(armhardwaresecuritymodules.ActivationState("null")),
	// 				AutoGeneratedDomainNameLabelScope: to.Ptr(armhardwaresecuritymodules.AutoGeneratedDomainNameLabelScopeTenantReuse),
	// 				ProvisioningState: to.Ptr(armhardwaresecuritymodules.ProvisioningStateSucceeded),
	// 				PublicNetworkAccess: to.Ptr(armhardwaresecuritymodules.PublicNetworkAccessDisabled),
	// 				StatusMessage: to.Ptr("This is a status message"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("chsm2"),
	// 			Type: to.Ptr("Microsoft.HardwareSecurityModules/cloudHsmClusters"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm2"),
	// 			SystemData: &armhardwaresecuritymodules.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("CHsmUser1"),
	// 				CreatedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-12T12:00:00.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("CHsmUser2"),
	// 				LastModifiedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("eastus2"),
	// 			Tags: map[string]*string{
	// 				"Dept": to.Ptr("hsm"),
	// 				"Environment": to.Ptr("dogfood"),
	// 			},
	// 			Identity: &armhardwaresecuritymodules.ManagedServiceIdentity{
	// 				Type: to.Ptr(armhardwaresecuritymodules.ManagedServiceIdentityTypeUserAssigned),
	// 				UserAssignedIdentities: map[string]*armhardwaresecuritymodules.UserAssignedIdentity{
	// 					"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-2": &armhardwaresecuritymodules.UserAssignedIdentity{
	// 						ClientID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 						PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 					},
	// 				},
	// 			},
	// 			SKU: &armhardwaresecuritymodules.CloudHsmClusterSKU{
	// 				Name: to.Ptr(armhardwaresecuritymodules.CloudHsmClusterSKUNameStandardB1),
	// 				Family: to.Ptr(armhardwaresecuritymodules.CloudHsmClusterSKUFamilyB),
	// 			},
	// 			Properties: &armhardwaresecuritymodules.CloudHsmClusterProperties{
	// 				ActivationState: to.Ptr(armhardwaresecuritymodules.ActivationState("null")),
	// 				AutoGeneratedDomainNameLabelScope: to.Ptr(armhardwaresecuritymodules.AutoGeneratedDomainNameLabelScopeTenantReuse),
	// 				ProvisioningState: to.Ptr(armhardwaresecuritymodules.ProvisioningStateSucceeded),
	// 				PublicNetworkAccess: to.Ptr(armhardwaresecuritymodules.PublicNetworkAccessDisabled),
	// 				StatusMessage: to.Ptr("This is a status message"),
	// 			},
	// 	}},
	// }
}

Output:

type CloudHsmClustersClientBackupResponse 

type CloudHsmClustersClientBackupResponse struct {
	// Backup operation Result
	BackupResult
}

CloudHsmClustersClientBackupResponse contains the response from method CloudHsmClustersClient.BeginBackup.

type CloudHsmClustersClientBeginBackupOptions 

type CloudHsmClustersClientBeginBackupOptions struct {
	// Azure storage Resource Uri
	BackupRequestProperties *BackupRequestProperties

	// Resumes the LRO from the provided token.
	ResumeToken string
}

CloudHsmClustersClientBeginBackupOptions contains the optional parameters for the CloudHsmClustersClient.BeginBackup method.

type CloudHsmClustersClientBeginCreateOrUpdateOptions 

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

CloudHsmClustersClientBeginCreateOrUpdateOptions contains the optional parameters for the CloudHsmClustersClient.BeginCreateOrUpdate method.

type CloudHsmClustersClientBeginDeleteOptions 

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

CloudHsmClustersClientBeginDeleteOptions contains the optional parameters for the CloudHsmClustersClient.BeginDelete method.

type CloudHsmClustersClientBeginRestoreOptions 

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

CloudHsmClustersClientBeginRestoreOptions contains the optional parameters for the CloudHsmClustersClient.BeginRestore method.

type CloudHsmClustersClientBeginUpdateOptions 

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

CloudHsmClustersClientBeginUpdateOptions contains the optional parameters for the CloudHsmClustersClient.BeginUpdate method.

type CloudHsmClustersClientBeginValidateBackupPropertiesOptions 

type CloudHsmClustersClientBeginValidateBackupPropertiesOptions struct {
	// Backup Operation Required properties
	BackupRequestProperties *BackupRequestProperties

	// Resumes the LRO from the provided token.
	ResumeToken string
}

CloudHsmClustersClientBeginValidateBackupPropertiesOptions contains the optional parameters for the CloudHsmClustersClient.BeginValidateBackupProperties method.

type CloudHsmClustersClientBeginValidateRestorePropertiesOptions 

type CloudHsmClustersClientBeginValidateRestorePropertiesOptions struct {
	// Optional Parameters to validate prior performing a restore operation.
	RestoreRequestProperties *RestoreRequestProperties

	// Resumes the LRO from the provided token.
	ResumeToken string
}

CloudHsmClustersClientBeginValidateRestorePropertiesOptions contains the optional parameters for the CloudHsmClustersClient.BeginValidateRestoreProperties method.

type CloudHsmClustersClientCreateOrUpdateResponse 

type CloudHsmClustersClientCreateOrUpdateResponse struct {
	// Resource information with extended details.
	CloudHsmCluster
}

CloudHsmClustersClientCreateOrUpdateResponse contains the response from method CloudHsmClustersClient.BeginCreateOrUpdate.

type CloudHsmClustersClientDeleteResponse 

type CloudHsmClustersClientDeleteResponse struct {
}

CloudHsmClustersClientDeleteResponse contains the response from method CloudHsmClustersClient.BeginDelete.

type CloudHsmClustersClientGetOptions 

type CloudHsmClustersClientGetOptions struct {
}

CloudHsmClustersClientGetOptions contains the optional parameters for the CloudHsmClustersClient.Get method.

type CloudHsmClustersClientGetResponse 

type CloudHsmClustersClientGetResponse struct {
	// Resource information with extended details.
	CloudHsmCluster
}

CloudHsmClustersClientGetResponse contains the response from method CloudHsmClustersClient.Get.

type CloudHsmClustersClientListByResourceGroupOptions 

type CloudHsmClustersClientListByResourceGroupOptions struct {
	// The page-continuation token to use with a paged version of this API
	Skiptoken *string
}

CloudHsmClustersClientListByResourceGroupOptions contains the optional parameters for the CloudHsmClustersClient.NewListByResourceGroupPager method.

type CloudHsmClustersClientListByResourceGroupResponse 

type CloudHsmClustersClientListByResourceGroupResponse struct {
	// List of Cloud HSM Clusters
	CloudHsmClusterListResult
}

CloudHsmClustersClientListByResourceGroupResponse contains the response from method CloudHsmClustersClient.NewListByResourceGroupPager.

type CloudHsmClustersClientListBySubscriptionOptions 

type CloudHsmClustersClientListBySubscriptionOptions struct {
	// The page-continuation token to use with a paged version of this API
	Skiptoken *string
}

CloudHsmClustersClientListBySubscriptionOptions contains the optional parameters for the CloudHsmClustersClient.NewListBySubscriptionPager method.

type CloudHsmClustersClientListBySubscriptionResponse 

type CloudHsmClustersClientListBySubscriptionResponse struct {
	// List of Cloud HSM Clusters
	CloudHsmClusterListResult
}

CloudHsmClustersClientListBySubscriptionResponse contains the response from method CloudHsmClustersClient.NewListBySubscriptionPager.

type CloudHsmClustersClientRestoreResponse 

type CloudHsmClustersClientRestoreResponse struct {
	// Restore operation properties
	RestoreResult
}

CloudHsmClustersClientRestoreResponse contains the response from method CloudHsmClustersClient.BeginRestore.

type CloudHsmClustersClientUpdateResponse 

type CloudHsmClustersClientUpdateResponse struct {
	// Resource information with extended details.
	CloudHsmCluster
}

CloudHsmClustersClientUpdateResponse contains the response from method CloudHsmClustersClient.BeginUpdate.

type CloudHsmClustersClientValidateBackupPropertiesResponse 

type CloudHsmClustersClientValidateBackupPropertiesResponse struct {
	// Backup operation Result
	BackupResult
}

CloudHsmClustersClientValidateBackupPropertiesResponse contains the response from method CloudHsmClustersClient.BeginValidateBackupProperties.

type CloudHsmClustersClientValidateRestorePropertiesResponse 

type CloudHsmClustersClientValidateRestorePropertiesResponse struct {
	// Restore operation properties
	RestoreResult
}

CloudHsmClustersClientValidateRestorePropertiesResponse contains the response from method CloudHsmClustersClient.BeginValidateRestoreProperties.

type CloudHsmProperties 

type CloudHsmProperties struct {
	// FQDN of the Cloud HSM
	Fqdn *string

	// The Cloud HSM State. Values are: Deploying, ConfiguringSlb, Starting, Starting, Failed, Failed, Deleting, DeletingSlbEntry,
	// InitialProvisioning, Updating
	State *string

	// The Cloud HSM State message
	StateMessage *string
}

CloudHsmProperties - The Cloud HSM Properties

func (CloudHsmProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CloudHsmProperties.

func (*CloudHsmProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type CloudHsmProperties.

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 DedicatedHsm 

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

	// REQUIRED; Properties of the dedicated HSM
	Properties *DedicatedHsmProperties

	// REQUIRED; SKU details
	SKU *SKU

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

	// The Dedicated Hsm zones.
	Zones []*string

	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/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
}

DedicatedHsm - Resource information with extended details.

func (DedicatedHsm) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DedicatedHsm.

func (*DedicatedHsm) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DedicatedHsm.

type DedicatedHsmClient 

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

DedicatedHsmClient contains the methods for the DedicatedHsm group. Don't use this type directly, use NewDedicatedHsmClient() instead.

func NewDedicatedHsmClient 

func NewDedicatedHsmClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DedicatedHsmClient, error)

NewDedicatedHsmClient creates a new instance of DedicatedHsmClient with the specified values.

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

func (*DedicatedHsmClient) BeginCreateOrUpdate 

func (client *DedicatedHsmClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, name string, parameters DedicatedHsm, options *DedicatedHsmClientBeginCreateOrUpdateOptions) (*runtime.Poller[DedicatedHsmClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or Update a dedicated HSM in the specified subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • name - Name of the dedicated Hsm
  • parameters - Parameters to create or update the dedicated hsm
  • options - DedicatedHsmClientBeginCreateOrUpdateOptions contains the optional parameters for the DedicatedHsmClient.BeginCreateOrUpdate method.
Example (CreateANewOrUpdateAnExistingDedicatedHsm)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/DedicatedHsm_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDedicatedHsmClient().BeginCreateOrUpdate(ctx, "hsm-group", "hsm1", armhardwaresecuritymodules.DedicatedHsm{
	Location: to.Ptr("westus"),
	Tags: map[string]*string{
		"Dept":        to.Ptr("hsm"),
		"Environment": to.Ptr("dogfood"),
	},
	Properties: &armhardwaresecuritymodules.DedicatedHsmProperties{
		NetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
			NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
				{
					PrivateIPAddress: to.Ptr("1.0.0.1"),
				}},
			Subnet: &armhardwaresecuritymodules.APIEntityReference{
				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
			},
		},
		StampID: to.Ptr("stamp01"),
	},
	SKU: &armhardwaresecuritymodules.SKU{
		Name: to.Ptr(armhardwaresecuritymodules.SKUNameSafeNetLunaNetworkHSMA790),
	},
}, 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.DedicatedHsm = armhardwaresecuritymodules.DedicatedHsm{
// 	Name: to.Ptr("hsm1"),
// 	Type: to.Ptr("Microsoft.HardwareSecurityModules/dedicatedHSMs"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm1"),
// 	Location: to.Ptr("westus"),
// 	Tags: map[string]*string{
// 		"Dept": to.Ptr("hsm"),
// 		"Environment": to.Ptr("dogfood"),
// 	},
// 	Properties: &armhardwaresecuritymodules.DedicatedHsmProperties{
// 		NetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
// 			NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
// 				{
// 					PrivateIPAddress: to.Ptr("1.0.0.1"),
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm_vnic"),
// 			}},
// 			Subnet: &armhardwaresecuritymodules.APIEntityReference{
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armhardwaresecuritymodules.JSONWebKeyTypeSucceeded),
// 		StampID: to.Ptr("stamp01"),
// 		StatusMessage: to.Ptr("DedicatedHsm device is functional."),
// 	},
// 	SKU: &armhardwaresecuritymodules.SKU{
// 		Name: to.Ptr(armhardwaresecuritymodules.SKUNameSafeNetLunaNetworkHSMA790),
// 	},
// }

Output:
Example (CreateANewOrUpdateAnExistingPaymentHsm)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/PaymentHsm_CreateOrUpdate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDedicatedHsmClient().BeginCreateOrUpdate(ctx, "hsm-group", "hsm1", armhardwaresecuritymodules.DedicatedHsm{
	Location: to.Ptr("westus"),
	Tags: map[string]*string{
		"Dept":        to.Ptr("hsm"),
		"Environment": to.Ptr("dogfood"),
	},
	Properties: &armhardwaresecuritymodules.DedicatedHsmProperties{
		NetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
			NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
				{
					PrivateIPAddress: to.Ptr("1.0.0.1"),
				}},
			Subnet: &armhardwaresecuritymodules.APIEntityReference{
				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
			},
		},
		StampID: to.Ptr("stamp01"),
	},
	SKU: &armhardwaresecuritymodules.SKU{
		Name: to.Ptr(armhardwaresecuritymodules.SKUNamePayShield10KLMK1CPS60),
	},
}, 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.DedicatedHsm = armhardwaresecuritymodules.DedicatedHsm{
// 	Name: to.Ptr("hsm1"),
// 	Type: to.Ptr("Microsoft.HardwareSecurityModules/dedicatedHSMs"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm1"),
// 	SystemData: &armhardwaresecuritymodules.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("westus"),
// 	Tags: map[string]*string{
// 		"Dept": to.Ptr("hsm"),
// 		"Environment": to.Ptr("dogfood"),
// 	},
// 	Properties: &armhardwaresecuritymodules.DedicatedHsmProperties{
// 		ManagementNetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
// 			NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
// 				{
// 					PrivateIPAddress: to.Ptr("1.0.0.2"),
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm1_HSMMgmtNic"),
// 			}},
// 			Subnet: &armhardwaresecuritymodules.APIEntityReference{
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
// 			},
// 		},
// 		NetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
// 			NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
// 				{
// 					PrivateIPAddress: to.Ptr("1.0.0.1"),
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm1_HSMHost1Nic"),
// 			}},
// 			Subnet: &armhardwaresecuritymodules.APIEntityReference{
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armhardwaresecuritymodules.JSONWebKeyTypeSucceeded),
// 		StampID: to.Ptr("stamp01"),
// 		StatusMessage: to.Ptr("DedicatedHsm device is functional."),
// 	},
// 	SKU: &armhardwaresecuritymodules.SKU{
// 		Name: to.Ptr(armhardwaresecuritymodules.SKUNamePayShield10KLMK1CPS60),
// 	},
// }

Output:
Example (CreateANewOrUpdateAnExistingPaymentHsmWithManagementProfile)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/PaymentHsm_CreateOrUpdate_WithManagementProfile.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDedicatedHsmClient().BeginCreateOrUpdate(ctx, "hsm-group", "hsm1", armhardwaresecuritymodules.DedicatedHsm{
	Location: to.Ptr("westus"),
	Tags: map[string]*string{
		"Dept":        to.Ptr("hsm"),
		"Environment": to.Ptr("dogfood"),
	},
	Properties: &armhardwaresecuritymodules.DedicatedHsmProperties{
		ManagementNetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
			NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
				{
					PrivateIPAddress: to.Ptr("1.0.0.2"),
				}},
			Subnet: &armhardwaresecuritymodules.APIEntityReference{
				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
			},
		},
		NetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
			NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
				{
					PrivateIPAddress: to.Ptr("1.0.0.1"),
				}},
			Subnet: &armhardwaresecuritymodules.APIEntityReference{
				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
			},
		},
		StampID: to.Ptr("stamp01"),
	},
	SKU: &armhardwaresecuritymodules.SKU{
		Name: to.Ptr(armhardwaresecuritymodules.SKUNamePayShield10KLMK1CPS60),
	},
}, 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.DedicatedHsm = armhardwaresecuritymodules.DedicatedHsm{
// 	Name: to.Ptr("hsm1"),
// 	Type: to.Ptr("Microsoft.HardwareSecurityModules/dedicatedHSMs"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm1"),
// 	SystemData: &armhardwaresecuritymodules.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("westus"),
// 	Tags: map[string]*string{
// 		"Dept": to.Ptr("hsm"),
// 		"Environment": to.Ptr("dogfood"),
// 	},
// 	Properties: &armhardwaresecuritymodules.DedicatedHsmProperties{
// 		ManagementNetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
// 			NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
// 				{
// 					PrivateIPAddress: to.Ptr("1.0.0.2"),
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm1_HSMMgmtNic"),
// 			}},
// 			Subnet: &armhardwaresecuritymodules.APIEntityReference{
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
// 			},
// 		},
// 		NetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
// 			NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
// 				{
// 					PrivateIPAddress: to.Ptr("1.0.0.1"),
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm1_HSMHost1Nic"),
// 			}},
// 			Subnet: &armhardwaresecuritymodules.APIEntityReference{
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armhardwaresecuritymodules.JSONWebKeyTypeSucceeded),
// 		StampID: to.Ptr("stamp01"),
// 		StatusMessage: to.Ptr("DedicatedHsm device is functional."),
// 	},
// 	SKU: &armhardwaresecuritymodules.SKU{
// 		Name: to.Ptr(armhardwaresecuritymodules.SKUNamePayShield10KLMK1CPS60),
// 	},
// }

Output:

func (*DedicatedHsmClient) BeginDelete 

func (client *DedicatedHsmClient) BeginDelete(ctx context.Context, resourceGroupName string, name string, options *DedicatedHsmClientBeginDeleteOptions) (*runtime.Poller[DedicatedHsmClientDeleteResponse], error)

BeginDelete - Deletes the specified Azure Dedicated HSM. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • name - Name of the dedicated Hsm
  • options - DedicatedHsmClientBeginDeleteOptions contains the optional parameters for the DedicatedHsmClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/DedicatedHsm_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDedicatedHsmClient().BeginDelete(ctx, "hsm-group", "hsm1", 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 (*DedicatedHsmClient) BeginUpdate 

func (client *DedicatedHsmClient) BeginUpdate(ctx context.Context, resourceGroupName string, name string, parameters DedicatedHsmPatchParameters, options *DedicatedHsmClientBeginUpdateOptions) (*runtime.Poller[DedicatedHsmClientUpdateResponse], error)

BeginUpdate - Update a dedicated HSM in the specified subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • name - Name of the dedicated Hsm
  • parameters - Parameters to patch the dedicated HSM
  • options - DedicatedHsmClientBeginUpdateOptions contains the optional parameters for the DedicatedHsmClient.BeginUpdate method.
Example (UpdateAnExistingDedicatedHsm)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/DedicatedHsm_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDedicatedHsmClient().BeginUpdate(ctx, "hsm-group", "hsm1", armhardwaresecuritymodules.DedicatedHsmPatchParameters{
	Tags: map[string]*string{
		"Dept":        to.Ptr("hsm"),
		"Environment": to.Ptr("dogfood"),
		"Slice":       to.Ptr("A"),
	},
}, 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.DedicatedHsm = armhardwaresecuritymodules.DedicatedHsm{
// 	Name: to.Ptr("hsm1"),
// 	Type: to.Ptr("Microsoft.HardwareSecurityModules/dedicatedHSMs"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm1"),
// 	Location: to.Ptr("westus"),
// 	Tags: map[string]*string{
// 		"Dept": to.Ptr("hsm"),
// 		"Environment": to.Ptr("dogfood"),
// 		"Slice": to.Ptr("A"),
// 	},
// 	Properties: &armhardwaresecuritymodules.DedicatedHsmProperties{
// 		NetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
// 			NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
// 				{
// 					PrivateIPAddress: to.Ptr("1.0.0.1"),
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm_vnic"),
// 			}},
// 			Subnet: &armhardwaresecuritymodules.APIEntityReference{
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armhardwaresecuritymodules.JSONWebKeyTypeSucceeded),
// 		StampID: to.Ptr("stamp01"),
// 		StatusMessage: to.Ptr("DedicatedHsm device is functional."),
// 	},
// 	SKU: &armhardwaresecuritymodules.SKU{
// 		Name: to.Ptr(armhardwaresecuritymodules.SKUNameSafeNetLunaNetworkHSMA790),
// 	},
// }

Output:
Example (UpdateAnExistingPaymentHsm)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/PaymentHsm_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewDedicatedHsmClient().BeginUpdate(ctx, "hsm-group", "hsm1", armhardwaresecuritymodules.DedicatedHsmPatchParameters{
	Tags: map[string]*string{
		"Dept":        to.Ptr("hsm"),
		"Environment": to.Ptr("dogfood"),
		"Slice":       to.Ptr("A"),
	},
}, 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.DedicatedHsm = armhardwaresecuritymodules.DedicatedHsm{
// 	Name: to.Ptr("hsm1"),
// 	Type: to.Ptr("Microsoft.HardwareSecurityModules/dedicatedHSMs"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm1"),
// 	SystemData: &armhardwaresecuritymodules.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("westus"),
// 	Tags: map[string]*string{
// 		"Dept": to.Ptr("hsm"),
// 		"Environment": to.Ptr("dogfood"),
// 		"Slice": to.Ptr("A"),
// 	},
// 	Properties: &armhardwaresecuritymodules.DedicatedHsmProperties{
// 		ManagementNetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
// 			NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
// 				{
// 					PrivateIPAddress: to.Ptr("1.0.0.2"),
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm1_HSMMgmtNic"),
// 			}},
// 			Subnet: &armhardwaresecuritymodules.APIEntityReference{
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
// 			},
// 		},
// 		NetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
// 			NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
// 				{
// 					PrivateIPAddress: to.Ptr("1.0.0.1"),
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm1_HSMHost1Nic"),
// 			}},
// 			Subnet: &armhardwaresecuritymodules.APIEntityReference{
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armhardwaresecuritymodules.JSONWebKeyTypeSucceeded),
// 		StampID: to.Ptr("stamp01"),
// 		StatusMessage: to.Ptr("DedicatedHsm device is functional."),
// 	},
// 	SKU: &armhardwaresecuritymodules.SKU{
// 		Name: to.Ptr(armhardwaresecuritymodules.SKUNamePayShield10KLMK1CPS60),
// 	},
// }

Output:

func (*DedicatedHsmClient) Get 

func (client *DedicatedHsmClient) Get(ctx context.Context, resourceGroupName string, name string, options *DedicatedHsmClientGetOptions) (DedicatedHsmClientGetResponse, error)

Get - Gets the specified Azure dedicated HSM. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • name - Name of the dedicated Hsm
  • options - DedicatedHsmClientGetOptions contains the optional parameters for the DedicatedHsmClient.Get method.
Example (GetADedicatedHsm)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/DedicatedHsm_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDedicatedHsmClient().Get(ctx, "hsm-group", "hsm1", 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.DedicatedHsm = armhardwaresecuritymodules.DedicatedHsm{
// 	Name: to.Ptr("hsm1"),
// 	Type: to.Ptr("Microsoft.HardwareSecurityModules/dedicatedHSMs"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm1"),
// 	Location: to.Ptr("westus"),
// 	Tags: map[string]*string{
// 		"Dept": to.Ptr("hsm"),
// 		"Environment": to.Ptr("dogfood"),
// 		"Slice": to.Ptr("A"),
// 	},
// 	Properties: &armhardwaresecuritymodules.DedicatedHsmProperties{
// 		NetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
// 			NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
// 				{
// 					PrivateIPAddress: to.Ptr("1.0.0.1"),
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm_vnic"),
// 			}},
// 			Subnet: &armhardwaresecuritymodules.APIEntityReference{
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armhardwaresecuritymodules.JSONWebKeyTypeSucceeded),
// 		StampID: to.Ptr("stamp01"),
// 		StatusMessage: to.Ptr("DedicatedHsm device is functional."),
// 	},
// 	SKU: &armhardwaresecuritymodules.SKU{
// 		Name: to.Ptr(armhardwaresecuritymodules.SKUNameSafeNetLunaNetworkHSMA790),
// 	},
// }

Output:
Example (GetAPaymentHsm)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/PaymentHsm_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDedicatedHsmClient().Get(ctx, "hsm-group", "hsm1", 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.DedicatedHsm = armhardwaresecuritymodules.DedicatedHsm{
// 	Name: to.Ptr("hsm1"),
// 	Type: to.Ptr("Microsoft.HardwareSecurityModules/dedicatedHSMs"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm1"),
// 	SystemData: &armhardwaresecuritymodules.SystemData{
// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
// 		CreatedBy: to.Ptr("user1"),
// 		CreatedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
// 		LastModifiedBy: to.Ptr("user2"),
// 		LastModifiedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
// 	},
// 	Location: to.Ptr("westus"),
// 	Tags: map[string]*string{
// 		"Dept": to.Ptr("hsm"),
// 		"Environment": to.Ptr("dogfood"),
// 		"Slice": to.Ptr("A"),
// 	},
// 	Properties: &armhardwaresecuritymodules.DedicatedHsmProperties{
// 		ManagementNetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
// 			NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
// 				{
// 					PrivateIPAddress: to.Ptr("1.0.0.2"),
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm1_HSMMgmtNic"),
// 			}},
// 			Subnet: &armhardwaresecuritymodules.APIEntityReference{
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
// 			},
// 		},
// 		NetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
// 			NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
// 				{
// 					PrivateIPAddress: to.Ptr("1.0.0.1"),
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm1_HSMHost1Nic"),
// 			}},
// 			Subnet: &armhardwaresecuritymodules.APIEntityReference{
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armhardwaresecuritymodules.JSONWebKeyTypeSucceeded),
// 		StampID: to.Ptr("stamp01"),
// 		StatusMessage: to.Ptr("DedicatedHsm device is functional."),
// 	},
// 	SKU: &armhardwaresecuritymodules.SKU{
// 		Name: to.Ptr(armhardwaresecuritymodules.SKUNamePayShield10KLMK1CPS60),
// 	},
// }

Output:
Example (GetAPaymentHsmWith20181031PreviewApiVersion)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/PaymentHsm_Get_With_2018-10-31Preview_Version.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDedicatedHsmClient().Get(ctx, "hsm-group", "hsm1", 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.DedicatedHsm = armhardwaresecuritymodules.DedicatedHsm{
// 	Name: to.Ptr("hsm1"),
// 	Type: to.Ptr("Microsoft.HardwareSecurityModules/dedicatedHSMs"),
// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm1"),
// 	Location: to.Ptr("westus"),
// 	Tags: map[string]*string{
// 		"Dept": to.Ptr("hsm"),
// 		"Environment": to.Ptr("dogfood"),
// 		"Slice": to.Ptr("A"),
// 	},
// 	Properties: &armhardwaresecuritymodules.DedicatedHsmProperties{
// 		NetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
// 			NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
// 				{
// 					PrivateIPAddress: to.Ptr("1.0.0.1"),
// 					ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm1_HSMHost1Nic"),
// 			}},
// 			Subnet: &armhardwaresecuritymodules.APIEntityReference{
// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
// 			},
// 		},
// 		ProvisioningState: to.Ptr(armhardwaresecuritymodules.JSONWebKeyTypeSucceeded),
// 		StampID: to.Ptr("stamp01"),
// 		StatusMessage: to.Ptr("DedicatedHsm device is functional."),
// 	},
// 	SKU: &armhardwaresecuritymodules.SKU{
// 		Name: to.Ptr(armhardwaresecuritymodules.SKUNamePayShield10KLMK1CPS60),
// 	},
// }

Output:

func (*DedicatedHsmClient) NewListByResourceGroupPager 

func (client *DedicatedHsmClient) NewListByResourceGroupPager(resourceGroupName string, options *DedicatedHsmClientListByResourceGroupOptions) *runtime.Pager[DedicatedHsmClientListByResourceGroupResponse]

NewListByResourceGroupPager - The List operation gets information about the dedicated hsms associated with the subscription and within the specified resource group.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - DedicatedHsmClientListByResourceGroupOptions contains the optional parameters for the DedicatedHsmClient.NewListByResourceGroupPager method.
Example (ListDedicatedHsmDevicesInAResourceGroup)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/DedicatedHsm_ListByResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDedicatedHsmClient().NewListByResourceGroupPager("hsm-group", &armhardwaresecuritymodules.DedicatedHsmClientListByResourceGroupOptions{Top: 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.DedicatedHsmListResult = armhardwaresecuritymodules.DedicatedHsmListResult{
	// 	Value: []*armhardwaresecuritymodules.DedicatedHsm{
	// 		{
	// 			Name: to.Ptr("hsm1"),
	// 			Type: to.Ptr("Microsoft.HardwareSecurityModules/dedicatedHSMs"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm1"),
	// 			Location: to.Ptr("westus"),
	// 			Tags: map[string]*string{
	// 				"Dept": to.Ptr("hsm"),
	// 				"Environment": to.Ptr("dogfood"),
	// 				"Slice": to.Ptr("A"),
	// 			},
	// 			Properties: &armhardwaresecuritymodules.DedicatedHsmProperties{
	// 				NetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
	// 					NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
	// 						{
	// 							PrivateIPAddress: to.Ptr("1.0.0.1"),
	// 							ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm_vnic"),
	// 					}},
	// 					Subnet: &armhardwaresecuritymodules.APIEntityReference{
	// 						ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
	// 					},
	// 				},
	// 				ProvisioningState: to.Ptr(armhardwaresecuritymodules.JSONWebKeyTypeSucceeded),
	// 				StampID: to.Ptr("stamp01"),
	// 				StatusMessage: to.Ptr("DedicatedHsm device is functional."),
	// 			},
	// 			SKU: &armhardwaresecuritymodules.SKU{
	// 				Name: to.Ptr(armhardwaresecuritymodules.SKUNameSafeNetLunaNetworkHSMA790),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("hsm1"),
	// 			Type: to.Ptr("Microsoft.HardwareSecurityModules/dedicatedHSMs"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm2"),
	// 			Location: to.Ptr("westus"),
	// 			Tags: map[string]*string{
	// 				"Dept": to.Ptr("hsm"),
	// 				"Environment": to.Ptr("dogfood"),
	// 				"Slice": to.Ptr("B"),
	// 			},
	// 			Properties: &armhardwaresecuritymodules.DedicatedHsmProperties{
	// 				NetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
	// 					NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
	// 						{
	// 							PrivateIPAddress: to.Ptr("1.0.0.2"),
	// 							ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm_vnic"),
	// 					}},
	// 					Subnet: &armhardwaresecuritymodules.APIEntityReference{
	// 						ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
	// 					},
	// 				},
	// 				ProvisioningState: to.Ptr(armhardwaresecuritymodules.JSONWebKeyTypeSucceeded),
	// 				StampID: to.Ptr("stamp01"),
	// 				StatusMessage: to.Ptr("DedicatedHsm device is functional."),
	// 			},
	// 			SKU: &armhardwaresecuritymodules.SKU{
	// 				Name: to.Ptr(armhardwaresecuritymodules.SKUNameSafeNetLunaNetworkHSMA790),
	// 			},
	// 	}},
	// }
}

Output:
Example (ListDedicatedHsmDevicesInAResourceGroupIncludingPaymentHsm)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/PaymentHsm_ListByResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDedicatedHsmClient().NewListByResourceGroupPager("hsm-group", &armhardwaresecuritymodules.DedicatedHsmClientListByResourceGroupOptions{Top: 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.DedicatedHsmListResult = armhardwaresecuritymodules.DedicatedHsmListResult{
	// 	Value: []*armhardwaresecuritymodules.DedicatedHsm{
	// 		{
	// 			Name: to.Ptr("hsm1"),
	// 			Type: to.Ptr("Microsoft.HardwareSecurityModules/dedicatedHSMs"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm1"),
	// 			SystemData: &armhardwaresecuritymodules.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("westus"),
	// 			Tags: map[string]*string{
	// 				"Dept": to.Ptr("hsm"),
	// 				"Environment": to.Ptr("dogfood"),
	// 				"Slice": to.Ptr("A"),
	// 			},
	// 			Properties: &armhardwaresecuritymodules.DedicatedHsmProperties{
	// 				ManagementNetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
	// 					NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
	// 						{
	// 							PrivateIPAddress: to.Ptr("1.0.0.2"),
	// 							ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm1_HSMMgmtNic"),
	// 					}},
	// 					Subnet: &armhardwaresecuritymodules.APIEntityReference{
	// 						ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
	// 					},
	// 				},
	// 				NetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
	// 					NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
	// 						{
	// 							PrivateIPAddress: to.Ptr("1.0.0.1"),
	// 							ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm1_HSMHost1Nic"),
	// 					}},
	// 					Subnet: &armhardwaresecuritymodules.APIEntityReference{
	// 						ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
	// 					},
	// 				},
	// 				ProvisioningState: to.Ptr(armhardwaresecuritymodules.JSONWebKeyTypeSucceeded),
	// 				StampID: to.Ptr("stamp01"),
	// 				StatusMessage: to.Ptr("DedicatedHsm device is functional."),
	// 			},
	// 			SKU: &armhardwaresecuritymodules.SKU{
	// 				Name: to.Ptr(armhardwaresecuritymodules.SKUNamePayShield10KLMK1CPS60),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("hsm2"),
	// 			Type: to.Ptr("Microsoft.HardwareSecurityModules/dedicatedHSMs"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm2"),
	// 			SystemData: &armhardwaresecuritymodules.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("westus"),
	// 			Tags: map[string]*string{
	// 				"Dept": to.Ptr("hsm"),
	// 				"Environment": to.Ptr("dogfood"),
	// 				"Slice": to.Ptr("B"),
	// 			},
	// 			Properties: &armhardwaresecuritymodules.DedicatedHsmProperties{
	// 				ManagementNetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
	// 					NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
	// 						{
	// 							PrivateIPAddress: to.Ptr("1.0.0.4"),
	// 							ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm2_HSMMgmtNic"),
	// 					}},
	// 					Subnet: &armhardwaresecuritymodules.APIEntityReference{
	// 						ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
	// 					},
	// 				},
	// 				NetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
	// 					NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
	// 						{
	// 							PrivateIPAddress: to.Ptr("1.0.0.3"),
	// 							ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm2_HSMHost1Nic"),
	// 					}},
	// 					Subnet: &armhardwaresecuritymodules.APIEntityReference{
	// 						ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
	// 					},
	// 				},
	// 				ProvisioningState: to.Ptr(armhardwaresecuritymodules.JSONWebKeyTypeSucceeded),
	// 				StampID: to.Ptr("stamp01"),
	// 				StatusMessage: to.Ptr("DedicatedHsm device is functional."),
	// 			},
	// 			SKU: &armhardwaresecuritymodules.SKU{
	// 				Name: to.Ptr(armhardwaresecuritymodules.SKUNamePayShield10KLMK1CPS60),
	// 			},
	// 	}},
	// }
}

Output:

func (*DedicatedHsmClient) NewListBySubscriptionPager 

func (client *DedicatedHsmClient) NewListBySubscriptionPager(options *DedicatedHsmClientListBySubscriptionOptions) *runtime.Pager[DedicatedHsmClientListBySubscriptionResponse]

NewListBySubscriptionPager - The List operation gets information about the dedicated HSMs associated with the subscription.

Generated from API version 2024-06-30-preview

  • options - DedicatedHsmClientListBySubscriptionOptions contains the optional parameters for the DedicatedHsmClient.NewListBySubscriptionPager method.
Example (ListDedicatedHsmDevicesInASubscription)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/DedicatedHsm_ListBySubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDedicatedHsmClient().NewListBySubscriptionPager(&armhardwaresecuritymodules.DedicatedHsmClientListBySubscriptionOptions{Top: 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.DedicatedHsmListResult = armhardwaresecuritymodules.DedicatedHsmListResult{
	// 	Value: []*armhardwaresecuritymodules.DedicatedHsm{
	// 		{
	// 			Name: to.Ptr("hsm1"),
	// 			Type: to.Ptr("Microsoft.HardwareSecurityModules/dedicatedHSMs"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm1"),
	// 			Location: to.Ptr("westus"),
	// 			Tags: map[string]*string{
	// 				"Dept": to.Ptr("hsm"),
	// 				"Environment": to.Ptr("dogfood"),
	// 				"Slice": to.Ptr("A"),
	// 			},
	// 			Properties: &armhardwaresecuritymodules.DedicatedHsmProperties{
	// 				NetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
	// 					NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
	// 						{
	// 							PrivateIPAddress: to.Ptr("1.0.0.1"),
	// 							ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm_vnic"),
	// 					}},
	// 					Subnet: &armhardwaresecuritymodules.APIEntityReference{
	// 						ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
	// 					},
	// 				},
	// 				ProvisioningState: to.Ptr(armhardwaresecuritymodules.JSONWebKeyTypeSucceeded),
	// 				StampID: to.Ptr("stamp01"),
	// 				StatusMessage: to.Ptr("DedicatedHsm device is functional."),
	// 			},
	// 			SKU: &armhardwaresecuritymodules.SKU{
	// 				Name: to.Ptr(armhardwaresecuritymodules.SKUNameSafeNetLunaNetworkHSMA790),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("hsm1"),
	// 			Type: to.Ptr("Microsoft.HardwareSecurityModules/dedicatedHSMs"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm2"),
	// 			Location: to.Ptr("westus"),
	// 			Tags: map[string]*string{
	// 				"Dept": to.Ptr("hsm"),
	// 				"Environment": to.Ptr("dogfood"),
	// 				"Slice": to.Ptr("B"),
	// 			},
	// 			Properties: &armhardwaresecuritymodules.DedicatedHsmProperties{
	// 				NetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
	// 					NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
	// 						{
	// 							PrivateIPAddress: to.Ptr("1.0.0.2"),
	// 							ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm_vnic"),
	// 					}},
	// 					Subnet: &armhardwaresecuritymodules.APIEntityReference{
	// 						ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
	// 					},
	// 				},
	// 				ProvisioningState: to.Ptr(armhardwaresecuritymodules.JSONWebKeyTypeSucceeded),
	// 				StampID: to.Ptr("stamp01"),
	// 				StatusMessage: to.Ptr("DedicatedHsm device is functional."),
	// 			},
	// 			SKU: &armhardwaresecuritymodules.SKU{
	// 				Name: to.Ptr(armhardwaresecuritymodules.SKUNameSafeNetLunaNetworkHSMA790),
	// 			},
	// 	}},
	// }
}

Output:
Example (ListDedicatedHsmDevicesInASubscriptionIncludingPaymentHsm)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/PaymentHsm_ListBySubscription.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDedicatedHsmClient().NewListBySubscriptionPager(&armhardwaresecuritymodules.DedicatedHsmClientListBySubscriptionOptions{Top: 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.DedicatedHsmListResult = armhardwaresecuritymodules.DedicatedHsmListResult{
	// 	Value: []*armhardwaresecuritymodules.DedicatedHsm{
	// 		{
	// 			Name: to.Ptr("hsm1"),
	// 			Type: to.Ptr("Microsoft.HardwareSecurityModules/dedicatedHSMs"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm1"),
	// 			SystemData: &armhardwaresecuritymodules.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("westus"),
	// 			Tags: map[string]*string{
	// 				"Dept": to.Ptr("hsm1"),
	// 				"Environment": to.Ptr("dogfood"),
	// 				"Slice": to.Ptr("A"),
	// 			},
	// 			Properties: &armhardwaresecuritymodules.DedicatedHsmProperties{
	// 				ManagementNetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
	// 					NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
	// 						{
	// 							PrivateIPAddress: to.Ptr("1.0.0.2"),
	// 							ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm1_HSMMgmtNic"),
	// 					}},
	// 					Subnet: &armhardwaresecuritymodules.APIEntityReference{
	// 						ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
	// 					},
	// 				},
	// 				NetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
	// 					NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
	// 						{
	// 							PrivateIPAddress: to.Ptr("1.0.0.1"),
	// 							ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm1_HSMHost1Nic"),
	// 					}},
	// 					Subnet: &armhardwaresecuritymodules.APIEntityReference{
	// 						ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
	// 					},
	// 				},
	// 				ProvisioningState: to.Ptr(armhardwaresecuritymodules.JSONWebKeyTypeSucceeded),
	// 				StampID: to.Ptr("stamp01"),
	// 				StatusMessage: to.Ptr("DedicatedHsm device is functional."),
	// 			},
	// 			SKU: &armhardwaresecuritymodules.SKU{
	// 				Name: to.Ptr(armhardwaresecuritymodules.SKUNamePayShield10KLMK1CPS60),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("hsm2"),
	// 			Type: to.Ptr("Microsoft.HardwareSecurityModules/dedicatedHSMs"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/hsm2"),
	// 			SystemData: &armhardwaresecuritymodules.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("user1"),
	// 				CreatedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("user2"),
	// 				LastModifiedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 			},
	// 			Location: to.Ptr("westus"),
	// 			Tags: map[string]*string{
	// 				"Dept": to.Ptr("hsm"),
	// 				"Environment": to.Ptr("dogfood"),
	// 				"Slice": to.Ptr("B"),
	// 			},
	// 			Properties: &armhardwaresecuritymodules.DedicatedHsmProperties{
	// 				ManagementNetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
	// 					NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
	// 						{
	// 							PrivateIPAddress: to.Ptr("1.0.0.4"),
	// 							ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm2_HSMMgmtNic"),
	// 					}},
	// 					Subnet: &armhardwaresecuritymodules.APIEntityReference{
	// 						ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
	// 					},
	// 				},
	// 				NetworkProfile: &armhardwaresecuritymodules.NetworkProfile{
	// 					NetworkInterfaces: []*armhardwaresecuritymodules.NetworkInterface{
	// 						{
	// 							PrivateIPAddress: to.Ptr("1.0.0.3"),
	// 							ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/networkInterfaces/hsm2_HSMHost1Nic"),
	// 					}},
	// 					Subnet: &armhardwaresecuritymodules.APIEntityReference{
	// 						ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01"),
	// 					},
	// 				},
	// 				ProvisioningState: to.Ptr(armhardwaresecuritymodules.JSONWebKeyTypeSucceeded),
	// 				StampID: to.Ptr("stamp01"),
	// 				StatusMessage: to.Ptr("DedicatedHsm device is functional."),
	// 			},
	// 			SKU: &armhardwaresecuritymodules.SKU{
	// 				Name: to.Ptr(armhardwaresecuritymodules.SKUNamePayShield10KLMK1CPS60),
	// 			},
	// 	}},
	// }
}

Output:

func (*DedicatedHsmClient) NewListOutboundNetworkDependenciesEndpointsPager 

func (client *DedicatedHsmClient) NewListOutboundNetworkDependenciesEndpointsPager(resourceGroupName string, name string, options *DedicatedHsmClientListOutboundNetworkDependenciesEndpointsOptions) *runtime.Pager[DedicatedHsmClientListOutboundNetworkDependenciesEndpointsResponse]

NewListOutboundNetworkDependenciesEndpointsPager - Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified dedicated hsm resource. The operation returns properties of each egress endpoint.

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • name - Name of the dedicated Hsm
  • options - DedicatedHsmClientListOutboundNetworkDependenciesEndpointsOptions contains the optional parameters for the DedicatedHsmClient.NewListOutboundNetworkDependenciesEndpointsPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/GetOutboundNetworkDependenciesEndpointsList.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewDedicatedHsmClient().NewListOutboundNetworkDependenciesEndpointsPager("hsm-group", "hsm1", 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.OutboundEnvironmentEndpointCollection = armhardwaresecuritymodules.OutboundEnvironmentEndpointCollection{
	// 	Value: []*armhardwaresecuritymodules.OutboundEnvironmentEndpoint{
	// 	},
	// }
}

Output:

type DedicatedHsmClientBeginCreateOrUpdateOptions 

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

DedicatedHsmClientBeginCreateOrUpdateOptions contains the optional parameters for the DedicatedHsmClient.BeginCreateOrUpdate method.

type DedicatedHsmClientBeginDeleteOptions 

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

DedicatedHsmClientBeginDeleteOptions contains the optional parameters for the DedicatedHsmClient.BeginDelete method.

type DedicatedHsmClientBeginUpdateOptions 

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

DedicatedHsmClientBeginUpdateOptions contains the optional parameters for the DedicatedHsmClient.BeginUpdate method.

type DedicatedHsmClientCreateOrUpdateResponse 

type DedicatedHsmClientCreateOrUpdateResponse struct {
	// Resource information with extended details.
	DedicatedHsm
}

DedicatedHsmClientCreateOrUpdateResponse contains the response from method DedicatedHsmClient.BeginCreateOrUpdate.

type DedicatedHsmClientDeleteResponse 

type DedicatedHsmClientDeleteResponse struct {
}

DedicatedHsmClientDeleteResponse contains the response from method DedicatedHsmClient.BeginDelete.

type DedicatedHsmClientGetOptions 

type DedicatedHsmClientGetOptions struct {
}

DedicatedHsmClientGetOptions contains the optional parameters for the DedicatedHsmClient.Get method.

type DedicatedHsmClientGetResponse 

type DedicatedHsmClientGetResponse struct {
	// Resource information with extended details.
	DedicatedHsm
}

DedicatedHsmClientGetResponse contains the response from method DedicatedHsmClient.Get.

type DedicatedHsmClientListByResourceGroupOptions 

type DedicatedHsmClientListByResourceGroupOptions struct {
	// Maximum number of results to return.
	Top *int32
}

DedicatedHsmClientListByResourceGroupOptions contains the optional parameters for the DedicatedHsmClient.NewListByResourceGroupPager method.

type DedicatedHsmClientListByResourceGroupResponse 

type DedicatedHsmClientListByResourceGroupResponse struct {
	// List of dedicated HSMs
	DedicatedHsmListResult
}

DedicatedHsmClientListByResourceGroupResponse contains the response from method DedicatedHsmClient.NewListByResourceGroupPager.

type DedicatedHsmClientListBySubscriptionOptions 

type DedicatedHsmClientListBySubscriptionOptions struct {
	// Maximum number of results to return.
	Top *int32
}

DedicatedHsmClientListBySubscriptionOptions contains the optional parameters for the DedicatedHsmClient.NewListBySubscriptionPager method.

type DedicatedHsmClientListBySubscriptionResponse 

type DedicatedHsmClientListBySubscriptionResponse struct {
	// List of dedicated HSMs
	DedicatedHsmListResult
}

DedicatedHsmClientListBySubscriptionResponse contains the response from method DedicatedHsmClient.NewListBySubscriptionPager.

type DedicatedHsmClientListOutboundNetworkDependenciesEndpointsOptions 

type DedicatedHsmClientListOutboundNetworkDependenciesEndpointsOptions struct {
}

DedicatedHsmClientListOutboundNetworkDependenciesEndpointsOptions contains the optional parameters for the DedicatedHsmClient.NewListOutboundNetworkDependenciesEndpointsPager method.

type DedicatedHsmClientListOutboundNetworkDependenciesEndpointsResponse 

type DedicatedHsmClientListOutboundNetworkDependenciesEndpointsResponse struct {
	// Collection of OutboundEnvironmentEndpoint
	OutboundEnvironmentEndpointCollection
}

DedicatedHsmClientListOutboundNetworkDependenciesEndpointsResponse contains the response from method DedicatedHsmClient.NewListOutboundNetworkDependenciesEndpointsPager.

type DedicatedHsmClientUpdateResponse 

type DedicatedHsmClientUpdateResponse struct {
	// Resource information with extended details.
	DedicatedHsm
}

DedicatedHsmClientUpdateResponse contains the response from method DedicatedHsmClient.BeginUpdate.

type DedicatedHsmError 

type DedicatedHsmError struct {
	// READ-ONLY; The error detail of the operation if any.
	Error *Error
}

DedicatedHsmError - The error exception.

func (DedicatedHsmError) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DedicatedHsmError.

func (*DedicatedHsmError) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DedicatedHsmError.

type DedicatedHsmListResult 

type DedicatedHsmListResult struct {
	// The URL to get the next set of dedicated hsms.
	NextLink *string

	// The list of dedicated HSMs.
	Value []*DedicatedHsm
}

DedicatedHsmListResult - List of dedicated HSMs

func (DedicatedHsmListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DedicatedHsmListResult.

func (*DedicatedHsmListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DedicatedHsmListResult.

type DedicatedHsmPatchParameters 

type DedicatedHsmPatchParameters struct {
	// Resource tags
	Tags map[string]*string
}

DedicatedHsmPatchParameters - Patchable properties of the dedicated HSM

func (DedicatedHsmPatchParameters) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DedicatedHsmPatchParameters.

func (*DedicatedHsmPatchParameters) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DedicatedHsmPatchParameters.

type DedicatedHsmProperties 

type DedicatedHsmProperties struct {
	// Specifies the management network interfaces of the dedicated hsm.
	ManagementNetworkProfile *NetworkProfile

	// Specifies the network interfaces of the dedicated hsm.
	NetworkProfile *NetworkProfile

	// This field will be used when RP does not support Availability zones.
	StampID *string

	// READ-ONLY; Provisioning state.
	ProvisioningState *JSONWebKeyType

	// READ-ONLY; Resource Status Message.
	StatusMessage *string
}

DedicatedHsmProperties - Properties of the dedicated hsm

func (DedicatedHsmProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DedicatedHsmProperties.

func (*DedicatedHsmProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type DedicatedHsmProperties.

type EndpointDependency 

type EndpointDependency struct {
	// The domain name of the dependency.
	DomainName *string

	// The Ports and Protocols used when connecting to domainName.
	EndpointDetails []*EndpointDetail
}

EndpointDependency - A domain name that dedicated hsm services are reaching at.

func (EndpointDependency) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EndpointDependency.

func (*EndpointDependency) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EndpointDependency.

type EndpointDetail 

type EndpointDetail struct {
	// Description of the detail
	Description *string

	// An IP Address that Domain Name currently resolves to.
	IPAddress *string

	// The port an endpoint is connected to.
	Port *int32

	// The protocol used for connection
	Protocol *string
}

EndpointDetail - Connect information from the dedicated hsm service to a single endpoint.

func (EndpointDetail) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EndpointDetail.

func (*EndpointDetail) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EndpointDetail.

type Error 

type Error struct {
	// READ-ONLY; The error code.
	Code *string

	// READ-ONLY; Contains more specific error that narrows down the cause. May be null.
	InnerError *Error

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

Error - The key vault server error.

func (Error) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Error.

func (*Error) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Error.

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 

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

MarshalJSON implements the json.Marshaller interface for type ErrorAdditionalInfo.

func (*ErrorAdditionalInfo) UnmarshalJSON 

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 

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 

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

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

type IdentityType 

type IdentityType string

IdentityType - The type of identity. 

const (
	IdentityTypeApplication     IdentityType = "Application"
	IdentityTypeKey             IdentityType = "Key"
	IdentityTypeManagedIdentity IdentityType = "ManagedIdentity"
	IdentityTypeUser            IdentityType = "User"
)

func PossibleIdentityTypeValues 

func PossibleIdentityTypeValues() []IdentityType

PossibleIdentityTypeValues returns the possible values for the IdentityType const type.

type JSONWebKeyType 

type JSONWebKeyType string

JSONWebKeyType - Provisioning state. 

const (
	// JSONWebKeyTypeAllocating - A device is currently being allocated for the dedicated HSM resource.
	JSONWebKeyTypeAllocating JSONWebKeyType = "Allocating"
	// JSONWebKeyTypeCheckingQuota - Validating the subscription has sufficient quota to allocate a dedicated HSM device.
	JSONWebKeyTypeCheckingQuota JSONWebKeyType = "CheckingQuota"
	// JSONWebKeyTypeConnecting - The dedicated HSM is being connected to the virtual network.
	JSONWebKeyTypeConnecting JSONWebKeyType = "Connecting"
	// JSONWebKeyTypeDeleting - The dedicated HSM is currently being deleted.
	JSONWebKeyTypeDeleting JSONWebKeyType = "Deleting"
	// JSONWebKeyTypeFailed - Provisioning of the dedicated HSM has failed.
	JSONWebKeyTypeFailed JSONWebKeyType = "Failed"
	// JSONWebKeyTypeProvisioning - The dedicated HSM is currently being provisioned.
	JSONWebKeyTypeProvisioning JSONWebKeyType = "Provisioning"
	// JSONWebKeyTypeSucceeded - The dedicated HSM has been fully provisioned.
	JSONWebKeyTypeSucceeded JSONWebKeyType = "Succeeded"
)

func PossibleJSONWebKeyTypeValues 

func PossibleJSONWebKeyTypeValues() []JSONWebKeyType

PossibleJSONWebKeyTypeValues returns the possible values for the JSONWebKeyType const type.

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 NetworkInterface 

type NetworkInterface struct {
	// Private Ip address of the interface
	PrivateIPAddress *string

	// READ-ONLY; The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/…
	ResourceID *string
}

NetworkInterface - The network interface definition.

func (NetworkInterface) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type NetworkInterface.

func (*NetworkInterface) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkInterface.

type NetworkProfile 

type NetworkProfile struct {
	// Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM.
	NetworkInterfaces []*NetworkInterface

	// Specifies the identifier of the subnet.
	Subnet *APIEntityReference
}

NetworkProfile - The network profile definition.

func (NetworkProfile) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type NetworkProfile.

func (*NetworkProfile) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type NetworkProfile.

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 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - Get a list of Hardware Security Modules operations.

Generated from API version 2024-06-30-preview

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
Example (GetAListOfDedicatedHsmOperations)

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/OperationsList.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.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 = armhardwaresecuritymodules.OperationListResult{
	// 	Value: []*armhardwaresecuritymodules.Operation{
	// 		{
	// 			Name: to.Ptr("Microsoft.HardwareSecurityModules/dedicatedhsms/read"),
	// 			Display: &armhardwaresecuritymodules.OperationDisplay{
	// 				Description: to.Ptr("View the properties of a DedicatedHsm"),
	// 				Operation: to.Ptr("View DedicatedHsm"),
	// 				Provider: to.Ptr("Microsoft Hardware Security Modules"),
	// 				Resource: to.Ptr("DedicatedHsm"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 			Origin: to.Ptr(armhardwaresecuritymodules.OriginSystem),
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.HardwareSecurityModules/cloudHsmClusters/read"),
	// 			Display: &armhardwaresecuritymodules.OperationDisplay{
	// 				Description: to.Ptr("View the properties of a CloudHsm"),
	// 				Operation: to.Ptr("View CloudHsm"),
	// 				Provider: to.Ptr("Microsoft Hardware Security Modules"),
	// 				Resource: to.Ptr("CloudHsm"),
	// 			},
	// 			IsDataAction: to.Ptr(false),
	// 			Origin: to.Ptr(armhardwaresecuritymodules.OriginSystem),
	// 	}},
	// }
}

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 OutboundEnvironmentEndpoint 

type OutboundEnvironmentEndpoint struct {
	// The category of endpoints accessed by the dedicated hsm service, e.g. azure-resource-management, apiserver, etc.
	Category *string

	// The endpoints that dedicated hsm service connects to
	Endpoints []*EndpointDependency
}

OutboundEnvironmentEndpoint - Egress endpoints which dedicated hsm service connects to for common purpose.

func (OutboundEnvironmentEndpoint) MarshalJSON 

func (o OutboundEnvironmentEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OutboundEnvironmentEndpoint.

func (*OutboundEnvironmentEndpoint) UnmarshalJSON 

func (o *OutboundEnvironmentEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OutboundEnvironmentEndpoint.

type OutboundEnvironmentEndpointCollection 

type OutboundEnvironmentEndpointCollection struct {
	// REQUIRED; Collection of resources.
	Value []*OutboundEnvironmentEndpoint

	// READ-ONLY; Link to next page of resources.
	NextLink *string
}

OutboundEnvironmentEndpointCollection - Collection of OutboundEnvironmentEndpoint

func (OutboundEnvironmentEndpointCollection) MarshalJSON 

func (o OutboundEnvironmentEndpointCollection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OutboundEnvironmentEndpointCollection.

func (*OutboundEnvironmentEndpointCollection) UnmarshalJSON 

func (o *OutboundEnvironmentEndpointCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OutboundEnvironmentEndpointCollection.

type PrivateEndpoint 

type PrivateEndpoint struct {
	// READ-ONLY; The ARM identifier for private endpoint.
	ID *string
}

PrivateEndpoint - The private endpoint resource.

func (PrivateEndpoint) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateEndpoint.

func (*PrivateEndpoint) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpoint.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	// Modified whenever there is a change in the state of private endpoint connection.
	Etag *string

	// Resource properties.
	Properties *PrivateEndpointConnectionProperties

	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/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
}

PrivateEndpointConnection - The private endpoint connection resource.

func (PrivateEndpointConnection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnection.

func (*PrivateEndpointConnection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnection.

type PrivateEndpointConnectionListResult 

type PrivateEndpointConnectionListResult struct {
	// The URL to get the next set of private endpoint connections.
	NextLink *string

	// Array of private endpoint connections.
	Value []*PrivateEndpointConnection
}

PrivateEndpointConnectionListResult - List of private endpoint connections associated with the specified resource.

func (PrivateEndpointConnectionListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionListResult.

func (*PrivateEndpointConnectionListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionListResult.

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// REQUIRED; A collection of information about the state of the connection between service consumer and provider.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState

	// The private endpoint resource.
	PrivateEndpoint *PrivateEndpoint

	// READ-ONLY; The group ids for the private endpoint resource.
	GroupIDs []*string

	// READ-ONLY; The provisioning state of the private endpoint connection resource.
	ProvisioningState *PrivateEndpointConnectionProvisioningState
}

PrivateEndpointConnectionProperties - Properties of the private endpoint connection.

func (PrivateEndpointConnectionProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionProperties.

func (*PrivateEndpointConnectionProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionProperties.

type PrivateEndpointConnectionProvisioningState 

type PrivateEndpointConnectionProvisioningState string

PrivateEndpointConnectionProvisioningState - The current provisioning state. 

const (
	PrivateEndpointConnectionProvisioningStateCanceled      PrivateEndpointConnectionProvisioningState = "Canceled"
	PrivateEndpointConnectionProvisioningStateCreating      PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleting      PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateFailed        PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateInternalError PrivateEndpointConnectionProvisioningState = "InternalError"
	PrivateEndpointConnectionProvisioningStateSucceeded     PrivateEndpointConnectionProvisioningState = "Succeeded"
	PrivateEndpointConnectionProvisioningStateUpdating      PrivateEndpointConnectionProvisioningState = "Updating"
)

func PossiblePrivateEndpointConnectionProvisioningStateValues 

func PossiblePrivateEndpointConnectionProvisioningStateValues() []PrivateEndpointConnectionProvisioningState

PossiblePrivateEndpointConnectionProvisioningStateValues returns the possible values for the PrivateEndpointConnectionProvisioningState const type.

type PrivateEndpointConnectionsClient 

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

PrivateEndpointConnectionsClient contains the methods for the PrivateEndpointConnections group. Don't use this type directly, use NewPrivateEndpointConnectionsClient() instead.

func NewPrivateEndpointConnectionsClient 

func NewPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateEndpointConnectionsClient, error)

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient with the specified values.

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

func (*PrivateEndpointConnectionsClient) NewListByCloudHsmClusterPager 

func (client *PrivateEndpointConnectionsClient) NewListByCloudHsmClusterPager(resourceGroupName string, cloudHsmClusterName string, options *PrivateEndpointConnectionsClientListByCloudHsmClusterOptions) *runtime.Pager[PrivateEndpointConnectionsClientListByCloudHsmClusterResponse]

NewListByCloudHsmClusterPager - The List operation gets information about the private endpoint connections associated with the Cloud HSM Cluster

Generated from API version 2024-06-30-preview

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • cloudHsmClusterName - The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
  • options - PrivateEndpointConnectionsClientListByCloudHsmClusterOptions contains the optional parameters for the PrivateEndpointConnectionsClient.NewListByCloudHsmClusterPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e838027e88cca634c1545e744630de9262a6e72a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2024-06-30-preview/examples/CloudHsmClusterPrivateEndpointConnection_ListByCloudHsmCluster_MaximumSet_Gen.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armhardwaresecuritymodules.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPrivateEndpointConnectionsClient().NewListByCloudHsmClusterPager("rgcloudhsm", "chsm1", 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.PrivateEndpointConnectionListResult = armhardwaresecuritymodules.PrivateEndpointConnectionListResult{
	// 	Value: []*armhardwaresecuritymodules.PrivateEndpointConnection{
	// 		{
	// 			Name: to.Ptr("chsm1"),
	// 			Type: to.Ptr("Microsoft.HardwareSecurityModules/cloudHsmClusters/privateEndpointConnections"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1/privateEndpointConnections/sample-pec1"),
	// 			SystemData: &armhardwaresecuritymodules.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("User1"),
	// 				CreatedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("User2"),
	// 				LastModifiedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 			},
	// 			Properties: &armhardwaresecuritymodules.PrivateEndpointConnectionProperties{
	// 				PrivateEndpoint: &armhardwaresecuritymodules.PrivateEndpoint{
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.Network/privateEndpoints/sample-pec1"),
	// 				},
	// 				PrivateLinkServiceConnectionState: &armhardwaresecuritymodules.PrivateLinkServiceConnectionState{
	// 					Description: to.Ptr("This was automatically approved by user1234@contoso.com"),
	// 					ActionsRequired: to.Ptr("None"),
	// 					Status: to.Ptr(armhardwaresecuritymodules.PrivateEndpointServiceConnectionStatusApproved),
	// 				},
	// 				ProvisioningState: to.Ptr(armhardwaresecuritymodules.PrivateEndpointConnectionProvisioningStateSucceeded),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("chsm2"),
	// 			Type: to.Ptr("Microsoft.HardwareSecurityModules/cloudHsmClusters/privateEndpointConnections"),
	// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm2/privateEndpointConnections/sample-pec2"),
	// 			SystemData: &armhardwaresecuritymodules.SystemData{
	// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
	// 				CreatedBy: to.Ptr("User1"),
	// 				CreatedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T12:00:00.000Z"); return t}()),
	// 				LastModifiedBy: to.Ptr("User2"),
	// 				LastModifiedByType: to.Ptr(armhardwaresecuritymodules.CreatedByTypeUser),
	// 			},
	// 			Properties: &armhardwaresecuritymodules.PrivateEndpointConnectionProperties{
	// 				PrivateEndpoint: &armhardwaresecuritymodules.PrivateEndpoint{
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.Network/privateEndpoints/sample-pec2"),
	// 				},
	// 				PrivateLinkServiceConnectionState: &armhardwaresecuritymodules.PrivateLinkServiceConnectionState{
	// 					Description: to.Ptr("This was automatically approved by user1234@contoso.com"),
	// 					ActionsRequired: to.Ptr("None"),
	// 					Status: to.Ptr(armhardwaresecuritymodules.PrivateEndpointServiceConnectionStatusApproved),
	// 				},
	// 				ProvisioningState: to.Ptr(armhardwaresecuritymodules.PrivateEndpointConnectionProvisioningStateSucceeded),
	// 			},
	// 	}},
	// }
}

Output:

type PrivateEndpointConnectionsClientListByCloudHsmClusterOptions 

type PrivateEndpointConnectionsClientListByCloudHsmClusterOptions struct {
}

PrivateEndpointConnectionsClientListByCloudHsmClusterOptions contains the optional parameters for the PrivateEndpointConnectionsClient.NewListByCloudHsmClusterPager method.

type PrivateEndpointConnectionsClientListByCloudHsmClusterResponse 

type PrivateEndpointConnectionsClientListByCloudHsmClusterResponse struct {
	// List of private endpoint connections associated with the specified resource.
	PrivateEndpointConnectionListResult
}

PrivateEndpointConnectionsClientListByCloudHsmClusterResponse contains the response from method PrivateEndpointConnectionsClient.NewListByCloudHsmClusterPager.

type PrivateEndpointServiceConnectionStatus 

type PrivateEndpointServiceConnectionStatus string

PrivateEndpointServiceConnectionStatus - The private endpoint connection status. 

const (
	PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
	PrivateEndpointServiceConnectionStatusPending  PrivateEndpointServiceConnectionStatus = "Pending"
	PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)

func PossiblePrivateEndpointServiceConnectionStatusValues 

func PossiblePrivateEndpointServiceConnectionStatusValues() []PrivateEndpointServiceConnectionStatus

PossiblePrivateEndpointServiceConnectionStatusValues returns the possible values for the PrivateEndpointServiceConnectionStatus const type.

type PrivateLinkResource 

type PrivateLinkResource struct {
	// Resource properties.
	Properties *PrivateLinkResourceProperties

	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/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
}

PrivateLinkResource - A private link resource.

func (PrivateLinkResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResource.

func (*PrivateLinkResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResource.

type PrivateLinkResourceListResult 

type PrivateLinkResourceListResult struct {
	// Array of private link resources
	Value []*PrivateLinkResource

	// READ-ONLY; URL to get the next set of operation list results (if there are any).
	NextLink *string
}

PrivateLinkResourceListResult - A list of private link resources.

func (PrivateLinkResourceListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceListResult.

func (*PrivateLinkResourceListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResourceListResult.

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	// The private link resource private link DNS zone name.
	RequiredZoneNames []*string

	// READ-ONLY; The private link resource group id.
	GroupID *string

	// READ-ONLY; The private link resource required member names.
	RequiredMembers []*string
}

PrivateLinkResourceProperties - Properties of a private link resource.

func (PrivateLinkResourceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceProperties.

func (*PrivateLinkResourceProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResourceProperties.

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	// A message indicating if changes on the service provider require any updates on the consumer.
	ActionsRequired *string

	// The reason for approval/rejection of the connection.
	Description *string

	// Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
	Status *PrivateEndpointServiceConnectionStatus
}

PrivateLinkServiceConnectionState - A collection of information about the state of the connection between service consumer and provider.

func (PrivateLinkServiceConnectionState) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServiceConnectionState.

func (*PrivateLinkServiceConnectionState) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkServiceConnectionState.

type ProvisioningState 

type ProvisioningState string

ProvisioningState - The Cloud HSM Cluster's provisioningState 

const (
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type ProxyResource 

type ProxyResource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/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
}

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

func (ProxyResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ProxyResource.

func (*ProxyResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ProxyResource.

type PublicNetworkAccess 

type PublicNetworkAccess string

PublicNetworkAccess - The Cloud HSM Cluster public network access 

const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
)

func PossiblePublicNetworkAccessValues 

func PossiblePublicNetworkAccessValues() []PublicNetworkAccess

PossiblePublicNetworkAccessValues returns the possible values for the PublicNetworkAccess const type.

type Resource 

type Resource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. E.g. "/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
}

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 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Resource.

type RestoreRequestProperties 

type RestoreRequestProperties struct {
	// REQUIRED; The Azure blob storage container Uri which contains the backup
	AzureStorageBlobContainerURI *string

	// REQUIRED; An autogenerated unique string ID for labeling the backup. It contains both a UUID and a date timestamp.
	BackupID *string

	// The SAS token pointing to an Azure blob storage container. This property is reserved for Azure Backup Service.
	Token *string
}

RestoreRequestProperties - Cloud Hsm Cluster restore information

func (RestoreRequestProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RestoreRequestProperties.

func (*RestoreRequestProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RestoreRequestProperties.

type RestoreResult 

type RestoreResult struct {
	// Backup and Restore operation common properties
	Properties *BackupRestoreBaseResultProperties
}

RestoreResult - Restore operation properties

func (RestoreResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RestoreResult.

func (*RestoreResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RestoreResult.

type SKU 

type SKU struct {
	// SKU of the dedicated HSM
	Name *SKUName
}

SKU of the dedicated HSM

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 - SKU of the dedicated HSM 

const (
	// SKUNamePayShield10KLMK1CPS250 - The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device
	// with 1 local master key which supports up to 250 calls per second.
	SKUNamePayShield10KLMK1CPS250 SKUName = "payShield10K_LMK1_CPS250"
	// SKUNamePayShield10KLMK1CPS2500 - The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device
	// with 1 local master key which supports up to 2500 calls per second.
	SKUNamePayShield10KLMK1CPS2500 SKUName = "payShield10K_LMK1_CPS2500"
	// SKUNamePayShield10KLMK1CPS60 - The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device
	// with 1 local master key which supports up to 60 calls per second.
	SKUNamePayShield10KLMK1CPS60 SKUName = "payShield10K_LMK1_CPS60"
	// SKUNamePayShield10KLMK2CPS250 - The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device
	// with 2 local master keys which supports up to 250 calls per second.
	SKUNamePayShield10KLMK2CPS250 SKUName = "payShield10K_LMK2_CPS250"
	// SKUNamePayShield10KLMK2CPS2500 - The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device
	// with 2 local master keys which supports up to 2500 calls per second.
	SKUNamePayShield10KLMK2CPS2500 SKUName = "payShield10K_LMK2_CPS2500"
	// SKUNamePayShield10KLMK2CPS60 - The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device
	// with 2 local master keys which supports up to 60 calls per second.
	SKUNamePayShield10KLMK2CPS60 SKUName = "payShield10K_LMK2_CPS60"
	// SKUNameSafeNetLunaNetworkHSMA790 - The dedicated HSM is a Safenet Luna Network HSM A790 device.
	SKUNameSafeNetLunaNetworkHSMA790 SKUName = "SafeNet Luna Network HSM A790"
)

func PossibleSKUNameValues 

func PossibleSKUNameValues() []SKUName

PossibleSKUNameValues returns the possible values for the SKUName 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. E.g. "/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
}

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 

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

UnmarshalJSON implements the json.Unmarshaller interface for type TrackedResource.

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.

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.