import "github.com/Azure/azure-sdk-for-go/services/preview/hardwaresecuritymodules/mgmt/2018-10-31-preview/hardwaresecuritymodules"
Package hardwaresecuritymodules implements the Azure ARM Hardwaresecuritymodules service API version 2018-10-31-preview.
The Azure management API provides a RESTful set of web services that interact with Azure Dedicated HSM RP.
client.go dedicatedhsm.go enums.go models.go operations.go version.go
const (
// DefaultBaseURI is the default URI used for the service Hardwaresecuritymodules
DefaultBaseURI = "https://management.azure.com"
)UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
type APIEntityReference struct {
// ID - The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
ID *string `json:"id,omitempty"`
}APIEntityReference the API entity reference.
BaseClient is the base client for Hardwaresecuritymodules.
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
type DedicatedHsm struct {
autorest.Response `json:"-"`
// DedicatedHsmProperties - Properties of the dedicated HSM
*DedicatedHsmProperties `json:"properties,omitempty"`
// ID - READ-ONLY; The Azure Resource Manager resource ID for the dedicated HSM.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the dedicated HSM.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The resource type of the dedicated HSM.
Type *string `json:"type,omitempty"`
// Location - The supported Azure location where the dedicated HSM should be created.
Location *string `json:"location,omitempty"`
// Sku - SKU details
Sku *Sku `json:"sku,omitempty"`
// Zones - The Dedicated Hsm zones.
Zones *[]string `json:"zones,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}DedicatedHsm resource information with extended details.
func (dh DedicatedHsm) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DedicatedHsm.
func (dh *DedicatedHsm) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DedicatedHsm struct.
type DedicatedHsmClient struct {
BaseClient
}DedicatedHsmClient is the the Azure management API provides a RESTful set of web services that interact with Azure Dedicated HSM RP.
func NewDedicatedHsmClient(subscriptionID string) DedicatedHsmClient
NewDedicatedHsmClient creates an instance of the DedicatedHsmClient client.
func NewDedicatedHsmClientWithBaseURI(baseURI string, subscriptionID string) DedicatedHsmClient
NewDedicatedHsmClientWithBaseURI creates an instance of the DedicatedHsmClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client DedicatedHsmClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, name string, parameters DedicatedHsm) (result DedicatedHsmCreateOrUpdateFuture, err error)
CreateOrUpdate create or Update a dedicated HSM in the specified subscription. Parameters: resourceGroupName - the name of the Resource Group to which the resource belongs. name - name of the dedicated Hsm parameters - parameters to create or update the dedicated hsm
func (client DedicatedHsmClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, name string, parameters DedicatedHsm) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client DedicatedHsmClient) CreateOrUpdateResponder(resp *http.Response) (result DedicatedHsm, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DedicatedHsmClient) CreateOrUpdateSender(req *http.Request) (future DedicatedHsmCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client DedicatedHsmClient) Delete(ctx context.Context, resourceGroupName string, name string) (result DedicatedHsmDeleteFuture, err error)
Delete deletes the specified Azure Dedicated HSM. Parameters: resourceGroupName - the name of the Resource Group to which the dedicated HSM belongs. name - the name of the dedicated HSM to delete
func (client DedicatedHsmClient) DeletePreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client DedicatedHsmClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client DedicatedHsmClient) DeleteSender(req *http.Request) (future DedicatedHsmDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client DedicatedHsmClient) Get(ctx context.Context, resourceGroupName string, name string) (result DedicatedHsm, err error)
Get gets the specified Azure dedicated HSM. Parameters: resourceGroupName - the name of the Resource Group to which the dedicated hsm belongs. name - the name of the dedicated HSM.
func (client DedicatedHsmClient) GetPreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client DedicatedHsmClient) GetResponder(resp *http.Response) (result DedicatedHsm, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client DedicatedHsmClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, top *int32) (result DedicatedHsmListResultPage, err error)
ListByResourceGroup the List operation gets information about the dedicated hsms associated with the subscription and within the specified resource group. Parameters: resourceGroupName - the name of the Resource Group to which the dedicated HSM belongs. top - maximum number of results to return.
func (client DedicatedHsmClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, top *int32) (result DedicatedHsmListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client DedicatedHsmClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, top *int32) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client DedicatedHsmClient) ListByResourceGroupResponder(resp *http.Response) (result DedicatedHsmListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client DedicatedHsmClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client DedicatedHsmClient) ListBySubscription(ctx context.Context, top *int32) (result DedicatedHsmListResultPage, err error)
ListBySubscription the List operation gets information about the dedicated HSMs associated with the subscription. Parameters: top - maximum number of results to return.
func (client DedicatedHsmClient) ListBySubscriptionComplete(ctx context.Context, top *int32) (result DedicatedHsmListResultIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client DedicatedHsmClient) ListBySubscriptionPreparer(ctx context.Context, top *int32) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (client DedicatedHsmClient) ListBySubscriptionResponder(resp *http.Response) (result DedicatedHsmListResult, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (client DedicatedHsmClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (client DedicatedHsmClient) Update(ctx context.Context, resourceGroupName string, name string, parameters DedicatedHsmPatchParameters) (result DedicatedHsmUpdateFuture, err error)
Update update a dedicated HSM in the specified subscription. Parameters: resourceGroupName - the name of the Resource Group to which the server belongs. name - name of the dedicated HSM parameters - parameters to patch the dedicated HSM
func (client DedicatedHsmClient) UpdatePreparer(ctx context.Context, resourceGroupName string, name string, parameters DedicatedHsmPatchParameters) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (client DedicatedHsmClient) UpdateResponder(resp *http.Response) (result DedicatedHsm, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client DedicatedHsmClient) UpdateSender(req *http.Request) (future DedicatedHsmUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type DedicatedHsmCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DedicatedHsmClient) (DedicatedHsm, error)
}DedicatedHsmCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DedicatedHsmDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DedicatedHsmClient) (autorest.Response, error)
}DedicatedHsmDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
DedicatedHsmError the error exception.
type DedicatedHsmListResult struct {
autorest.Response `json:"-"`
// Value - The list of dedicated HSMs.
Value *[]DedicatedHsm `json:"value,omitempty"`
// NextLink - The URL to get the next set of dedicated hsms.
NextLink *string `json:"nextLink,omitempty"`
}DedicatedHsmListResult list of dedicated HSMs
func (dhlr DedicatedHsmListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type DedicatedHsmListResultIterator struct {
// contains filtered or unexported fields
}DedicatedHsmListResultIterator provides access to a complete listing of DedicatedHsm values.
func NewDedicatedHsmListResultIterator(page DedicatedHsmListResultPage) DedicatedHsmListResultIterator
Creates a new instance of the DedicatedHsmListResultIterator type.
func (iter *DedicatedHsmListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (iter *DedicatedHsmListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (iter DedicatedHsmListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter DedicatedHsmListResultIterator) Response() DedicatedHsmListResult
Response returns the raw server response from the last page request.
func (iter DedicatedHsmListResultIterator) Value() DedicatedHsm
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type DedicatedHsmListResultPage struct {
// contains filtered or unexported fields
}DedicatedHsmListResultPage contains a page of DedicatedHsm values.
func NewDedicatedHsmListResultPage(cur DedicatedHsmListResult, getNextPage func(context.Context, DedicatedHsmListResult) (DedicatedHsmListResult, error)) DedicatedHsmListResultPage
Creates a new instance of the DedicatedHsmListResultPage type.
func (page *DedicatedHsmListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (page *DedicatedHsmListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (page DedicatedHsmListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page DedicatedHsmListResultPage) Response() DedicatedHsmListResult
Response returns the raw server response from the last page request.
func (page DedicatedHsmListResultPage) Values() []DedicatedHsm
Values returns the slice of values for the current page or nil if there are no values.
type DedicatedHsmOperation struct {
// Name - The name of the Dedicated HSM Resource Provider Operation.
Name *string `json:"name,omitempty"`
// IsDataAction - READ-ONLY; Gets or sets a value indicating whether it is a data plane action
IsDataAction *string `json:"isDataAction,omitempty"`
Display *DedicatedHsmOperationDisplay `json:"display,omitempty"`
}DedicatedHsmOperation REST API operation
func (dho DedicatedHsmOperation) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DedicatedHsmOperation.
type DedicatedHsmOperationDisplay struct {
// Provider - The Resource Provider of the operation
Provider *string `json:"provider,omitempty"`
// Resource - Resource on which the operation is performed.
Resource *string `json:"resource,omitempty"`
// Operation - Operation type: Read, write, delete, etc.
Operation *string `json:"operation,omitempty"`
// Description - The object that represents the operation.
Description *string `json:"description,omitempty"`
}DedicatedHsmOperationDisplay ...
type DedicatedHsmOperationListResult struct {
autorest.Response `json:"-"`
// Value - List of Dedicated HSM Resource Provider operations.
Value *[]DedicatedHsmOperation `json:"value,omitempty"`
}DedicatedHsmOperationListResult result of the request to list Dedicated HSM Provider operations. It contains a list of operations.
type DedicatedHsmPatchParameters struct {
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}DedicatedHsmPatchParameters patchable properties of the dedicated HSM
func (dhpp DedicatedHsmPatchParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DedicatedHsmPatchParameters.
type DedicatedHsmProperties struct {
// NetworkProfile - Specifies the network interfaces of the dedicated hsm.
NetworkProfile *NetworkProfile `json:"networkProfile,omitempty"`
// StampID - This field will be used when RP does not support Availability zones.
StampID *string `json:"stampId,omitempty"`
// StatusMessage - READ-ONLY; Resource Status Message.
StatusMessage *string `json:"statusMessage,omitempty"`
// ProvisioningState - READ-ONLY; Provisioning state. Possible values include: 'Succeeded', 'Provisioning', 'Allocating', 'Connecting', 'Failed', 'CheckingQuota', 'Deleting'
ProvisioningState JSONWebKeyType `json:"provisioningState,omitempty"`
}DedicatedHsmProperties properties of the dedicated hsm
func (dhp DedicatedHsmProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DedicatedHsmProperties.
type DedicatedHsmUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DedicatedHsmClient) (DedicatedHsm, error)
}DedicatedHsmUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type Error struct {
// Code - READ-ONLY; The error code.
Code *string `json:"code,omitempty"`
// Message - READ-ONLY; The error message.
Message *string `json:"message,omitempty"`
// InnerError - READ-ONLY
InnerError *Error `json:"innererror,omitempty"`
}Error the key vault server error.
JSONWebKeyType enumerates the values for json web key type.
const (
// Allocating A device is currently being allocated for the dedicated HSM resource.
Allocating JSONWebKeyType = "Allocating"
// CheckingQuota Validating the subscription has sufficient quota to allocate a dedicated HSM device.
CheckingQuota JSONWebKeyType = "CheckingQuota"
// Connecting The dedicated HSM is being connected to the virtual network.
Connecting JSONWebKeyType = "Connecting"
// Deleting The dedicated HSM is currently being deleted.
Deleting JSONWebKeyType = "Deleting"
// Failed Provisioning of the dedicated HSM has failed.
Failed JSONWebKeyType = "Failed"
// Provisioning The dedicated HSM is currently being provisioned.
Provisioning JSONWebKeyType = "Provisioning"
// Succeeded The dedicated HSM has been full provisioned.
Succeeded JSONWebKeyType = "Succeeded"
)func PossibleJSONWebKeyTypeValues() []JSONWebKeyType
PossibleJSONWebKeyTypeValues returns an array of possible values for the JSONWebKeyType const type.
Name enumerates the values for name.
const (
// SafeNetLunaNetworkHSMA790 ...
SafeNetLunaNetworkHSMA790 Name = "SafeNet Luna Network HSM A790"
)PossibleNameValues returns an array of possible values for the Name const type.
type NetworkInterface struct {
// ID - READ-ONLY; The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
ID *string `json:"id,omitempty"`
// PrivateIPAddress - Private Ip address of the interface
PrivateIPAddress *string `json:"privateIpAddress,omitempty"`
}NetworkInterface the network interface definition.
func (ni NetworkInterface) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for NetworkInterface.
type NetworkProfile struct {
// Subnet - Specifies the identifier of the subnet.
Subnet *APIEntityReference `json:"subnet,omitempty"`
// NetworkInterfaces - Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM.
NetworkInterfaces *[]NetworkInterface `json:"networkInterfaces,omitempty"`
}NetworkProfile ...
type OperationsClient struct {
BaseClient
}OperationsClient is the the Azure management API provides a RESTful set of web services that interact with Azure Dedicated HSM RP.
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client OperationsClient) List(ctx context.Context) (result DedicatedHsmOperationListResult, err error)
List get a list of Dedicated HSM operations.
ListPreparer prepares the List request.
func (client OperationsClient) ListResponder(resp *http.Response) (result DedicatedHsmOperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type Resource struct {
// ID - READ-ONLY; The Azure Resource Manager resource ID for the dedicated HSM.
ID *string `json:"id,omitempty"`
// Name - READ-ONLY; The name of the dedicated HSM.
Name *string `json:"name,omitempty"`
// Type - READ-ONLY; The resource type of the dedicated HSM.
Type *string `json:"type,omitempty"`
// Location - The supported Azure location where the dedicated HSM should be created.
Location *string `json:"location,omitempty"`
// Sku - SKU details
Sku *Sku `json:"sku,omitempty"`
// Zones - The Dedicated Hsm zones.
Zones *[]string `json:"zones,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}Resource dedicated HSM resource
MarshalJSON is the custom marshaler for Resource.
type ResourceListResult struct {
// Value - The list of dedicated HSM resources.
Value *[]Resource `json:"value,omitempty"`
// NextLink - The URL to get the next set of dedicated HSM resources.
NextLink *string `json:"nextLink,omitempty"`
}ResourceListResult list of dedicated HSM resources.
type Sku struct {
// Name - SKU of the dedicated HSM. Possible values include: 'SafeNetLunaNetworkHSMA790'
Name Name `json:"name,omitempty"`
}Sku ...
| Path | Synopsis |
|---|---|
| hardwaresecuritymodulesapi |
Package hardwaresecuritymodules imports 9 packages (graph) and is imported by 3 packages. Updated 2021-01-26. Refresh now. Tools for package owners.