hardwaresecuritymodules

package
v66.0.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Jun 14, 2022 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hardwaresecuritymodules/armhardwaresecuritymodules(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hardwaresecuritymodules/armhardwaresecuritymodules). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Package hardwaresecuritymodules implements the Azure ARM Hardwaresecuritymodules service API version 2021-11-30.

The Azure management API provides a RESTful set of web services that interact with Azure Dedicated HSM RP.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Hardwaresecuritymodules
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type APIEntityReference 

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.

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Hardwaresecuritymodules.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

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 

type DedicatedHsm struct {
	autorest.Response `json:"-"`
	// SystemData - Metadata pertaining to creation and last modification of the resource
	SystemData *SystemData `json:"systemData,omitempty"`
	// 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 (DedicatedHsm) MarshalJSON 

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

MarshalJSON is the custom marshaler for DedicatedHsm.

func (*DedicatedHsm) UnmarshalJSON 

func (dh *DedicatedHsm) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DedicatedHsm struct.

type DedicatedHsmClient 

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 

func NewDedicatedHsmClient(subscriptionID string) DedicatedHsmClient

NewDedicatedHsmClient creates an instance of the DedicatedHsmClient client.

func NewDedicatedHsmClientWithBaseURI 

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 (DedicatedHsmClient) CreateOrUpdate 

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 (DedicatedHsmClient) CreateOrUpdatePreparer 

func (client DedicatedHsmClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, name string, parameters DedicatedHsm) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (DedicatedHsmClient) CreateOrUpdateResponder 

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 (DedicatedHsmClient) CreateOrUpdateSender 

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 (DedicatedHsmClient) Delete 

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 (DedicatedHsmClient) DeletePreparer 

func (client DedicatedHsmClient) DeletePreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (DedicatedHsmClient) DeleteResponder 

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 (DedicatedHsmClient) DeleteSender 

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 (DedicatedHsmClient) Get 

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 (DedicatedHsmClient) GetPreparer 

func (client DedicatedHsmClient) GetPreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DedicatedHsmClient) GetResponder 

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.

func (DedicatedHsmClient) GetSender 

func (client DedicatedHsmClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (DedicatedHsmClient) ListByResourceGroup 

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 (DedicatedHsmClient) ListByResourceGroupComplete 

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 (DedicatedHsmClient) ListByResourceGroupPreparer 

func (client DedicatedHsmClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, top *int32) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (DedicatedHsmClient) ListByResourceGroupResponder 

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 (DedicatedHsmClient) ListByResourceGroupSender 

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 (DedicatedHsmClient) ListBySubscription 

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 (DedicatedHsmClient) ListBySubscriptionComplete 

func (client DedicatedHsmClient) ListBySubscriptionComplete(ctx context.Context, top *int32) (result DedicatedHsmListResultIterator, err error)

ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.

func (DedicatedHsmClient) ListBySubscriptionPreparer 

func (client DedicatedHsmClient) ListBySubscriptionPreparer(ctx context.Context, top *int32) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (DedicatedHsmClient) ListBySubscriptionResponder 

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 (DedicatedHsmClient) ListBySubscriptionSender 

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 (DedicatedHsmClient) ListOutboundNetworkDependenciesEndpoints 

func (client DedicatedHsmClient) ListOutboundNetworkDependenciesEndpoints(ctx context.Context, resourceGroupName string, name string) (result OutboundEnvironmentEndpointCollectionPage, err error)

ListOutboundNetworkDependenciesEndpoints 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. Parameters: resourceGroupName - the name of the Resource Group to which the dedicated hsm belongs. name - the name of the dedicated HSM.

func (DedicatedHsmClient) ListOutboundNetworkDependenciesEndpointsComplete 

func (client DedicatedHsmClient) ListOutboundNetworkDependenciesEndpointsComplete(ctx context.Context, resourceGroupName string, name string) (result OutboundEnvironmentEndpointCollectionIterator, err error)

ListOutboundNetworkDependenciesEndpointsComplete enumerates all values, automatically crossing page boundaries as required.

func (DedicatedHsmClient) ListOutboundNetworkDependenciesEndpointsPreparer 

func (client DedicatedHsmClient) ListOutboundNetworkDependenciesEndpointsPreparer(ctx context.Context, resourceGroupName string, name string) (*http.Request, error)

ListOutboundNetworkDependenciesEndpointsPreparer prepares the ListOutboundNetworkDependenciesEndpoints request.

func (DedicatedHsmClient) ListOutboundNetworkDependenciesEndpointsResponder 

func (client DedicatedHsmClient) ListOutboundNetworkDependenciesEndpointsResponder(resp *http.Response) (result OutboundEnvironmentEndpointCollection, err error)

ListOutboundNetworkDependenciesEndpointsResponder handles the response to the ListOutboundNetworkDependenciesEndpoints request. The method always closes the http.Response Body.

func (DedicatedHsmClient) ListOutboundNetworkDependenciesEndpointsSender 

func (client DedicatedHsmClient) ListOutboundNetworkDependenciesEndpointsSender(req *http.Request) (*http.Response, error)

ListOutboundNetworkDependenciesEndpointsSender sends the ListOutboundNetworkDependenciesEndpoints request. The method will close the http.Response Body if it receives an error.

func (DedicatedHsmClient) Update 

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 (DedicatedHsmClient) UpdatePreparer 

func (client DedicatedHsmClient) UpdatePreparer(ctx context.Context, resourceGroupName string, name string, parameters DedicatedHsmPatchParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (DedicatedHsmClient) UpdateResponder 

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 (DedicatedHsmClient) UpdateSender 

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 

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.

func (*DedicatedHsmCreateOrUpdateFuture) UnmarshalJSON 

func (future *DedicatedHsmCreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type DedicatedHsmDeleteFuture 

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.

func (*DedicatedHsmDeleteFuture) UnmarshalJSON 

func (future *DedicatedHsmDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type DedicatedHsmError 

type DedicatedHsmError struct {
	// Error - READ-ONLY; The error detail of the operation if any.
	Error *Error `json:"error,omitempty"`
}

DedicatedHsmError the error exception.

func (DedicatedHsmError) MarshalJSON 

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

MarshalJSON is the custom marshaler for DedicatedHsmError.

type DedicatedHsmListResult 

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 (DedicatedHsmListResult) IsEmpty 

func (dhlr DedicatedHsmListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DedicatedHsmListResultIterator 

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

DedicatedHsmListResultIterator provides access to a complete listing of DedicatedHsm values.

func NewDedicatedHsmListResultIterator 

func NewDedicatedHsmListResultIterator(page DedicatedHsmListResultPage) DedicatedHsmListResultIterator

Creates a new instance of the DedicatedHsmListResultIterator type.

func (*DedicatedHsmListResultIterator) Next 

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 (*DedicatedHsmListResultIterator) NextWithContext 

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 (DedicatedHsmListResultIterator) NotDone 

func (iter DedicatedHsmListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (DedicatedHsmListResultIterator) Response 

func (iter DedicatedHsmListResultIterator) Response() DedicatedHsmListResult

Response returns the raw server response from the last page request.

func (DedicatedHsmListResultIterator) Value 

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 

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

DedicatedHsmListResultPage contains a page of DedicatedHsm values.

func NewDedicatedHsmListResultPage 

func NewDedicatedHsmListResultPage(cur DedicatedHsmListResult, getNextPage func(context.Context, DedicatedHsmListResult) (DedicatedHsmListResult, error)) DedicatedHsmListResultPage

Creates a new instance of the DedicatedHsmListResultPage type.

func (*DedicatedHsmListResultPage) Next 

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 (*DedicatedHsmListResultPage) NextWithContext 

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 (DedicatedHsmListResultPage) NotDone 

func (page DedicatedHsmListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (DedicatedHsmListResultPage) Response 

func (page DedicatedHsmListResultPage) Response() DedicatedHsmListResult

Response returns the raw server response from the last page request.

func (DedicatedHsmListResultPage) Values 

func (page DedicatedHsmListResultPage) Values() []DedicatedHsm

Values returns the slice of values for the current page or nil if there are no values.

type DedicatedHsmOperation 

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 - The display string.
	Display *DedicatedHsmOperationDisplay `json:"display,omitempty"`
}

DedicatedHsmOperation REST API operation

func (DedicatedHsmOperation) MarshalJSON 

func (dho DedicatedHsmOperation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DedicatedHsmOperation.

type DedicatedHsmOperationDisplay 

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 the display string.

type DedicatedHsmOperationListResult 

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 

type DedicatedHsmPatchParameters struct {
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
}

DedicatedHsmPatchParameters patchable properties of the dedicated HSM

func (DedicatedHsmPatchParameters) MarshalJSON 

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

MarshalJSON is the custom marshaler for DedicatedHsmPatchParameters.

type DedicatedHsmProperties 

type DedicatedHsmProperties struct {
	// NetworkProfile - Specifies the network interfaces of the dedicated hsm.
	NetworkProfile *NetworkProfile `json:"networkProfile,omitempty"`
	// ManagementNetworkProfile - Specifies the management network interfaces of the dedicated hsm.
	ManagementNetworkProfile *NetworkProfile `json:"managementNetworkProfile,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: 'JSONWebKeyTypeSucceeded', 'JSONWebKeyTypeProvisioning', 'JSONWebKeyTypeAllocating', 'JSONWebKeyTypeConnecting', 'JSONWebKeyTypeFailed', 'JSONWebKeyTypeCheckingQuota', 'JSONWebKeyTypeDeleting'
	ProvisioningState JSONWebKeyType `json:"provisioningState,omitempty"`
}

DedicatedHsmProperties properties of the dedicated hsm

func (DedicatedHsmProperties) MarshalJSON 

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

MarshalJSON is the custom marshaler for DedicatedHsmProperties.

type DedicatedHsmUpdateFuture 

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.

func (*DedicatedHsmUpdateFuture) UnmarshalJSON 

func (future *DedicatedHsmUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type EndpointDependency 

type EndpointDependency struct {
	// DomainName - The domain name of the dependency.
	DomainName *string `json:"domainName,omitempty"`
	// EndpointDetails - The Ports and Protocols used when connecting to domainName.
	EndpointDetails *[]EndpointDetail `json:"endpointDetails,omitempty"`
}

EndpointDependency a domain name that dedicated hsm services are reaching at.

type EndpointDetail 

type EndpointDetail struct {
	// IPAddress - An IP Address that Domain Name currently resolves to.
	IPAddress *string `json:"ipAddress,omitempty"`
	// Port - The port an endpoint is connected to.
	Port *int32 `json:"port,omitempty"`
	// Protocol - The protocol used for connection
	Protocol *string `json:"protocol,omitempty"`
	// Description - Description of the detail
	Description *string `json:"description,omitempty"`
}

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

type Error 

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; Contains more specific error that narrows down the cause. May be null.
	InnerError *Error `json:"innererror,omitempty"`
}

Error the key vault server error.

func (Error) MarshalJSON 

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

MarshalJSON is the custom marshaler for Error.

type IdentityType 

type IdentityType string

IdentityType enumerates the values for identity type. 

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

func PossibleIdentityTypeValues 

func PossibleIdentityTypeValues() []IdentityType

PossibleIdentityTypeValues returns an array of possible values for the IdentityType const type.

type JSONWebKeyType 

type JSONWebKeyType string

JSONWebKeyType enumerates the values for json web key type. 

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 full provisioned.
	JSONWebKeyTypeSucceeded JSONWebKeyType = "Succeeded"
)

func PossibleJSONWebKeyTypeValues 

func PossibleJSONWebKeyTypeValues() []JSONWebKeyType

PossibleJSONWebKeyTypeValues returns an array of possible values for the JSONWebKeyType const type.

type NetworkInterface 

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 (NetworkInterface) MarshalJSON 

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

MarshalJSON is the custom marshaler for NetworkInterface.

type NetworkProfile 

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 the network profile definition.

type OperationsClient 

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 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

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 (OperationsClient) List 

func (client OperationsClient) List(ctx context.Context) (result DedicatedHsmOperationListResult, err error)

List get a list of Dedicated HSM operations.

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

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.

func (OperationsClient) ListSender 

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type OutboundEnvironmentEndpoint 

type OutboundEnvironmentEndpoint struct {
	// Category - The category of endpoints accessed by the dedicated hsm service, e.g. azure-resource-management, apiserver, etc.
	Category *string `json:"category,omitempty"`
	// Endpoints - The endpoints that dedicated hsm service connects to
	Endpoints *[]EndpointDependency `json:"endpoints,omitempty"`
}

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

type OutboundEnvironmentEndpointCollection 

type OutboundEnvironmentEndpointCollection struct {
	autorest.Response `json:"-"`
	// Value - Collection of resources.
	Value *[]OutboundEnvironmentEndpoint `json:"value,omitempty"`
	// NextLink - READ-ONLY; Link to next page of resources.
	NextLink *string `json:"nextLink,omitempty"`
}

OutboundEnvironmentEndpointCollection collection of OutboundEnvironmentEndpoint

func (OutboundEnvironmentEndpointCollection) IsEmpty 

func (oeec OutboundEnvironmentEndpointCollection) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (OutboundEnvironmentEndpointCollection) MarshalJSON 

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

MarshalJSON is the custom marshaler for OutboundEnvironmentEndpointCollection.

type OutboundEnvironmentEndpointCollectionIterator 

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

OutboundEnvironmentEndpointCollectionIterator provides access to a complete listing of OutboundEnvironmentEndpoint values.

func NewOutboundEnvironmentEndpointCollectionIterator 

func NewOutboundEnvironmentEndpointCollectionIterator(page OutboundEnvironmentEndpointCollectionPage) OutboundEnvironmentEndpointCollectionIterator

Creates a new instance of the OutboundEnvironmentEndpointCollectionIterator type.

func (*OutboundEnvironmentEndpointCollectionIterator) Next 

func (iter *OutboundEnvironmentEndpointCollectionIterator) 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 (*OutboundEnvironmentEndpointCollectionIterator) NextWithContext 

func (iter *OutboundEnvironmentEndpointCollectionIterator) 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 (OutboundEnvironmentEndpointCollectionIterator) NotDone 

func (iter OutboundEnvironmentEndpointCollectionIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OutboundEnvironmentEndpointCollectionIterator) Response 

func (iter OutboundEnvironmentEndpointCollectionIterator) Response() OutboundEnvironmentEndpointCollection

Response returns the raw server response from the last page request.

func (OutboundEnvironmentEndpointCollectionIterator) Value 

func (iter OutboundEnvironmentEndpointCollectionIterator) Value() OutboundEnvironmentEndpoint

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OutboundEnvironmentEndpointCollectionPage 

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

OutboundEnvironmentEndpointCollectionPage contains a page of OutboundEnvironmentEndpoint values.

func NewOutboundEnvironmentEndpointCollectionPage 

func NewOutboundEnvironmentEndpointCollectionPage(cur OutboundEnvironmentEndpointCollection, getNextPage func(context.Context, OutboundEnvironmentEndpointCollection) (OutboundEnvironmentEndpointCollection, error)) OutboundEnvironmentEndpointCollectionPage

Creates a new instance of the OutboundEnvironmentEndpointCollectionPage type.

func (*OutboundEnvironmentEndpointCollectionPage) Next 

func (page *OutboundEnvironmentEndpointCollectionPage) 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 (*OutboundEnvironmentEndpointCollectionPage) NextWithContext 

func (page *OutboundEnvironmentEndpointCollectionPage) 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 (OutboundEnvironmentEndpointCollectionPage) NotDone 

func (page OutboundEnvironmentEndpointCollectionPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OutboundEnvironmentEndpointCollectionPage) Response 

func (page OutboundEnvironmentEndpointCollectionPage) Response() OutboundEnvironmentEndpointCollection

Response returns the raw server response from the last page request.

func (OutboundEnvironmentEndpointCollectionPage) Values 

func (page OutboundEnvironmentEndpointCollectionPage) Values() []OutboundEnvironmentEndpoint

Values returns the slice of values for the current page or nil if there are no values.

type Resource 

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

func (Resource) MarshalJSON 

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

MarshalJSON is the custom marshaler for Resource.

type ResourceListResult 

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 

type Sku struct {
	// Name - SKU of the dedicated HSM. Possible values include: 'SkuNameSafeNetLunaNetworkHSMA790', 'SkuNamePayShield10KLMK1CPS60', 'SkuNamePayShield10KLMK1CPS250', 'SkuNamePayShield10KLMK1CPS2500', 'SkuNamePayShield10KLMK2CPS60', 'SkuNamePayShield10KLMK2CPS250', 'SkuNamePayShield10KLMK2CPS2500'
	Name SkuName `json:"name,omitempty"`
}

Sku SKU of the dedicated HSM

type SkuName 

type SkuName string

SkuName enumerates the values for sku name. 

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 an array of possible values for the SkuName const type.

type SystemData 

type SystemData struct {
	// CreatedBy - The identity that created dedicated hsm resource.
	CreatedBy *string `json:"createdBy,omitempty"`
	// CreatedByType - The type of identity that created dedicated hsm resource. Possible values include: 'IdentityTypeUser', 'IdentityTypeApplication', 'IdentityTypeManagedIdentity', 'IdentityTypeKey'
	CreatedByType IdentityType `json:"createdByType,omitempty"`
	// CreatedAt - The timestamp of dedicated hsm resource creation (UTC).
	CreatedAt *date.Time `json:"createdAt,omitempty"`
	// LastModifiedBy - The identity that last modified dedicated hsm resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
	// LastModifiedByType - The type of identity that last modified dedicated hsm resource. Possible values include: 'IdentityTypeUser', 'IdentityTypeApplication', 'IdentityTypeManagedIdentity', 'IdentityTypeKey'
	LastModifiedByType IdentityType `json:"lastModifiedByType,omitempty"`
	// LastModifiedAt - The timestamp of dedicated hsm resource last modification (UTC).
	LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"`
}

SystemData metadata pertaining to creation and last modification of dedicated hsm resource.

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.