README
¶
github.com/hashicorp/go-azure-sdk/resource-manager/compute/2023-04-02/diskencryptionsets
Documentation
The diskencryptionsets
SDK allows for interaction with the Azure Resource Manager Service compute
(API Version 2023-04-02
).
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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/compute/2023-04-02/diskencryptionsets"
Client Initialization
client := diskencryptionsets.NewDiskEncryptionSetsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: DiskEncryptionSetsClient.CreateOrUpdate
ctx := context.TODO()
id := commonids.NewDiskEncryptionSetID("12345678-1234-9876-4563-123456789012", "example-resource-group", "diskEncryptionSetValue")
payload := diskencryptionsets.DiskEncryptionSet{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: DiskEncryptionSetsClient.Delete
ctx := context.TODO()
id := commonids.NewDiskEncryptionSetID("12345678-1234-9876-4563-123456789012", "example-resource-group", "diskEncryptionSetValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: DiskEncryptionSetsClient.Get
ctx := context.TODO()
id := commonids.NewDiskEncryptionSetID("12345678-1234-9876-4563-123456789012", "example-resource-group", "diskEncryptionSetValue")
read, err := client.Get(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: DiskEncryptionSetsClient.List
ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")
// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: DiskEncryptionSetsClient.ListAssociatedResources
ctx := context.TODO()
id := commonids.NewDiskEncryptionSetID("12345678-1234-9876-4563-123456789012", "example-resource-group", "diskEncryptionSetValue")
// alternatively `client.ListAssociatedResources(ctx, id)` can be used to do batched pagination
items, err := client.ListAssociatedResourcesComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: DiskEncryptionSetsClient.ListByResourceGroup
ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")
// alternatively `client.ListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.ListByResourceGroupComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: DiskEncryptionSetsClient.Update
ctx := context.TODO()
id := commonids.NewDiskEncryptionSetID("12345678-1234-9876-4563-123456789012", "example-resource-group", "diskEncryptionSetValue")
payload := diskencryptionsets.DiskEncryptionSetUpdate{
// ...
}
if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Documentation
¶
Index ¶
- func PossibleValuesForDiskEncryptionSetType() []string
- type ApiError
- type ApiErrorBase
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type DiskEncryptionSet
- type DiskEncryptionSetOperationPredicate
- type DiskEncryptionSetType
- type DiskEncryptionSetUpdate
- type DiskEncryptionSetUpdateProperties
- type DiskEncryptionSetsClient
- func (c DiskEncryptionSetsClient) CreateOrUpdate(ctx context.Context, id commonids.DiskEncryptionSetId, input DiskEncryptionSet) (result CreateOrUpdateOperationResponse, err error)
- func (c DiskEncryptionSetsClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.DiskEncryptionSetId, input DiskEncryptionSet) error
- func (c DiskEncryptionSetsClient) Delete(ctx context.Context, id commonids.DiskEncryptionSetId) (result DeleteOperationResponse, err error)
- func (c DiskEncryptionSetsClient) DeleteThenPoll(ctx context.Context, id commonids.DiskEncryptionSetId) error
- func (c DiskEncryptionSetsClient) Get(ctx context.Context, id commonids.DiskEncryptionSetId) (result GetOperationResponse, err error)
- func (c DiskEncryptionSetsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
- func (c DiskEncryptionSetsClient) ListAssociatedResources(ctx context.Context, id commonids.DiskEncryptionSetId) (result ListAssociatedResourcesOperationResponse, err error)
- func (c DiskEncryptionSetsClient) ListAssociatedResourcesComplete(ctx context.Context, id commonids.DiskEncryptionSetId) (result ListAssociatedResourcesCompleteResult, err error)
- func (c DiskEncryptionSetsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)
- func (c DiskEncryptionSetsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)
- func (c DiskEncryptionSetsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, ...) (result ListByResourceGroupCompleteResult, err error)
- func (c DiskEncryptionSetsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)
- func (c DiskEncryptionSetsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListCompleteResult, err error)
- func (c DiskEncryptionSetsClient) Update(ctx context.Context, id commonids.DiskEncryptionSetId, ...) (result UpdateOperationResponse, err error)
- func (c DiskEncryptionSetsClient) UpdateThenPoll(ctx context.Context, id commonids.DiskEncryptionSetId, ...) error
- type EncryptionSetProperties
- type GetOperationResponse
- type InnerError
- type KeyForDiskEncryptionSet
- type ListAssociatedResourcesCompleteResult
- type ListAssociatedResourcesCustomPager
- type ListAssociatedResourcesOperationResponse
- type ListByResourceGroupCompleteResult
- type ListByResourceGroupCustomPager
- type ListByResourceGroupOperationResponse
- type ListCompleteResult
- type ListCustomPager
- type ListOperationResponse
- type SourceVault
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForDiskEncryptionSetType ¶
func PossibleValuesForDiskEncryptionSetType() []string
Types ¶
type ApiError ¶
type ApiError struct { Code *string `json:"code,omitempty"` Details *[]ApiErrorBase `json:"details,omitempty"` Innererror *InnerError `json:"innererror,omitempty"` Message *string `json:"message,omitempty"` Target *string `json:"target,omitempty"` }
type ApiErrorBase ¶
type DeleteOperationResponse ¶
type DiskEncryptionSet ¶
type DiskEncryptionSet struct { Id *string `json:"id,omitempty"` Identity *identity.SystemAndUserAssignedMap `json:"identity,omitempty"` Location string `json:"location"` Name *string `json:"name,omitempty"` Properties *EncryptionSetProperties `json:"properties,omitempty"` Tags *map[string]string `json:"tags,omitempty"` Type *string `json:"type,omitempty"` }
type DiskEncryptionSetOperationPredicate ¶
type DiskEncryptionSetOperationPredicate struct { Id *string Location *string Name *string Type *string }
func (DiskEncryptionSetOperationPredicate) Matches ¶
func (p DiskEncryptionSetOperationPredicate) Matches(input DiskEncryptionSet) bool
type DiskEncryptionSetType ¶
type DiskEncryptionSetType string
const ( DiskEncryptionSetTypeConfidentialVMEncryptedWithCustomerKey DiskEncryptionSetType = "ConfidentialVmEncryptedWithCustomerKey" DiskEncryptionSetTypeEncryptionAtRestWithCustomerKey DiskEncryptionSetType = "EncryptionAtRestWithCustomerKey" DiskEncryptionSetTypeEncryptionAtRestWithPlatformAndCustomerKeys DiskEncryptionSetType = "EncryptionAtRestWithPlatformAndCustomerKeys" )
func (*DiskEncryptionSetType) UnmarshalJSON ¶
func (s *DiskEncryptionSetType) UnmarshalJSON(bytes []byte) error
type DiskEncryptionSetUpdate ¶
type DiskEncryptionSetUpdate struct { Identity *identity.SystemAndUserAssignedMap `json:"identity,omitempty"` Properties *DiskEncryptionSetUpdateProperties `json:"properties,omitempty"` Tags *map[string]string `json:"tags,omitempty"` }
type DiskEncryptionSetUpdateProperties ¶
type DiskEncryptionSetUpdateProperties struct { ActiveKey *KeyForDiskEncryptionSet `json:"activeKey,omitempty"` EncryptionType *DiskEncryptionSetType `json:"encryptionType,omitempty"` FederatedClientId *string `json:"federatedClientId,omitempty"` RotationToLatestKeyVersionEnabled *bool `json:"rotationToLatestKeyVersionEnabled,omitempty"` }
type DiskEncryptionSetsClient ¶
type DiskEncryptionSetsClient struct {
Client *resourcemanager.Client
}
func NewDiskEncryptionSetsClientWithBaseURI ¶
func NewDiskEncryptionSetsClientWithBaseURI(sdkApi sdkEnv.Api) (*DiskEncryptionSetsClient, error)
func (DiskEncryptionSetsClient) CreateOrUpdate ¶
func (c DiskEncryptionSetsClient) CreateOrUpdate(ctx context.Context, id commonids.DiskEncryptionSetId, input DiskEncryptionSet) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (DiskEncryptionSetsClient) CreateOrUpdateThenPoll ¶
func (c DiskEncryptionSetsClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.DiskEncryptionSetId, input DiskEncryptionSet) error
CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed
func (DiskEncryptionSetsClient) Delete ¶
func (c DiskEncryptionSetsClient) Delete(ctx context.Context, id commonids.DiskEncryptionSetId) (result DeleteOperationResponse, err error)
Delete ...
func (DiskEncryptionSetsClient) DeleteThenPoll ¶
func (c DiskEncryptionSetsClient) DeleteThenPoll(ctx context.Context, id commonids.DiskEncryptionSetId) error
DeleteThenPoll performs Delete then polls until it's completed
func (DiskEncryptionSetsClient) Get ¶
func (c DiskEncryptionSetsClient) Get(ctx context.Context, id commonids.DiskEncryptionSetId) (result GetOperationResponse, err error)
Get ...
func (DiskEncryptionSetsClient) List ¶
func (c DiskEncryptionSetsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
List ...
func (DiskEncryptionSetsClient) ListAssociatedResources ¶
func (c DiskEncryptionSetsClient) ListAssociatedResources(ctx context.Context, id commonids.DiskEncryptionSetId) (result ListAssociatedResourcesOperationResponse, err error)
ListAssociatedResources ...
func (DiskEncryptionSetsClient) ListAssociatedResourcesComplete ¶
func (c DiskEncryptionSetsClient) ListAssociatedResourcesComplete(ctx context.Context, id commonids.DiskEncryptionSetId) (result ListAssociatedResourcesCompleteResult, err error)
ListAssociatedResourcesComplete retrieves all the results into a single object
func (DiskEncryptionSetsClient) ListByResourceGroup ¶
func (c DiskEncryptionSetsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)
ListByResourceGroup ...
func (DiskEncryptionSetsClient) ListByResourceGroupComplete ¶
func (c DiskEncryptionSetsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)
ListByResourceGroupComplete retrieves all the results into a single object
func (DiskEncryptionSetsClient) ListByResourceGroupCompleteMatchingPredicate ¶
func (c DiskEncryptionSetsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate DiskEncryptionSetOperationPredicate) (result ListByResourceGroupCompleteResult, err error)
ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (DiskEncryptionSetsClient) ListComplete ¶
func (c DiskEncryptionSetsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)
ListComplete retrieves all the results into a single object
func (DiskEncryptionSetsClient) ListCompleteMatchingPredicate ¶
func (c DiskEncryptionSetsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate DiskEncryptionSetOperationPredicate) (result ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (DiskEncryptionSetsClient) Update ¶
func (c DiskEncryptionSetsClient) Update(ctx context.Context, id commonids.DiskEncryptionSetId, input DiskEncryptionSetUpdate) (result UpdateOperationResponse, err error)
Update ...
func (DiskEncryptionSetsClient) UpdateThenPoll ¶
func (c DiskEncryptionSetsClient) UpdateThenPoll(ctx context.Context, id commonids.DiskEncryptionSetId, input DiskEncryptionSetUpdate) error
UpdateThenPoll performs Update then polls until it's completed
type EncryptionSetProperties ¶
type EncryptionSetProperties struct { ActiveKey *KeyForDiskEncryptionSet `json:"activeKey,omitempty"` AutoKeyRotationError *ApiError `json:"autoKeyRotationError,omitempty"` EncryptionType *DiskEncryptionSetType `json:"encryptionType,omitempty"` FederatedClientId *string `json:"federatedClientId,omitempty"` LastKeyRotationTimestamp *string `json:"lastKeyRotationTimestamp,omitempty"` PreviousKeys *[]KeyForDiskEncryptionSet `json:"previousKeys,omitempty"` ProvisioningState *string `json:"provisioningState,omitempty"` RotationToLatestKeyVersionEnabled *bool `json:"rotationToLatestKeyVersionEnabled,omitempty"` }
func (*EncryptionSetProperties) GetLastKeyRotationTimestampAsTime ¶
func (o *EncryptionSetProperties) GetLastKeyRotationTimestampAsTime() (*time.Time, error)
func (*EncryptionSetProperties) SetLastKeyRotationTimestampAsTime ¶
func (o *EncryptionSetProperties) SetLastKeyRotationTimestampAsTime(input time.Time)
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *DiskEncryptionSet }
type InnerError ¶
type KeyForDiskEncryptionSet ¶
type KeyForDiskEncryptionSet struct { KeyUrl string `json:"keyUrl"` SourceVault *SourceVault `json:"sourceVault,omitempty"` }
type ListAssociatedResourcesCustomPager ¶ added in v0.20240628.1153531
func (*ListAssociatedResourcesCustomPager) NextPageLink ¶ added in v0.20240628.1153531
func (p *ListAssociatedResourcesCustomPager) NextPageLink() *odata.Link
type ListByResourceGroupCompleteResult ¶
type ListByResourceGroupCompleteResult struct { LatestHttpResponse *http.Response Items []DiskEncryptionSet }
type ListByResourceGroupCustomPager ¶ added in v0.20240628.1153531
func (*ListByResourceGroupCustomPager) NextPageLink ¶ added in v0.20240628.1153531
func (p *ListByResourceGroupCustomPager) NextPageLink() *odata.Link
type ListByResourceGroupOperationResponse ¶
type ListByResourceGroupOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]DiskEncryptionSet }
type ListCompleteResult ¶
type ListCompleteResult struct { LatestHttpResponse *http.Response Items []DiskEncryptionSet }
type ListCustomPager ¶ added in v0.20240628.1153531
func (*ListCustomPager) NextPageLink ¶ added in v0.20240628.1153531
func (p *ListCustomPager) NextPageLink() *odata.Link
type ListOperationResponse ¶
type ListOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]DiskEncryptionSet }
type SourceVault ¶
type SourceVault struct {
Id *string `json:"id,omitempty"`
}
type UpdateOperationResponse ¶
Source Files
¶
- client.go
- constants.go
- method_createorupdate.go
- method_delete.go
- method_get.go
- method_list.go
- method_listassociatedresources.go
- method_listbyresourcegroup.go
- method_update.go
- model_apierror.go
- model_apierrorbase.go
- model_diskencryptionset.go
- model_diskencryptionsetupdate.go
- model_diskencryptionsetupdateproperties.go
- model_encryptionsetproperties.go
- model_innererror.go
- model_keyfordiskencryptionset.go
- model_sourcevault.go
- predicates.go
- version.go