armkeyvault

package module
v0.3.0 Latest Latest
Warning

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

 Go to latest Published: Jan 13, 2022 License: MIT Imports: 16 Imported by: 25

README

Azure Key Vault Module for Go

PkgGoDev

The armkeyvault module provides operations for working with Azure Key Vault.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Key Vault module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Key Vault. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure Key Vault modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client := armkeyvault.NewKeysClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options = arm.ClientOptions{
    Host: arm.AzureChina,
}
client := armkeyvault.NewKeysClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Key Vault label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessPolicyEntry 

type AccessPolicyEntry struct {
	// REQUIRED; 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"`

	// REQUIRED; Permissions the identity has for keys, secrets and certificates.
	Permissions *Permissions `json:"permissions,omitempty"`

	// REQUIRED; The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
	TenantID *string `json:"tenantId,omitempty"`

	// Application ID of the client making request on behalf of a principal
	ApplicationID *string `json:"applicationId,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
const (
	AccessPolicyUpdateKindAdd     AccessPolicyUpdateKind = "add"
	AccessPolicyUpdateKindReplace AccessPolicyUpdateKind = "replace"
	AccessPolicyUpdateKindRemove  AccessPolicyUpdateKind = "remove"
)

func PossibleAccessPolicyUpdateKindValues 

func PossibleAccessPolicyUpdateKindValues() []AccessPolicyUpdateKind

PossibleAccessPolicyUpdateKindValues returns the possible values for the AccessPolicyUpdateKind const type.

func (AccessPolicyUpdateKind) ToPtr 

func (c AccessPolicyUpdateKind) ToPtr() *AccessPolicyUpdateKind

ToPtr returns a *AccessPolicyUpdateKind pointing to the current value.

type Action 

type Action struct {
	// The type of action.
	Type *KeyRotationPolicyActionType `json:"type,omitempty"`
}

type ActionsRequired 

type ActionsRequired string

ActionsRequired - A message indicating if changes on the service provider require any updates on the consumer. 

const (
	ActionsRequiredNone ActionsRequired = "None"
)

func PossibleActionsRequiredValues 

func PossibleActionsRequiredValues() []ActionsRequired

PossibleActionsRequiredValues returns the possible values for the ActionsRequired const type.

func (ActionsRequired) ToPtr 

func (c ActionsRequired) ToPtr() *ActionsRequired

ToPtr returns a *ActionsRequired pointing to the current value.

type Attributes 

type Attributes struct {
	// Determines whether the object is enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// Expiry date in seconds since 1970-01-01T00:00:00Z.
	Expires *time.Time `json:"exp,omitempty"`

	// Not before date in seconds since 1970-01-01T00:00:00Z.
	NotBefore *time.Time `json:"nbf,omitempty"`

	// READ-ONLY; Creation time in seconds since 1970-01-01T00:00:00Z.
	Created *time.Time `json:"created,omitempty" azure:"ro"`

	// READ-ONLY; Last updated time in seconds since 1970-01-01T00:00:00Z.
	Updated *time.Time `json:"updated,omitempty" azure:"ro"`
}

Attributes - The object attributes managed by the KeyVault service.

func (Attributes) MarshalJSON 

func (a Attributes) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Attributes.

func (*Attributes) UnmarshalJSON 

func (a *Attributes) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Attributes.

type CertificatePermissions 

type CertificatePermissions string
const (
	CertificatePermissionsAll            CertificatePermissions = "all"
	CertificatePermissionsBackup         CertificatePermissions = "backup"
	CertificatePermissionsCreate         CertificatePermissions = "create"
	CertificatePermissionsDelete         CertificatePermissions = "delete"
	CertificatePermissionsDeleteissuers  CertificatePermissions = "deleteissuers"
	CertificatePermissionsGet            CertificatePermissions = "get"
	CertificatePermissionsGetissuers     CertificatePermissions = "getissuers"
	CertificatePermissionsImport         CertificatePermissions = "import"
	CertificatePermissionsList           CertificatePermissions = "list"
	CertificatePermissionsListissuers    CertificatePermissions = "listissuers"
	CertificatePermissionsManagecontacts CertificatePermissions = "managecontacts"
	CertificatePermissionsManageissuers  CertificatePermissions = "manageissuers"
	CertificatePermissionsPurge          CertificatePermissions = "purge"
	CertificatePermissionsRecover        CertificatePermissions = "recover"
	CertificatePermissionsRestore        CertificatePermissions = "restore"
	CertificatePermissionsSetissuers     CertificatePermissions = "setissuers"
	CertificatePermissionsUpdate         CertificatePermissions = "update"
)

func PossibleCertificatePermissionsValues 

func PossibleCertificatePermissionsValues() []CertificatePermissions

PossibleCertificatePermissionsValues returns the possible values for the CertificatePermissions const type.

func (CertificatePermissions) ToPtr 

func (c CertificatePermissions) ToPtr() *CertificatePermissions

ToPtr returns a *CertificatePermissions pointing to the current value.

type CheckNameAvailabilityResult 

type CheckNameAvailabilityResult struct {
	// READ-ONLY; An error message explaining the Reason value in more detail.
	Message *string `json:"message,omitempty" azure:"ro"`

	// 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" azure:"ro"`

	// READ-ONLY; The reason that a vault name could not be used. The Reason element is only returned if NameAvailable is false.
	Reason *Reason `json:"reason,omitempty" azure:"ro"`
}

CheckNameAvailabilityResult - The CheckNameAvailability operation response.

type CloudError 

type CloudError struct {
	// An error response from Key Vault resource provider
	Error *CloudErrorBody `json:"error,omitempty"`
}

CloudError - An error response from Key Vault resource provider

type CloudErrorBody 

type CloudErrorBody struct {
	// Error code. This is a mnemonic that can be consumed programmatically.
	Code *string `json:"code,omitempty"`

	// 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 - The vault's create mode to indicate whether the vault need to be recovered or not. 

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

func PossibleCreateModeValues 

func PossibleCreateModeValues() []CreateMode

PossibleCreateModeValues returns the possible values for the CreateMode const type.

func (CreateMode) ToPtr 

func (c CreateMode) ToPtr() *CreateMode

ToPtr returns a *CreateMode pointing to the current value.

type DeletedManagedHsm 

type DeletedManagedHsm struct {
	// Properties of the deleted managed HSM
	Properties *DeletedManagedHsmProperties `json:"properties,omitempty"`

	// READ-ONLY; The Azure Resource Manager resource ID for the deleted managed HSM Pool.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the managed HSM Pool.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The resource type of the managed HSM Pool.
	Type *string `json:"type,omitempty" azure:"ro"`
}

type DeletedManagedHsmListResult 

type DeletedManagedHsmListResult struct {
	// The URL to get the next set of deleted managed HSM Pools.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of deleted managed HSM Pools.
	Value []*DeletedManagedHsm `json:"value,omitempty"`
}

DeletedManagedHsmListResult - List of deleted managed HSM Pools

func (DeletedManagedHsmListResult) MarshalJSON 

func (d DeletedManagedHsmListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeletedManagedHsmListResult.

type DeletedManagedHsmProperties 

type DeletedManagedHsmProperties struct {
	// READ-ONLY; The deleted date.
	DeletionDate *time.Time `json:"deletionDate,omitempty" azure:"ro"`

	// READ-ONLY; The location of the original managed HSM.
	Location *string `json:"location,omitempty" azure:"ro"`

	// READ-ONLY; The resource id of the original managed HSM.
	MhsmID *string `json:"mhsmId,omitempty" azure:"ro"`

	// READ-ONLY; Purge protection status of the original managed HSM.
	PurgeProtectionEnabled *bool `json:"purgeProtectionEnabled,omitempty" azure:"ro"`

	// READ-ONLY; The scheduled purged date.
	ScheduledPurgeDate *time.Time `json:"scheduledPurgeDate,omitempty" azure:"ro"`

	// READ-ONLY; Tags of the original managed HSM.
	Tags map[string]*string `json:"tags,omitempty" azure:"ro"`
}

DeletedManagedHsmProperties - Properties of the deleted managed HSM.

func (DeletedManagedHsmProperties) MarshalJSON 

func (d DeletedManagedHsmProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeletedManagedHsmProperties.

func (*DeletedManagedHsmProperties) UnmarshalJSON 

func (d *DeletedManagedHsmProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeletedManagedHsmProperties.

type DeletedVault 

type DeletedVault struct {
	// Properties of the vault
	Properties *DeletedVaultProperties `json:"properties,omitempty"`

	// READ-ONLY; The resource ID for the deleted key vault.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the key vault.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The resource type of the key vault.
	Type *string `json:"type,omitempty" azure:"ro"`
}

DeletedVault - Deleted vault information with extended details.

type DeletedVaultListResult 

type DeletedVaultListResult struct {
	// The URL to get the next set of deleted vaults.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of deleted vaults.
	Value []*DeletedVault `json:"value,omitempty"`
}

DeletedVaultListResult - List of vaults

func (DeletedVaultListResult) MarshalJSON 

func (d DeletedVaultListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DeletedVaultListResult.

type DeletedVaultProperties 

type DeletedVaultProperties struct {
	// READ-ONLY; The deleted date.
	DeletionDate *time.Time `json:"deletionDate,omitempty" azure:"ro"`

	// READ-ONLY; The location of the original vault.
	Location *string `json:"location,omitempty" azure:"ro"`

	// READ-ONLY; Purge protection status of the original vault.
	PurgeProtectionEnabled *bool `json:"purgeProtectionEnabled,omitempty" azure:"ro"`

	// READ-ONLY; The scheduled purged date.
	ScheduledPurgeDate *time.Time `json:"scheduledPurgeDate,omitempty" azure:"ro"`

	// READ-ONLY; Tags of the original vault.
	Tags map[string]*string `json:"tags,omitempty" azure:"ro"`

	// READ-ONLY; The resource id of the original vault.
	VaultID *string `json:"vaultId,omitempty" azure:"ro"`
}

DeletedVaultProperties - Properties of the deleted vault.

func (DeletedVaultProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type DeletedVaultProperties.

func (*DeletedVaultProperties) UnmarshalJSON 

func (d *DeletedVaultProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DeletedVaultProperties.

type DeletionRecoveryLevel 

type DeletionRecoveryLevel string

DeletionRecoveryLevel - The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval. 

const (
	DeletionRecoveryLevelPurgeable                        DeletionRecoveryLevel = "Purgeable"
	DeletionRecoveryLevelRecoverable                      DeletionRecoveryLevel = "Recoverable"
	DeletionRecoveryLevelRecoverableProtectedSubscription DeletionRecoveryLevel = "Recoverable+ProtectedSubscription"
	DeletionRecoveryLevelRecoverablePurgeable             DeletionRecoveryLevel = "Recoverable+Purgeable"
)

func PossibleDeletionRecoveryLevelValues 

func PossibleDeletionRecoveryLevelValues() []DeletionRecoveryLevel

PossibleDeletionRecoveryLevelValues returns the possible values for the DeletionRecoveryLevel const type.

func (DeletionRecoveryLevel) ToPtr 

func (c DeletionRecoveryLevel) ToPtr() *DeletionRecoveryLevel

ToPtr returns a *DeletionRecoveryLevel pointing to the current value.

type DimensionProperties 

type DimensionProperties struct {
	// Display name of dimension.
	DisplayName *string `json:"displayName,omitempty"`

	// Name of dimension.
	Name *string `json:"name,omitempty"`

	// Property to specify whether the dimension should be exported for Shoebox.
	ToBeExportedForShoebox *bool `json:"toBeExportedForShoebox,omitempty"`
}

DimensionProperties - Type of operation: get, read, delete, etc.

type Error 

type Error struct {
	// READ-ONLY; The error code.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; The inner error, contains a more specific error code.
	InnerError *Error `json:"innererror,omitempty" azure:"ro"`

	// READ-ONLY; The error message.
	Message *string `json:"message,omitempty" azure:"ro"`
}

Error - The server error.

type IPRule 

type IPRule struct {
	// REQUIRED; 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 IdentityType 

type IdentityType string

IdentityType - The type of identity. 

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

func PossibleIdentityTypeValues 

func PossibleIdentityTypeValues() []IdentityType

PossibleIdentityTypeValues returns the possible values for the IdentityType const type.

func (IdentityType) ToPtr 

func (c IdentityType) ToPtr() *IdentityType

ToPtr returns a *IdentityType pointing to the current value.

type JSONWebKeyCurveName 

type JSONWebKeyCurveName string

JSONWebKeyCurveName - The elliptic curve name. For valid values, see JsonWebKeyCurveName. 

const (
	JSONWebKeyCurveNameP256  JSONWebKeyCurveName = "P-256"
	JSONWebKeyCurveNameP256K JSONWebKeyCurveName = "P-256K"
	JSONWebKeyCurveNameP384  JSONWebKeyCurveName = "P-384"
	JSONWebKeyCurveNameP521  JSONWebKeyCurveName = "P-521"
)

func PossibleJSONWebKeyCurveNameValues 

func PossibleJSONWebKeyCurveNameValues() []JSONWebKeyCurveName

PossibleJSONWebKeyCurveNameValues returns the possible values for the JSONWebKeyCurveName const type.

func (JSONWebKeyCurveName) ToPtr 

func (c JSONWebKeyCurveName) ToPtr() *JSONWebKeyCurveName

ToPtr returns a *JSONWebKeyCurveName pointing to the current value.

type JSONWebKeyOperation 

type JSONWebKeyOperation string

JSONWebKeyOperation - The permitted JSON web key operations of the key. For more information, see JsonWebKeyOperation. 

const (
	JSONWebKeyOperationDecrypt   JSONWebKeyOperation = "decrypt"
	JSONWebKeyOperationEncrypt   JSONWebKeyOperation = "encrypt"
	JSONWebKeyOperationImport    JSONWebKeyOperation = "import"
	JSONWebKeyOperationRelease   JSONWebKeyOperation = "release"
	JSONWebKeyOperationSign      JSONWebKeyOperation = "sign"
	JSONWebKeyOperationUnwrapKey JSONWebKeyOperation = "unwrapKey"
	JSONWebKeyOperationVerify    JSONWebKeyOperation = "verify"
	JSONWebKeyOperationWrapKey   JSONWebKeyOperation = "wrapKey"
)

func PossibleJSONWebKeyOperationValues 

func PossibleJSONWebKeyOperationValues() []JSONWebKeyOperation

PossibleJSONWebKeyOperationValues returns the possible values for the JSONWebKeyOperation const type.

func (JSONWebKeyOperation) ToPtr 

func (c JSONWebKeyOperation) ToPtr() *JSONWebKeyOperation

ToPtr returns a *JSONWebKeyOperation pointing to the current value.

type JSONWebKeyType 

type JSONWebKeyType string

JSONWebKeyType - The type of the key. For valid values, see JsonWebKeyType. 

const (
	JSONWebKeyTypeEC     JSONWebKeyType = "EC"
	JSONWebKeyTypeECHSM  JSONWebKeyType = "EC-HSM"
	JSONWebKeyTypeRSA    JSONWebKeyType = "RSA"
	JSONWebKeyTypeRSAHSM JSONWebKeyType = "RSA-HSM"
)

func PossibleJSONWebKeyTypeValues 

func PossibleJSONWebKeyTypeValues() []JSONWebKeyType

PossibleJSONWebKeyTypeValues returns the possible values for the JSONWebKeyType const type.

func (JSONWebKeyType) ToPtr 

func (c JSONWebKeyType) ToPtr() *JSONWebKeyType

ToPtr returns a *JSONWebKeyType pointing to the current value.

type Key 

type Key struct {
	// REQUIRED; The properties of the key.
	Properties *KeyProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified identifier of the key vault resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Azure location of the key vault resource.
	Location *string `json:"location,omitempty" azure:"ro"`

	// READ-ONLY; Name of the key vault resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Tags assigned to the key vault resource.
	Tags map[string]*string `json:"tags,omitempty" azure:"ro"`

	// READ-ONLY; Resource type of the key vault resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Key - The key resource.

func (Key) MarshalJSON 

func (k Key) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Key.

type KeyAttributes 

type KeyAttributes struct {
	// Determines whether or not the object is enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// Expiry date in seconds since 1970-01-01T00:00:00Z.
	Expires *int64 `json:"exp,omitempty"`

	// Indicates if the private key can be exported.
	Exportable *bool `json:"exportable,omitempty"`

	// Not before date in seconds since 1970-01-01T00:00:00Z.
	NotBefore *int64 `json:"nbf,omitempty"`

	// READ-ONLY; Creation time in seconds since 1970-01-01T00:00:00Z.
	Created *int64 `json:"created,omitempty" azure:"ro"`

	// READ-ONLY; The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object
	// can be permanently deleted by a privileged user; otherwise, only the system can purge the
	// object at the end of the retention interval.
	RecoveryLevel *DeletionRecoveryLevel `json:"recoveryLevel,omitempty" azure:"ro"`

	// READ-ONLY; Last updated time in seconds since 1970-01-01T00:00:00Z.
	Updated *int64 `json:"updated,omitempty" azure:"ro"`
}

KeyAttributes - The object attributes managed by the Azure Key Vault service.

type KeyCreateParameters 

type KeyCreateParameters struct {
	// REQUIRED; The properties of the key to be created.
	Properties *KeyProperties `json:"properties,omitempty"`

	// The tags that will be assigned to the key.
	Tags map[string]*string `json:"tags,omitempty"`
}

KeyCreateParameters - The parameters used to create a key.

func (KeyCreateParameters) MarshalJSON 

func (k KeyCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KeyCreateParameters.

type KeyListResult 

type KeyListResult struct {
	// The URL to get the next page of keys.
	NextLink *string `json:"nextLink,omitempty"`

	// The key resources.
	Value []*Key `json:"value,omitempty"`
}

KeyListResult - The page of keys.

func (KeyListResult) MarshalJSON 

func (k KeyListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KeyListResult.

type KeyPermissions 

type KeyPermissions string
const (
	KeyPermissionsAll               KeyPermissions = "all"
	KeyPermissionsBackup            KeyPermissions = "backup"
	KeyPermissionsCreate            KeyPermissions = "create"
	KeyPermissionsDecrypt           KeyPermissions = "decrypt"
	KeyPermissionsDelete            KeyPermissions = "delete"
	KeyPermissionsEncrypt           KeyPermissions = "encrypt"
	KeyPermissionsGet               KeyPermissions = "get"
	KeyPermissionsGetrotationpolicy KeyPermissions = "getrotationpolicy"
	KeyPermissionsImport            KeyPermissions = "import"
	KeyPermissionsList              KeyPermissions = "list"
	KeyPermissionsPurge             KeyPermissions = "purge"
	KeyPermissionsRecover           KeyPermissions = "recover"
	KeyPermissionsRelease           KeyPermissions = "release"
	KeyPermissionsRestore           KeyPermissions = "restore"
	KeyPermissionsRotate            KeyPermissions = "rotate"
	KeyPermissionsSetrotationpolicy KeyPermissions = "setrotationpolicy"
	KeyPermissionsSign              KeyPermissions = "sign"
	KeyPermissionsUnwrapKey         KeyPermissions = "unwrapKey"
	KeyPermissionsUpdate            KeyPermissions = "update"
	KeyPermissionsVerify            KeyPermissions = "verify"
	KeyPermissionsWrapKey           KeyPermissions = "wrapKey"
)

func PossibleKeyPermissionsValues 

func PossibleKeyPermissionsValues() []KeyPermissions

PossibleKeyPermissionsValues returns the possible values for the KeyPermissions const type.

func (KeyPermissions) ToPtr 

func (c KeyPermissions) ToPtr() *KeyPermissions

ToPtr returns a *KeyPermissions pointing to the current value.

type KeyProperties 

type KeyProperties struct {
	// The attributes of the key.
	Attributes *KeyAttributes `json:"attributes,omitempty"`

	// The elliptic curve name. For valid values, see JsonWebKeyCurveName.
	CurveName *JSONWebKeyCurveName   `json:"curveName,omitempty"`
	KeyOps    []*JSONWebKeyOperation `json:"keyOps,omitempty"`

	// The key size in bits. For example: 2048, 3072, or 4096 for RSA.
	KeySize *int32 `json:"keySize,omitempty"`

	// The type of the key. For valid values, see JsonWebKeyType.
	Kty *JSONWebKeyType `json:"kty,omitempty"`

	// Key release policy in response. It will be used for both output and input. Omitted if empty
	ReleasePolicy *KeyReleasePolicy `json:"release_policy,omitempty"`

	// Key rotation policy in response. It will be used for both output and input. Omitted if empty
	RotationPolicy *RotationPolicy `json:"rotationPolicy,omitempty"`

	// READ-ONLY; The URI to retrieve the current version of the key.
	KeyURI *string `json:"keyUri,omitempty" azure:"ro"`

	// READ-ONLY; The URI to retrieve the specific version of the key.
	KeyURIWithVersion *string `json:"keyUriWithVersion,omitempty" azure:"ro"`
}

KeyProperties - The properties of the key.

func (KeyProperties) MarshalJSON 

func (k KeyProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KeyProperties.

type KeyReleasePolicy 

type KeyReleasePolicy struct {
	// Content type and version of key release policy
	ContentType *string `json:"contentType,omitempty"`

	// Blob encoding the policy rules under which the key can be released.
	Data []byte `json:"data,omitempty"`
}

func (KeyReleasePolicy) MarshalJSON 

func (k KeyReleasePolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KeyReleasePolicy.

func (*KeyReleasePolicy) UnmarshalJSON 

func (k *KeyReleasePolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KeyReleasePolicy.

type KeyRotationPolicyActionType 

type KeyRotationPolicyActionType string

KeyRotationPolicyActionType - The type of action. 

const (
	KeyRotationPolicyActionTypeRotate KeyRotationPolicyActionType = "rotate"
	KeyRotationPolicyActionTypeNotify KeyRotationPolicyActionType = "notify"
)

func PossibleKeyRotationPolicyActionTypeValues 

func PossibleKeyRotationPolicyActionTypeValues() []KeyRotationPolicyActionType

PossibleKeyRotationPolicyActionTypeValues returns the possible values for the KeyRotationPolicyActionType const type.

func (KeyRotationPolicyActionType) ToPtr 

func (c KeyRotationPolicyActionType) ToPtr() *KeyRotationPolicyActionType

ToPtr returns a *KeyRotationPolicyActionType pointing to the current value.

type KeyRotationPolicyAttributes 

type KeyRotationPolicyAttributes struct {
	// The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'.
	ExpiryTime *string `json:"expiryTime,omitempty"`

	// READ-ONLY; Creation time in seconds since 1970-01-01T00:00:00Z.
	Created *int64 `json:"created,omitempty" azure:"ro"`

	// READ-ONLY; Last updated time in seconds since 1970-01-01T00:00:00Z.
	Updated *int64 `json:"updated,omitempty" azure:"ro"`
}

type KeysClient 

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

KeysClient contains the methods for the Keys group. Don't use this type directly, use NewKeysClient() instead.

func NewKeysClient 

func NewKeysClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *KeysClient

NewKeysClient creates a new instance of KeysClient with the specified values. subscriptionID - Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*KeysClient) CreateIfNotExist 

func (client *KeysClient) CreateIfNotExist(ctx context.Context, resourceGroupName string, vaultName string, keyName string, parameters KeyCreateParameters, options *KeysClientCreateIfNotExistOptions) (KeysClientCreateIfNotExistResponse, error)

CreateIfNotExist - Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group which contains the specified key vault. vaultName - The name of the key vault which contains the key to be created. keyName - The name of the key to be created. parameters - The parameters used to create the specified key. options - KeysClientCreateIfNotExistOptions contains the optional parameters for the KeysClient.CreateIfNotExist method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/createKey.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewKeysClient("<subscription-id>", cred, nil)
	res, err := client.CreateIfNotExist(ctx,
		"<resource-group-name>",
		"<vault-name>",
		"<key-name>",
		armkeyvault.KeyCreateParameters{
			Properties: &armkeyvault.KeyProperties{
				Kty: armkeyvault.JSONWebKeyType("RSA").ToPtr(),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.KeysClientCreateIfNotExistResult)
}

Output:

func (*KeysClient) Get 

func (client *KeysClient) Get(ctx context.Context, resourceGroupName string, vaultName string, keyName string, options *KeysClientGetOptions) (KeysClientGetResponse, error)

Get - Gets the current version of the specified key from the specified key vault. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group which contains the specified key vault. vaultName - The name of the vault which contains the key to be retrieved. keyName - The name of the key to be retrieved. options - KeysClientGetOptions contains the optional parameters for the KeysClient.Get method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/getKey.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewKeysClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<vault-name>",
		"<key-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.KeysClientGetResult)
}

Output:

func (*KeysClient) GetVersion 

func (client *KeysClient) GetVersion(ctx context.Context, resourceGroupName string, vaultName string, keyName string, keyVersion string, options *KeysClientGetVersionOptions) (KeysClientGetVersionResponse, error)

GetVersion - Gets the specified version of the specified key in the specified key vault. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group which contains the specified key vault. vaultName - The name of the vault which contains the key version to be retrieved. keyName - The name of the key version to be retrieved. keyVersion - The version of the key to be retrieved. options - KeysClientGetVersionOptions contains the optional parameters for the KeysClient.GetVersion method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/getKeyVersion.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewKeysClient("<subscription-id>", cred, nil)
	res, err := client.GetVersion(ctx,
		"<resource-group-name>",
		"<vault-name>",
		"<key-name>",
		"<key-version>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.KeysClientGetVersionResult)
}

Output:

func (*KeysClient) List 

func (client *KeysClient) List(resourceGroupName string, vaultName string, options *KeysClientListOptions) *KeysClientListPager

List - Lists the keys in the specified key vault. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group which contains the specified key vault. vaultName - The name of the vault which contains the keys to be retrieved. options - KeysClientListOptions contains the optional parameters for the KeysClient.List method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/listKeys.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewKeysClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<vault-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*KeysClient) ListVersions 

func (client *KeysClient) ListVersions(resourceGroupName string, vaultName string, keyName string, options *KeysClientListVersionsOptions) *KeysClientListVersionsPager

ListVersions - Lists the versions of the specified key in the specified key vault. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group which contains the specified key vault. vaultName - The name of the vault which contains the key versions to be retrieved. keyName - The name of the key versions to be retrieved. options - KeysClientListVersionsOptions contains the optional parameters for the KeysClient.ListVersions method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/listKeyVersions.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewKeysClient("<subscription-id>", cred, nil)
	pager := client.ListVersions("<resource-group-name>",
		"<vault-name>",
		"<key-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type KeysClientCreateIfNotExistOptions added in v0.3.0 

type KeysClientCreateIfNotExistOptions struct {
}

KeysClientCreateIfNotExistOptions contains the optional parameters for the KeysClient.CreateIfNotExist method.

type KeysClientCreateIfNotExistResponse added in v0.3.0 

type KeysClientCreateIfNotExistResponse struct {
	KeysClientCreateIfNotExistResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

KeysClientCreateIfNotExistResponse contains the response from method KeysClient.CreateIfNotExist.

type KeysClientCreateIfNotExistResult added in v0.3.0 

type KeysClientCreateIfNotExistResult struct {
	Key
}

KeysClientCreateIfNotExistResult contains the result from method KeysClient.CreateIfNotExist.

type KeysClientGetOptions added in v0.3.0 

type KeysClientGetOptions struct {
}

KeysClientGetOptions contains the optional parameters for the KeysClient.Get method.

type KeysClientGetResponse added in v0.3.0 

type KeysClientGetResponse struct {
	KeysClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

KeysClientGetResponse contains the response from method KeysClient.Get.

type KeysClientGetResult added in v0.3.0 

type KeysClientGetResult struct {
	Key
}

KeysClientGetResult contains the result from method KeysClient.Get.

type KeysClientGetVersionOptions added in v0.3.0 

type KeysClientGetVersionOptions struct {
}

KeysClientGetVersionOptions contains the optional parameters for the KeysClient.GetVersion method.

type KeysClientGetVersionResponse added in v0.3.0 

type KeysClientGetVersionResponse struct {
	KeysClientGetVersionResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

KeysClientGetVersionResponse contains the response from method KeysClient.GetVersion.

type KeysClientGetVersionResult added in v0.3.0 

type KeysClientGetVersionResult struct {
	Key
}

KeysClientGetVersionResult contains the result from method KeysClient.GetVersion.

type KeysClientListOptions added in v0.3.0 

type KeysClientListOptions struct {
}

KeysClientListOptions contains the optional parameters for the KeysClient.List method.

type KeysClientListPager added in v0.3.0 

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

KeysClientListPager provides operations for iterating over paged responses.

func (*KeysClientListPager) Err added in v0.3.0 

func (p *KeysClientListPager) Err() error

Err returns the last error encountered while paging.

func (*KeysClientListPager) NextPage added in v0.3.0 

func (p *KeysClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*KeysClientListPager) PageResponse added in v0.3.0 

func (p *KeysClientListPager) PageResponse() KeysClientListResponse

PageResponse returns the current KeysClientListResponse page.

type KeysClientListResponse added in v0.3.0 

type KeysClientListResponse struct {
	KeysClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

KeysClientListResponse contains the response from method KeysClient.List.

type KeysClientListResult added in v0.3.0 

type KeysClientListResult struct {
	KeyListResult
}

KeysClientListResult contains the result from method KeysClient.List.

type KeysClientListVersionsOptions added in v0.3.0 

type KeysClientListVersionsOptions struct {
}

KeysClientListVersionsOptions contains the optional parameters for the KeysClient.ListVersions method.

type KeysClientListVersionsPager added in v0.3.0 

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

KeysClientListVersionsPager provides operations for iterating over paged responses.

func (*KeysClientListVersionsPager) Err added in v0.3.0 

func (p *KeysClientListVersionsPager) Err() error

Err returns the last error encountered while paging.

func (*KeysClientListVersionsPager) NextPage added in v0.3.0 

func (p *KeysClientListVersionsPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*KeysClientListVersionsPager) PageResponse added in v0.3.0 

func (p *KeysClientListVersionsPager) PageResponse() KeysClientListVersionsResponse

PageResponse returns the current KeysClientListVersionsResponse page.

type KeysClientListVersionsResponse added in v0.3.0 

type KeysClientListVersionsResponse struct {
	KeysClientListVersionsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

KeysClientListVersionsResponse contains the response from method KeysClient.ListVersions.

type KeysClientListVersionsResult added in v0.3.0 

type KeysClientListVersionsResult struct {
	KeyListResult
}

KeysClientListVersionsResult contains the result from method KeysClient.ListVersions.

type LifetimeAction 

type LifetimeAction struct {
	// The action of key rotation policy lifetimeAction.
	Action *Action `json:"action,omitempty"`

	// The trigger of key rotation policy lifetimeAction.
	Trigger *Trigger `json:"trigger,omitempty"`
}

type LogSpecification 

type LogSpecification struct {
	// Blob duration of specification.
	BlobDuration *string `json:"blobDuration,omitempty"`

	// Display name of log specification.
	DisplayName *string `json:"displayName,omitempty"`

	// Name of log specification.
	Name *string `json:"name,omitempty"`
}

LogSpecification - Log specification of operation.

type MHSMIPRule 

type MHSMIPRule struct {
	// REQUIRED; 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"`
}

MHSMIPRule - A rule governing the accessibility of a managed hsm pool from a specific ip address or ip range.

type MHSMNetworkRuleSet 

type MHSMNetworkRuleSet struct {
	// Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.
	Bypass *NetworkRuleBypassOptions `json:"bypass,omitempty"`

	// The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property
	// has been evaluated.
	DefaultAction *NetworkRuleAction `json:"defaultAction,omitempty"`

	// The list of IP address rules.
	IPRules []*MHSMIPRule `json:"ipRules,omitempty"`

	// The list of virtual network rules.
	VirtualNetworkRules []*MHSMVirtualNetworkRule `json:"virtualNetworkRules,omitempty"`
}

MHSMNetworkRuleSet - A set of rules governing the network accessibility of a managed hsm pool.

func (MHSMNetworkRuleSet) MarshalJSON 

func (m MHSMNetworkRuleSet) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MHSMNetworkRuleSet.

type MHSMPrivateEndpoint 

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

MHSMPrivateEndpoint - Private endpoint object properties.

type MHSMPrivateEndpointConnection 

type MHSMPrivateEndpointConnection struct {
	// Modified whenever there is a change in the state of private endpoint connection.
	Etag *string `json:"etag,omitempty"`

	// The supported Azure location where the managed HSM Pool should be created.
	Location *string `json:"location,omitempty"`

	// Resource properties.
	Properties *MHSMPrivateEndpointConnectionProperties `json:"properties,omitempty"`

	// SKU details
	SKU *ManagedHsmSKU `json:"sku,omitempty"`

	// Resource tags
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; The Azure Resource Manager resource ID for the managed HSM Pool.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the managed HSM Pool.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Metadata pertaining to creation and last modification of the key vault resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The resource type of the managed HSM Pool.
	Type *string `json:"type,omitempty" azure:"ro"`
}

MHSMPrivateEndpointConnection - Private endpoint connection resource.

func (MHSMPrivateEndpointConnection) MarshalJSON 

func (m MHSMPrivateEndpointConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MHSMPrivateEndpointConnection.

type MHSMPrivateEndpointConnectionItem 

type MHSMPrivateEndpointConnectionItem struct {
	// Private endpoint connection properties.
	Properties *MHSMPrivateEndpointConnectionProperties `json:"properties,omitempty"`
}

MHSMPrivateEndpointConnectionItem - Private endpoint connection item.

type MHSMPrivateEndpointConnectionProperties 

type MHSMPrivateEndpointConnectionProperties struct {
	// Properties of the private endpoint object.
	PrivateEndpoint *MHSMPrivateEndpoint `json:"privateEndpoint,omitempty"`

	// Approval state of the private link connection.
	PrivateLinkServiceConnectionState *MHSMPrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`

	// Provisioning state of the private endpoint connection.
	ProvisioningState *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}

MHSMPrivateEndpointConnectionProperties - Properties of the private endpoint connection resource.

type MHSMPrivateEndpointConnectionsClient 

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

MHSMPrivateEndpointConnectionsClient contains the methods for the MHSMPrivateEndpointConnections group. Don't use this type directly, use NewMHSMPrivateEndpointConnectionsClient() instead.

func NewMHSMPrivateEndpointConnectionsClient 

func NewMHSMPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *MHSMPrivateEndpointConnectionsClient

NewMHSMPrivateEndpointConnectionsClient creates a new instance of MHSMPrivateEndpointConnectionsClient with the specified values. subscriptionID - Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*MHSMPrivateEndpointConnectionsClient) BeginDelete 

func (client *MHSMPrivateEndpointConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, name string, privateEndpointConnectionName string, options *MHSMPrivateEndpointConnectionsClientBeginDeleteOptions) (MHSMPrivateEndpointConnectionsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified private endpoint connection associated with the managed hsm pool. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - Name of the resource group that contains the managed HSM pool. name - Name of the managed HSM Pool privateEndpointConnectionName - Name of the private endpoint connection associated with the managed hsm pool. options - MHSMPrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the MHSMPrivateEndpointConnectionsClient.BeginDelete method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/ManagedHsm_deletePrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewMHSMPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<name>",
		"<private-endpoint-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.MHSMPrivateEndpointConnectionsClientDeleteResult)
}

Output:

func (*MHSMPrivateEndpointConnectionsClient) Get 

func (client *MHSMPrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, name string, privateEndpointConnectionName string, options *MHSMPrivateEndpointConnectionsClientGetOptions) (MHSMPrivateEndpointConnectionsClientGetResponse, error)

Get - Gets the specified private endpoint connection associated with the managed HSM Pool. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - Name of the resource group that contains the managed HSM pool. name - Name of the managed HSM Pool privateEndpointConnectionName - Name of the private endpoint connection associated with the managed hsm pool. options - MHSMPrivateEndpointConnectionsClientGetOptions contains the optional parameters for the MHSMPrivateEndpointConnectionsClient.Get method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/ManagedHsm_getPrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewMHSMPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<name>",
		"<private-endpoint-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.MHSMPrivateEndpointConnectionsClientGetResult)
}

Output:

func (*MHSMPrivateEndpointConnectionsClient) ListByResource 

func (client *MHSMPrivateEndpointConnectionsClient) ListByResource(resourceGroupName string, name string, options *MHSMPrivateEndpointConnectionsClientListByResourceOptions) *MHSMPrivateEndpointConnectionsClientListByResourcePager

ListByResource - The List operation gets information about the private endpoint connections associated with the managed HSM Pool. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - Name of the resource group that contains the managed HSM pool. name - Name of the managed HSM Pool options - MHSMPrivateEndpointConnectionsClientListByResourceOptions contains the optional parameters for the MHSMPrivateEndpointConnectionsClient.ListByResource method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/ManagedHsm_ListPrivateEndpointConnectionsByResource.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewMHSMPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	pager := client.ListByResource("<resource-group-name>",
		"<name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*MHSMPrivateEndpointConnectionsClient) Put 

func (client *MHSMPrivateEndpointConnectionsClient) Put(ctx context.Context, resourceGroupName string, name string, privateEndpointConnectionName string, properties MHSMPrivateEndpointConnection, options *MHSMPrivateEndpointConnectionsClientPutOptions) (MHSMPrivateEndpointConnectionsClientPutResponse, error)

Put - Updates the specified private endpoint connection associated with the managed hsm pool. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - Name of the resource group that contains the managed HSM pool. name - Name of the managed HSM Pool privateEndpointConnectionName - Name of the private endpoint connection associated with the managed hsm pool. properties - The intended state of private endpoint connection. options - MHSMPrivateEndpointConnectionsClientPutOptions contains the optional parameters for the MHSMPrivateEndpointConnectionsClient.Put method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/ManagedHsm_putPrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewMHSMPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.Put(ctx,
		"<resource-group-name>",
		"<name>",
		"<private-endpoint-connection-name>",
		armkeyvault.MHSMPrivateEndpointConnection{
			Properties: &armkeyvault.MHSMPrivateEndpointConnectionProperties{
				PrivateLinkServiceConnectionState: &armkeyvault.MHSMPrivateLinkServiceConnectionState{
					Description: to.StringPtr("<description>"),
					Status:      armkeyvault.PrivateEndpointServiceConnectionStatus("Approved").ToPtr(),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.MHSMPrivateEndpointConnectionsClientPutResult)
}

Output:

type MHSMPrivateEndpointConnectionsClientBeginDeleteOptions added in v0.3.0 

type MHSMPrivateEndpointConnectionsClientBeginDeleteOptions struct {
}

MHSMPrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the MHSMPrivateEndpointConnectionsClient.BeginDelete method.

type MHSMPrivateEndpointConnectionsClientDeletePoller added in v0.3.0 

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

MHSMPrivateEndpointConnectionsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*MHSMPrivateEndpointConnectionsClientDeletePoller) Done added in v0.3.0 

func (p *MHSMPrivateEndpointConnectionsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*MHSMPrivateEndpointConnectionsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *MHSMPrivateEndpointConnectionsClientDeletePoller) FinalResponse(ctx context.Context) (MHSMPrivateEndpointConnectionsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final MHSMPrivateEndpointConnectionsClientDeleteResponse will be returned.

func (*MHSMPrivateEndpointConnectionsClientDeletePoller) Poll added in v0.3.0 

func (p *MHSMPrivateEndpointConnectionsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*MHSMPrivateEndpointConnectionsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *MHSMPrivateEndpointConnectionsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type MHSMPrivateEndpointConnectionsClientDeletePollerResponse added in v0.3.0 

type MHSMPrivateEndpointConnectionsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *MHSMPrivateEndpointConnectionsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

MHSMPrivateEndpointConnectionsClientDeletePollerResponse contains the response from method MHSMPrivateEndpointConnectionsClient.Delete.

func (MHSMPrivateEndpointConnectionsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l MHSMPrivateEndpointConnectionsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (MHSMPrivateEndpointConnectionsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*MHSMPrivateEndpointConnectionsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *MHSMPrivateEndpointConnectionsClientDeletePollerResponse) Resume(ctx context.Context, client *MHSMPrivateEndpointConnectionsClient, token string) error

Resume rehydrates a MHSMPrivateEndpointConnectionsClientDeletePollerResponse from the provided client and resume token.

type MHSMPrivateEndpointConnectionsClientDeleteResponse added in v0.3.0 

type MHSMPrivateEndpointConnectionsClientDeleteResponse struct {
	MHSMPrivateEndpointConnectionsClientDeleteResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

MHSMPrivateEndpointConnectionsClientDeleteResponse contains the response from method MHSMPrivateEndpointConnectionsClient.Delete.

type MHSMPrivateEndpointConnectionsClientDeleteResult added in v0.3.0 

type MHSMPrivateEndpointConnectionsClientDeleteResult struct {
	MHSMPrivateEndpointConnection
}

MHSMPrivateEndpointConnectionsClientDeleteResult contains the result from method MHSMPrivateEndpointConnectionsClient.Delete.

type MHSMPrivateEndpointConnectionsClientGetOptions added in v0.3.0 

type MHSMPrivateEndpointConnectionsClientGetOptions struct {
}

MHSMPrivateEndpointConnectionsClientGetOptions contains the optional parameters for the MHSMPrivateEndpointConnectionsClient.Get method.

type MHSMPrivateEndpointConnectionsClientGetResponse added in v0.3.0 

type MHSMPrivateEndpointConnectionsClientGetResponse struct {
	MHSMPrivateEndpointConnectionsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

MHSMPrivateEndpointConnectionsClientGetResponse contains the response from method MHSMPrivateEndpointConnectionsClient.Get.

type MHSMPrivateEndpointConnectionsClientGetResult added in v0.3.0 

type MHSMPrivateEndpointConnectionsClientGetResult struct {
	MHSMPrivateEndpointConnection
}

MHSMPrivateEndpointConnectionsClientGetResult contains the result from method MHSMPrivateEndpointConnectionsClient.Get.

type MHSMPrivateEndpointConnectionsClientListByResourceOptions added in v0.3.0 

type MHSMPrivateEndpointConnectionsClientListByResourceOptions struct {
}

MHSMPrivateEndpointConnectionsClientListByResourceOptions contains the optional parameters for the MHSMPrivateEndpointConnectionsClient.ListByResource method.

type MHSMPrivateEndpointConnectionsClientListByResourcePager added in v0.3.0 

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

MHSMPrivateEndpointConnectionsClientListByResourcePager provides operations for iterating over paged responses.

func (*MHSMPrivateEndpointConnectionsClientListByResourcePager) Err added in v0.3.0 

func (p *MHSMPrivateEndpointConnectionsClientListByResourcePager) Err() error

Err returns the last error encountered while paging.

func (*MHSMPrivateEndpointConnectionsClientListByResourcePager) NextPage added in v0.3.0 

func (p *MHSMPrivateEndpointConnectionsClientListByResourcePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*MHSMPrivateEndpointConnectionsClientListByResourcePager) PageResponse added in v0.3.0 

func (p *MHSMPrivateEndpointConnectionsClientListByResourcePager) PageResponse() MHSMPrivateEndpointConnectionsClientListByResourceResponse

PageResponse returns the current MHSMPrivateEndpointConnectionsClientListByResourceResponse page.

type MHSMPrivateEndpointConnectionsClientListByResourceResponse added in v0.3.0 

type MHSMPrivateEndpointConnectionsClientListByResourceResponse struct {
	MHSMPrivateEndpointConnectionsClientListByResourceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

MHSMPrivateEndpointConnectionsClientListByResourceResponse contains the response from method MHSMPrivateEndpointConnectionsClient.ListByResource.

type MHSMPrivateEndpointConnectionsClientListByResourceResult added in v0.3.0 

type MHSMPrivateEndpointConnectionsClientListByResourceResult struct {
	MHSMPrivateEndpointConnectionsListResult
}

MHSMPrivateEndpointConnectionsClientListByResourceResult contains the result from method MHSMPrivateEndpointConnectionsClient.ListByResource.

type MHSMPrivateEndpointConnectionsClientPutOptions added in v0.3.0 

type MHSMPrivateEndpointConnectionsClientPutOptions struct {
}

MHSMPrivateEndpointConnectionsClientPutOptions contains the optional parameters for the MHSMPrivateEndpointConnectionsClient.Put method.

type MHSMPrivateEndpointConnectionsClientPutResponse added in v0.3.0 

type MHSMPrivateEndpointConnectionsClientPutResponse struct {
	MHSMPrivateEndpointConnectionsClientPutResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

MHSMPrivateEndpointConnectionsClientPutResponse contains the response from method MHSMPrivateEndpointConnectionsClient.Put.

type MHSMPrivateEndpointConnectionsClientPutResult added in v0.3.0 

type MHSMPrivateEndpointConnectionsClientPutResult struct {
	MHSMPrivateEndpointConnection
	// AzureAsyncOperation contains the information returned from the Azure-AsyncOperation header response.
	AzureAsyncOperation *string

	// RetryAfter contains the information returned from the Retry-After header response.
	RetryAfter *int32
}

MHSMPrivateEndpointConnectionsClientPutResult contains the result from method MHSMPrivateEndpointConnectionsClient.Put.

type MHSMPrivateEndpointConnectionsListResult 

type MHSMPrivateEndpointConnectionsListResult struct {
	// The URL to get the next set of managed HSM Pools.
	NextLink *string `json:"nextLink,omitempty"`

	// The private endpoint connection associated with a managed HSM Pools.
	Value []*MHSMPrivateEndpointConnection `json:"value,omitempty"`
}

MHSMPrivateEndpointConnectionsListResult - List of private endpoint connections associated with a managed HSM Pools

func (MHSMPrivateEndpointConnectionsListResult) MarshalJSON 

func (m MHSMPrivateEndpointConnectionsListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MHSMPrivateEndpointConnectionsListResult.

type MHSMPrivateLinkResource 

type MHSMPrivateLinkResource struct {
	// The supported Azure location where the managed HSM Pool should be created.
	Location *string `json:"location,omitempty"`

	// Resource properties.
	Properties *MHSMPrivateLinkResourceProperties `json:"properties,omitempty"`

	// SKU details
	SKU *ManagedHsmSKU `json:"sku,omitempty"`

	// Resource tags
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; The Azure Resource Manager resource ID for the managed HSM Pool.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the managed HSM Pool.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Metadata pertaining to creation and last modification of the key vault resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The resource type of the managed HSM Pool.
	Type *string `json:"type,omitempty" azure:"ro"`
}

MHSMPrivateLinkResource - A private link resource

func (MHSMPrivateLinkResource) MarshalJSON 

func (m MHSMPrivateLinkResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MHSMPrivateLinkResource.

type MHSMPrivateLinkResourceListResult 

type MHSMPrivateLinkResourceListResult struct {
	// Array of private link resources
	Value []*MHSMPrivateLinkResource `json:"value,omitempty"`
}

MHSMPrivateLinkResourceListResult - A list of private link resources

func (MHSMPrivateLinkResourceListResult) MarshalJSON 

func (m MHSMPrivateLinkResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MHSMPrivateLinkResourceListResult.

type MHSMPrivateLinkResourceProperties 

type MHSMPrivateLinkResourceProperties struct {
	// Required DNS zone names of the the private link resource.
	RequiredZoneNames []*string `json:"requiredZoneNames,omitempty"`

	// READ-ONLY; Group identifier of private link resource.
	GroupID *string `json:"groupId,omitempty" azure:"ro"`

	// READ-ONLY; Required member names of private link resource.
	RequiredMembers []*string `json:"requiredMembers,omitempty" azure:"ro"`
}

MHSMPrivateLinkResourceProperties - Properties of a private link resource.

func (MHSMPrivateLinkResourceProperties) MarshalJSON 

func (m MHSMPrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MHSMPrivateLinkResourceProperties.

type MHSMPrivateLinkResourcesClient 

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

MHSMPrivateLinkResourcesClient contains the methods for the MHSMPrivateLinkResources group. Don't use this type directly, use NewMHSMPrivateLinkResourcesClient() instead.

func NewMHSMPrivateLinkResourcesClient 

func NewMHSMPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *MHSMPrivateLinkResourcesClient

NewMHSMPrivateLinkResourcesClient creates a new instance of MHSMPrivateLinkResourcesClient with the specified values. subscriptionID - Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*MHSMPrivateLinkResourcesClient) ListByMHSMResource 

func (client *MHSMPrivateLinkResourcesClient) ListByMHSMResource(ctx context.Context, resourceGroupName string, name string, options *MHSMPrivateLinkResourcesClientListByMHSMResourceOptions) (MHSMPrivateLinkResourcesClientListByMHSMResourceResponse, error)

ListByMHSMResource - Gets the private link resources supported for the managed hsm pool. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - Name of the resource group that contains the managed HSM pool. name - Name of the managed HSM Pool options - MHSMPrivateLinkResourcesClientListByMHSMResourceOptions contains the optional parameters for the MHSMPrivateLinkResourcesClient.ListByMHSMResource method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/ManagedHsm_listPrivateLinkResources.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewMHSMPrivateLinkResourcesClient("<subscription-id>", cred, nil)
	res, err := client.ListByMHSMResource(ctx,
		"<resource-group-name>",
		"<name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.MHSMPrivateLinkResourcesClientListByMHSMResourceResult)
}

Output:

type MHSMPrivateLinkResourcesClientListByMHSMResourceOptions added in v0.3.0 

type MHSMPrivateLinkResourcesClientListByMHSMResourceOptions struct {
}

MHSMPrivateLinkResourcesClientListByMHSMResourceOptions contains the optional parameters for the MHSMPrivateLinkResourcesClient.ListByMHSMResource method.

type MHSMPrivateLinkResourcesClientListByMHSMResourceResponse added in v0.3.0 

type MHSMPrivateLinkResourcesClientListByMHSMResourceResponse struct {
	MHSMPrivateLinkResourcesClientListByMHSMResourceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

MHSMPrivateLinkResourcesClientListByMHSMResourceResponse contains the response from method MHSMPrivateLinkResourcesClient.ListByMHSMResource.

type MHSMPrivateLinkResourcesClientListByMHSMResourceResult added in v0.3.0 

type MHSMPrivateLinkResourcesClientListByMHSMResourceResult struct {
	MHSMPrivateLinkResourceListResult
}

MHSMPrivateLinkResourcesClientListByMHSMResourceResult contains the result from method MHSMPrivateLinkResourcesClient.ListByMHSMResource.

type MHSMPrivateLinkServiceConnectionState 

type MHSMPrivateLinkServiceConnectionState struct {
	// A message indicating if changes on the service provider require any updates on the consumer.
	ActionsRequired *ActionsRequired `json:"actionsRequired,omitempty"`

	// The reason for approval or rejection.
	Description *string `json:"description,omitempty"`

	// Indicates whether the connection has been approved, rejected or removed by the key vault owner.
	Status *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

MHSMPrivateLinkServiceConnectionState - An object that represents the approval state of the private link connection.

type MHSMVirtualNetworkRule 

type MHSMVirtualNetworkRule struct {
	// REQUIRED; 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"`
}

MHSMVirtualNetworkRule - A rule governing the accessibility of a managed hsm pool from a specific virtual network.

type ManagedHsm 

type ManagedHsm struct {
	// The supported Azure location where the managed HSM Pool should be created.
	Location *string `json:"location,omitempty"`

	// Properties of the managed HSM
	Properties *ManagedHsmProperties `json:"properties,omitempty"`

	// SKU details
	SKU *ManagedHsmSKU `json:"sku,omitempty"`

	// Resource tags
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; The Azure Resource Manager resource ID for the managed HSM Pool.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the managed HSM Pool.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Metadata pertaining to creation and last modification of the key vault resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The resource type of the managed HSM Pool.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ManagedHsm - Resource information with extended details.

func (ManagedHsm) MarshalJSON 

func (m ManagedHsm) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedHsm.

type ManagedHsmError 

type ManagedHsmError struct {
	// READ-ONLY; The server error.
	Error *Error `json:"error,omitempty" azure:"ro"`
}

ManagedHsmError - The error exception.

type ManagedHsmListResult 

type ManagedHsmListResult struct {
	// The URL to get the next set of managed HSM Pools.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of managed HSM Pools.
	Value []*ManagedHsm `json:"value,omitempty"`
}

ManagedHsmListResult - List of managed HSM Pools

func (ManagedHsmListResult) MarshalJSON 

func (m ManagedHsmListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedHsmListResult.

type ManagedHsmProperties 

type ManagedHsmProperties struct {
	// The create mode to indicate whether the resource is being created or is being recovered from a deleted resource.
	CreateMode *CreateMode `json:"createMode,omitempty"`

	// Property specifying whether protection against purge is enabled for this managed HSM pool. Setting this property to true
	// activates protection against purge for this managed HSM pool and its content -
	// only the Managed HSM service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete
	// is also enabled. Enabling this functionality is irreversible.
	EnablePurgeProtection *bool `json:"enablePurgeProtection,omitempty"`

	// Property to specify whether the 'soft delete' functionality is enabled for this managed HSM pool. If it's not set to any
	// value(true or false) when creating new managed HSM pool, it will be set to true
	// by default. Once set to true, it cannot be reverted to false.
	EnableSoftDelete *bool `json:"enableSoftDelete,omitempty"`

	// Array of initial administrators object ids for this managed hsm pool.
	InitialAdminObjectIDs []*string `json:"initialAdminObjectIds,omitempty"`

	// Rules governing the accessibility of the key vault from specific network locations.
	NetworkACLs *MHSMNetworkRuleSet `json:"networkAcls,omitempty"`

	// Control permission for data plane traffic coming from public networks while private endpoint is enabled.
	PublicNetworkAccess *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`

	// softDelete data retention days. It accepts >=7 and <=90.
	SoftDeleteRetentionInDays *int32 `json:"softDeleteRetentionInDays,omitempty"`

	// The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool.
	TenantID *string `json:"tenantId,omitempty"`

	// READ-ONLY; The URI of the managed hsm pool for performing operations on keys.
	HsmURI *string `json:"hsmUri,omitempty" azure:"ro"`

	// READ-ONLY; List of private endpoint connections associated with the managed hsm pool.
	PrivateEndpointConnections []*MHSMPrivateEndpointConnectionItem `json:"privateEndpointConnections,omitempty" azure:"ro"`

	// READ-ONLY; Provisioning state.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The scheduled purge date in UTC.
	ScheduledPurgeDate *time.Time `json:"scheduledPurgeDate,omitempty" azure:"ro"`

	// READ-ONLY; Resource Status Message.
	StatusMessage *string `json:"statusMessage,omitempty" azure:"ro"`
}

ManagedHsmProperties - Properties of the managed HSM Pool

func (ManagedHsmProperties) MarshalJSON 

func (m ManagedHsmProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedHsmProperties.

func (*ManagedHsmProperties) UnmarshalJSON 

func (m *ManagedHsmProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedHsmProperties.

type ManagedHsmResource 

type ManagedHsmResource struct {
	// The supported Azure location where the managed HSM Pool should be created.
	Location *string `json:"location,omitempty"`

	// SKU details
	SKU *ManagedHsmSKU `json:"sku,omitempty"`

	// Resource tags
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; The Azure Resource Manager resource ID for the managed HSM Pool.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the managed HSM Pool.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Metadata pertaining to creation and last modification of the key vault resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The resource type of the managed HSM Pool.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ManagedHsmResource - Managed HSM resource

func (ManagedHsmResource) MarshalJSON 

func (m ManagedHsmResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedHsmResource.

type ManagedHsmSKU 

type ManagedHsmSKU struct {
	// REQUIRED; SKU Family of the managed HSM Pool
	Family *ManagedHsmSKUFamily `json:"family,omitempty"`

	// REQUIRED; SKU of the managed HSM Pool
	Name *ManagedHsmSKUName `json:"name,omitempty"`
}

ManagedHsmSKU - SKU details

type ManagedHsmSKUFamily 

type ManagedHsmSKUFamily string

ManagedHsmSKUFamily - SKU Family of the managed HSM Pool 

const (
	ManagedHsmSKUFamilyB ManagedHsmSKUFamily = "B"
)

func PossibleManagedHsmSKUFamilyValues 

func PossibleManagedHsmSKUFamilyValues() []ManagedHsmSKUFamily

PossibleManagedHsmSKUFamilyValues returns the possible values for the ManagedHsmSKUFamily const type.

func (ManagedHsmSKUFamily) ToPtr 

func (c ManagedHsmSKUFamily) ToPtr() *ManagedHsmSKUFamily

ToPtr returns a *ManagedHsmSKUFamily pointing to the current value.

type ManagedHsmSKUName 

type ManagedHsmSKUName string

ManagedHsmSKUName - SKU of the managed HSM Pool 

const (
	ManagedHsmSKUNameStandardB1 ManagedHsmSKUName = "Standard_B1"
	ManagedHsmSKUNameCustomB32  ManagedHsmSKUName = "Custom_B32"
)

func PossibleManagedHsmSKUNameValues 

func PossibleManagedHsmSKUNameValues() []ManagedHsmSKUName

PossibleManagedHsmSKUNameValues returns the possible values for the ManagedHsmSKUName const type.

func (ManagedHsmSKUName) ToPtr 

func (c ManagedHsmSKUName) ToPtr() *ManagedHsmSKUName

ToPtr returns a *ManagedHsmSKUName pointing to the current value.

type ManagedHsmsClient 

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

ManagedHsmsClient contains the methods for the ManagedHsms group. Don't use this type directly, use NewManagedHsmsClient() instead.

func NewManagedHsmsClient 

func NewManagedHsmsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ManagedHsmsClient

NewManagedHsmsClient creates a new instance of ManagedHsmsClient with the specified values. subscriptionID - Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ManagedHsmsClient) BeginCreateOrUpdate 

func (client *ManagedHsmsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, name string, parameters ManagedHsm, options *ManagedHsmsClientBeginCreateOrUpdateOptions) (ManagedHsmsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Create or update a managed HSM Pool in the specified subscription. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - Name of the resource group that contains the managed HSM pool. name - Name of the managed HSM Pool parameters - Parameters to create or update the managed HSM Pool options - ManagedHsmsClientBeginCreateOrUpdateOptions contains the optional parameters for the ManagedHsmsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/ManagedHsm_CreateOrUpdate.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewManagedHsmsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<name>",
		armkeyvault.ManagedHsm{
			Location: to.StringPtr("<location>"),
			SKU: &armkeyvault.ManagedHsmSKU{
				Name:   armkeyvault.ManagedHsmSKUNameStandardB1.ToPtr(),
				Family: armkeyvault.ManagedHsmSKUFamily("B").ToPtr(),
			},
			Tags: map[string]*string{
				"Dept":        to.StringPtr("hsm"),
				"Environment": to.StringPtr("dogfood"),
			},
			Properties: &armkeyvault.ManagedHsmProperties{
				EnablePurgeProtection: to.BoolPtr(true),
				EnableSoftDelete:      to.BoolPtr(true),
				InitialAdminObjectIDs: []*string{
					to.StringPtr("00000000-0000-0000-0000-000000000000")},
				SoftDeleteRetentionInDays: to.Int32Ptr(90),
				TenantID:                  to.StringPtr("<tenant-id>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ManagedHsmsClientCreateOrUpdateResult)
}

Output:

func (*ManagedHsmsClient) BeginDelete 

func (client *ManagedHsmsClient) BeginDelete(ctx context.Context, resourceGroupName string, name string, options *ManagedHsmsClientBeginDeleteOptions) (ManagedHsmsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified managed HSM Pool. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - Name of the resource group that contains the managed HSM pool. name - The name of the managed HSM Pool to delete options - ManagedHsmsClientBeginDeleteOptions contains the optional parameters for the ManagedHsmsClient.BeginDelete method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/ManagedHsm_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewManagedHsmsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ManagedHsmsClient) BeginPurgeDeleted 

func (client *ManagedHsmsClient) BeginPurgeDeleted(ctx context.Context, name string, location string, options *ManagedHsmsClientBeginPurgeDeletedOptions) (ManagedHsmsClientPurgeDeletedPollerResponse, error)

BeginPurgeDeleted - Permanently deletes the specified managed HSM. If the operation fails it returns an *azcore.ResponseError type. name - The name of the soft-deleted managed HSM. location - The location of the soft-deleted managed HSM. options - ManagedHsmsClientBeginPurgeDeletedOptions contains the optional parameters for the ManagedHsmsClient.BeginPurgeDeleted method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/DeletedManagedHsm_Purge.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewManagedHsmsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginPurgeDeleted(ctx,
		"<name>",
		"<location>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ManagedHsmsClient) BeginUpdate 

func (client *ManagedHsmsClient) BeginUpdate(ctx context.Context, resourceGroupName string, name string, parameters ManagedHsm, options *ManagedHsmsClientBeginUpdateOptions) (ManagedHsmsClientUpdatePollerResponse, error)

BeginUpdate - Update a managed HSM Pool in the specified subscription. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - Name of the resource group that contains the managed HSM pool. name - Name of the managed HSM Pool parameters - Parameters to patch the managed HSM Pool options - ManagedHsmsClientBeginUpdateOptions contains the optional parameters for the ManagedHsmsClient.BeginUpdate method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/ManagedHsm_Update.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewManagedHsmsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpdate(ctx,
		"<resource-group-name>",
		"<name>",
		armkeyvault.ManagedHsm{
			Tags: map[string]*string{
				"Dept":        to.StringPtr("hsm"),
				"Environment": to.StringPtr("dogfood"),
				"Slice":       to.StringPtr("A"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ManagedHsmsClientUpdateResult)
}

Output:

func (*ManagedHsmsClient) Get 

func (client *ManagedHsmsClient) Get(ctx context.Context, resourceGroupName string, name string, options *ManagedHsmsClientGetOptions) (ManagedHsmsClientGetResponse, error)

Get - Gets the specified managed HSM Pool. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - Name of the resource group that contains the managed HSM pool. name - The name of the managed HSM Pool. options - ManagedHsmsClientGetOptions contains the optional parameters for the ManagedHsmsClient.Get method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/ManagedHsm_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewManagedHsmsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ManagedHsmsClientGetResult)
}

Output:

func (*ManagedHsmsClient) GetDeleted 

func (client *ManagedHsmsClient) GetDeleted(ctx context.Context, name string, location string, options *ManagedHsmsClientGetDeletedOptions) (ManagedHsmsClientGetDeletedResponse, error)

GetDeleted - Gets the specified deleted managed HSM. If the operation fails it returns an *azcore.ResponseError type. name - The name of the deleted managed HSM. location - The location of the deleted managed HSM. options - ManagedHsmsClientGetDeletedOptions contains the optional parameters for the ManagedHsmsClient.GetDeleted method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/DeletedManagedHsm_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewManagedHsmsClient("<subscription-id>", cred, nil)
	res, err := client.GetDeleted(ctx,
		"<name>",
		"<location>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ManagedHsmsClientGetDeletedResult)
}

Output:

func (*ManagedHsmsClient) ListByResourceGroup 

func (client *ManagedHsmsClient) ListByResourceGroup(resourceGroupName string, options *ManagedHsmsClientListByResourceGroupOptions) *ManagedHsmsClientListByResourceGroupPager

ListByResourceGroup - The List operation gets information about the managed HSM Pools associated with the subscription and within the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - Name of the resource group that contains the managed HSM pool. options - ManagedHsmsClientListByResourceGroupOptions contains the optional parameters for the ManagedHsmsClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/ManagedHsm_ListByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewManagedHsmsClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		&armkeyvault.ManagedHsmsClientListByResourceGroupOptions{Top: nil})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ManagedHsmsClient) ListBySubscription 

func (client *ManagedHsmsClient) ListBySubscription(options *ManagedHsmsClientListBySubscriptionOptions) *ManagedHsmsClientListBySubscriptionPager

ListBySubscription - The List operation gets information about the managed HSM Pools associated with the subscription. If the operation fails it returns an *azcore.ResponseError type. options - ManagedHsmsClientListBySubscriptionOptions contains the optional parameters for the ManagedHsmsClient.ListBySubscription method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/ManagedHsm_ListBySubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewManagedHsmsClient("<subscription-id>", cred, nil)
	pager := client.ListBySubscription(&armkeyvault.ManagedHsmsClientListBySubscriptionOptions{Top: nil})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*ManagedHsmsClient) ListDeleted 

func (client *ManagedHsmsClient) ListDeleted(options *ManagedHsmsClientListDeletedOptions) *ManagedHsmsClientListDeletedPager

ListDeleted - The List operation gets information about the deleted managed HSMs associated with the subscription. If the operation fails it returns an *azcore.ResponseError type. options - ManagedHsmsClientListDeletedOptions contains the optional parameters for the ManagedHsmsClient.ListDeleted method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/DeletedManagedHsm_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewManagedHsmsClient("<subscription-id>", cred, nil)
	pager := client.ListDeleted(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type ManagedHsmsClientBeginCreateOrUpdateOptions added in v0.3.0 

type ManagedHsmsClientBeginCreateOrUpdateOptions struct {
}

ManagedHsmsClientBeginCreateOrUpdateOptions contains the optional parameters for the ManagedHsmsClient.BeginCreateOrUpdate method.

type ManagedHsmsClientBeginDeleteOptions added in v0.3.0 

type ManagedHsmsClientBeginDeleteOptions struct {
}

ManagedHsmsClientBeginDeleteOptions contains the optional parameters for the ManagedHsmsClient.BeginDelete method.

type ManagedHsmsClientBeginPurgeDeletedOptions added in v0.3.0 

type ManagedHsmsClientBeginPurgeDeletedOptions struct {
}

ManagedHsmsClientBeginPurgeDeletedOptions contains the optional parameters for the ManagedHsmsClient.BeginPurgeDeleted method.

type ManagedHsmsClientBeginUpdateOptions added in v0.3.0 

type ManagedHsmsClientBeginUpdateOptions struct {
}

ManagedHsmsClientBeginUpdateOptions contains the optional parameters for the ManagedHsmsClient.BeginUpdate method.

type ManagedHsmsClientCreateOrUpdatePoller added in v0.3.0 

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

ManagedHsmsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ManagedHsmsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *ManagedHsmsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ManagedHsmsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *ManagedHsmsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (ManagedHsmsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ManagedHsmsClientCreateOrUpdateResponse will be returned.

func (*ManagedHsmsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *ManagedHsmsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ManagedHsmsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *ManagedHsmsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ManagedHsmsClientCreateOrUpdatePollerResponse added in v0.3.0 

type ManagedHsmsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ManagedHsmsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagedHsmsClientCreateOrUpdatePollerResponse contains the response from method ManagedHsmsClient.CreateOrUpdate.

func (ManagedHsmsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ManagedHsmsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ManagedHsmsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ManagedHsmsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *ManagedHsmsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *ManagedHsmsClient, token string) error

Resume rehydrates a ManagedHsmsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type ManagedHsmsClientCreateOrUpdateResponse added in v0.3.0 

type ManagedHsmsClientCreateOrUpdateResponse struct {
	ManagedHsmsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagedHsmsClientCreateOrUpdateResponse contains the response from method ManagedHsmsClient.CreateOrUpdate.

type ManagedHsmsClientCreateOrUpdateResult added in v0.3.0 

type ManagedHsmsClientCreateOrUpdateResult struct {
	ManagedHsm
}

ManagedHsmsClientCreateOrUpdateResult contains the result from method ManagedHsmsClient.CreateOrUpdate.

type ManagedHsmsClientDeletePoller added in v0.3.0 

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

ManagedHsmsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ManagedHsmsClientDeletePoller) Done added in v0.3.0 

func (p *ManagedHsmsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ManagedHsmsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *ManagedHsmsClientDeletePoller) FinalResponse(ctx context.Context) (ManagedHsmsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ManagedHsmsClientDeleteResponse will be returned.

func (*ManagedHsmsClientDeletePoller) Poll added in v0.3.0 

func (p *ManagedHsmsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ManagedHsmsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *ManagedHsmsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ManagedHsmsClientDeletePollerResponse added in v0.3.0 

type ManagedHsmsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ManagedHsmsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagedHsmsClientDeletePollerResponse contains the response from method ManagedHsmsClient.Delete.

func (ManagedHsmsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l ManagedHsmsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ManagedHsmsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ManagedHsmsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *ManagedHsmsClientDeletePollerResponse) Resume(ctx context.Context, client *ManagedHsmsClient, token string) error

Resume rehydrates a ManagedHsmsClientDeletePollerResponse from the provided client and resume token.

type ManagedHsmsClientDeleteResponse added in v0.3.0 

type ManagedHsmsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagedHsmsClientDeleteResponse contains the response from method ManagedHsmsClient.Delete.

type ManagedHsmsClientGetDeletedOptions added in v0.3.0 

type ManagedHsmsClientGetDeletedOptions struct {
}

ManagedHsmsClientGetDeletedOptions contains the optional parameters for the ManagedHsmsClient.GetDeleted method.

type ManagedHsmsClientGetDeletedResponse added in v0.3.0 

type ManagedHsmsClientGetDeletedResponse struct {
	ManagedHsmsClientGetDeletedResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagedHsmsClientGetDeletedResponse contains the response from method ManagedHsmsClient.GetDeleted.

type ManagedHsmsClientGetDeletedResult added in v0.3.0 

type ManagedHsmsClientGetDeletedResult struct {
	DeletedManagedHsm
}

ManagedHsmsClientGetDeletedResult contains the result from method ManagedHsmsClient.GetDeleted.

type ManagedHsmsClientGetOptions added in v0.3.0 

type ManagedHsmsClientGetOptions struct {
}

ManagedHsmsClientGetOptions contains the optional parameters for the ManagedHsmsClient.Get method.

type ManagedHsmsClientGetResponse added in v0.3.0 

type ManagedHsmsClientGetResponse struct {
	ManagedHsmsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagedHsmsClientGetResponse contains the response from method ManagedHsmsClient.Get.

type ManagedHsmsClientGetResult added in v0.3.0 

type ManagedHsmsClientGetResult struct {
	ManagedHsm
}

ManagedHsmsClientGetResult contains the result from method ManagedHsmsClient.Get.

type ManagedHsmsClientListByResourceGroupOptions added in v0.3.0 

type ManagedHsmsClientListByResourceGroupOptions struct {
	// Maximum number of results to return.
	Top *int32
}

ManagedHsmsClientListByResourceGroupOptions contains the optional parameters for the ManagedHsmsClient.ListByResourceGroup method.

type ManagedHsmsClientListByResourceGroupPager added in v0.3.0 

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

ManagedHsmsClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*ManagedHsmsClientListByResourceGroupPager) Err added in v0.3.0 

func (p *ManagedHsmsClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*ManagedHsmsClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *ManagedHsmsClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ManagedHsmsClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *ManagedHsmsClientListByResourceGroupPager) PageResponse() ManagedHsmsClientListByResourceGroupResponse

PageResponse returns the current ManagedHsmsClientListByResourceGroupResponse page.

type ManagedHsmsClientListByResourceGroupResponse added in v0.3.0 

type ManagedHsmsClientListByResourceGroupResponse struct {
	ManagedHsmsClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagedHsmsClientListByResourceGroupResponse contains the response from method ManagedHsmsClient.ListByResourceGroup.

type ManagedHsmsClientListByResourceGroupResult added in v0.3.0 

type ManagedHsmsClientListByResourceGroupResult struct {
	ManagedHsmListResult
}

ManagedHsmsClientListByResourceGroupResult contains the result from method ManagedHsmsClient.ListByResourceGroup.

type ManagedHsmsClientListBySubscriptionOptions added in v0.3.0 

type ManagedHsmsClientListBySubscriptionOptions struct {
	// Maximum number of results to return.
	Top *int32
}

ManagedHsmsClientListBySubscriptionOptions contains the optional parameters for the ManagedHsmsClient.ListBySubscription method.

type ManagedHsmsClientListBySubscriptionPager added in v0.3.0 

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

ManagedHsmsClientListBySubscriptionPager provides operations for iterating over paged responses.

func (*ManagedHsmsClientListBySubscriptionPager) Err added in v0.3.0 

func (p *ManagedHsmsClientListBySubscriptionPager) Err() error

Err returns the last error encountered while paging.

func (*ManagedHsmsClientListBySubscriptionPager) NextPage added in v0.3.0 

func (p *ManagedHsmsClientListBySubscriptionPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ManagedHsmsClientListBySubscriptionPager) PageResponse added in v0.3.0 

func (p *ManagedHsmsClientListBySubscriptionPager) PageResponse() ManagedHsmsClientListBySubscriptionResponse

PageResponse returns the current ManagedHsmsClientListBySubscriptionResponse page.

type ManagedHsmsClientListBySubscriptionResponse added in v0.3.0 

type ManagedHsmsClientListBySubscriptionResponse struct {
	ManagedHsmsClientListBySubscriptionResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagedHsmsClientListBySubscriptionResponse contains the response from method ManagedHsmsClient.ListBySubscription.

type ManagedHsmsClientListBySubscriptionResult added in v0.3.0 

type ManagedHsmsClientListBySubscriptionResult struct {
	ManagedHsmListResult
}

ManagedHsmsClientListBySubscriptionResult contains the result from method ManagedHsmsClient.ListBySubscription.

type ManagedHsmsClientListDeletedOptions added in v0.3.0 

type ManagedHsmsClientListDeletedOptions struct {
}

ManagedHsmsClientListDeletedOptions contains the optional parameters for the ManagedHsmsClient.ListDeleted method.

type ManagedHsmsClientListDeletedPager added in v0.3.0 

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

ManagedHsmsClientListDeletedPager provides operations for iterating over paged responses.

func (*ManagedHsmsClientListDeletedPager) Err added in v0.3.0 

func (p *ManagedHsmsClientListDeletedPager) Err() error

Err returns the last error encountered while paging.

func (*ManagedHsmsClientListDeletedPager) NextPage added in v0.3.0 

func (p *ManagedHsmsClientListDeletedPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ManagedHsmsClientListDeletedPager) PageResponse added in v0.3.0 

func (p *ManagedHsmsClientListDeletedPager) PageResponse() ManagedHsmsClientListDeletedResponse

PageResponse returns the current ManagedHsmsClientListDeletedResponse page.

type ManagedHsmsClientListDeletedResponse added in v0.3.0 

type ManagedHsmsClientListDeletedResponse struct {
	ManagedHsmsClientListDeletedResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagedHsmsClientListDeletedResponse contains the response from method ManagedHsmsClient.ListDeleted.

type ManagedHsmsClientListDeletedResult added in v0.3.0 

type ManagedHsmsClientListDeletedResult struct {
	DeletedManagedHsmListResult
}

ManagedHsmsClientListDeletedResult contains the result from method ManagedHsmsClient.ListDeleted.

type ManagedHsmsClientPurgeDeletedPoller added in v0.3.0 

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

ManagedHsmsClientPurgeDeletedPoller provides polling facilities until the operation reaches a terminal state.

func (*ManagedHsmsClientPurgeDeletedPoller) Done added in v0.3.0 

func (p *ManagedHsmsClientPurgeDeletedPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ManagedHsmsClientPurgeDeletedPoller) FinalResponse added in v0.3.0 

func (p *ManagedHsmsClientPurgeDeletedPoller) FinalResponse(ctx context.Context) (ManagedHsmsClientPurgeDeletedResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ManagedHsmsClientPurgeDeletedResponse will be returned.

func (*ManagedHsmsClientPurgeDeletedPoller) Poll added in v0.3.0 

func (p *ManagedHsmsClientPurgeDeletedPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ManagedHsmsClientPurgeDeletedPoller) ResumeToken added in v0.3.0 

func (p *ManagedHsmsClientPurgeDeletedPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ManagedHsmsClientPurgeDeletedPollerResponse added in v0.3.0 

type ManagedHsmsClientPurgeDeletedPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ManagedHsmsClientPurgeDeletedPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagedHsmsClientPurgeDeletedPollerResponse contains the response from method ManagedHsmsClient.PurgeDeleted.

func (ManagedHsmsClientPurgeDeletedPollerResponse) PollUntilDone added in v0.3.0 

func (l ManagedHsmsClientPurgeDeletedPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ManagedHsmsClientPurgeDeletedResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ManagedHsmsClientPurgeDeletedPollerResponse) Resume added in v0.3.0 

func (l *ManagedHsmsClientPurgeDeletedPollerResponse) Resume(ctx context.Context, client *ManagedHsmsClient, token string) error

Resume rehydrates a ManagedHsmsClientPurgeDeletedPollerResponse from the provided client and resume token.

type ManagedHsmsClientPurgeDeletedResponse added in v0.3.0 

type ManagedHsmsClientPurgeDeletedResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagedHsmsClientPurgeDeletedResponse contains the response from method ManagedHsmsClient.PurgeDeleted.

type ManagedHsmsClientUpdatePoller added in v0.3.0 

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

ManagedHsmsClientUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ManagedHsmsClientUpdatePoller) Done added in v0.3.0 

func (p *ManagedHsmsClientUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ManagedHsmsClientUpdatePoller) FinalResponse added in v0.3.0 

func (p *ManagedHsmsClientUpdatePoller) FinalResponse(ctx context.Context) (ManagedHsmsClientUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ManagedHsmsClientUpdateResponse will be returned.

func (*ManagedHsmsClientUpdatePoller) Poll added in v0.3.0 

func (p *ManagedHsmsClientUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ManagedHsmsClientUpdatePoller) ResumeToken added in v0.3.0 

func (p *ManagedHsmsClientUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ManagedHsmsClientUpdatePollerResponse added in v0.3.0 

type ManagedHsmsClientUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ManagedHsmsClientUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagedHsmsClientUpdatePollerResponse contains the response from method ManagedHsmsClient.Update.

func (ManagedHsmsClientUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l ManagedHsmsClientUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ManagedHsmsClientUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ManagedHsmsClientUpdatePollerResponse) Resume added in v0.3.0 

func (l *ManagedHsmsClientUpdatePollerResponse) Resume(ctx context.Context, client *ManagedHsmsClient, token string) error

Resume rehydrates a ManagedHsmsClientUpdatePollerResponse from the provided client and resume token.

type ManagedHsmsClientUpdateResponse added in v0.3.0 

type ManagedHsmsClientUpdateResponse struct {
	ManagedHsmsClientUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ManagedHsmsClientUpdateResponse contains the response from method ManagedHsmsClient.Update.

type ManagedHsmsClientUpdateResult added in v0.3.0 

type ManagedHsmsClientUpdateResult struct {
	ManagedHsm
}

ManagedHsmsClientUpdateResult contains the result from method ManagedHsmsClient.Update.

type MetricSpecification 

type MetricSpecification struct {
	// The metric aggregation type. Possible values include: 'Average', 'Count', 'Total'.
	AggregationType *string `json:"aggregationType,omitempty"`

	// The dimensions of metric
	Dimensions []*DimensionProperties `json:"dimensions,omitempty"`

	// Display description of metric specification.
	DisplayDescription *string `json:"displayDescription,omitempty"`

	// Display name of metric specification.
	DisplayName *string `json:"displayName,omitempty"`

	// Property to specify whether to fill gap with zero.
	FillGapWithZero *bool `json:"fillGapWithZero,omitempty"`

	// The internal metric name.
	InternalMetricName *string `json:"internalMetricName,omitempty"`

	// The metric lock aggregation type.
	LockAggregationType *string `json:"lockAggregationType,omitempty"`

	// Name of metric specification.
	Name *string `json:"name,omitempty"`

	// The supported aggregation types for the metrics.
	SupportedAggregationTypes []*string `json:"supportedAggregationTypes,omitempty"`

	// The supported time grain types for the metrics.
	SupportedTimeGrainTypes []*string `json:"supportedTimeGrainTypes,omitempty"`

	// The metric unit. Possible values include: 'Bytes', 'Count', 'Milliseconds'.
	Unit *string `json:"unit,omitempty"`
}

MetricSpecification - Metric specification of operation.

func (MetricSpecification) MarshalJSON 

func (m MetricSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MetricSpecification.

type NetworkRuleAction 

type NetworkRuleAction string

NetworkRuleAction - The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. 

const (
	NetworkRuleActionAllow NetworkRuleAction = "Allow"
	NetworkRuleActionDeny  NetworkRuleAction = "Deny"
)

func PossibleNetworkRuleActionValues 

func PossibleNetworkRuleActionValues() []NetworkRuleAction

PossibleNetworkRuleActionValues returns the possible values for the NetworkRuleAction const type.

func (NetworkRuleAction) ToPtr 

func (c NetworkRuleAction) ToPtr() *NetworkRuleAction

ToPtr returns a *NetworkRuleAction pointing to the current value.

type NetworkRuleBypassOptions 

type NetworkRuleBypassOptions string

NetworkRuleBypassOptions - Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'. 

const (
	NetworkRuleBypassOptionsAzureServices NetworkRuleBypassOptions = "AzureServices"
	NetworkRuleBypassOptionsNone          NetworkRuleBypassOptions = "None"
)

func PossibleNetworkRuleBypassOptionsValues 

func PossibleNetworkRuleBypassOptionsValues() []NetworkRuleBypassOptions

PossibleNetworkRuleBypassOptionsValues returns the possible values for the NetworkRuleBypassOptions const type.

func (NetworkRuleBypassOptions) ToPtr 

func (c NetworkRuleBypassOptions) ToPtr() *NetworkRuleBypassOptions

ToPtr returns a *NetworkRuleBypassOptions pointing to the current value.

type NetworkRuleSet 

type NetworkRuleSet struct {
	// Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.
	Bypass *NetworkRuleBypassOptions `json:"bypass,omitempty"`

	// The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property
	// has been evaluated.
	DefaultAction *NetworkRuleAction `json:"defaultAction,omitempty"`

	// The list of IP address rules.
	IPRules []*IPRule `json:"ipRules,omitempty"`

	// The list of virtual network rules.
	VirtualNetworkRules []*VirtualNetworkRule `json:"virtualNetworkRules,omitempty"`
}

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

func (NetworkRuleSet) MarshalJSON 

func (n NetworkRuleSet) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkRuleSet.

type Operation 

type Operation struct {
	// Display metadata associated with the operation.
	Display *OperationDisplay `json:"display,omitempty"`

	// Property to specify whether the action is a data action.
	IsDataAction *bool `json:"isDataAction,omitempty"`

	// Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`

	// Properties of operation, include metric specifications.
	OperationProperties *OperationProperties `json:"properties,omitempty"`

	// The origin of operations.
	Origin *string `json:"origin,omitempty"`
}

Operation - Key Vault REST API operation definition.

type OperationDisplay 

type OperationDisplay struct {
	// Description of operation.
	Description *string `json:"description,omitempty"`

	// Type of operation: get, read, delete, etc.
	Operation *string `json:"operation,omitempty"`

	// Service provider: Microsoft Key Vault.
	Provider *string `json:"provider,omitempty"`

	// Resource on which the operation is performed etc.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplay - Display metadata associated with the operation.

type OperationListResult 

type OperationListResult struct {
	// The URL to get the next set of operations.
	NextLink *string `json:"nextLink,omitempty"`

	// List of Storage operations supported by the Storage resource provider.
	Value []*Operation `json:"value,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) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

type OperationProperties 

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

OperationProperties - Properties of operation, include metric specifications.

type OperationsClient 

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

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) *OperationsClient

NewOperationsClient creates a new instance of OperationsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationsClient) List 

func (client *OperationsClient) List(options *OperationsClientListOptions) *OperationsClientListPager

List - Lists all of the available Key Vault Rest API operations. If the operation fails it returns an *azcore.ResponseError type. options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/listOperations.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewOperationsClient(cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type OperationsClientListOptions added in v0.3.0 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListPager added in v0.3.0 

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

OperationsClientListPager provides operations for iterating over paged responses.

func (*OperationsClientListPager) Err added in v0.3.0 

func (p *OperationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*OperationsClientListPager) NextPage added in v0.3.0 

func (p *OperationsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*OperationsClientListPager) PageResponse added in v0.3.0 

func (p *OperationsClientListPager) PageResponse() OperationsClientListResponse

PageResponse returns the current OperationsClientListResponse page.

type OperationsClientListResponse added in v0.3.0 

type OperationsClientListResponse struct {
	OperationsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type OperationsClientListResult added in v0.3.0 

type OperationsClientListResult struct {
	OperationListResult
}

OperationsClientListResult contains the result from method OperationsClient.List.

type Permissions 

type Permissions struct {
	// Permissions to certificates
	Certificates []*CertificatePermissions `json:"certificates,omitempty"`

	// Permissions to keys
	Keys []*KeyPermissions `json:"keys,omitempty"`

	// Permissions to secrets
	Secrets []*SecretPermissions `json:"secrets,omitempty"`

	// Permissions to storage accounts
	Storage []*StoragePermissions `json:"storage,omitempty"`
}

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

func (Permissions) MarshalJSON 

func (p Permissions) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Permissions.

type PrivateEndpoint 

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

PrivateEndpoint - Private endpoint object properties.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	// Modified whenever there is a change in the state of private endpoint connection.
	Etag *string `json:"etag,omitempty"`

	// Resource properties.
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified identifier of the key vault resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Azure location of the key vault resource.
	Location *string `json:"location,omitempty" azure:"ro"`

	// READ-ONLY; Name of the key vault resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Tags assigned to the key vault resource.
	Tags map[string]*string `json:"tags,omitempty" azure:"ro"`

	// READ-ONLY; Resource type of the key vault resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateEndpointConnection - Private endpoint connection resource.

func (PrivateEndpointConnection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnection.

type PrivateEndpointConnectionItem 

type PrivateEndpointConnectionItem struct {
	// Modified whenever there is a change in the state of private endpoint connection.
	Etag *string `json:"etag,omitempty"`

	// Id of private endpoint connection.
	ID *string `json:"id,omitempty"`

	// Private endpoint connection properties.
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
}

PrivateEndpointConnectionItem - Private endpoint connection item.

type PrivateEndpointConnectionListResult 

type PrivateEndpointConnectionListResult struct {
	// The URL to get the next set of private endpoint connections.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of private endpoint connections.
	Value []*PrivateEndpointConnection `json:"value,omitempty"`
}

PrivateEndpointConnectionListResult - List of private endpoint connections.

func (PrivateEndpointConnectionListResult) MarshalJSON 

func (p PrivateEndpointConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionListResult.

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// Properties of the private endpoint object.
	PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`

	// Approval state of the private link connection.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`

	// Provisioning state of the private endpoint connection.
	ProvisioningState *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}

PrivateEndpointConnectionProperties - Properties of the private endpoint connection resource.

type PrivateEndpointConnectionProvisioningState 

type PrivateEndpointConnectionProvisioningState string

PrivateEndpointConnectionProvisioningState - The current provisioning state. 

const (
	PrivateEndpointConnectionProvisioningStateCreating     PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleting     PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateDisconnected PrivateEndpointConnectionProvisioningState = "Disconnected"
	PrivateEndpointConnectionProvisioningStateFailed       PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateSucceeded    PrivateEndpointConnectionProvisioningState = "Succeeded"
	PrivateEndpointConnectionProvisioningStateUpdating     PrivateEndpointConnectionProvisioningState = "Updating"
)

func PossiblePrivateEndpointConnectionProvisioningStateValues 

func PossiblePrivateEndpointConnectionProvisioningStateValues() []PrivateEndpointConnectionProvisioningState

PossiblePrivateEndpointConnectionProvisioningStateValues returns the possible values for the PrivateEndpointConnectionProvisioningState const type.

func (PrivateEndpointConnectionProvisioningState) ToPtr 

func (c PrivateEndpointConnectionProvisioningState) ToPtr() *PrivateEndpointConnectionProvisioningState

ToPtr returns a *PrivateEndpointConnectionProvisioningState pointing to the current value.

type PrivateEndpointConnectionsClient 

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

PrivateEndpointConnectionsClient contains the methods for the PrivateEndpointConnections group. Don't use this type directly, use NewPrivateEndpointConnectionsClient() instead.

func NewPrivateEndpointConnectionsClient 

func NewPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient with the specified values. subscriptionID - Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateEndpointConnectionsClient) BeginDelete 

func (client *PrivateEndpointConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, vaultName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientBeginDeleteOptions) (PrivateEndpointConnectionsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified private endpoint connection associated with the key vault. If the operation fails it returns an *azcore.ResponseError type. 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. options - PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/deletePrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<vault-name>",
		"<private-endpoint-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateEndpointConnectionsClientDeleteResult)
}

Output:

func (*PrivateEndpointConnectionsClient) Get 

func (client *PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, vaultName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientGetOptions) (PrivateEndpointConnectionsClientGetResponse, error)

Get - Gets the specified private endpoint connection associated with the key vault. If the operation fails it returns an *azcore.ResponseError type. 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. options - PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/getPrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<vault-name>",
		"<private-endpoint-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateEndpointConnectionsClientGetResult)
}

Output:

func (*PrivateEndpointConnectionsClient) ListByResource 

func (client *PrivateEndpointConnectionsClient) ListByResource(resourceGroupName string, vaultName string, options *PrivateEndpointConnectionsClientListByResourceOptions) *PrivateEndpointConnectionsClientListByResourcePager

ListByResource - The List operation gets information about the private endpoint connections associated with the vault. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - Name of the resource group that contains the key vault. vaultName - The name of the key vault. options - PrivateEndpointConnectionsClientListByResourceOptions contains the optional parameters for the PrivateEndpointConnectionsClient.ListByResource method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/listPrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	pager := client.ListByResource("<resource-group-name>",
		"<vault-name>",
		nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*PrivateEndpointConnectionsClient) Put 

func (client *PrivateEndpointConnectionsClient) Put(ctx context.Context, resourceGroupName string, vaultName string, privateEndpointConnectionName string, properties PrivateEndpointConnection, options *PrivateEndpointConnectionsClientPutOptions) (PrivateEndpointConnectionsClientPutResponse, error)

Put - Updates the specified private endpoint connection associated with the key vault. If the operation fails it returns an *azcore.ResponseError type. 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. options - PrivateEndpointConnectionsClientPutOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Put method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/putPrivateEndpointConnection.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.Put(ctx,
		"<resource-group-name>",
		"<vault-name>",
		"<private-endpoint-connection-name>",
		armkeyvault.PrivateEndpointConnection{
			Etag: to.StringPtr("<etag>"),
			Properties: &armkeyvault.PrivateEndpointConnectionProperties{
				PrivateLinkServiceConnectionState: &armkeyvault.PrivateLinkServiceConnectionState{
					Description: to.StringPtr("<description>"),
					Status:      armkeyvault.PrivateEndpointServiceConnectionStatus("Approved").ToPtr(),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateEndpointConnectionsClientPutResult)
}

Output:

type PrivateEndpointConnectionsClientBeginDeleteOptions added in v0.3.0 

type PrivateEndpointConnectionsClientBeginDeleteOptions struct {
}

PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.

type PrivateEndpointConnectionsClientDeletePoller added in v0.3.0 

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

PrivateEndpointConnectionsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateEndpointConnectionsClientDeletePoller) Done added in v0.3.0 

func (p *PrivateEndpointConnectionsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PrivateEndpointConnectionsClientDeletePoller) FinalResponse added in v0.3.0 

func (p *PrivateEndpointConnectionsClientDeletePoller) FinalResponse(ctx context.Context) (PrivateEndpointConnectionsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateEndpointConnectionsClientDeleteResponse will be returned.

func (*PrivateEndpointConnectionsClientDeletePoller) Poll added in v0.3.0 

func (p *PrivateEndpointConnectionsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateEndpointConnectionsClientDeletePoller) ResumeToken added in v0.3.0 

func (p *PrivateEndpointConnectionsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateEndpointConnectionsClientDeletePollerResponse added in v0.3.0 

type PrivateEndpointConnectionsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateEndpointConnectionsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsClientDeletePollerResponse contains the response from method PrivateEndpointConnectionsClient.Delete.

func (PrivateEndpointConnectionsClientDeletePollerResponse) PollUntilDone added in v0.3.0 

func (l PrivateEndpointConnectionsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateEndpointConnectionsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateEndpointConnectionsClientDeletePollerResponse) Resume added in v0.3.0 

func (l *PrivateEndpointConnectionsClientDeletePollerResponse) Resume(ctx context.Context, client *PrivateEndpointConnectionsClient, token string) error

Resume rehydrates a PrivateEndpointConnectionsClientDeletePollerResponse from the provided client and resume token.

type PrivateEndpointConnectionsClientDeleteResponse added in v0.3.0 

type PrivateEndpointConnectionsClientDeleteResponse struct {
	PrivateEndpointConnectionsClientDeleteResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsClientDeleteResponse contains the response from method PrivateEndpointConnectionsClient.Delete.

type PrivateEndpointConnectionsClientDeleteResult added in v0.3.0 

type PrivateEndpointConnectionsClientDeleteResult struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientDeleteResult contains the result from method PrivateEndpointConnectionsClient.Delete.

type PrivateEndpointConnectionsClientGetOptions added in v0.3.0 

type PrivateEndpointConnectionsClientGetOptions struct {
}

PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

type PrivateEndpointConnectionsClientGetResponse added in v0.3.0 

type PrivateEndpointConnectionsClientGetResponse struct {
	PrivateEndpointConnectionsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsClientGetResponse contains the response from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientGetResult added in v0.3.0 

type PrivateEndpointConnectionsClientGetResult struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientGetResult contains the result from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientListByResourceOptions added in v0.3.0 

type PrivateEndpointConnectionsClientListByResourceOptions struct {
}

PrivateEndpointConnectionsClientListByResourceOptions contains the optional parameters for the PrivateEndpointConnectionsClient.ListByResource method.

type PrivateEndpointConnectionsClientListByResourcePager added in v0.3.0 

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

PrivateEndpointConnectionsClientListByResourcePager provides operations for iterating over paged responses.

func (*PrivateEndpointConnectionsClientListByResourcePager) Err added in v0.3.0 

func (p *PrivateEndpointConnectionsClientListByResourcePager) Err() error

Err returns the last error encountered while paging.

func (*PrivateEndpointConnectionsClientListByResourcePager) NextPage added in v0.3.0 

func (p *PrivateEndpointConnectionsClientListByResourcePager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*PrivateEndpointConnectionsClientListByResourcePager) PageResponse added in v0.3.0 

func (p *PrivateEndpointConnectionsClientListByResourcePager) PageResponse() PrivateEndpointConnectionsClientListByResourceResponse

PageResponse returns the current PrivateEndpointConnectionsClientListByResourceResponse page.

type PrivateEndpointConnectionsClientListByResourceResponse added in v0.3.0 

type PrivateEndpointConnectionsClientListByResourceResponse struct {
	PrivateEndpointConnectionsClientListByResourceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsClientListByResourceResponse contains the response from method PrivateEndpointConnectionsClient.ListByResource.

type PrivateEndpointConnectionsClientListByResourceResult added in v0.3.0 

type PrivateEndpointConnectionsClientListByResourceResult struct {
	PrivateEndpointConnectionListResult
}

PrivateEndpointConnectionsClientListByResourceResult contains the result from method PrivateEndpointConnectionsClient.ListByResource.

type PrivateEndpointConnectionsClientPutOptions added in v0.3.0 

type PrivateEndpointConnectionsClientPutOptions struct {
}

PrivateEndpointConnectionsClientPutOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Put method.

type PrivateEndpointConnectionsClientPutResponse added in v0.3.0 

type PrivateEndpointConnectionsClientPutResponse struct {
	PrivateEndpointConnectionsClientPutResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsClientPutResponse contains the response from method PrivateEndpointConnectionsClient.Put.

type PrivateEndpointConnectionsClientPutResult added in v0.3.0 

type PrivateEndpointConnectionsClientPutResult struct {
	PrivateEndpointConnection
	// AzureAsyncOperation contains the information returned from the Azure-AsyncOperation header response.
	AzureAsyncOperation *string

	// RetryAfter contains the information returned from the Retry-After header response.
	RetryAfter *int32
}

PrivateEndpointConnectionsClientPutResult contains the result from method PrivateEndpointConnectionsClient.Put.

type PrivateEndpointServiceConnectionStatus 

type PrivateEndpointServiceConnectionStatus string

PrivateEndpointServiceConnectionStatus - The private endpoint connection status. 

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

func PossiblePrivateEndpointServiceConnectionStatusValues 

func PossiblePrivateEndpointServiceConnectionStatusValues() []PrivateEndpointServiceConnectionStatus

PossiblePrivateEndpointServiceConnectionStatusValues returns the possible values for the PrivateEndpointServiceConnectionStatus const type.

func (PrivateEndpointServiceConnectionStatus) ToPtr 

func (c PrivateEndpointServiceConnectionStatus) ToPtr() *PrivateEndpointServiceConnectionStatus

ToPtr returns a *PrivateEndpointServiceConnectionStatus pointing to the current value.

type PrivateLinkResource 

type PrivateLinkResource struct {
	// Resource properties.
	Properties *PrivateLinkResourceProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified identifier of the key vault resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Azure location of the key vault resource.
	Location *string `json:"location,omitempty" azure:"ro"`

	// READ-ONLY; Name of the key vault resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Tags assigned to the key vault resource.
	Tags map[string]*string `json:"tags,omitempty" azure:"ro"`

	// READ-ONLY; Resource type of the key vault resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateLinkResource - A private link resource

func (PrivateLinkResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResource.

type PrivateLinkResourceListResult 

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

PrivateLinkResourceListResult - A list of private link resources

func (PrivateLinkResourceListResult) MarshalJSON 

func (p PrivateLinkResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceListResult.

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	// Required DNS zone names of the the private link resource.
	RequiredZoneNames []*string `json:"requiredZoneNames,omitempty"`

	// READ-ONLY; Group identifier of private link resource.
	GroupID *string `json:"groupId,omitempty" azure:"ro"`

	// READ-ONLY; Required member names of private link resource.
	RequiredMembers []*string `json:"requiredMembers,omitempty" azure:"ro"`
}

PrivateLinkResourceProperties - Properties of a private link resource.

func (PrivateLinkResourceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceProperties.

type PrivateLinkResourcesClient 

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

PrivateLinkResourcesClient contains the methods for the PrivateLinkResources group. Don't use this type directly, use NewPrivateLinkResourcesClient() instead.

func NewPrivateLinkResourcesClient 

func NewPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient with the specified values. subscriptionID - Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateLinkResourcesClient) ListByVault 

func (client *PrivateLinkResourcesClient) ListByVault(ctx context.Context, resourceGroupName string, vaultName string, options *PrivateLinkResourcesClientListByVaultOptions) (PrivateLinkResourcesClientListByVaultResponse, error)

ListByVault - Gets the private link resources supported for the key vault. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - Name of the resource group that contains the key vault. vaultName - The name of the key vault. options - PrivateLinkResourcesClientListByVaultOptions contains the optional parameters for the PrivateLinkResourcesClient.ListByVault method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/listPrivateLinkResources.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewPrivateLinkResourcesClient("<subscription-id>", cred, nil)
	res, err := client.ListByVault(ctx,
		"<resource-group-name>",
		"<vault-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateLinkResourcesClientListByVaultResult)
}

Output:

type PrivateLinkResourcesClientListByVaultOptions added in v0.3.0 

type PrivateLinkResourcesClientListByVaultOptions struct {
}

PrivateLinkResourcesClientListByVaultOptions contains the optional parameters for the PrivateLinkResourcesClient.ListByVault method.

type PrivateLinkResourcesClientListByVaultResponse added in v0.3.0 

type PrivateLinkResourcesClientListByVaultResponse struct {
	PrivateLinkResourcesClientListByVaultResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkResourcesClientListByVaultResponse contains the response from method PrivateLinkResourcesClient.ListByVault.

type PrivateLinkResourcesClientListByVaultResult added in v0.3.0 

type PrivateLinkResourcesClientListByVaultResult struct {
	PrivateLinkResourceListResult
}

PrivateLinkResourcesClientListByVaultResult contains the result from method PrivateLinkResourcesClient.ListByVault.

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	// A message indicating if changes on the service provider require any updates on the consumer.
	ActionsRequired *ActionsRequired `json:"actionsRequired,omitempty"`

	// The reason for approval or rejection.
	Description *string `json:"description,omitempty"`

	// Indicates whether the connection has been approved, rejected or removed by the key vault owner.
	Status *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

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

type ProvisioningState 

type ProvisioningState string

ProvisioningState - Provisioning state. 

const (
	// ProvisioningStateActivated - The managed HSM pool is ready for normal use.
	ProvisioningStateActivated ProvisioningState = "Activated"
	// ProvisioningStateDeleting - The managed HSM Pool is currently being deleted.
	ProvisioningStateDeleting ProvisioningState = "Deleting"
	// ProvisioningStateFailed - Provisioning of the managed HSM Pool has failed.
	ProvisioningStateFailed ProvisioningState = "Failed"
	// ProvisioningStateProvisioning - The managed HSM Pool is currently being provisioned.
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	// ProvisioningStateRestoring - The managed HSM pool is being restored from full HSM backup.
	ProvisioningStateRestoring ProvisioningState = "Restoring"
	// ProvisioningStateSecurityDomainRestore - The managed HSM pool is waiting for a security domain restore action.
	ProvisioningStateSecurityDomainRestore ProvisioningState = "SecurityDomainRestore"
	// ProvisioningStateSucceeded - The managed HSM Pool has been full provisioned.
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	// ProvisioningStateUpdating - The managed HSM Pool is currently being updated.
	ProvisioningStateUpdating ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

func (ProvisioningState) ToPtr 

func (c ProvisioningState) ToPtr() *ProvisioningState

ToPtr returns a *ProvisioningState pointing to the current value.

type PublicNetworkAccess 

type PublicNetworkAccess string

PublicNetworkAccess - Control permission for data plane traffic coming from public networks while private endpoint is enabled. 

const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func PossiblePublicNetworkAccessValues 

func PossiblePublicNetworkAccessValues() []PublicNetworkAccess

PossiblePublicNetworkAccessValues returns the possible values for the PublicNetworkAccess const type.

func (PublicNetworkAccess) ToPtr 

func (c PublicNetworkAccess) ToPtr() *PublicNetworkAccess

ToPtr returns a *PublicNetworkAccess pointing to the current value.

type Reason 

type Reason string

Reason - The reason that a vault name could not be used. The Reason element is only returned if NameAvailable is false. 

const (
	ReasonAccountNameInvalid Reason = "AccountNameInvalid"
	ReasonAlreadyExists      Reason = "AlreadyExists"
)

func PossibleReasonValues 

func PossibleReasonValues() []Reason

PossibleReasonValues returns the possible values for the Reason const type.

func (Reason) ToPtr 

func (c Reason) ToPtr() *Reason

ToPtr returns a *Reason pointing to the current value.

type Resource 

type Resource struct {
	// READ-ONLY; Fully qualified identifier of the key vault resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Azure location of the key vault resource.
	Location *string `json:"location,omitempty" azure:"ro"`

	// READ-ONLY; Name of the key vault resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Tags assigned to the key vault resource.
	Tags map[string]*string `json:"tags,omitempty" azure:"ro"`

	// READ-ONLY; Resource type of the key vault resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - Key Vault resource

func (Resource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Resource.

type ResourceListResult 

type ResourceListResult struct {
	// The URL to get the next set of vault resources.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of vault resources.
	Value []*Resource `json:"value,omitempty"`
}

ResourceListResult - List of vault resources.

func (ResourceListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ResourceListResult.

type RotationPolicy 

type RotationPolicy struct {
	// The attributes of key rotation policy.
	Attributes *KeyRotationPolicyAttributes `json:"attributes,omitempty"`

	// The lifetimeActions for key rotation action.
	LifetimeActions []*LifetimeAction `json:"lifetimeActions,omitempty"`
}

func (RotationPolicy) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RotationPolicy.

type SKU 

type SKU struct {
	// REQUIRED; SKU family name
	Family *SKUFamily `json:"family,omitempty"`

	// REQUIRED; SKU name to specify whether the key vault is a standard vault or a premium vault.
	Name *SKUName `json:"name,omitempty"`
}

SKU details

type SKUFamily 

type SKUFamily string

SKUFamily - SKU family name 

const (
	SKUFamilyA SKUFamily = "A"
)

func PossibleSKUFamilyValues 

func PossibleSKUFamilyValues() []SKUFamily

PossibleSKUFamilyValues returns the possible values for the SKUFamily const type.

func (SKUFamily) ToPtr 

func (c SKUFamily) ToPtr() *SKUFamily

ToPtr returns a *SKUFamily pointing to the current value.

type SKUName 

type SKUName string

SKUName - SKU name to specify whether the key vault is a standard vault or a premium vault. 

const (
	SKUNameStandard SKUName = "standard"
	SKUNamePremium  SKUName = "premium"
)

func PossibleSKUNameValues 

func PossibleSKUNameValues() []SKUName

PossibleSKUNameValues returns the possible values for the SKUName const type.

func (SKUName) ToPtr 

func (c SKUName) ToPtr() *SKUName

ToPtr returns a *SKUName pointing to the current value.

type Secret 

type Secret struct {
	// REQUIRED; Properties of the secret
	Properties *SecretProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified identifier of the key vault resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Azure location of the key vault resource.
	Location *string `json:"location,omitempty" azure:"ro"`

	// READ-ONLY; Name of the key vault resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Tags assigned to the key vault resource.
	Tags map[string]*string `json:"tags,omitempty" azure:"ro"`

	// READ-ONLY; Resource type of the key vault resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Secret - Resource information with extended details.

func (Secret) MarshalJSON 

func (s Secret) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Secret.

type SecretAttributes 

type SecretAttributes struct {
	// Determines whether the object is enabled.
	Enabled *bool `json:"enabled,omitempty"`

	// Expiry date in seconds since 1970-01-01T00:00:00Z.
	Expires *time.Time `json:"exp,omitempty"`

	// Not before date in seconds since 1970-01-01T00:00:00Z.
	NotBefore *time.Time `json:"nbf,omitempty"`

	// READ-ONLY; Creation time in seconds since 1970-01-01T00:00:00Z.
	Created *time.Time `json:"created,omitempty" azure:"ro"`

	// READ-ONLY; Last updated time in seconds since 1970-01-01T00:00:00Z.
	Updated *time.Time `json:"updated,omitempty" azure:"ro"`
}

SecretAttributes - The secret management attributes.

func (SecretAttributes) MarshalJSON added in v0.3.0 

func (s SecretAttributes) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecretAttributes.

func (*SecretAttributes) UnmarshalJSON added in v0.3.0 

func (s *SecretAttributes) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SecretAttributes.

type SecretCreateOrUpdateParameters 

type SecretCreateOrUpdateParameters struct {
	// REQUIRED; Properties of the secret
	Properties *SecretProperties `json:"properties,omitempty"`

	// The tags that will be assigned to the secret.
	Tags map[string]*string `json:"tags,omitempty"`
}

SecretCreateOrUpdateParameters - Parameters for creating or updating a secret

func (SecretCreateOrUpdateParameters) MarshalJSON 

func (s SecretCreateOrUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecretCreateOrUpdateParameters.

type SecretListResult 

type SecretListResult struct {
	// The URL to get the next set of secrets.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of secrets.
	Value []*Secret `json:"value,omitempty"`
}

SecretListResult - List of secrets

func (SecretListResult) MarshalJSON 

func (s SecretListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecretListResult.

type SecretPatchParameters 

type SecretPatchParameters struct {
	// Properties of the secret
	Properties *SecretPatchProperties `json:"properties,omitempty"`

	// The tags that will be assigned to the secret.
	Tags map[string]*string `json:"tags,omitempty"`
}

SecretPatchParameters - Parameters for patching a secret

func (SecretPatchParameters) MarshalJSON 

func (s SecretPatchParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SecretPatchParameters.

type SecretPatchProperties 

type SecretPatchProperties struct {
	// The attributes of the secret.
	Attributes *SecretAttributes `json:"attributes,omitempty"`

	// The content type of the secret.
	ContentType *string `json:"contentType,omitempty"`

	// The value of the secret.
	Value *string `json:"value,omitempty"`
}

SecretPatchProperties - Properties of the secret

type SecretPermissions 

type SecretPermissions string
const (
	SecretPermissionsAll     SecretPermissions = "all"
	SecretPermissionsBackup  SecretPermissions = "backup"
	SecretPermissionsDelete  SecretPermissions = "delete"
	SecretPermissionsGet     SecretPermissions = "get"
	SecretPermissionsList    SecretPermissions = "list"
	SecretPermissionsPurge   SecretPermissions = "purge"
	SecretPermissionsRecover SecretPermissions = "recover"
	SecretPermissionsRestore SecretPermissions = "restore"
	SecretPermissionsSet     SecretPermissions = "set"
)

func PossibleSecretPermissionsValues 

func PossibleSecretPermissionsValues() []SecretPermissions

PossibleSecretPermissionsValues returns the possible values for the SecretPermissions const type.

func (SecretPermissions) ToPtr 

func (c SecretPermissions) ToPtr() *SecretPermissions

ToPtr returns a *SecretPermissions pointing to the current value.

type SecretProperties 

type SecretProperties struct {
	// The attributes of the secret.
	Attributes *SecretAttributes `json:"attributes,omitempty"`

	// The content type of the secret.
	ContentType *string `json:"contentType,omitempty"`

	// The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended
	// for internal use in ARM deployments. Users should use the data-plane REST
	// service for interaction with vault secrets.
	Value *string `json:"value,omitempty"`

	// READ-ONLY; The URI to retrieve the current version of the secret.
	SecretURI *string `json:"secretUri,omitempty" azure:"ro"`

	// READ-ONLY; The URI to retrieve the specific version of the secret.
	SecretURIWithVersion *string `json:"secretUriWithVersion,omitempty" azure:"ro"`
}

SecretProperties - Properties of the secret

type SecretsClient 

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

SecretsClient contains the methods for the Secrets group. Don't use this type directly, use NewSecretsClient() instead.

func NewSecretsClient 

func NewSecretsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *SecretsClient

NewSecretsClient creates a new instance of SecretsClient with the specified values. subscriptionID - Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SecretsClient) CreateOrUpdate 

func (client *SecretsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, vaultName string, secretName string, parameters SecretCreateOrUpdateParameters, options *SecretsClientCreateOrUpdateOptions) (SecretsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update a secret in a key vault in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the Resource Group to which the vault belongs. vaultName - Name of the vault secretName - Name of the secret parameters - Parameters to create or update the secret options - SecretsClientCreateOrUpdateOptions contains the optional parameters for the SecretsClient.CreateOrUpdate method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/createSecret.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewSecretsClient("<subscription-id>", cred, nil)
	res, err := client.CreateOrUpdate(ctx,
		"<resource-group-name>",
		"<vault-name>",
		"<secret-name>",
		armkeyvault.SecretCreateOrUpdateParameters{
			Properties: &armkeyvault.SecretProperties{
				Value: to.StringPtr("<value>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.SecretsClientCreateOrUpdateResult)
}

Output:

func (*SecretsClient) Get 

func (client *SecretsClient) Get(ctx context.Context, resourceGroupName string, vaultName string, secretName string, options *SecretsClientGetOptions) (SecretsClientGetResponse, error)

Get - Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the Resource Group to which the vault belongs. vaultName - The name of the vault. secretName - The name of the secret. options - SecretsClientGetOptions contains the optional parameters for the SecretsClient.Get method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/getSecret.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewSecretsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<vault-name>",
		"<secret-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.SecretsClientGetResult)
}

Output:

func (*SecretsClient) List 

func (client *SecretsClient) List(resourceGroupName string, vaultName string, options *SecretsClientListOptions) *SecretsClientListPager

List - The List operation gets information about the secrets in a vault. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the Resource Group to which the vault belongs. vaultName - The name of the vault. options - SecretsClientListOptions contains the optional parameters for the SecretsClient.List method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/listSecrets.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewSecretsClient("<subscription-id>", cred, nil)
	pager := client.List("<resource-group-name>",
		"<vault-name>",
		&armkeyvault.SecretsClientListOptions{Top: nil})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*SecretsClient) Update 

func (client *SecretsClient) Update(ctx context.Context, resourceGroupName string, vaultName string, secretName string, parameters SecretPatchParameters, options *SecretsClientUpdateOptions) (SecretsClientUpdateResponse, error)

Update - Update a secret in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the Resource Group to which the vault belongs. vaultName - Name of the vault secretName - Name of the secret parameters - Parameters to patch the secret options - SecretsClientUpdateOptions contains the optional parameters for the SecretsClient.Update method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/updateSecret.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewSecretsClient("<subscription-id>", cred, nil)
	res, err := client.Update(ctx,
		"<resource-group-name>",
		"<vault-name>",
		"<secret-name>",
		armkeyvault.SecretPatchParameters{
			Properties: &armkeyvault.SecretPatchProperties{
				Value: to.StringPtr("<value>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.SecretsClientUpdateResult)
}

Output:

type SecretsClientCreateOrUpdateOptions added in v0.3.0 

type SecretsClientCreateOrUpdateOptions struct {
}

SecretsClientCreateOrUpdateOptions contains the optional parameters for the SecretsClient.CreateOrUpdate method.

type SecretsClientCreateOrUpdateResponse added in v0.3.0 

type SecretsClientCreateOrUpdateResponse struct {
	SecretsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecretsClientCreateOrUpdateResponse contains the response from method SecretsClient.CreateOrUpdate.

type SecretsClientCreateOrUpdateResult added in v0.3.0 

type SecretsClientCreateOrUpdateResult struct {
	Secret
}

SecretsClientCreateOrUpdateResult contains the result from method SecretsClient.CreateOrUpdate.

type SecretsClientGetOptions added in v0.3.0 

type SecretsClientGetOptions struct {
}

SecretsClientGetOptions contains the optional parameters for the SecretsClient.Get method.

type SecretsClientGetResponse added in v0.3.0 

type SecretsClientGetResponse struct {
	SecretsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecretsClientGetResponse contains the response from method SecretsClient.Get.

type SecretsClientGetResult added in v0.3.0 

type SecretsClientGetResult struct {
	Secret
}

SecretsClientGetResult contains the result from method SecretsClient.Get.

type SecretsClientListOptions added in v0.3.0 

type SecretsClientListOptions struct {
	// Maximum number of results to return.
	Top *int32
}

SecretsClientListOptions contains the optional parameters for the SecretsClient.List method.

type SecretsClientListPager added in v0.3.0 

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

SecretsClientListPager provides operations for iterating over paged responses.

func (*SecretsClientListPager) Err added in v0.3.0 

func (p *SecretsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*SecretsClientListPager) NextPage added in v0.3.0 

func (p *SecretsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*SecretsClientListPager) PageResponse added in v0.3.0 

func (p *SecretsClientListPager) PageResponse() SecretsClientListResponse

PageResponse returns the current SecretsClientListResponse page.

type SecretsClientListResponse added in v0.3.0 

type SecretsClientListResponse struct {
	SecretsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecretsClientListResponse contains the response from method SecretsClient.List.

type SecretsClientListResult added in v0.3.0 

type SecretsClientListResult struct {
	SecretListResult
}

SecretsClientListResult contains the result from method SecretsClient.List.

type SecretsClientUpdateOptions added in v0.3.0 

type SecretsClientUpdateOptions struct {
}

SecretsClientUpdateOptions contains the optional parameters for the SecretsClient.Update method.

type SecretsClientUpdateResponse added in v0.3.0 

type SecretsClientUpdateResponse struct {
	SecretsClientUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SecretsClientUpdateResponse contains the response from method SecretsClient.Update.

type SecretsClientUpdateResult added in v0.3.0 

type SecretsClientUpdateResult struct {
	Secret
}

SecretsClientUpdateResult contains the result from method SecretsClient.Update.

type ServiceSpecification 

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

	// Metric specifications of operation.
	MetricSpecifications []*MetricSpecification `json:"metricSpecifications,omitempty"`
}

ServiceSpecification - One property of operation, include log specifications.

func (ServiceSpecification) MarshalJSON 

func (s ServiceSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceSpecification.

type StoragePermissions 

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

func PossibleStoragePermissionsValues 

func PossibleStoragePermissionsValues() []StoragePermissions

PossibleStoragePermissionsValues returns the possible values for the StoragePermissions const type.

func (StoragePermissions) ToPtr 

func (c StoragePermissions) ToPtr() *StoragePermissions

ToPtr returns a *StoragePermissions pointing to the current value.

type SystemData 

type SystemData struct {
	// The timestamp of the key vault resource creation (UTC).
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// The identity that created the key vault resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the key vault resource.
	CreatedByType *IdentityType `json:"createdByType,omitempty"`

	// The timestamp of the key vault resource last modification (UTC).
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the key vault resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the key vault resource.
	LastModifiedByType *IdentityType `json:"lastModifiedByType,omitempty"`
}

SystemData - Metadata pertaining to creation and last modification of the key vault resource.

func (SystemData) MarshalJSON 

func (s SystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON 

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type Trigger 

type Trigger struct {
	// The time duration after key creation to rotate the key. It only applies to rotate. It will be in ISO 8601 duration format.
	// Eg: 'P90D', 'P1Y'.
	TimeAfterCreate *string `json:"timeAfterCreate,omitempty"`

	// The time duration before key expiring to rotate or notify. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'.
	TimeBeforeExpiry *string `json:"timeBeforeExpiry,omitempty"`
}

type Vault 

type Vault struct {
	// REQUIRED; Properties of the vault
	Properties *VaultProperties `json:"properties,omitempty"`

	// Azure location of the key vault resource.
	Location *string `json:"location,omitempty"`

	// Tags assigned to the key vault resource.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified identifier of the key vault resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Name of the key vault resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; System metadata for the key vault.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; Resource type of the key vault resource.
	Type *string `json:"type,omitempty" azure:"ro"`
}

Vault - Resource information with extended details.

func (Vault) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Vault.

type VaultAccessPolicyParameters 

type VaultAccessPolicyParameters struct {
	// REQUIRED; Properties of the access policy
	Properties *VaultAccessPolicyProperties `json:"properties,omitempty"`

	// READ-ONLY; The resource id of the access policy.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The resource type of the access policy.
	Location *string `json:"location,omitempty" azure:"ro"`

	// READ-ONLY; The resource name of the access policy.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The resource name of the access policy.
	Type *string `json:"type,omitempty" azure:"ro"`
}

VaultAccessPolicyParameters - Parameters for updating the access policy in a vault

type VaultAccessPolicyProperties 

type VaultAccessPolicyProperties struct {
	// REQUIRED; 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

func (VaultAccessPolicyProperties) MarshalJSON 

func (v VaultAccessPolicyProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VaultAccessPolicyProperties.

type VaultCheckNameAvailabilityParameters 

type VaultCheckNameAvailabilityParameters struct {
	// REQUIRED; The vault name.
	Name *string `json:"name,omitempty"`

	// REQUIRED; 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 {
	// REQUIRED; The supported Azure location where the key vault should be created.
	Location *string `json:"location,omitempty"`

	// REQUIRED; Properties of the vault
	Properties *VaultProperties `json:"properties,omitempty"`

	// The tags that will be assigned to the key vault.
	Tags map[string]*string `json:"tags,omitempty"`
}

VaultCreateOrUpdateParameters - Parameters for creating or updating a vault

func (VaultCreateOrUpdateParameters) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type VaultCreateOrUpdateParameters.

type VaultListResult 

type VaultListResult struct {
	// The URL to get the next set of vaults.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of vaults.
	Value []*Vault `json:"value,omitempty"`
}

VaultListResult - List of vaults

func (VaultListResult) MarshalJSON 

func (v VaultListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VaultListResult.

type VaultPatchParameters 

type VaultPatchParameters struct {
	// Properties of the vault
	Properties *VaultPatchProperties `json:"properties,omitempty"`

	// The tags that will be assigned to the key vault.
	Tags map[string]*string `json:"tags,omitempty"`
}

VaultPatchParameters - Parameters for creating or updating a vault

func (VaultPatchParameters) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type VaultPatchParameters.

type VaultPatchProperties 

type VaultPatchProperties struct {
	// 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"`

	// The vault's create mode to indicate whether the vault need to be recovered or not.
	CreateMode *CreateMode `json:"createMode,omitempty"`

	// 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"`

	// Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC)
	// for authorization of data actions, and the access policies specified in vault
	// properties will be ignored (warning: this is a preview feature). When false, the key vault will use the access policies
	// specified in vault properties, and any policy stored on Azure Resource Manager
	// will be ignored. If null or not specified, the value of this property will not change.
	EnableRbacAuthorization *bool `json:"enableRbacAuthorization,omitempty"`

	// Property to specify whether the 'soft delete' functionality is enabled for this key vault. Once set to true, it cannot
	// be reverted to false.
	EnableSoftDelete *bool `json:"enableSoftDelete,omitempty"`

	// Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key
	// vault.
	EnabledForDeployment *bool `json:"enabledForDeployment,omitempty"`

	// Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
	EnabledForDiskEncryption *bool `json:"enabledForDiskEncryption,omitempty"`

	// Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
	EnabledForTemplateDeployment *bool `json:"enabledForTemplateDeployment,omitempty"`

	// A collection of rules governing the accessibility of the vault from specific network locations.
	NetworkACLs *NetworkRuleSet `json:"networkAcls,omitempty"`

	// Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except
	// private endpoint traffic and that that originates from trusted services will be
	// blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor
	// the rules.
	PublicNetworkAccess *string `json:"publicNetworkAccess,omitempty"`

	// SKU details
	SKU *SKU `json:"sku,omitempty"`

	// softDelete data retention days. It accepts >=7 and <=90.
	SoftDeleteRetentionInDays *int32 `json:"softDeleteRetentionInDays,omitempty"`

	// The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
	TenantID *string `json:"tenantId,omitempty"`
}

VaultPatchProperties - Properties of the vault

func (VaultPatchProperties) MarshalJSON 

func (v VaultPatchProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VaultPatchProperties.

type VaultProperties 

type VaultProperties struct {
	// REQUIRED; SKU details
	SKU *SKU `json:"sku,omitempty"`

	// REQUIRED; The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
	TenantID *string `json:"tenantId,omitempty"`

	// 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"`

	// The vault's create mode to indicate whether the vault need to be recovered or not.
	CreateMode *CreateMode `json:"createMode,omitempty"`

	// 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"`

	// Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC)
	// for authorization of data actions, and the access policies specified in vault
	// properties will be ignored (warning: this is a preview feature). When false, the key vault will use the access policies
	// specified in vault properties, and any policy stored on Azure Resource Manager
	// will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions
	// are always authorized with RBAC.
	EnableRbacAuthorization *bool `json:"enableRbacAuthorization,omitempty"`

	// Property to specify whether the 'soft delete' functionality is enabled for this key vault. If it's not set to any value(true
	// or false) when creating new key vault, it will be set to true by default.
	// Once set to true, it cannot be reverted to false.
	EnableSoftDelete *bool `json:"enableSoftDelete,omitempty"`

	// Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key
	// vault.
	EnabledForDeployment *bool `json:"enabledForDeployment,omitempty"`

	// Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
	EnabledForDiskEncryption *bool `json:"enabledForDiskEncryption,omitempty"`

	// Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
	EnabledForTemplateDeployment *bool `json:"enabledForTemplateDeployment,omitempty"`

	// Rules governing the accessibility of the key vault from specific network locations.
	NetworkACLs *NetworkRuleSet `json:"networkAcls,omitempty"`

	// Provisioning state of the vault.
	ProvisioningState *VaultProvisioningState `json:"provisioningState,omitempty"`

	// Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except
	// private endpoint traffic and that that originates from trusted services will be
	// blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor
	// the rules.
	PublicNetworkAccess *string `json:"publicNetworkAccess,omitempty"`

	// softDelete data retention days. It accepts >=7 and <=90.
	SoftDeleteRetentionInDays *int32 `json:"softDeleteRetentionInDays,omitempty"`

	// The URI of the vault for performing operations on keys and secrets.
	VaultURI *string `json:"vaultUri,omitempty"`

	// READ-ONLY; The resource id of HSM Pool.
	HsmPoolResourceID *string `json:"hsmPoolResourceId,omitempty" azure:"ro"`

	// READ-ONLY; List of private endpoint connections associated with the key vault.
	PrivateEndpointConnections []*PrivateEndpointConnectionItem `json:"privateEndpointConnections,omitempty" azure:"ro"`
}

VaultProperties - Properties of the vault

func (VaultProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type VaultProperties.

type VaultProvisioningState 

type VaultProvisioningState string

VaultProvisioningState - Provisioning state of the vault. 

const (
	VaultProvisioningStateRegisteringDNS VaultProvisioningState = "RegisteringDns"
	VaultProvisioningStateSucceeded      VaultProvisioningState = "Succeeded"
)

func PossibleVaultProvisioningStateValues 

func PossibleVaultProvisioningStateValues() []VaultProvisioningState

PossibleVaultProvisioningStateValues returns the possible values for the VaultProvisioningState const type.

func (VaultProvisioningState) ToPtr 

func (c VaultProvisioningState) ToPtr() *VaultProvisioningState

ToPtr returns a *VaultProvisioningState pointing to the current value.

type VaultsClient 

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

VaultsClient contains the methods for the Vaults group. Don't use this type directly, use NewVaultsClient() instead.

func NewVaultsClient 

func NewVaultsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *VaultsClient

NewVaultsClient creates a new instance of VaultsClient with the specified values. subscriptionID - Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*VaultsClient) BeginCreateOrUpdate 

func (client *VaultsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, vaultName string, parameters VaultCreateOrUpdateParameters, options *VaultsClientBeginCreateOrUpdateOptions) (VaultsClientCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Create or update a key vault in the specified subscription. If the operation fails it returns an *azcore.ResponseError type. 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 options - VaultsClientBeginCreateOrUpdateOptions contains the optional parameters for the VaultsClient.BeginCreateOrUpdate method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/createVault.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewVaultsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreateOrUpdate(ctx,
		"<resource-group-name>",
		"<vault-name>",
		armkeyvault.VaultCreateOrUpdateParameters{
			Location: to.StringPtr("<location>"),
			Properties: &armkeyvault.VaultProperties{
				AccessPolicies: []*armkeyvault.AccessPolicyEntry{
					{
						ObjectID: to.StringPtr("<object-id>"),
						Permissions: &armkeyvault.Permissions{
							Certificates: []*armkeyvault.CertificatePermissions{
								armkeyvault.CertificatePermissions("get").ToPtr(),
								armkeyvault.CertificatePermissions("list").ToPtr(),
								armkeyvault.CertificatePermissions("delete").ToPtr(),
								armkeyvault.CertificatePermissions("create").ToPtr(),
								armkeyvault.CertificatePermissions("import").ToPtr(),
								armkeyvault.CertificatePermissions("update").ToPtr(),
								armkeyvault.CertificatePermissions("managecontacts").ToPtr(),
								armkeyvault.CertificatePermissions("getissuers").ToPtr(),
								armkeyvault.CertificatePermissions("listissuers").ToPtr(),
								armkeyvault.CertificatePermissions("setissuers").ToPtr(),
								armkeyvault.CertificatePermissions("deleteissuers").ToPtr(),
								armkeyvault.CertificatePermissions("manageissuers").ToPtr(),
								armkeyvault.CertificatePermissions("recover").ToPtr(),
								armkeyvault.CertificatePermissions("purge").ToPtr()},
							Keys: []*armkeyvault.KeyPermissions{
								armkeyvault.KeyPermissions("encrypt").ToPtr(),
								armkeyvault.KeyPermissions("decrypt").ToPtr(),
								armkeyvault.KeyPermissions("wrapKey").ToPtr(),
								armkeyvault.KeyPermissions("unwrapKey").ToPtr(),
								armkeyvault.KeyPermissions("sign").ToPtr(),
								armkeyvault.KeyPermissions("verify").ToPtr(),
								armkeyvault.KeyPermissions("get").ToPtr(),
								armkeyvault.KeyPermissions("list").ToPtr(),
								armkeyvault.KeyPermissions("create").ToPtr(),
								armkeyvault.KeyPermissions("update").ToPtr(),
								armkeyvault.KeyPermissions("import").ToPtr(),
								armkeyvault.KeyPermissions("delete").ToPtr(),
								armkeyvault.KeyPermissions("backup").ToPtr(),
								armkeyvault.KeyPermissions("restore").ToPtr(),
								armkeyvault.KeyPermissions("recover").ToPtr(),
								armkeyvault.KeyPermissions("purge").ToPtr()},
							Secrets: []*armkeyvault.SecretPermissions{
								armkeyvault.SecretPermissions("get").ToPtr(),
								armkeyvault.SecretPermissions("list").ToPtr(),
								armkeyvault.SecretPermissions("set").ToPtr(),
								armkeyvault.SecretPermissions("delete").ToPtr(),
								armkeyvault.SecretPermissions("backup").ToPtr(),
								armkeyvault.SecretPermissions("restore").ToPtr(),
								armkeyvault.SecretPermissions("recover").ToPtr(),
								armkeyvault.SecretPermissions("purge").ToPtr()},
						},
						TenantID: to.StringPtr("<tenant-id>"),
					}},
				EnabledForDeployment:         to.BoolPtr(true),
				EnabledForDiskEncryption:     to.BoolPtr(true),
				EnabledForTemplateDeployment: to.BoolPtr(true),
				PublicNetworkAccess:          to.StringPtr("<public-network-access>"),
				SKU: &armkeyvault.SKU{
					Name:   armkeyvault.SKUNameStandard.ToPtr(),
					Family: armkeyvault.SKUFamily("A").ToPtr(),
				},
				TenantID: to.StringPtr("<tenant-id>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VaultsClientCreateOrUpdateResult)
}

Output:

func (*VaultsClient) BeginPurgeDeleted 

func (client *VaultsClient) BeginPurgeDeleted(ctx context.Context, vaultName string, location string, options *VaultsClientBeginPurgeDeletedOptions) (VaultsClientPurgeDeletedPollerResponse, error)

BeginPurgeDeleted - Permanently deletes the specified vault. aka Purges the deleted Azure key vault. If the operation fails it returns an *azcore.ResponseError type. vaultName - The name of the soft-deleted vault. location - The location of the soft-deleted vault. options - VaultsClientBeginPurgeDeletedOptions contains the optional parameters for the VaultsClient.BeginPurgeDeleted method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/purgeDeletedVault.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewVaultsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginPurgeDeleted(ctx,
		"<vault-name>",
		"<location>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VaultsClient) CheckNameAvailability 

func (client *VaultsClient) CheckNameAvailability(ctx context.Context, vaultName VaultCheckNameAvailabilityParameters, options *VaultsClientCheckNameAvailabilityOptions) (VaultsClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Checks that the vault name is valid and is not already in use. If the operation fails it returns an *azcore.ResponseError type. vaultName - The name of the vault. options - VaultsClientCheckNameAvailabilityOptions contains the optional parameters for the VaultsClient.CheckNameAvailability method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/checkVaultNameAvailability.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewVaultsClient("<subscription-id>", cred, nil)
	res, err := client.CheckNameAvailability(ctx,
		armkeyvault.VaultCheckNameAvailabilityParameters{
			Name: to.StringPtr("<name>"),
			Type: to.StringPtr("<type>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VaultsClientCheckNameAvailabilityResult)
}

Output:

func (*VaultsClient) Delete 

func (client *VaultsClient) Delete(ctx context.Context, resourceGroupName string, vaultName string, options *VaultsClientDeleteOptions) (VaultsClientDeleteResponse, error)

Delete - Deletes the specified Azure key vault. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the Resource Group to which the vault belongs. vaultName - The name of the vault to delete options - VaultsClientDeleteOptions contains the optional parameters for the VaultsClient.Delete method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/deleteVault.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewVaultsClient("<subscription-id>", cred, nil)
	_, err = client.Delete(ctx,
		"<resource-group-name>",
		"<vault-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*VaultsClient) Get 

func (client *VaultsClient) Get(ctx context.Context, resourceGroupName string, vaultName string, options *VaultsClientGetOptions) (VaultsClientGetResponse, error)

Get - Gets the specified Azure key vault. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the Resource Group to which the vault belongs. vaultName - The name of the vault. options - VaultsClientGetOptions contains the optional parameters for the VaultsClient.Get method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/getVault.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewVaultsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<vault-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VaultsClientGetResult)
}

Output:

func (*VaultsClient) GetDeleted 

func (client *VaultsClient) GetDeleted(ctx context.Context, vaultName string, location string, options *VaultsClientGetDeletedOptions) (VaultsClientGetDeletedResponse, error)

GetDeleted - Gets the deleted Azure key vault. If the operation fails it returns an *azcore.ResponseError type. vaultName - The name of the vault. location - The location of the deleted vault. options - VaultsClientGetDeletedOptions contains the optional parameters for the VaultsClient.GetDeleted method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/getDeletedVault.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewVaultsClient("<subscription-id>", cred, nil)
	res, err := client.GetDeleted(ctx,
		"<vault-name>",
		"<location>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VaultsClientGetDeletedResult)
}

Output:

func (*VaultsClient) List 

func (client *VaultsClient) List(options *VaultsClientListOptions) *VaultsClientListPager

List - The List operation gets information about the vaults associated with the subscription. If the operation fails it returns an *azcore.ResponseError type. options - VaultsClientListOptions contains the optional parameters for the VaultsClient.List method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/listVault.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewVaultsClient("<subscription-id>", cred, nil)
	pager := client.List(&armkeyvault.VaultsClientListOptions{Top: to.Int32Ptr(1)})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VaultsClient) ListByResourceGroup 

func (client *VaultsClient) ListByResourceGroup(resourceGroupName string, options *VaultsClientListByResourceGroupOptions) *VaultsClientListByResourceGroupPager

ListByResourceGroup - The List operation gets information about the vaults associated with the subscription and within the specified resource group. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the Resource Group to which the vault belongs. options - VaultsClientListByResourceGroupOptions contains the optional parameters for the VaultsClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/listVaultByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewVaultsClient("<subscription-id>", cred, nil)
	pager := client.ListByResourceGroup("<resource-group-name>",
		&armkeyvault.VaultsClientListByResourceGroupOptions{Top: to.Int32Ptr(1)})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VaultsClient) ListBySubscription 

func (client *VaultsClient) ListBySubscription(options *VaultsClientListBySubscriptionOptions) *VaultsClientListBySubscriptionPager

ListBySubscription - The List operation gets information about the vaults associated with the subscription. If the operation fails it returns an *azcore.ResponseError type. options - VaultsClientListBySubscriptionOptions contains the optional parameters for the VaultsClient.ListBySubscription method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/listVaultBySubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewVaultsClient("<subscription-id>", cred, nil)
	pager := client.ListBySubscription(&armkeyvault.VaultsClientListBySubscriptionOptions{Top: to.Int32Ptr(1)})
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VaultsClient) ListDeleted 

func (client *VaultsClient) ListDeleted(options *VaultsClientListDeletedOptions) *VaultsClientListDeletedPager

ListDeleted - Gets information about the deleted vaults in a subscription. If the operation fails it returns an *azcore.ResponseError type. options - VaultsClientListDeletedOptions contains the optional parameters for the VaultsClient.ListDeleted method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/listDeletedVaults.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewVaultsClient("<subscription-id>", cred, nil)
	pager := client.ListDeleted(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

func (*VaultsClient) Update 

func (client *VaultsClient) Update(ctx context.Context, resourceGroupName string, vaultName string, parameters VaultPatchParameters, options *VaultsClientUpdateOptions) (VaultsClientUpdateResponse, error)

Update - Update a key vault in the specified subscription. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the Resource Group to which the server belongs. vaultName - Name of the vault parameters - Parameters to patch the vault options - VaultsClientUpdateOptions contains the optional parameters for the VaultsClient.Update method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/updateVault.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewVaultsClient("<subscription-id>", cred, nil)
	res, err := client.Update(ctx,
		"<resource-group-name>",
		"<vault-name>",
		armkeyvault.VaultPatchParameters{
			Properties: &armkeyvault.VaultPatchProperties{
				AccessPolicies: []*armkeyvault.AccessPolicyEntry{
					{
						ObjectID: to.StringPtr("<object-id>"),
						Permissions: &armkeyvault.Permissions{
							Certificates: []*armkeyvault.CertificatePermissions{
								armkeyvault.CertificatePermissions("get").ToPtr(),
								armkeyvault.CertificatePermissions("list").ToPtr(),
								armkeyvault.CertificatePermissions("delete").ToPtr(),
								armkeyvault.CertificatePermissions("create").ToPtr(),
								armkeyvault.CertificatePermissions("import").ToPtr(),
								armkeyvault.CertificatePermissions("update").ToPtr(),
								armkeyvault.CertificatePermissions("managecontacts").ToPtr(),
								armkeyvault.CertificatePermissions("getissuers").ToPtr(),
								armkeyvault.CertificatePermissions("listissuers").ToPtr(),
								armkeyvault.CertificatePermissions("setissuers").ToPtr(),
								armkeyvault.CertificatePermissions("deleteissuers").ToPtr(),
								armkeyvault.CertificatePermissions("manageissuers").ToPtr(),
								armkeyvault.CertificatePermissions("recover").ToPtr(),
								armkeyvault.CertificatePermissions("purge").ToPtr()},
							Keys: []*armkeyvault.KeyPermissions{
								armkeyvault.KeyPermissions("encrypt").ToPtr(),
								armkeyvault.KeyPermissions("decrypt").ToPtr(),
								armkeyvault.KeyPermissions("wrapKey").ToPtr(),
								armkeyvault.KeyPermissions("unwrapKey").ToPtr(),
								armkeyvault.KeyPermissions("sign").ToPtr(),
								armkeyvault.KeyPermissions("verify").ToPtr(),
								armkeyvault.KeyPermissions("get").ToPtr(),
								armkeyvault.KeyPermissions("list").ToPtr(),
								armkeyvault.KeyPermissions("create").ToPtr(),
								armkeyvault.KeyPermissions("update").ToPtr(),
								armkeyvault.KeyPermissions("import").ToPtr(),
								armkeyvault.KeyPermissions("delete").ToPtr(),
								armkeyvault.KeyPermissions("backup").ToPtr(),
								armkeyvault.KeyPermissions("restore").ToPtr(),
								armkeyvault.KeyPermissions("recover").ToPtr(),
								armkeyvault.KeyPermissions("purge").ToPtr()},
							Secrets: []*armkeyvault.SecretPermissions{
								armkeyvault.SecretPermissions("get").ToPtr(),
								armkeyvault.SecretPermissions("list").ToPtr(),
								armkeyvault.SecretPermissions("set").ToPtr(),
								armkeyvault.SecretPermissions("delete").ToPtr(),
								armkeyvault.SecretPermissions("backup").ToPtr(),
								armkeyvault.SecretPermissions("restore").ToPtr(),
								armkeyvault.SecretPermissions("recover").ToPtr(),
								armkeyvault.SecretPermissions("purge").ToPtr()},
						},
						TenantID: to.StringPtr("<tenant-id>"),
					}},
				EnabledForDeployment:         to.BoolPtr(true),
				EnabledForDiskEncryption:     to.BoolPtr(true),
				EnabledForTemplateDeployment: to.BoolPtr(true),
				PublicNetworkAccess:          to.StringPtr("<public-network-access>"),
				SKU: &armkeyvault.SKU{
					Name:   armkeyvault.SKUNameStandard.ToPtr(),
					Family: armkeyvault.SKUFamily("A").ToPtr(),
				},
				TenantID: to.StringPtr("<tenant-id>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VaultsClientUpdateResult)
}

Output:

func (*VaultsClient) UpdateAccessPolicy 

func (client *VaultsClient) UpdateAccessPolicy(ctx context.Context, resourceGroupName string, vaultName string, operationKind AccessPolicyUpdateKind, parameters VaultAccessPolicyParameters, options *VaultsClientUpdateAccessPolicyOptions) (VaultsClientUpdateAccessPolicyResponse, error)

UpdateAccessPolicy - Update access policies in a key vault in the specified subscription. If the operation fails it returns an *azcore.ResponseError type. 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 options - VaultsClientUpdateAccessPolicyOptions contains the optional parameters for the VaultsClient.UpdateAccessPolicy method.

Example

x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/examples/updateAccessPoliciesAdd.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armkeyvault.NewVaultsClient("<subscription-id>", cred, nil)
	res, err := client.UpdateAccessPolicy(ctx,
		"<resource-group-name>",
		"<vault-name>",
		armkeyvault.AccessPolicyUpdateKindAdd,
		armkeyvault.VaultAccessPolicyParameters{
			Properties: &armkeyvault.VaultAccessPolicyProperties{
				AccessPolicies: []*armkeyvault.AccessPolicyEntry{
					{
						ObjectID: to.StringPtr("<object-id>"),
						Permissions: &armkeyvault.Permissions{
							Certificates: []*armkeyvault.CertificatePermissions{
								armkeyvault.CertificatePermissions("get").ToPtr()},
							Keys: []*armkeyvault.KeyPermissions{
								armkeyvault.KeyPermissions("encrypt").ToPtr()},
							Secrets: []*armkeyvault.SecretPermissions{
								armkeyvault.SecretPermissions("get").ToPtr()},
						},
						TenantID: to.StringPtr("<tenant-id>"),
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.VaultsClientUpdateAccessPolicyResult)
}

Output:

type VaultsClientBeginCreateOrUpdateOptions added in v0.3.0 

type VaultsClientBeginCreateOrUpdateOptions struct {
}

VaultsClientBeginCreateOrUpdateOptions contains the optional parameters for the VaultsClient.BeginCreateOrUpdate method.

type VaultsClientBeginPurgeDeletedOptions added in v0.3.0 

type VaultsClientBeginPurgeDeletedOptions struct {
}

VaultsClientBeginPurgeDeletedOptions contains the optional parameters for the VaultsClient.BeginPurgeDeleted method.

type VaultsClientCheckNameAvailabilityOptions added in v0.3.0 

type VaultsClientCheckNameAvailabilityOptions struct {
}

VaultsClientCheckNameAvailabilityOptions contains the optional parameters for the VaultsClient.CheckNameAvailability method.

type VaultsClientCheckNameAvailabilityResponse added in v0.3.0 

type VaultsClientCheckNameAvailabilityResponse struct {
	VaultsClientCheckNameAvailabilityResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VaultsClientCheckNameAvailabilityResponse contains the response from method VaultsClient.CheckNameAvailability.

type VaultsClientCheckNameAvailabilityResult added in v0.3.0 

type VaultsClientCheckNameAvailabilityResult struct {
	CheckNameAvailabilityResult
}

VaultsClientCheckNameAvailabilityResult contains the result from method VaultsClient.CheckNameAvailability.

type VaultsClientCreateOrUpdatePoller added in v0.3.0 

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

VaultsClientCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*VaultsClientCreateOrUpdatePoller) Done added in v0.3.0 

func (p *VaultsClientCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VaultsClientCreateOrUpdatePoller) FinalResponse added in v0.3.0 

func (p *VaultsClientCreateOrUpdatePoller) FinalResponse(ctx context.Context) (VaultsClientCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VaultsClientCreateOrUpdateResponse will be returned.

func (*VaultsClientCreateOrUpdatePoller) Poll added in v0.3.0 

func (p *VaultsClientCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VaultsClientCreateOrUpdatePoller) ResumeToken added in v0.3.0 

func (p *VaultsClientCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VaultsClientCreateOrUpdatePollerResponse added in v0.3.0 

type VaultsClientCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VaultsClientCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VaultsClientCreateOrUpdatePollerResponse contains the response from method VaultsClient.CreateOrUpdate.

func (VaultsClientCreateOrUpdatePollerResponse) PollUntilDone added in v0.3.0 

func (l VaultsClientCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VaultsClientCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VaultsClientCreateOrUpdatePollerResponse) Resume added in v0.3.0 

func (l *VaultsClientCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *VaultsClient, token string) error

Resume rehydrates a VaultsClientCreateOrUpdatePollerResponse from the provided client and resume token.

type VaultsClientCreateOrUpdateResponse added in v0.3.0 

type VaultsClientCreateOrUpdateResponse struct {
	VaultsClientCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VaultsClientCreateOrUpdateResponse contains the response from method VaultsClient.CreateOrUpdate.

type VaultsClientCreateOrUpdateResult added in v0.3.0 

type VaultsClientCreateOrUpdateResult struct {
	Vault
}

VaultsClientCreateOrUpdateResult contains the result from method VaultsClient.CreateOrUpdate.

type VaultsClientDeleteOptions added in v0.3.0 

type VaultsClientDeleteOptions struct {
}

VaultsClientDeleteOptions contains the optional parameters for the VaultsClient.Delete method.

type VaultsClientDeleteResponse added in v0.3.0 

type VaultsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VaultsClientDeleteResponse contains the response from method VaultsClient.Delete.

type VaultsClientGetDeletedOptions added in v0.3.0 

type VaultsClientGetDeletedOptions struct {
}

VaultsClientGetDeletedOptions contains the optional parameters for the VaultsClient.GetDeleted method.

type VaultsClientGetDeletedResponse added in v0.3.0 

type VaultsClientGetDeletedResponse struct {
	VaultsClientGetDeletedResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VaultsClientGetDeletedResponse contains the response from method VaultsClient.GetDeleted.

type VaultsClientGetDeletedResult added in v0.3.0 

type VaultsClientGetDeletedResult struct {
	DeletedVault
}

VaultsClientGetDeletedResult contains the result from method VaultsClient.GetDeleted.

type VaultsClientGetOptions added in v0.3.0 

type VaultsClientGetOptions struct {
}

VaultsClientGetOptions contains the optional parameters for the VaultsClient.Get method.

type VaultsClientGetResponse added in v0.3.0 

type VaultsClientGetResponse struct {
	VaultsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VaultsClientGetResponse contains the response from method VaultsClient.Get.

type VaultsClientGetResult added in v0.3.0 

type VaultsClientGetResult struct {
	Vault
}

VaultsClientGetResult contains the result from method VaultsClient.Get.

type VaultsClientListByResourceGroupOptions added in v0.3.0 

type VaultsClientListByResourceGroupOptions struct {
	// Maximum number of results to return.
	Top *int32
}

VaultsClientListByResourceGroupOptions contains the optional parameters for the VaultsClient.ListByResourceGroup method.

type VaultsClientListByResourceGroupPager added in v0.3.0 

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

VaultsClientListByResourceGroupPager provides operations for iterating over paged responses.

func (*VaultsClientListByResourceGroupPager) Err added in v0.3.0 

func (p *VaultsClientListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*VaultsClientListByResourceGroupPager) NextPage added in v0.3.0 

func (p *VaultsClientListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VaultsClientListByResourceGroupPager) PageResponse added in v0.3.0 

func (p *VaultsClientListByResourceGroupPager) PageResponse() VaultsClientListByResourceGroupResponse

PageResponse returns the current VaultsClientListByResourceGroupResponse page.

type VaultsClientListByResourceGroupResponse added in v0.3.0 

type VaultsClientListByResourceGroupResponse struct {
	VaultsClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VaultsClientListByResourceGroupResponse contains the response from method VaultsClient.ListByResourceGroup.

type VaultsClientListByResourceGroupResult added in v0.3.0 

type VaultsClientListByResourceGroupResult struct {
	VaultListResult
}

VaultsClientListByResourceGroupResult contains the result from method VaultsClient.ListByResourceGroup.

type VaultsClientListBySubscriptionOptions added in v0.3.0 

type VaultsClientListBySubscriptionOptions struct {
	// Maximum number of results to return.
	Top *int32
}

VaultsClientListBySubscriptionOptions contains the optional parameters for the VaultsClient.ListBySubscription method.

type VaultsClientListBySubscriptionPager added in v0.3.0 

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

VaultsClientListBySubscriptionPager provides operations for iterating over paged responses.

func (*VaultsClientListBySubscriptionPager) Err added in v0.3.0 

func (p *VaultsClientListBySubscriptionPager) Err() error

Err returns the last error encountered while paging.

func (*VaultsClientListBySubscriptionPager) NextPage added in v0.3.0 

func (p *VaultsClientListBySubscriptionPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VaultsClientListBySubscriptionPager) PageResponse added in v0.3.0 

func (p *VaultsClientListBySubscriptionPager) PageResponse() VaultsClientListBySubscriptionResponse

PageResponse returns the current VaultsClientListBySubscriptionResponse page.

type VaultsClientListBySubscriptionResponse added in v0.3.0 

type VaultsClientListBySubscriptionResponse struct {
	VaultsClientListBySubscriptionResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VaultsClientListBySubscriptionResponse contains the response from method VaultsClient.ListBySubscription.

type VaultsClientListBySubscriptionResult added in v0.3.0 

type VaultsClientListBySubscriptionResult struct {
	VaultListResult
}

VaultsClientListBySubscriptionResult contains the result from method VaultsClient.ListBySubscription.

type VaultsClientListDeletedOptions added in v0.3.0 

type VaultsClientListDeletedOptions struct {
}

VaultsClientListDeletedOptions contains the optional parameters for the VaultsClient.ListDeleted method.

type VaultsClientListDeletedPager added in v0.3.0 

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

VaultsClientListDeletedPager provides operations for iterating over paged responses.

func (*VaultsClientListDeletedPager) Err added in v0.3.0 

func (p *VaultsClientListDeletedPager) Err() error

Err returns the last error encountered while paging.

func (*VaultsClientListDeletedPager) NextPage added in v0.3.0 

func (p *VaultsClientListDeletedPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VaultsClientListDeletedPager) PageResponse added in v0.3.0 

func (p *VaultsClientListDeletedPager) PageResponse() VaultsClientListDeletedResponse

PageResponse returns the current VaultsClientListDeletedResponse page.

type VaultsClientListDeletedResponse added in v0.3.0 

type VaultsClientListDeletedResponse struct {
	VaultsClientListDeletedResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VaultsClientListDeletedResponse contains the response from method VaultsClient.ListDeleted.

type VaultsClientListDeletedResult added in v0.3.0 

type VaultsClientListDeletedResult struct {
	DeletedVaultListResult
}

VaultsClientListDeletedResult contains the result from method VaultsClient.ListDeleted.

type VaultsClientListOptions added in v0.3.0 

type VaultsClientListOptions struct {
	// Maximum number of results to return.
	Top *int32
}

VaultsClientListOptions contains the optional parameters for the VaultsClient.List method.

type VaultsClientListPager added in v0.3.0 

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

VaultsClientListPager provides operations for iterating over paged responses.

func (*VaultsClientListPager) Err added in v0.3.0 

func (p *VaultsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*VaultsClientListPager) NextPage added in v0.3.0 

func (p *VaultsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*VaultsClientListPager) PageResponse added in v0.3.0 

func (p *VaultsClientListPager) PageResponse() VaultsClientListResponse

PageResponse returns the current VaultsClientListResponse page.

type VaultsClientListResponse added in v0.3.0 

type VaultsClientListResponse struct {
	VaultsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VaultsClientListResponse contains the response from method VaultsClient.List.

type VaultsClientListResult added in v0.3.0 

type VaultsClientListResult struct {
	ResourceListResult
}

VaultsClientListResult contains the result from method VaultsClient.List.

type VaultsClientPurgeDeletedPoller added in v0.3.0 

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

VaultsClientPurgeDeletedPoller provides polling facilities until the operation reaches a terminal state.

func (*VaultsClientPurgeDeletedPoller) Done added in v0.3.0 

func (p *VaultsClientPurgeDeletedPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*VaultsClientPurgeDeletedPoller) FinalResponse added in v0.3.0 

func (p *VaultsClientPurgeDeletedPoller) FinalResponse(ctx context.Context) (VaultsClientPurgeDeletedResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final VaultsClientPurgeDeletedResponse will be returned.

func (*VaultsClientPurgeDeletedPoller) Poll added in v0.3.0 

func (p *VaultsClientPurgeDeletedPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*VaultsClientPurgeDeletedPoller) ResumeToken added in v0.3.0 

func (p *VaultsClientPurgeDeletedPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type VaultsClientPurgeDeletedPollerResponse added in v0.3.0 

type VaultsClientPurgeDeletedPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *VaultsClientPurgeDeletedPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VaultsClientPurgeDeletedPollerResponse contains the response from method VaultsClient.PurgeDeleted.

func (VaultsClientPurgeDeletedPollerResponse) PollUntilDone added in v0.3.0 

func (l VaultsClientPurgeDeletedPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (VaultsClientPurgeDeletedResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*VaultsClientPurgeDeletedPollerResponse) Resume added in v0.3.0 

func (l *VaultsClientPurgeDeletedPollerResponse) Resume(ctx context.Context, client *VaultsClient, token string) error

Resume rehydrates a VaultsClientPurgeDeletedPollerResponse from the provided client and resume token.

type VaultsClientPurgeDeletedResponse added in v0.3.0 

type VaultsClientPurgeDeletedResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VaultsClientPurgeDeletedResponse contains the response from method VaultsClient.PurgeDeleted.

type VaultsClientUpdateAccessPolicyOptions added in v0.3.0 

type VaultsClientUpdateAccessPolicyOptions struct {
}

VaultsClientUpdateAccessPolicyOptions contains the optional parameters for the VaultsClient.UpdateAccessPolicy method.

type VaultsClientUpdateAccessPolicyResponse added in v0.3.0 

type VaultsClientUpdateAccessPolicyResponse struct {
	VaultsClientUpdateAccessPolicyResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VaultsClientUpdateAccessPolicyResponse contains the response from method VaultsClient.UpdateAccessPolicy.

type VaultsClientUpdateAccessPolicyResult added in v0.3.0 

type VaultsClientUpdateAccessPolicyResult struct {
	VaultAccessPolicyParameters
}

VaultsClientUpdateAccessPolicyResult contains the result from method VaultsClient.UpdateAccessPolicy.

type VaultsClientUpdateOptions added in v0.3.0 

type VaultsClientUpdateOptions struct {
}

VaultsClientUpdateOptions contains the optional parameters for the VaultsClient.Update method.

type VaultsClientUpdateResponse added in v0.3.0 

type VaultsClientUpdateResponse struct {
	VaultsClientUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

VaultsClientUpdateResponse contains the response from method VaultsClient.Update.

type VaultsClientUpdateResult added in v0.3.0 

type VaultsClientUpdateResult struct {
	Vault
}

VaultsClientUpdateResult contains the result from method VaultsClient.Update.

type VirtualNetworkRule 

type VirtualNetworkRule struct {
	// REQUIRED; 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"`

	// Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured.
	IgnoreMissingVnetServiceEndpoint *bool `json:"ignoreMissingVnetServiceEndpoint,omitempty"`
}

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

Source Files

View all Source files

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.