keyvault

package
v60.1.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Dec 10, 2021 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package keyvault implements the Azure ARM Keyvault service API version 2018-02-14.

The Azure management API provides a RESTful set of web services that interact with Azure Key Vault.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Keyvault
	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 AccessPolicyEntry 

type AccessPolicyEntry struct {
	// TenantID - The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
	TenantID *uuid.UUID `json:"tenantId,omitempty"`
	// ObjectID - The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies.
	ObjectID *string `json:"objectId,omitempty"`
	// ApplicationID -  Application ID of the client making request on behalf of a principal
	ApplicationID *uuid.UUID `json:"applicationId,omitempty"`
	// Permissions - Permissions the identity has for keys, secrets and certificates.
	Permissions *Permissions `json:"permissions,omitempty"`
}

AccessPolicyEntry an identity that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.

type AccessPolicyUpdateKind 

type AccessPolicyUpdateKind string

AccessPolicyUpdateKind enumerates the values for access policy update kind. 

const (
	// Add ...
	Add AccessPolicyUpdateKind = "add"
	// Remove ...
	Remove AccessPolicyUpdateKind = "remove"
	// Replace ...
	Replace AccessPolicyUpdateKind = "replace"
)

func PossibleAccessPolicyUpdateKindValues 

func PossibleAccessPolicyUpdateKindValues() []AccessPolicyUpdateKind

PossibleAccessPolicyUpdateKindValues returns an array of possible values for the AccessPolicyUpdateKind const type.

type BaseClient 

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

BaseClient is the base client for Keyvault.

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 CertificatePermissions 

type CertificatePermissions string

CertificatePermissions enumerates the values for certificate permissions. 

const (
	// Backup ...
	Backup CertificatePermissions = "backup"
	// Create ...
	Create CertificatePermissions = "create"
	// Delete ...
	Delete CertificatePermissions = "delete"
	// Deleteissuers ...
	Deleteissuers CertificatePermissions = "deleteissuers"
	// Get ...
	Get CertificatePermissions = "get"
	// Getissuers ...
	Getissuers CertificatePermissions = "getissuers"
	// Import ...
	Import CertificatePermissions = "import"
	// List ...
	List CertificatePermissions = "list"
	// Listissuers ...
	Listissuers CertificatePermissions = "listissuers"
	// Managecontacts ...
	Managecontacts CertificatePermissions = "managecontacts"
	// Manageissuers ...
	Manageissuers CertificatePermissions = "manageissuers"
	// Purge ...
	Purge CertificatePermissions = "purge"
	// Recover ...
	Recover CertificatePermissions = "recover"
	// Restore ...
	Restore CertificatePermissions = "restore"
	// Setissuers ...
	Setissuers CertificatePermissions = "setissuers"
	// Update ...
	Update CertificatePermissions = "update"
)

func PossibleCertificatePermissionsValues 

func PossibleCertificatePermissionsValues() []CertificatePermissions

PossibleCertificatePermissionsValues returns an array of possible values for the CertificatePermissions const type.

type CheckNameAvailabilityResult 

type CheckNameAvailabilityResult struct {
	autorest.Response `json:"-"`
	// NameAvailable - READ-ONLY; A boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used.
	NameAvailable *bool `json:"nameAvailable,omitempty"`
	// Reason - READ-ONLY; The reason that a vault name could not be used. The Reason element is only returned if NameAvailable is false. Possible values include: 'AccountNameInvalid', 'AlreadyExists'
	Reason Reason `json:"reason,omitempty"`
	// Message - READ-ONLY; An error message explaining the Reason value in more detail.
	Message *string `json:"message,omitempty"`
}

CheckNameAvailabilityResult the CheckNameAvailability operation response.

func (CheckNameAvailabilityResult) MarshalJSON 

func (cnar CheckNameAvailabilityResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CheckNameAvailabilityResult.

type CloudError 

type CloudError struct {
	Error *CloudErrorBody `json:"error,omitempty"`
}

CloudError an error response from Key Vault resource provider

type CloudErrorBody 

type CloudErrorBody struct {
	// Code - Error code. This is a mnemonic that can be consumed programmatically.
	Code *string `json:"code,omitempty"`
	// Message - User friendly error message. The message is typically localized and may vary with service version.
	Message *string `json:"message,omitempty"`
}

CloudErrorBody an error response from Key Vault resource provider

type CreateMode 

type CreateMode string

CreateMode enumerates the values for create mode. 

const (
	// CreateModeDefault ...
	CreateModeDefault CreateMode = "default"
	// CreateModeRecover ...
	CreateModeRecover CreateMode = "recover"
)

func PossibleCreateModeValues 

func PossibleCreateModeValues() []CreateMode

PossibleCreateModeValues returns an array of possible values for the CreateMode const type.

type DeletedVault 

type DeletedVault struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The resource ID for the deleted key vault.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the key vault.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The resource type of the key vault.
	Type *string `json:"type,omitempty"`
	// Properties - Properties of the vault
	Properties *DeletedVaultProperties `json:"properties,omitempty"`
}

DeletedVault deleted vault information with extended details.

func (DeletedVault) MarshalJSON 

func (dv DeletedVault) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeletedVault.

type DeletedVaultListResult 

type DeletedVaultListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of deleted vaults.
	Value *[]DeletedVault `json:"value,omitempty"`
	// NextLink - The URL to get the next set of deleted vaults.
	NextLink *string `json:"nextLink,omitempty"`
}

DeletedVaultListResult list of vaults

func (DeletedVaultListResult) IsEmpty 

func (dvlr DeletedVaultListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type DeletedVaultListResultIterator 

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

DeletedVaultListResultIterator provides access to a complete listing of DeletedVault values.

func NewDeletedVaultListResultIterator 

func NewDeletedVaultListResultIterator(page DeletedVaultListResultPage) DeletedVaultListResultIterator

Creates a new instance of the DeletedVaultListResultIterator type.

func (*DeletedVaultListResultIterator) Next 

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

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

func (iter DeletedVaultListResultIterator) NotDone() bool

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

func (DeletedVaultListResultIterator) Response 

func (iter DeletedVaultListResultIterator) Response() DeletedVaultListResult

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

func (DeletedVaultListResultIterator) Value 

func (iter DeletedVaultListResultIterator) Value() DeletedVault

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

type DeletedVaultListResultPage 

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

DeletedVaultListResultPage contains a page of DeletedVault values.

func NewDeletedVaultListResultPage 

func NewDeletedVaultListResultPage(cur DeletedVaultListResult, getNextPage func(context.Context, DeletedVaultListResult) (DeletedVaultListResult, error)) DeletedVaultListResultPage

Creates a new instance of the DeletedVaultListResultPage type.

func (*DeletedVaultListResultPage) Next 

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

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

func (page DeletedVaultListResultPage) NotDone() bool

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

func (DeletedVaultListResultPage) Response 

func (page DeletedVaultListResultPage) Response() DeletedVaultListResult

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

func (DeletedVaultListResultPage) Values 

func (page DeletedVaultListResultPage) Values() []DeletedVault

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

type DeletedVaultProperties 

type DeletedVaultProperties struct {
	// VaultID - READ-ONLY; The resource id of the original vault.
	VaultID *string `json:"vaultId,omitempty"`
	// Location - READ-ONLY; The location of the original vault.
	Location *string `json:"location,omitempty"`
	// DeletionDate - READ-ONLY; The deleted date.
	DeletionDate *date.Time `json:"deletionDate,omitempty"`
	// ScheduledPurgeDate - READ-ONLY; The scheduled purged date.
	ScheduledPurgeDate *date.Time `json:"scheduledPurgeDate,omitempty"`
	// Tags - READ-ONLY; Tags of the original vault.
	Tags map[string]*string `json:"tags"`
}

DeletedVaultProperties properties of the deleted vault.

func (DeletedVaultProperties) MarshalJSON 

func (dvp DeletedVaultProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeletedVaultProperties.

type IPRule 

type IPRule struct {
	// Value - An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78).
	Value *string `json:"value,omitempty"`
}

IPRule a rule governing the accessibility of a vault from a specific ip address or ip range.

type KeyPermissions 

type KeyPermissions string

KeyPermissions enumerates the values for key permissions. 

const (
	// KeyPermissionsBackup ...
	KeyPermissionsBackup KeyPermissions = "backup"
	// KeyPermissionsCreate ...
	KeyPermissionsCreate KeyPermissions = "create"
	// KeyPermissionsDecrypt ...
	KeyPermissionsDecrypt KeyPermissions = "decrypt"
	// KeyPermissionsDelete ...
	KeyPermissionsDelete KeyPermissions = "delete"
	// KeyPermissionsEncrypt ...
	KeyPermissionsEncrypt KeyPermissions = "encrypt"
	// KeyPermissionsGet ...
	KeyPermissionsGet KeyPermissions = "get"
	// KeyPermissionsImport ...
	KeyPermissionsImport KeyPermissions = "import"
	// KeyPermissionsList ...
	KeyPermissionsList KeyPermissions = "list"
	// KeyPermissionsPurge ...
	KeyPermissionsPurge KeyPermissions = "purge"
	// KeyPermissionsRecover ...
	KeyPermissionsRecover KeyPermissions = "recover"
	// KeyPermissionsRestore ...
	KeyPermissionsRestore KeyPermissions = "restore"
	// KeyPermissionsSign ...
	KeyPermissionsSign KeyPermissions = "sign"
	// KeyPermissionsUnwrapKey ...
	KeyPermissionsUnwrapKey KeyPermissions = "unwrapKey"
	// KeyPermissionsUpdate ...
	KeyPermissionsUpdate KeyPermissions = "update"
	// KeyPermissionsVerify ...
	KeyPermissionsVerify KeyPermissions = "verify"
	// KeyPermissionsWrapKey ...
	KeyPermissionsWrapKey KeyPermissions = "wrapKey"
)

func PossibleKeyPermissionsValues 

func PossibleKeyPermissionsValues() []KeyPermissions

PossibleKeyPermissionsValues returns an array of possible values for the KeyPermissions const type.

type LogSpecification 

type LogSpecification struct {
	// Name - Name of log specification.
	Name *string `json:"name,omitempty"`
	// DisplayName - Display name of log specification.
	DisplayName *string `json:"displayName,omitempty"`
	// BlobDuration - Blob duration of specification.
	BlobDuration *string `json:"blobDuration,omitempty"`
}

LogSpecification log specification of operation.

type NetworkRuleAction 

type NetworkRuleAction string

NetworkRuleAction enumerates the values for network rule action. 

const (
	// Allow ...
	Allow NetworkRuleAction = "Allow"
	// Deny ...
	Deny NetworkRuleAction = "Deny"
)

func PossibleNetworkRuleActionValues 

func PossibleNetworkRuleActionValues() []NetworkRuleAction

PossibleNetworkRuleActionValues returns an array of possible values for the NetworkRuleAction const type.

type NetworkRuleBypassOptions 

type NetworkRuleBypassOptions string

NetworkRuleBypassOptions enumerates the values for network rule bypass options. 

const (
	// AzureServices ...
	AzureServices NetworkRuleBypassOptions = "AzureServices"
	// None ...
	None NetworkRuleBypassOptions = "None"
)

func PossibleNetworkRuleBypassOptionsValues 

func PossibleNetworkRuleBypassOptionsValues() []NetworkRuleBypassOptions

PossibleNetworkRuleBypassOptionsValues returns an array of possible values for the NetworkRuleBypassOptions const type.

type NetworkRuleSet 

type NetworkRuleSet struct {
	// Bypass - Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'.  If not specified the default is 'AzureServices'. Possible values include: 'AzureServices', 'None'
	Bypass NetworkRuleBypassOptions `json:"bypass,omitempty"`
	// DefaultAction - The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. Possible values include: 'Allow', 'Deny'
	DefaultAction NetworkRuleAction `json:"defaultAction,omitempty"`
	// IPRules - The list of IP address rules.
	IPRules *[]IPRule `json:"ipRules,omitempty"`
	// VirtualNetworkRules - The list of virtual network rules.
	VirtualNetworkRules *[]VirtualNetworkRule `json:"virtualNetworkRules,omitempty"`
}

NetworkRuleSet a set of rules governing the network accessibility of a vault.

type Operation 

type Operation struct {
	// Name - Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`
	// Display - Display metadata associated with the operation.
	Display *OperationDisplay `json:"display,omitempty"`
	// Origin - The origin of operations.
	Origin *string `json:"origin,omitempty"`
	// OperationProperties - Properties of operation, include metric specifications.
	*OperationProperties `json:"properties,omitempty"`
}

Operation key Vault REST API operation definition.

func (Operation) MarshalJSON 

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Operation.

func (*Operation) UnmarshalJSON 

func (o *Operation) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Operation struct.

type OperationDisplay 

type OperationDisplay struct {
	// Provider - Service provider: Microsoft Key Vault.
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource on which the operation is performed etc.
	Resource *string `json:"resource,omitempty"`
	// Operation - Type of operation: get, read, delete, etc.
	Operation *string `json:"operation,omitempty"`
	// Description - Description of operation.
	Description *string `json:"description,omitempty"`
}

OperationDisplay display metadata associated with the operation.

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - List of Storage operations supported by the Storage resource provider.
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - The URL to get the next set of operations.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationListResult result of the request to list Storage operations. It contains a list of operations and a URL link to get the next set of results.

func (OperationListResult) IsEmpty 

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator 

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator 

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next 

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

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

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response 

func (iter OperationListResultIterator) Response() OperationListResult

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

func (OperationListResultIterator) Value 

func (iter OperationListResultIterator) Value() Operation

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

type OperationListResultPage 

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage 

func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next 

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

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

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response 

func (page OperationListResultPage) Response() OperationListResult

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

func (OperationListResultPage) Values 

func (page OperationListResultPage) Values() []Operation

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

type OperationProperties 

type OperationProperties struct {
	// ServiceSpecification - One property of operation, include metric specifications.
	ServiceSpecification *ServiceSpecification `json:"serviceSpecification,omitempty"`
}

OperationProperties properties of operation, include metric specifications.

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the the Azure management API provides a RESTful set of web services that interact with Azure Key Vault.

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 OperationListResultPage, err error)

List lists all of the available Key Vault Rest API operations.

func (OperationsClient) ListComplete 

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)

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

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 OperationListResult, 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 Permissions 

type Permissions struct {
	// Keys - Permissions to keys
	Keys *[]KeyPermissions `json:"keys,omitempty"`
	// Secrets - Permissions to secrets
	Secrets *[]SecretPermissions `json:"secrets,omitempty"`
	// Certificates - Permissions to certificates
	Certificates *[]CertificatePermissions `json:"certificates,omitempty"`
	// Storage - Permissions to storage accounts
	Storage *[]StoragePermissions `json:"storage,omitempty"`
}

Permissions permissions the identity has for keys, secrets, certificates and storage.

type PrivateEndpoint 

type PrivateEndpoint struct {
	// ID - READ-ONLY; Full identifier of the private endpoint resource.
	ID *string `json:"id,omitempty"`
}

PrivateEndpoint private endpoint object properties.

func (PrivateEndpoint) MarshalJSON 

func (peVar PrivateEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateEndpoint.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	autorest.Response `json:"-"`
	// PrivateEndpointConnectionProperties - Resource properties.
	*PrivateEndpointConnectionProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Fully qualified identifier of the key vault resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Name of the key vault resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type of the key vault resource.
	Type *string `json:"type,omitempty"`
	// Location - READ-ONLY; Azure location of the key vault resource.
	Location *string `json:"location,omitempty"`
	// Tags - READ-ONLY; Tags assigned to the key vault resource.
	Tags map[string]*string `json:"tags"`
}

PrivateEndpointConnection private endpoint connection resource.

func (PrivateEndpointConnection) MarshalJSON 

func (pec PrivateEndpointConnection) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateEndpointConnection.

func (*PrivateEndpointConnection) UnmarshalJSON 

func (pec *PrivateEndpointConnection) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PrivateEndpointConnection struct.

type PrivateEndpointConnectionItem 

type PrivateEndpointConnectionItem struct {
	// PrivateEndpointConnectionProperties - Private endpoint connection properties.
	*PrivateEndpointConnectionProperties `json:"properties,omitempty"`
}

PrivateEndpointConnectionItem private endpoint connection item.

func (PrivateEndpointConnectionItem) MarshalJSON 

func (peci PrivateEndpointConnectionItem) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateEndpointConnectionItem.

func (*PrivateEndpointConnectionItem) UnmarshalJSON 

func (peci *PrivateEndpointConnectionItem) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PrivateEndpointConnectionItem struct.

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// PrivateEndpoint - Properties of the private endpoint object.
	PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`
	// PrivateLinkServiceConnectionState - Approval state of the private link connection.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`
	// ProvisioningState - Provisioning state of the private endpoint connection. Possible values include: 'Succeeded', 'Creating', 'Updating', 'Deleting', 'Failed', 'Disconnected'
	ProvisioningState PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}

PrivateEndpointConnectionProperties properties of the private endpoint connection resource.

type PrivateEndpointConnectionProvisioningState 

type PrivateEndpointConnectionProvisioningState string

PrivateEndpointConnectionProvisioningState enumerates the values for private endpoint connection provisioning state. 

const (
	// Creating ...
	Creating PrivateEndpointConnectionProvisioningState = "Creating"
	// Deleting ...
	Deleting PrivateEndpointConnectionProvisioningState = "Deleting"
	// Disconnected ...
	Disconnected PrivateEndpointConnectionProvisioningState = "Disconnected"
	// Failed ...
	Failed PrivateEndpointConnectionProvisioningState = "Failed"
	// Succeeded ...
	Succeeded PrivateEndpointConnectionProvisioningState = "Succeeded"
	// Updating ...
	Updating PrivateEndpointConnectionProvisioningState = "Updating"
)

func PossiblePrivateEndpointConnectionProvisioningStateValues 

func PossiblePrivateEndpointConnectionProvisioningStateValues() []PrivateEndpointConnectionProvisioningState

PossiblePrivateEndpointConnectionProvisioningStateValues returns an array of possible values for the PrivateEndpointConnectionProvisioningState const type.

type PrivateEndpointConnectionsClient 

type PrivateEndpointConnectionsClient struct {
	BaseClient
}

PrivateEndpointConnectionsClient is the the Azure management API provides a RESTful set of web services that interact with Azure Key Vault.

func NewPrivateEndpointConnectionsClient 

func NewPrivateEndpointConnectionsClient(subscriptionID string) PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates an instance of the PrivateEndpointConnectionsClient client.

func NewPrivateEndpointConnectionsClientWithBaseURI 

func NewPrivateEndpointConnectionsClientWithBaseURI(baseURI string, subscriptionID string) PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClientWithBaseURI creates an instance of the PrivateEndpointConnectionsClient 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 (PrivateEndpointConnectionsClient) Delete 

func (client PrivateEndpointConnectionsClient) Delete(ctx context.Context, resourceGroupName string, vaultName string, privateEndpointConnectionName string) (result PrivateEndpointConnectionsDeleteFuture, err error)

Delete deletes the specified private endpoint connection associated with the key vault. Parameters: resourceGroupName - name of the resource group that contains the key vault. vaultName - the name of the key vault. privateEndpointConnectionName - name of the private endpoint connection associated with the key vault.

func (PrivateEndpointConnectionsClient) DeletePreparer 

func (client PrivateEndpointConnectionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, vaultName string, privateEndpointConnectionName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (PrivateEndpointConnectionsClient) DeleteResponder 

func (client PrivateEndpointConnectionsClient) DeleteResponder(resp *http.Response) (result PrivateEndpointConnection, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (PrivateEndpointConnectionsClient) DeleteSender 

func (client PrivateEndpointConnectionsClient) DeleteSender(req *http.Request) (future PrivateEndpointConnectionsDeleteFuture, err error)

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

func (PrivateEndpointConnectionsClient) Get 

func (client PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, vaultName string, privateEndpointConnectionName string) (result PrivateEndpointConnection, err error)

Get gets the specified private endpoint connection associated with the key vault. Parameters: resourceGroupName - name of the resource group that contains the key vault. vaultName - the name of the key vault. privateEndpointConnectionName - name of the private endpoint connection associated with the key vault.

func (PrivateEndpointConnectionsClient) GetPreparer 

func (client PrivateEndpointConnectionsClient) GetPreparer(ctx context.Context, resourceGroupName string, vaultName string, privateEndpointConnectionName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (PrivateEndpointConnectionsClient) GetResponder 

func (client PrivateEndpointConnectionsClient) GetResponder(resp *http.Response) (result PrivateEndpointConnection, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (PrivateEndpointConnectionsClient) GetSender 

func (client PrivateEndpointConnectionsClient) 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 (PrivateEndpointConnectionsClient) Put 

func (client PrivateEndpointConnectionsClient) Put(ctx context.Context, resourceGroupName string, vaultName string, privateEndpointConnectionName string, properties PrivateEndpointConnection) (result PrivateEndpointConnection, err error)

Put updates the specified private endpoint connection associated with the key vault. Parameters: resourceGroupName - name of the resource group that contains the key vault. vaultName - the name of the key vault. privateEndpointConnectionName - name of the private endpoint connection associated with the key vault. properties - the intended state of private endpoint connection.

func (PrivateEndpointConnectionsClient) PutPreparer 

func (client PrivateEndpointConnectionsClient) PutPreparer(ctx context.Context, resourceGroupName string, vaultName string, privateEndpointConnectionName string, properties PrivateEndpointConnection) (*http.Request, error)

PutPreparer prepares the Put request.

func (PrivateEndpointConnectionsClient) PutResponder 

func (client PrivateEndpointConnectionsClient) PutResponder(resp *http.Response) (result PrivateEndpointConnection, err error)

PutResponder handles the response to the Put request. The method always closes the http.Response Body.

func (PrivateEndpointConnectionsClient) PutSender 

func (client PrivateEndpointConnectionsClient) PutSender(req *http.Request) (*http.Response, error)

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

type PrivateEndpointConnectionsDeleteFuture 

type PrivateEndpointConnectionsDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(PrivateEndpointConnectionsClient) (PrivateEndpointConnection, error)
}

PrivateEndpointConnectionsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*PrivateEndpointConnectionsDeleteFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type PrivateEndpointServiceConnectionStatus 

type PrivateEndpointServiceConnectionStatus string

PrivateEndpointServiceConnectionStatus enumerates the values for private endpoint service connection status. 

const (
	// PrivateEndpointServiceConnectionStatusApproved ...
	PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
	// PrivateEndpointServiceConnectionStatusDisconnected ...
	PrivateEndpointServiceConnectionStatusDisconnected PrivateEndpointServiceConnectionStatus = "Disconnected"
	// PrivateEndpointServiceConnectionStatusPending ...
	PrivateEndpointServiceConnectionStatusPending PrivateEndpointServiceConnectionStatus = "Pending"
	// PrivateEndpointServiceConnectionStatusRejected ...
	PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)

func PossiblePrivateEndpointServiceConnectionStatusValues 

func PossiblePrivateEndpointServiceConnectionStatusValues() []PrivateEndpointServiceConnectionStatus

PossiblePrivateEndpointServiceConnectionStatusValues returns an array of possible values for the PrivateEndpointServiceConnectionStatus const type.

type PrivateLinkResource 

type PrivateLinkResource struct {
	// PrivateLinkResourceProperties - Resource properties.
	*PrivateLinkResourceProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Fully qualified identifier of the key vault resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Name of the key vault resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type of the key vault resource.
	Type *string `json:"type,omitempty"`
	// Location - READ-ONLY; Azure location of the key vault resource.
	Location *string `json:"location,omitempty"`
	// Tags - READ-ONLY; Tags assigned to the key vault resource.
	Tags map[string]*string `json:"tags"`
}

PrivateLinkResource a private link resource

func (PrivateLinkResource) MarshalJSON 

func (plr PrivateLinkResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateLinkResource.

func (*PrivateLinkResource) UnmarshalJSON 

func (plr *PrivateLinkResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PrivateLinkResource struct.

type PrivateLinkResourceListResult 

type PrivateLinkResourceListResult struct {
	autorest.Response `json:"-"`
	// Value - Array of private link resources
	Value *[]PrivateLinkResource `json:"value,omitempty"`
}

PrivateLinkResourceListResult a list of private link resources

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	// GroupID - READ-ONLY; Group identifier of private link resource.
	GroupID *string `json:"groupId,omitempty"`
	// RequiredMembers - READ-ONLY; Required member names of private link resource.
	RequiredMembers *[]string `json:"requiredMembers,omitempty"`
	// RequiredZoneNames - Required DNS zone names of the the private link resource.
	RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}

PrivateLinkResourceProperties properties of a private link resource.

func (PrivateLinkResourceProperties) MarshalJSON 

func (plrp PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateLinkResourceProperties.

type PrivateLinkResourcesClient 

type PrivateLinkResourcesClient struct {
	BaseClient
}

PrivateLinkResourcesClient is the the Azure management API provides a RESTful set of web services that interact with Azure Key Vault.

func NewPrivateLinkResourcesClient 

func NewPrivateLinkResourcesClient(subscriptionID string) PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates an instance of the PrivateLinkResourcesClient client.

func NewPrivateLinkResourcesClientWithBaseURI 

func NewPrivateLinkResourcesClientWithBaseURI(baseURI string, subscriptionID string) PrivateLinkResourcesClient

NewPrivateLinkResourcesClientWithBaseURI creates an instance of the PrivateLinkResourcesClient 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 (PrivateLinkResourcesClient) ListByVault 

func (client PrivateLinkResourcesClient) ListByVault(ctx context.Context, resourceGroupName string, vaultName string) (result PrivateLinkResourceListResult, err error)

ListByVault gets the private link resources supported for the key vault. Parameters: resourceGroupName - name of the resource group that contains the key vault. vaultName - the name of the key vault.

func (PrivateLinkResourcesClient) ListByVaultPreparer 

func (client PrivateLinkResourcesClient) ListByVaultPreparer(ctx context.Context, resourceGroupName string, vaultName string) (*http.Request, error)

ListByVaultPreparer prepares the ListByVault request.

func (PrivateLinkResourcesClient) ListByVaultResponder 

func (client PrivateLinkResourcesClient) ListByVaultResponder(resp *http.Response) (result PrivateLinkResourceListResult, err error)

ListByVaultResponder handles the response to the ListByVault request. The method always closes the http.Response Body.

func (PrivateLinkResourcesClient) ListByVaultSender 

func (client PrivateLinkResourcesClient) ListByVaultSender(req *http.Request) (*http.Response, error)

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

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	// Status - Indicates whether the connection has been approved, rejected or removed by the key vault owner. Possible values include: 'PrivateEndpointServiceConnectionStatusPending', 'PrivateEndpointServiceConnectionStatusApproved', 'PrivateEndpointServiceConnectionStatusRejected', 'PrivateEndpointServiceConnectionStatusDisconnected'
	Status PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
	// Description - The reason for approval or rejection.
	Description *string `json:"description,omitempty"`
	// ActionRequired - A message indicating if changes on the service provider require any updates on the consumer.
	ActionRequired *string `json:"actionRequired,omitempty"`
}

PrivateLinkServiceConnectionState an object that represents the approval state of the private link connection.

type Reason 

type Reason string

Reason enumerates the values for reason. 

const (
	// AccountNameInvalid ...
	AccountNameInvalid Reason = "AccountNameInvalid"
	// AlreadyExists ...
	AlreadyExists Reason = "AlreadyExists"
)

func PossibleReasonValues 

func PossibleReasonValues() []Reason

PossibleReasonValues returns an array of possible values for the Reason const type.

type Resource 

type Resource struct {
	// ID - READ-ONLY; Fully qualified identifier of the key vault resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Name of the key vault resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type of the key vault resource.
	Type *string `json:"type,omitempty"`
	// Location - READ-ONLY; Azure location of the key vault resource.
	Location *string `json:"location,omitempty"`
	// Tags - READ-ONLY; Tags assigned to the key vault resource.
	Tags map[string]*string `json:"tags"`
}

Resource key Vault resource

func (Resource) MarshalJSON 

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

MarshalJSON is the custom marshaler for Resource.

type ResourceListResult 

type ResourceListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of vault resources.
	Value *[]Resource `json:"value,omitempty"`
	// NextLink - The URL to get the next set of vault resources.
	NextLink *string `json:"nextLink,omitempty"`
}

ResourceListResult list of vault resources.

func (ResourceListResult) IsEmpty 

func (rlr ResourceListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ResourceListResultIterator 

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

ResourceListResultIterator provides access to a complete listing of Resource values.

func NewResourceListResultIterator 

func NewResourceListResultIterator(page ResourceListResultPage) ResourceListResultIterator

Creates a new instance of the ResourceListResultIterator type.

func (*ResourceListResultIterator) Next 

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

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

func (iter ResourceListResultIterator) NotDone() bool

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

func (ResourceListResultIterator) Response 

func (iter ResourceListResultIterator) Response() ResourceListResult

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

func (ResourceListResultIterator) Value 

func (iter ResourceListResultIterator) Value() Resource

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

type ResourceListResultPage 

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

ResourceListResultPage contains a page of Resource values.

func NewResourceListResultPage 

func NewResourceListResultPage(cur ResourceListResult, getNextPage func(context.Context, ResourceListResult) (ResourceListResult, error)) ResourceListResultPage

Creates a new instance of the ResourceListResultPage type.

func (*ResourceListResultPage) Next 

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

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

func (page ResourceListResultPage) NotDone() bool

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

func (ResourceListResultPage) Response 

func (page ResourceListResultPage) Response() ResourceListResult

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

func (ResourceListResultPage) Values 

func (page ResourceListResultPage) Values() []Resource

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

type SecretPermissions 

type SecretPermissions string

SecretPermissions enumerates the values for secret permissions. 

const (
	// SecretPermissionsBackup ...
	SecretPermissionsBackup SecretPermissions = "backup"
	// SecretPermissionsDelete ...
	SecretPermissionsDelete SecretPermissions = "delete"
	// SecretPermissionsGet ...
	SecretPermissionsGet SecretPermissions = "get"
	// SecretPermissionsList ...
	SecretPermissionsList SecretPermissions = "list"
	// SecretPermissionsPurge ...
	SecretPermissionsPurge SecretPermissions = "purge"
	// SecretPermissionsRecover ...
	SecretPermissionsRecover SecretPermissions = "recover"
	// SecretPermissionsRestore ...
	SecretPermissionsRestore SecretPermissions = "restore"
	// SecretPermissionsSet ...
	SecretPermissionsSet SecretPermissions = "set"
)

func PossibleSecretPermissionsValues 

func PossibleSecretPermissionsValues() []SecretPermissions

PossibleSecretPermissionsValues returns an array of possible values for the SecretPermissions const type.

type ServiceSpecification 

type ServiceSpecification struct {
	// LogSpecifications - Log specifications of operation.
	LogSpecifications *[]LogSpecification `json:"logSpecifications,omitempty"`
}

ServiceSpecification one property of operation, include log specifications.

type Sku 

type Sku struct {
	// Family - SKU family name
	Family *string `json:"family,omitempty"`
	// Name - SKU name to specify whether the key vault is a standard vault or a premium vault. Possible values include: 'Standard', 'Premium'
	Name SkuName `json:"name,omitempty"`
}

Sku SKU details

type SkuName 

type SkuName string

SkuName enumerates the values for sku name. 

const (
	// Premium ...
	Premium SkuName = "premium"
	// Standard ...
	Standard SkuName = "standard"
)

func PossibleSkuNameValues 

func PossibleSkuNameValues() []SkuName

PossibleSkuNameValues returns an array of possible values for the SkuName const type.

type StoragePermissions 

type StoragePermissions string

StoragePermissions enumerates the values for storage permissions. 

const (
	// StoragePermissionsBackup ...
	StoragePermissionsBackup StoragePermissions = "backup"
	// StoragePermissionsDelete ...
	StoragePermissionsDelete StoragePermissions = "delete"
	// StoragePermissionsDeletesas ...
	StoragePermissionsDeletesas StoragePermissions = "deletesas"
	// StoragePermissionsGet ...
	StoragePermissionsGet StoragePermissions = "get"
	// StoragePermissionsGetsas ...
	StoragePermissionsGetsas StoragePermissions = "getsas"
	// StoragePermissionsList ...
	StoragePermissionsList StoragePermissions = "list"
	// StoragePermissionsListsas ...
	StoragePermissionsListsas StoragePermissions = "listsas"
	// StoragePermissionsPurge ...
	StoragePermissionsPurge StoragePermissions = "purge"
	// StoragePermissionsRecover ...
	StoragePermissionsRecover StoragePermissions = "recover"
	// StoragePermissionsRegeneratekey ...
	StoragePermissionsRegeneratekey StoragePermissions = "regeneratekey"
	// StoragePermissionsRestore ...
	StoragePermissionsRestore StoragePermissions = "restore"
	// StoragePermissionsSet ...
	StoragePermissionsSet StoragePermissions = "set"
	// StoragePermissionsSetsas ...
	StoragePermissionsSetsas StoragePermissions = "setsas"
	// StoragePermissionsUpdate ...
	StoragePermissionsUpdate StoragePermissions = "update"
)

func PossibleStoragePermissionsValues 

func PossibleStoragePermissionsValues() []StoragePermissions

PossibleStoragePermissionsValues returns an array of possible values for the StoragePermissions const type.

type Vault 

type Vault struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Fully qualified identifier of the key vault resource.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Name of the key vault resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type of the key vault resource.
	Type *string `json:"type,omitempty"`
	// Location - Azure location of the key vault resource.
	Location *string `json:"location,omitempty"`
	// Tags - Tags assigned to the key vault resource.
	Tags map[string]*string `json:"tags"`
	// Properties - Properties of the vault
	Properties *VaultProperties `json:"properties,omitempty"`
}

Vault resource information with extended details.

func (Vault) MarshalJSON 

func (vVar Vault) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Vault.

type VaultAccessPolicyParameters 

type VaultAccessPolicyParameters struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The resource id of the access policy.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The resource name of the access policy.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The resource name of the access policy.
	Type *string `json:"type,omitempty"`
	// Location - READ-ONLY; The resource type of the access policy.
	Location *string `json:"location,omitempty"`
	// Properties - Properties of the access policy
	Properties *VaultAccessPolicyProperties `json:"properties,omitempty"`
}

VaultAccessPolicyParameters parameters for updating the access policy in a vault

func (VaultAccessPolicyParameters) MarshalJSON 

func (vapp VaultAccessPolicyParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for VaultAccessPolicyParameters.

type VaultAccessPolicyProperties 

type VaultAccessPolicyProperties struct {
	// AccessPolicies - An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.
	AccessPolicies *[]AccessPolicyEntry `json:"accessPolicies,omitempty"`
}

VaultAccessPolicyProperties properties of the vault access policy

type VaultCheckNameAvailabilityParameters 

type VaultCheckNameAvailabilityParameters struct {
	// Name - The vault name.
	Name *string `json:"name,omitempty"`
	// Type - The type of resource, Microsoft.KeyVault/vaults
	Type *string `json:"type,omitempty"`
}

VaultCheckNameAvailabilityParameters the parameters used to check the availability of the vault name.

type VaultCreateOrUpdateParameters 

type VaultCreateOrUpdateParameters struct {
	// Location - The supported Azure location where the key vault should be created.
	Location *string `json:"location,omitempty"`
	// Tags - The tags that will be assigned to the key vault.
	Tags map[string]*string `json:"tags"`
	// Properties - Properties of the vault
	Properties *VaultProperties `json:"properties,omitempty"`
}

VaultCreateOrUpdateParameters parameters for creating or updating a vault

func (VaultCreateOrUpdateParameters) MarshalJSON 

func (vcoup VaultCreateOrUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for VaultCreateOrUpdateParameters.

type VaultListResult 

type VaultListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of vaults.
	Value *[]Vault `json:"value,omitempty"`
	// NextLink - The URL to get the next set of vaults.
	NextLink *string `json:"nextLink,omitempty"`
}

VaultListResult list of vaults

func (VaultListResult) IsEmpty 

func (vlr VaultListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type VaultListResultIterator 

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

VaultListResultIterator provides access to a complete listing of Vault values.

func NewVaultListResultIterator 

func NewVaultListResultIterator(page VaultListResultPage) VaultListResultIterator

Creates a new instance of the VaultListResultIterator type.

func (*VaultListResultIterator) Next 

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

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

func (iter VaultListResultIterator) NotDone() bool

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

func (VaultListResultIterator) Response 

func (iter VaultListResultIterator) Response() VaultListResult

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

func (VaultListResultIterator) Value 

func (iter VaultListResultIterator) Value() Vault

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

type VaultListResultPage 

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

VaultListResultPage contains a page of Vault values.

func NewVaultListResultPage 

func NewVaultListResultPage(cur VaultListResult, getNextPage func(context.Context, VaultListResult) (VaultListResult, error)) VaultListResultPage

Creates a new instance of the VaultListResultPage type.

func (*VaultListResultPage) Next 

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

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

func (page VaultListResultPage) NotDone() bool

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

func (VaultListResultPage) Response 

func (page VaultListResultPage) Response() VaultListResult

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

func (VaultListResultPage) Values 

func (page VaultListResultPage) Values() []Vault

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

type VaultPatchParameters 

type VaultPatchParameters struct {
	// Tags - The tags that will be assigned to the key vault.
	Tags map[string]*string `json:"tags"`
	// Properties - Properties of the vault
	Properties *VaultPatchProperties `json:"properties,omitempty"`
}

VaultPatchParameters parameters for creating or updating a vault

func (VaultPatchParameters) MarshalJSON 

func (vpp VaultPatchParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for VaultPatchParameters.

type VaultPatchProperties 

type VaultPatchProperties struct {
	// TenantID - The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
	TenantID *uuid.UUID `json:"tenantId,omitempty"`
	// Sku - SKU details
	Sku *Sku `json:"sku,omitempty"`
	// AccessPolicies - An array of 0 to 1024 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.
	AccessPolicies *[]AccessPolicyEntry `json:"accessPolicies,omitempty"`
	// EnabledForDeployment - Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
	EnabledForDeployment *bool `json:"enabledForDeployment,omitempty"`
	// EnabledForDiskEncryption - Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
	EnabledForDiskEncryption *bool `json:"enabledForDiskEncryption,omitempty"`
	// EnabledForTemplateDeployment - Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
	EnabledForTemplateDeployment *bool `json:"enabledForTemplateDeployment,omitempty"`
	// EnableSoftDelete - Property to specify whether the 'soft delete' functionality is enabled for this key vault. It does not accept false value.
	EnableSoftDelete *bool `json:"enableSoftDelete,omitempty"`
	// CreateMode - The vault's create mode to indicate whether the vault need to be recovered or not. Possible values include: 'CreateModeRecover', 'CreateModeDefault'
	CreateMode CreateMode `json:"createMode,omitempty"`
	// EnablePurgeProtection - Property specifying whether protection against purge is enabled for this vault. Setting this property to true activates protection against purge for this vault and its content - only the Key Vault service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible - that is, the property does not accept false as its value.
	EnablePurgeProtection *bool `json:"enablePurgeProtection,omitempty"`
	// NetworkAcls - A collection of rules governing the accessibility of the vault from specific network locations.
	NetworkAcls *NetworkRuleSet `json:"networkAcls,omitempty"`
}

VaultPatchProperties properties of the vault

type VaultProperties 

type VaultProperties struct {
	// TenantID - The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
	TenantID *uuid.UUID `json:"tenantId,omitempty"`
	// Sku - SKU details
	Sku *Sku `json:"sku,omitempty"`
	// AccessPolicies - An array of 0 to 1024 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. When `createMode` is set to `recover`, access policies are not required. Otherwise, access policies are required.
	AccessPolicies *[]AccessPolicyEntry `json:"accessPolicies,omitempty"`
	// VaultURI - The URI of the vault for performing operations on keys and secrets.
	VaultURI *string `json:"vaultUri,omitempty"`
	// EnabledForDeployment - Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
	EnabledForDeployment *bool `json:"enabledForDeployment,omitempty"`
	// EnabledForDiskEncryption - Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
	EnabledForDiskEncryption *bool `json:"enabledForDiskEncryption,omitempty"`
	// EnabledForTemplateDeployment - Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
	EnabledForTemplateDeployment *bool `json:"enabledForTemplateDeployment,omitempty"`
	// EnableSoftDelete - Property to specify whether the 'soft delete' functionality is enabled for this key vault. It does not accept false value.
	EnableSoftDelete *bool `json:"enableSoftDelete,omitempty"`
	// CreateMode - The vault's create mode to indicate whether the vault need to be recovered or not. Possible values include: 'CreateModeRecover', 'CreateModeDefault'
	CreateMode CreateMode `json:"createMode,omitempty"`
	// EnablePurgeProtection - Property specifying whether protection against purge is enabled for this vault. Setting this property to true activates protection against purge for this vault and its content - only the Key Vault service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible - that is, the property does not accept false as its value.
	EnablePurgeProtection *bool `json:"enablePurgeProtection,omitempty"`
	// NetworkAcls - Rules governing the accessibility of the key vault from specific network locations.
	NetworkAcls *NetworkRuleSet `json:"networkAcls,omitempty"`
	// PrivateEndpointConnections - READ-ONLY; List of private endpoint connections associated with the key vault.
	PrivateEndpointConnections *[]PrivateEndpointConnectionItem `json:"privateEndpointConnections,omitempty"`
}

VaultProperties properties of the vault

func (VaultProperties) MarshalJSON 

func (vp VaultProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for VaultProperties.

type VaultsClient 

type VaultsClient struct {
	BaseClient
}

VaultsClient is the the Azure management API provides a RESTful set of web services that interact with Azure Key Vault.

func NewVaultsClient 

func NewVaultsClient(subscriptionID string) VaultsClient

NewVaultsClient creates an instance of the VaultsClient client.

func NewVaultsClientWithBaseURI 

func NewVaultsClientWithBaseURI(baseURI string, subscriptionID string) VaultsClient

NewVaultsClientWithBaseURI creates an instance of the VaultsClient 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 (VaultsClient) CheckNameAvailability 

func (client VaultsClient) CheckNameAvailability(ctx context.Context, vaultName VaultCheckNameAvailabilityParameters) (result CheckNameAvailabilityResult, err error)

CheckNameAvailability checks that the vault name is valid and is not already in use. Parameters: vaultName - the name of the vault.

func (VaultsClient) CheckNameAvailabilityPreparer 

func (client VaultsClient) CheckNameAvailabilityPreparer(ctx context.Context, vaultName VaultCheckNameAvailabilityParameters) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (VaultsClient) CheckNameAvailabilityResponder 

func (client VaultsClient) CheckNameAvailabilityResponder(resp *http.Response) (result CheckNameAvailabilityResult, err error)

CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.

func (VaultsClient) CheckNameAvailabilitySender 

func (client VaultsClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)

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

func (VaultsClient) CreateOrUpdate 

func (client VaultsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, vaultName string, parameters VaultCreateOrUpdateParameters) (result VaultsCreateOrUpdateFuture, err error)

CreateOrUpdate create or update a key vault in the specified subscription. Parameters: resourceGroupName - the name of the Resource Group to which the server belongs. vaultName - name of the vault parameters - parameters to create or update the vault

func (VaultsClient) CreateOrUpdatePreparer 

func (client VaultsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, vaultName string, parameters VaultCreateOrUpdateParameters) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (VaultsClient) CreateOrUpdateResponder 

func (client VaultsClient) CreateOrUpdateResponder(resp *http.Response) (result Vault, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (VaultsClient) CreateOrUpdateSender 

func (client VaultsClient) CreateOrUpdateSender(req *http.Request) (future VaultsCreateOrUpdateFuture, err error)

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

func (VaultsClient) Delete 

func (client VaultsClient) Delete(ctx context.Context, resourceGroupName string, vaultName string) (result autorest.Response, err error)

Delete deletes the specified Azure key vault. Parameters: resourceGroupName - the name of the Resource Group to which the vault belongs. vaultName - the name of the vault to delete

func (VaultsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (VaultsClient) DeleteResponder 

func (client VaultsClient) 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 (VaultsClient) DeleteSender 

func (client VaultsClient) DeleteSender(req *http.Request) (*http.Response, error)

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

func (VaultsClient) Get 

func (client VaultsClient) Get(ctx context.Context, resourceGroupName string, vaultName string) (result Vault, err error)

Get gets the specified Azure key vault. Parameters: resourceGroupName - the name of the Resource Group to which the vault belongs. vaultName - the name of the vault.

func (VaultsClient) GetDeleted 

func (client VaultsClient) GetDeleted(ctx context.Context, vaultName string, location string) (result DeletedVault, err error)

GetDeleted gets the deleted Azure key vault. Parameters: vaultName - the name of the vault. location - the location of the deleted vault.

func (VaultsClient) GetDeletedPreparer 

func (client VaultsClient) GetDeletedPreparer(ctx context.Context, vaultName string, location string) (*http.Request, error)

GetDeletedPreparer prepares the GetDeleted request.

func (VaultsClient) GetDeletedResponder 

func (client VaultsClient) GetDeletedResponder(resp *http.Response) (result DeletedVault, err error)

GetDeletedResponder handles the response to the GetDeleted request. The method always closes the http.Response Body.

func (VaultsClient) GetDeletedSender 

func (client VaultsClient) GetDeletedSender(req *http.Request) (*http.Response, error)

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

func (VaultsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (VaultsClient) GetResponder 

func (client VaultsClient) GetResponder(resp *http.Response) (result Vault, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (VaultsClient) GetSender 

func (client VaultsClient) 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 (VaultsClient) List 

func (client VaultsClient) List(ctx context.Context, top *int32) (result ResourceListResultPage, err error)

List the List operation gets information about the vaults associated with the subscription. Parameters: top - maximum number of results to return.

func (VaultsClient) ListByResourceGroup 

func (client VaultsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, top *int32) (result VaultListResultPage, err error)

ListByResourceGroup the List operation gets information about the vaults associated with the subscription and within the specified resource group. Parameters: resourceGroupName - the name of the Resource Group to which the vault belongs. top - maximum number of results to return.

func (VaultsClient) ListByResourceGroupComplete 

func (client VaultsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, top *int32) (result VaultListResultIterator, err error)

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

func (VaultsClient) ListByResourceGroupPreparer 

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (VaultsClient) ListByResourceGroupResponder 

func (client VaultsClient) ListByResourceGroupResponder(resp *http.Response) (result VaultListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (VaultsClient) ListByResourceGroupSender 

func (client VaultsClient) 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 (VaultsClient) ListBySubscription 

func (client VaultsClient) ListBySubscription(ctx context.Context, top *int32) (result VaultListResultPage, err error)

ListBySubscription the List operation gets information about the vaults associated with the subscription. Parameters: top - maximum number of results to return.

func (VaultsClient) ListBySubscriptionComplete 

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

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

func (VaultsClient) ListBySubscriptionPreparer 

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

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (VaultsClient) ListBySubscriptionResponder 

func (client VaultsClient) ListBySubscriptionResponder(resp *http.Response) (result VaultListResult, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (VaultsClient) ListBySubscriptionSender 

func (client VaultsClient) 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 (VaultsClient) ListComplete 

func (client VaultsClient) ListComplete(ctx context.Context, top *int32) (result ResourceListResultIterator, err error)

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

func (VaultsClient) ListDeleted 

func (client VaultsClient) ListDeleted(ctx context.Context) (result DeletedVaultListResultPage, err error)

ListDeleted gets information about the deleted vaults in a subscription.

func (VaultsClient) ListDeletedComplete 

func (client VaultsClient) ListDeletedComplete(ctx context.Context) (result DeletedVaultListResultIterator, err error)

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

func (VaultsClient) ListDeletedPreparer 

func (client VaultsClient) ListDeletedPreparer(ctx context.Context) (*http.Request, error)

ListDeletedPreparer prepares the ListDeleted request.

func (VaultsClient) ListDeletedResponder 

func (client VaultsClient) ListDeletedResponder(resp *http.Response) (result DeletedVaultListResult, err error)

ListDeletedResponder handles the response to the ListDeleted request. The method always closes the http.Response Body.

func (VaultsClient) ListDeletedSender 

func (client VaultsClient) ListDeletedSender(req *http.Request) (*http.Response, error)

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

func (VaultsClient) ListPreparer 

func (client VaultsClient) ListPreparer(ctx context.Context, top *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (VaultsClient) ListResponder 

func (client VaultsClient) ListResponder(resp *http.Response) (result ResourceListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (VaultsClient) ListSender 

func (client VaultsClient) 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.

func (VaultsClient) PurgeDeleted 

func (client VaultsClient) PurgeDeleted(ctx context.Context, vaultName string, location string) (result VaultsPurgeDeletedFuture, err error)

PurgeDeleted permanently deletes the specified vault. aka Purges the deleted Azure key vault. Parameters: vaultName - the name of the soft-deleted vault. location - the location of the soft-deleted vault.

func (VaultsClient) PurgeDeletedPreparer 

func (client VaultsClient) PurgeDeletedPreparer(ctx context.Context, vaultName string, location string) (*http.Request, error)

PurgeDeletedPreparer prepares the PurgeDeleted request.

func (VaultsClient) PurgeDeletedResponder 

func (client VaultsClient) PurgeDeletedResponder(resp *http.Response) (result autorest.Response, err error)

PurgeDeletedResponder handles the response to the PurgeDeleted request. The method always closes the http.Response Body.

func (VaultsClient) PurgeDeletedSender 

func (client VaultsClient) PurgeDeletedSender(req *http.Request) (future VaultsPurgeDeletedFuture, err error)

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

func (VaultsClient) Update 

func (client VaultsClient) Update(ctx context.Context, resourceGroupName string, vaultName string, parameters VaultPatchParameters) (result Vault, err error)

Update update a key vault in the specified subscription. Parameters: resourceGroupName - the name of the Resource Group to which the server belongs. vaultName - name of the vault parameters - parameters to patch the vault

func (VaultsClient) UpdateAccessPolicy 

func (client VaultsClient) UpdateAccessPolicy(ctx context.Context, resourceGroupName string, vaultName string, operationKind AccessPolicyUpdateKind, parameters VaultAccessPolicyParameters) (result VaultAccessPolicyParameters, err error)

UpdateAccessPolicy update access policies in a key vault in the specified subscription. Parameters: resourceGroupName - the name of the Resource Group to which the vault belongs. vaultName - name of the vault operationKind - name of the operation parameters - access policy to merge into the vault

func (VaultsClient) UpdateAccessPolicyPreparer 

func (client VaultsClient) UpdateAccessPolicyPreparer(ctx context.Context, resourceGroupName string, vaultName string, operationKind AccessPolicyUpdateKind, parameters VaultAccessPolicyParameters) (*http.Request, error)

UpdateAccessPolicyPreparer prepares the UpdateAccessPolicy request.

func (VaultsClient) UpdateAccessPolicyResponder 

func (client VaultsClient) UpdateAccessPolicyResponder(resp *http.Response) (result VaultAccessPolicyParameters, err error)

UpdateAccessPolicyResponder handles the response to the UpdateAccessPolicy request. The method always closes the http.Response Body.

func (VaultsClient) UpdateAccessPolicySender 

func (client VaultsClient) UpdateAccessPolicySender(req *http.Request) (*http.Response, error)

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

func (VaultsClient) UpdatePreparer 

func (client VaultsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, vaultName string, parameters VaultPatchParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (VaultsClient) UpdateResponder 

func (client VaultsClient) UpdateResponder(resp *http.Response) (result Vault, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (VaultsClient) UpdateSender 

func (client VaultsClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type VaultsCreateOrUpdateFuture 

type VaultsCreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(VaultsClient) (Vault, error)
}

VaultsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*VaultsCreateOrUpdateFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type VaultsPurgeDeletedFuture 

type VaultsPurgeDeletedFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(VaultsClient) (autorest.Response, error)
}

VaultsPurgeDeletedFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*VaultsPurgeDeletedFuture) UnmarshalJSON 

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

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type VirtualNetworkRule 

type VirtualNetworkRule struct {
	// ID - Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.
	ID *string `json:"id,omitempty"`
}

VirtualNetworkRule a rule governing the accessibility of a vault from a specific virtual network.

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.