encryptionscopes

package
v0.20240416.1114103 Latest Latest
Warning

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

Go to latest
Published: Apr 16, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2023-10-01-preview/encryptionscopes Documentation

The encryptionscopes SDK allows for interaction with the Azure Resource Manager Service cognitive (API Version 2023-10-01-preview).

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/cognitive/2023-10-01-preview/encryptionscopes"

Client Initialization

client := encryptionscopes.NewEncryptionScopesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EncryptionScopesClient.CreateOrUpdate

ctx := context.TODO()
id := encryptionscopes.NewEncryptionScopeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "encryptionScopeValue")

payload := encryptionscopes.EncryptionScope{
	// ...
}


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

Example Usage: EncryptionScopesClient.Delete

ctx := context.TODO()
id := encryptionscopes.NewEncryptionScopeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "encryptionScopeValue")

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

Example Usage: EncryptionScopesClient.Get

ctx := context.TODO()
id := encryptionscopes.NewEncryptionScopeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue", "encryptionScopeValue")

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: EncryptionScopesClient.List

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

// 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
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForEncryptionScopeProvisioningState

func PossibleValuesForEncryptionScopeProvisioningState() []string

func PossibleValuesForEncryptionScopeState

func PossibleValuesForEncryptionScopeState() []string

func PossibleValuesForKeySource

func PossibleValuesForKeySource() []string

func ValidateAccountID

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

ValidateAccountID checks that 'input' can be parsed as a Account ID

func ValidateEncryptionScopeID

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

ValidateEncryptionScopeID checks that 'input' can be parsed as a Encryption Scope ID

Types

type AccountId

type AccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
}

AccountId is a struct representing the Resource ID for a Account

func NewAccountID

func NewAccountID(subscriptionId string, resourceGroupName string, accountName string) AccountId

NewAccountID returns a new AccountId struct

func ParseAccountID

func ParseAccountID(input string) (*AccountId, error)

ParseAccountID parses 'input' into a AccountId

func ParseAccountIDInsensitively

func ParseAccountIDInsensitively(input string) (*AccountId, error)

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

func (*AccountId) FromParseResult

func (id *AccountId) FromParseResult(input resourceids.ParseResult) error

func (AccountId) ID

func (id AccountId) ID() string

ID returns the formatted Account ID

func (AccountId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Account ID

func (AccountId) String

func (id AccountId) String() string

String returns a human-readable description of this Account ID

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EncryptionScope
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type EncryptionScope

type EncryptionScope struct {
	Etag       *string                    `json:"etag,omitempty"`
	Id         *string                    `json:"id,omitempty"`
	Name       *string                    `json:"name,omitempty"`
	Properties *EncryptionScopeProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData     `json:"systemData,omitempty"`
	Tags       *map[string]string         `json:"tags,omitempty"`
	Type       *string                    `json:"type,omitempty"`
}

type EncryptionScopeId

type EncryptionScopeId struct {
	SubscriptionId      string
	ResourceGroupName   string
	AccountName         string
	EncryptionScopeName string
}

EncryptionScopeId is a struct representing the Resource ID for a Encryption Scope

func NewEncryptionScopeID

func NewEncryptionScopeID(subscriptionId string, resourceGroupName string, accountName string, encryptionScopeName string) EncryptionScopeId

NewEncryptionScopeID returns a new EncryptionScopeId struct

func ParseEncryptionScopeID

func ParseEncryptionScopeID(input string) (*EncryptionScopeId, error)

ParseEncryptionScopeID parses 'input' into a EncryptionScopeId

func ParseEncryptionScopeIDInsensitively

func ParseEncryptionScopeIDInsensitively(input string) (*EncryptionScopeId, error)

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

func (*EncryptionScopeId) FromParseResult

func (id *EncryptionScopeId) FromParseResult(input resourceids.ParseResult) error

func (EncryptionScopeId) ID

func (id EncryptionScopeId) ID() string

ID returns the formatted Encryption Scope ID

func (EncryptionScopeId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Encryption Scope ID

func (EncryptionScopeId) String

func (id EncryptionScopeId) String() string

String returns a human-readable description of this Encryption Scope ID

type EncryptionScopeOperationPredicate

type EncryptionScopeOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (EncryptionScopeOperationPredicate) Matches

type EncryptionScopeProperties

type EncryptionScopeProperties struct {
	KeySource          *KeySource                        `json:"keySource,omitempty"`
	KeyVaultProperties *KeyVaultProperties               `json:"keyVaultProperties,omitempty"`
	ProvisioningState  *EncryptionScopeProvisioningState `json:"provisioningState,omitempty"`
	State              *EncryptionScopeState             `json:"state,omitempty"`
}

type EncryptionScopeProvisioningState

type EncryptionScopeProvisioningState string
const (
	EncryptionScopeProvisioningStateAccepted  EncryptionScopeProvisioningState = "Accepted"
	EncryptionScopeProvisioningStateCanceled  EncryptionScopeProvisioningState = "Canceled"
	EncryptionScopeProvisioningStateCreating  EncryptionScopeProvisioningState = "Creating"
	EncryptionScopeProvisioningStateDeleting  EncryptionScopeProvisioningState = "Deleting"
	EncryptionScopeProvisioningStateFailed    EncryptionScopeProvisioningState = "Failed"
	EncryptionScopeProvisioningStateMoving    EncryptionScopeProvisioningState = "Moving"
	EncryptionScopeProvisioningStateSucceeded EncryptionScopeProvisioningState = "Succeeded"
)

func (*EncryptionScopeProvisioningState) UnmarshalJSON

func (s *EncryptionScopeProvisioningState) UnmarshalJSON(bytes []byte) error

type EncryptionScopeState

type EncryptionScopeState string
const (
	EncryptionScopeStateDisabled EncryptionScopeState = "Disabled"
	EncryptionScopeStateEnabled  EncryptionScopeState = "Enabled"
)

func (*EncryptionScopeState) UnmarshalJSON

func (s *EncryptionScopeState) UnmarshalJSON(bytes []byte) error

type EncryptionScopesClient

type EncryptionScopesClient struct {
	Client *resourcemanager.Client
}

func NewEncryptionScopesClientWithBaseURI

func NewEncryptionScopesClientWithBaseURI(sdkApi sdkEnv.Api) (*EncryptionScopesClient, error)

func (EncryptionScopesClient) CreateOrUpdate

CreateOrUpdate ...

func (EncryptionScopesClient) Delete

Delete ...

func (EncryptionScopesClient) DeleteThenPoll

func (c EncryptionScopesClient) DeleteThenPoll(ctx context.Context, id EncryptionScopeId) error

DeleteThenPoll performs Delete then polls until it's completed

func (EncryptionScopesClient) Get

Get ...

func (EncryptionScopesClient) List

List ...

func (EncryptionScopesClient) ListComplete

ListComplete retrieves all the results into a single object

func (EncryptionScopesClient) ListCompleteMatchingPredicate

func (c EncryptionScopesClient) ListCompleteMatchingPredicate(ctx context.Context, id AccountId, predicate EncryptionScopeOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EncryptionScope
}

type KeySource

type KeySource string
const (
	KeySourceMicrosoftPointCognitiveServices KeySource = "Microsoft.CognitiveServices"
	KeySourceMicrosoftPointKeyVault          KeySource = "Microsoft.KeyVault"
)

func (*KeySource) UnmarshalJSON

func (s *KeySource) UnmarshalJSON(bytes []byte) error

type KeyVaultProperties

type KeyVaultProperties struct {
	IdentityClientId *string `json:"identityClientId,omitempty"`
	KeyName          *string `json:"keyName,omitempty"`
	KeyVaultUri      *string `json:"keyVaultUri,omitempty"`
	KeyVersion       *string `json:"keyVersion,omitempty"`
}

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []EncryptionScope
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]EncryptionScope
}

Jump to

Keyboard shortcuts

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