dedicatedhsms

package
v0.20230614.1151152 Latest Latest
Warning

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

Go to latest
Published: Jun 14, 2023 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/hardwaresecuritymodules/2021-11-30/dedicatedhsms Documentation

The dedicatedhsms SDK allows for interaction with the Azure Resource Manager Service hardwaresecuritymodules (API Version 2021-11-30).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/hardwaresecuritymodules/2021-11-30/dedicatedhsms"

Client Initialization

client := dedicatedhsms.NewDedicatedHsmsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DedicatedHsmsClient.DedicatedHsmCreateOrUpdate

ctx := context.TODO()
id := dedicatedhsms.NewDedicatedHSMID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dedicatedHSMValue")

payload := dedicatedhsms.DedicatedHsm{
	// ...
}


if err := client.DedicatedHsmCreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DedicatedHsmsClient.DedicatedHsmDelete

ctx := context.TODO()
id := dedicatedhsms.NewDedicatedHSMID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dedicatedHSMValue")

if err := client.DedicatedHsmDeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: DedicatedHsmsClient.DedicatedHsmGet

ctx := context.TODO()
id := dedicatedhsms.NewDedicatedHSMID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dedicatedHSMValue")

read, err := client.DedicatedHsmGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DedicatedHsmsClient.DedicatedHsmListByResourceGroup

ctx := context.TODO()
id := dedicatedhsms.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

// alternatively `client.DedicatedHsmListByResourceGroup(ctx, id, dedicatedhsms.DefaultDedicatedHsmListByResourceGroupOperationOptions())` can be used to do batched pagination
items, err := client.DedicatedHsmListByResourceGroupComplete(ctx, id, dedicatedhsms.DefaultDedicatedHsmListByResourceGroupOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: DedicatedHsmsClient.DedicatedHsmListBySubscription

ctx := context.TODO()
id := dedicatedhsms.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.DedicatedHsmListBySubscription(ctx, id, dedicatedhsms.DefaultDedicatedHsmListBySubscriptionOperationOptions())` can be used to do batched pagination
items, err := client.DedicatedHsmListBySubscriptionComplete(ctx, id, dedicatedhsms.DefaultDedicatedHsmListBySubscriptionOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: DedicatedHsmsClient.DedicatedHsmListOutboundNetworkDependenciesEndpoints

ctx := context.TODO()
id := dedicatedhsms.NewDedicatedHSMID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dedicatedHSMValue")

// alternatively `client.DedicatedHsmListOutboundNetworkDependenciesEndpoints(ctx, id)` can be used to do batched pagination
items, err := client.DedicatedHsmListOutboundNetworkDependenciesEndpointsComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: DedicatedHsmsClient.DedicatedHsmUpdate

ctx := context.TODO()
id := dedicatedhsms.NewDedicatedHSMID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dedicatedHSMValue")

payload := dedicatedhsms.DedicatedHsmPatchParameters{
	// ...
}


if err := client.DedicatedHsmUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForJsonWebKeyType

func PossibleValuesForJsonWebKeyType() []string

func PossibleValuesForSkuName

func PossibleValuesForSkuName() []string

func ValidateDedicatedHSMID

func ValidateDedicatedHSMID(input interface{}, key string) (warnings []string, errors []error)

ValidateDedicatedHSMID checks that 'input' can be parsed as a Dedicated H S M ID

Types

type ApiEntityReference

type ApiEntityReference struct {
	Id *string `json:"id,omitempty"`
}

type DedicatedHSMId

type DedicatedHSMId struct {
	SubscriptionId    string
	ResourceGroupName string
	DedicatedHSMName  string
}

DedicatedHSMId is a struct representing the Resource ID for a Dedicated H S M

func NewDedicatedHSMID

func NewDedicatedHSMID(subscriptionId string, resourceGroupName string, dedicatedHSMName string) DedicatedHSMId

NewDedicatedHSMID returns a new DedicatedHSMId struct

func ParseDedicatedHSMID

func ParseDedicatedHSMID(input string) (*DedicatedHSMId, error)

ParseDedicatedHSMID parses 'input' into a DedicatedHSMId

func ParseDedicatedHSMIDInsensitively

func ParseDedicatedHSMIDInsensitively(input string) (*DedicatedHSMId, error)

ParseDedicatedHSMIDInsensitively parses 'input' case-insensitively into a DedicatedHSMId note: this method should only be used for API response data and not user input

func (DedicatedHSMId) ID

func (id DedicatedHSMId) ID() string

ID returns the formatted Dedicated H S M ID

func (DedicatedHSMId) Segments

func (id DedicatedHSMId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Dedicated H S M ID

func (DedicatedHSMId) String

func (id DedicatedHSMId) String() string

String returns a human-readable description of this Dedicated H S M ID

type DedicatedHsm

type DedicatedHsm struct {
	Id         *string                `json:"id,omitempty"`
	Location   string                 `json:"location"`
	Name       *string                `json:"name,omitempty"`
	Properties DedicatedHsmProperties `json:"properties"`
	Sku        Sku                    `json:"sku"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Tags       *map[string]string     `json:"tags,omitempty"`
	Type       *string                `json:"type,omitempty"`
	Zones      *zones.Schema          `json:"zones,omitempty"`
}

type DedicatedHsmCreateOrUpdateOperationResponse

type DedicatedHsmCreateOrUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DedicatedHsmDeleteOperationResponse

type DedicatedHsmDeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DedicatedHsmGetOperationResponse

type DedicatedHsmGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *DedicatedHsm
}

type DedicatedHsmListByResourceGroupCompleteResult

type DedicatedHsmListByResourceGroupCompleteResult struct {
	Items []DedicatedHsm
}

type DedicatedHsmListByResourceGroupOperationOptions

type DedicatedHsmListByResourceGroupOperationOptions struct {
	Top *int64
}

func DefaultDedicatedHsmListByResourceGroupOperationOptions

func DefaultDedicatedHsmListByResourceGroupOperationOptions() DedicatedHsmListByResourceGroupOperationOptions

type DedicatedHsmListByResourceGroupOperationResponse

type DedicatedHsmListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]DedicatedHsm
	// contains filtered or unexported fields
}

func (DedicatedHsmListByResourceGroupOperationResponse) HasMore

func (DedicatedHsmListByResourceGroupOperationResponse) LoadMore

type DedicatedHsmListBySubscriptionCompleteResult

type DedicatedHsmListBySubscriptionCompleteResult struct {
	Items []DedicatedHsm
}

type DedicatedHsmListBySubscriptionOperationOptions

type DedicatedHsmListBySubscriptionOperationOptions struct {
	Top *int64
}

func DefaultDedicatedHsmListBySubscriptionOperationOptions

func DefaultDedicatedHsmListBySubscriptionOperationOptions() DedicatedHsmListBySubscriptionOperationOptions

type DedicatedHsmListBySubscriptionOperationResponse

type DedicatedHsmListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]DedicatedHsm
	// contains filtered or unexported fields
}

func (DedicatedHsmListBySubscriptionOperationResponse) HasMore

func (DedicatedHsmListBySubscriptionOperationResponse) LoadMore

type DedicatedHsmListOutboundNetworkDependenciesEndpointsCompleteResult

type DedicatedHsmListOutboundNetworkDependenciesEndpointsCompleteResult struct {
	Items []OutboundEnvironmentEndpoint
}

type DedicatedHsmListOutboundNetworkDependenciesEndpointsOperationResponse

type DedicatedHsmListOutboundNetworkDependenciesEndpointsOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]OutboundEnvironmentEndpoint
	// contains filtered or unexported fields
}

func (DedicatedHsmListOutboundNetworkDependenciesEndpointsOperationResponse) HasMore

func (DedicatedHsmListOutboundNetworkDependenciesEndpointsOperationResponse) LoadMore

type DedicatedHsmOperationPredicate

type DedicatedHsmOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (DedicatedHsmOperationPredicate) Matches

type DedicatedHsmPatchParameters

type DedicatedHsmPatchParameters struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type DedicatedHsmProperties

type DedicatedHsmProperties struct {
	ManagementNetworkProfile *NetworkProfile `json:"managementNetworkProfile,omitempty"`
	NetworkProfile           *NetworkProfile `json:"networkProfile,omitempty"`
	ProvisioningState        *JsonWebKeyType `json:"provisioningState,omitempty"`
	StampId                  *string         `json:"stampId,omitempty"`
	StatusMessage            *string         `json:"statusMessage,omitempty"`
}

type DedicatedHsmUpdateOperationResponse

type DedicatedHsmUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DedicatedHsmsClient

type DedicatedHsmsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewDedicatedHsmsClientWithBaseURI

func NewDedicatedHsmsClientWithBaseURI(endpoint string) DedicatedHsmsClient

func (DedicatedHsmsClient) DedicatedHsmCreateOrUpdate

func (c DedicatedHsmsClient) DedicatedHsmCreateOrUpdate(ctx context.Context, id DedicatedHSMId, input DedicatedHsm) (result DedicatedHsmCreateOrUpdateOperationResponse, err error)

DedicatedHsmCreateOrUpdate ...

func (DedicatedHsmsClient) DedicatedHsmCreateOrUpdateThenPoll

func (c DedicatedHsmsClient) DedicatedHsmCreateOrUpdateThenPoll(ctx context.Context, id DedicatedHSMId, input DedicatedHsm) error

DedicatedHsmCreateOrUpdateThenPoll performs DedicatedHsmCreateOrUpdate then polls until it's completed

func (DedicatedHsmsClient) DedicatedHsmDelete

func (c DedicatedHsmsClient) DedicatedHsmDelete(ctx context.Context, id DedicatedHSMId) (result DedicatedHsmDeleteOperationResponse, err error)

DedicatedHsmDelete ...

func (DedicatedHsmsClient) DedicatedHsmDeleteThenPoll

func (c DedicatedHsmsClient) DedicatedHsmDeleteThenPoll(ctx context.Context, id DedicatedHSMId) error

DedicatedHsmDeleteThenPoll performs DedicatedHsmDelete then polls until it's completed

func (DedicatedHsmsClient) DedicatedHsmGet

DedicatedHsmGet ...

func (DedicatedHsmsClient) DedicatedHsmListByResourceGroup

DedicatedHsmListByResourceGroup ...

func (DedicatedHsmsClient) DedicatedHsmListByResourceGroupComplete

DedicatedHsmListByResourceGroupComplete retrieves all of the results into a single object

func (DedicatedHsmsClient) DedicatedHsmListByResourceGroupCompleteMatchingPredicate

DedicatedHsmListByResourceGroupCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (DedicatedHsmsClient) DedicatedHsmListBySubscription

DedicatedHsmListBySubscription ...

func (DedicatedHsmsClient) DedicatedHsmListBySubscriptionComplete

DedicatedHsmListBySubscriptionComplete retrieves all of the results into a single object

func (DedicatedHsmsClient) DedicatedHsmListBySubscriptionCompleteMatchingPredicate

DedicatedHsmListBySubscriptionCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (DedicatedHsmsClient) DedicatedHsmListOutboundNetworkDependenciesEndpoints

func (c DedicatedHsmsClient) DedicatedHsmListOutboundNetworkDependenciesEndpoints(ctx context.Context, id DedicatedHSMId) (resp DedicatedHsmListOutboundNetworkDependenciesEndpointsOperationResponse, err error)

DedicatedHsmListOutboundNetworkDependenciesEndpoints ...

func (DedicatedHsmsClient) DedicatedHsmListOutboundNetworkDependenciesEndpointsComplete

func (c DedicatedHsmsClient) DedicatedHsmListOutboundNetworkDependenciesEndpointsComplete(ctx context.Context, id DedicatedHSMId) (DedicatedHsmListOutboundNetworkDependenciesEndpointsCompleteResult, error)

DedicatedHsmListOutboundNetworkDependenciesEndpointsComplete retrieves all of the results into a single object

func (DedicatedHsmsClient) DedicatedHsmListOutboundNetworkDependenciesEndpointsCompleteMatchingPredicate

func (c DedicatedHsmsClient) DedicatedHsmListOutboundNetworkDependenciesEndpointsCompleteMatchingPredicate(ctx context.Context, id DedicatedHSMId, predicate OutboundEnvironmentEndpointOperationPredicate) (resp DedicatedHsmListOutboundNetworkDependenciesEndpointsCompleteResult, err error)

DedicatedHsmListOutboundNetworkDependenciesEndpointsCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (DedicatedHsmsClient) DedicatedHsmUpdate

DedicatedHsmUpdate ...

func (DedicatedHsmsClient) DedicatedHsmUpdateThenPoll

func (c DedicatedHsmsClient) DedicatedHsmUpdateThenPoll(ctx context.Context, id DedicatedHSMId, input DedicatedHsmPatchParameters) error

DedicatedHsmUpdateThenPoll performs DedicatedHsmUpdate then polls until it's completed

type EndpointDependency

type EndpointDependency struct {
	DomainName      *string           `json:"domainName,omitempty"`
	EndpointDetails *[]EndpointDetail `json:"endpointDetails,omitempty"`
}

type EndpointDetail

type EndpointDetail struct {
	Description *string `json:"description,omitempty"`
	IPAddress   *string `json:"ipAddress,omitempty"`
	Port        *int64  `json:"port,omitempty"`
	Protocol    *string `json:"protocol,omitempty"`
}

type JsonWebKeyType

type JsonWebKeyType string
const (
	JsonWebKeyTypeAllocating    JsonWebKeyType = "Allocating"
	JsonWebKeyTypeCheckingQuota JsonWebKeyType = "CheckingQuota"
	JsonWebKeyTypeConnecting    JsonWebKeyType = "Connecting"
	JsonWebKeyTypeDeleting      JsonWebKeyType = "Deleting"
	JsonWebKeyTypeFailed        JsonWebKeyType = "Failed"
	JsonWebKeyTypeProvisioning  JsonWebKeyType = "Provisioning"
	JsonWebKeyTypeSucceeded     JsonWebKeyType = "Succeeded"
)

type NetworkInterface

type NetworkInterface struct {
	Id               *string `json:"id,omitempty"`
	PrivateIPAddress *string `json:"privateIpAddress,omitempty"`
}

type NetworkProfile

type NetworkProfile struct {
	NetworkInterfaces *[]NetworkInterface `json:"networkInterfaces,omitempty"`
	Subnet            *ApiEntityReference `json:"subnet,omitempty"`
}

type OutboundEnvironmentEndpoint

type OutboundEnvironmentEndpoint struct {
	Category  *string               `json:"category,omitempty"`
	Endpoints *[]EndpointDependency `json:"endpoints,omitempty"`
}

type OutboundEnvironmentEndpointOperationPredicate

type OutboundEnvironmentEndpointOperationPredicate struct {
	Category *string
}

func (OutboundEnvironmentEndpointOperationPredicate) Matches

type Sku

type Sku struct {
	Name *SkuName `json:"name,omitempty"`
}

type SkuName

type SkuName string
const (
	SkuNamePayShieldOneZeroKLMKOneCPSSixZero         SkuName = "payShield10K_LMK1_CPS60"
	SkuNamePayShieldOneZeroKLMKOneCPSTwoFiveZero     SkuName = "payShield10K_LMK1_CPS250"
	SkuNamePayShieldOneZeroKLMKOneCPSTwoFiveZeroZero SkuName = "payShield10K_LMK1_CPS2500"
	SkuNamePayShieldOneZeroKLMKTwoCPSSixZero         SkuName = "payShield10K_LMK2_CPS60"
	SkuNamePayShieldOneZeroKLMKTwoCPSTwoFiveZero     SkuName = "payShield10K_LMK2_CPS250"
	SkuNamePayShieldOneZeroKLMKTwoCPSTwoFiveZeroZero SkuName = "payShield10K_LMK2_CPS2500"
	SkuNameSafeNetLunaNetworkHSMASevenNineZero       SkuName = "SafeNet Luna Network HSM A790"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL