vaultcertificates

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservices/2023-02-01/vaultcertificates Documentation

The vaultcertificates SDK allows for interaction with the Azure Resource Manager Service recoveryservices (API Version 2023-02-01).

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

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservices/2023-02-01/vaultcertificates"

Client Initialization

client := vaultcertificates.NewVaultCertificatesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VaultCertificatesClient.Create

ctx := context.TODO()
id := vaultcertificates.NewCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "certificateValue")

payload := vaultcertificates.CertificateRequest{
	// ...
}


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

Documentation

Index

• func PossibleValuesForAuthType() []string
• func ValidateCertificateID(input interface{}, key string) (warnings []string, errors []error)
• type AuthType
• type CertificateId
  • func NewCertificateID(subscriptionId string, resourceGroupName string, vaultName string, ...) CertificateId
  • func ParseCertificateID(input string) (*CertificateId, error)
  • func ParseCertificateIDInsensitively(input string) (*CertificateId, error)
  • func (id CertificateId) ID() string
  • func (id CertificateId) Segments() []resourceids.Segment
  • func (id CertificateId) String() string
• type CertificateRequest
• type CreateOperationResponse
• type RawCertificateData
• type ResourceCertificateAndAadDetails
  • func (o *ResourceCertificateAndAadDetails) GetValidFromAsTime() (*time.Time, error)
  • func (o *ResourceCertificateAndAadDetails) GetValidToAsTime() (*time.Time, error)
  • func (s ResourceCertificateAndAadDetails) MarshalJSON() ([]byte, error)
  • func (o *ResourceCertificateAndAadDetails) SetValidFromAsTime(input time.Time)
  • func (o *ResourceCertificateAndAadDetails) SetValidToAsTime(input time.Time)
• type ResourceCertificateAndAcsDetails
  • func (o *ResourceCertificateAndAcsDetails) GetValidFromAsTime() (*time.Time, error)
  • func (o *ResourceCertificateAndAcsDetails) GetValidToAsTime() (*time.Time, error)
  • func (s ResourceCertificateAndAcsDetails) MarshalJSON() ([]byte, error)
  • func (o *ResourceCertificateAndAcsDetails) SetValidFromAsTime(input time.Time)
  • func (o *ResourceCertificateAndAcsDetails) SetValidToAsTime(input time.Time)
• type ResourceCertificateDetails
• type VaultCertificateResponse
  • func (s *VaultCertificateResponse) UnmarshalJSON(bytes []byte) error
• type VaultCertificatesClient
  • func NewVaultCertificatesClientWithBaseURI(endpoint string) VaultCertificatesClient
  • func (c VaultCertificatesClient) Create(ctx context.Context, id CertificateId, input CertificateRequest) (result CreateOperationResponse, err error)

Functions

func PossibleValuesForAuthType

func PossibleValuesForAuthType() []string

func ValidateCertificateID

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

ValidateCertificateID checks that 'input' can be parsed as a Certificate ID

Types

type AuthType

type AuthType string

const (
	AuthTypeAAD                  AuthType = "AAD"
	AuthTypeACS                  AuthType = "ACS"
	AuthTypeAccessControlService AuthType = "AccessControlService"
	AuthTypeAzureActiveDirectory AuthType = "AzureActiveDirectory"
	AuthTypeInvalid              AuthType = "Invalid"
)

type CertificateId

type CertificateId struct {
	SubscriptionId    string
	ResourceGroupName string
	VaultName         string
	CertificateName   string
}

CertificateId is a struct representing the Resource ID for a Certificate

func NewCertificateID

func NewCertificateID(subscriptionId string, resourceGroupName string, vaultName string, certificateName string) CertificateId

NewCertificateID returns a new CertificateId struct

func ParseCertificateID

func ParseCertificateID(input string) (*CertificateId, error)

ParseCertificateID parses 'input' into a CertificateId

func ParseCertificateIDInsensitively

func ParseCertificateIDInsensitively(input string) (*CertificateId, error)

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

func (CertificateId) ID

func (id CertificateId) ID() string

ID returns the formatted Certificate ID

func (CertificateId) Segments

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

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

func (CertificateId) String

func (id CertificateId) String() string

String returns a human-readable description of this Certificate ID

type CertificateRequest

type CertificateRequest struct {
	Properties *RawCertificateData `json:"properties,omitempty"`
}

type CreateOperationResponse

type CreateOperationResponse struct {
	HttpResponse *http.Response
	Model        *VaultCertificateResponse
}

type RawCertificateData

type RawCertificateData struct {
	AuthType    *AuthType `json:"authType,omitempty"`
	Certificate *string   `json:"certificate,omitempty"`
}

type ResourceCertificateAndAadDetails

type ResourceCertificateAndAadDetails struct {
	AadAudience                     *string `json:"aadAudience,omitempty"`
	AadAuthority                    string  `json:"aadAuthority"`
	AadTenantId                     string  `json:"aadTenantId"`
	AzureManagementEndpointAudience string  `json:"azureManagementEndpointAudience"`
	ServicePrincipalClientId        string  `json:"servicePrincipalClientId"`
	ServicePrincipalObjectId        string  `json:"servicePrincipalObjectId"`
	ServiceResourceId               *string `json:"serviceResourceId,omitempty"`

	// Fields inherited from ResourceCertificateDetails
	Certificate  *string `json:"certificate,omitempty"`
	FriendlyName *string `json:"friendlyName,omitempty"`
	Issuer       *string `json:"issuer,omitempty"`
	ResourceId   *int64  `json:"resourceId,omitempty"`
	Subject      *string `json:"subject,omitempty"`
	Thumbprint   *string `json:"thumbprint,omitempty"`
	ValidFrom    *string `json:"validFrom,omitempty"`
	ValidTo      *string `json:"validTo,omitempty"`
}

func (*ResourceCertificateAndAadDetails) GetValidFromAsTime

func (o *ResourceCertificateAndAadDetails) GetValidFromAsTime() (*time.Time, error)

func (*ResourceCertificateAndAadDetails) GetValidToAsTime

func (o *ResourceCertificateAndAadDetails) GetValidToAsTime() (*time.Time, error)

func (ResourceCertificateAndAadDetails) MarshalJSON

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

func (*ResourceCertificateAndAadDetails) SetValidFromAsTime

func (o *ResourceCertificateAndAadDetails) SetValidFromAsTime(input time.Time)

func (*ResourceCertificateAndAadDetails) SetValidToAsTime

func (o *ResourceCertificateAndAadDetails) SetValidToAsTime(input time.Time)

type ResourceCertificateAndAcsDetails

type ResourceCertificateAndAcsDetails struct {
	GlobalAcsHostName  string `json:"globalAcsHostName"`
	GlobalAcsNamespace string `json:"globalAcsNamespace"`
	GlobalAcsRPRealm   string `json:"globalAcsRPRealm"`

	// Fields inherited from ResourceCertificateDetails
	Certificate  *string `json:"certificate,omitempty"`
	FriendlyName *string `json:"friendlyName,omitempty"`
	Issuer       *string `json:"issuer,omitempty"`
	ResourceId   *int64  `json:"resourceId,omitempty"`
	Subject      *string `json:"subject,omitempty"`
	Thumbprint   *string `json:"thumbprint,omitempty"`
	ValidFrom    *string `json:"validFrom,omitempty"`
	ValidTo      *string `json:"validTo,omitempty"`
}

func (*ResourceCertificateAndAcsDetails) GetValidFromAsTime

func (o *ResourceCertificateAndAcsDetails) GetValidFromAsTime() (*time.Time, error)

func (*ResourceCertificateAndAcsDetails) GetValidToAsTime

func (o *ResourceCertificateAndAcsDetails) GetValidToAsTime() (*time.Time, error)

func (ResourceCertificateAndAcsDetails) MarshalJSON

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

func (*ResourceCertificateAndAcsDetails) SetValidFromAsTime

func (o *ResourceCertificateAndAcsDetails) SetValidFromAsTime(input time.Time)

func (*ResourceCertificateAndAcsDetails) SetValidToAsTime

func (o *ResourceCertificateAndAcsDetails) SetValidToAsTime(input time.Time)

type ResourceCertificateDetails

type ResourceCertificateDetails interface {
}

type VaultCertificateResponse

type VaultCertificateResponse struct {
	Id         *string                     `json:"id,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *ResourceCertificateDetails `json:"properties,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

func (*VaultCertificateResponse) UnmarshalJSON

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

type VaultCertificatesClient

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

func NewVaultCertificatesClientWithBaseURI

func NewVaultCertificatesClientWithBaseURI(endpoint string) VaultCertificatesClient

func (VaultCertificatesClient) Create

func (c VaultCertificatesClient) Create(ctx context.Context, id CertificateId, input CertificateRequest) (result CreateOperationResponse, err error)

Create ...