customerlockbox

package
v59.2.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Nov 10, 2021 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package customerlockbox implements the Azure ARM Customerlockbox service API version 2018-02-28-preview.

Azure Customer Lockbox API Reference

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Customerlockbox
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type Approval 

type Approval struct {
	autorest.Response `json:"-"`
	// Decision - Approval decision to the Lockbox request. Possible values include: 'Approve', 'Deny'
	Decision Decision `json:"decision,omitempty"`
	// Reason - Reason of the decision
	Reason *string `json:"reason,omitempty"`
}

Approval request content object, in the use of Approve or Deny a Lockbox request.

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI string
}

BaseClient is the base client for Customerlockbox.

func New 

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type Decision 

type Decision string

Decision enumerates the values for decision. 

const (
	// Approve ...
	Approve Decision = "Approve"
	// Deny ...
	Deny Decision = "Deny"
)

func PossibleDecisionValues 

func PossibleDecisionValues() []Decision

PossibleDecisionValues returns an array of possible values for the Decision const type.

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// Type - The type of error info.
	Type *string                  `json:"type,omitempty"`
	Info *ErrorAdditionalInfoInfo `json:"info,omitempty"`
}

ErrorAdditionalInfo an error additional info for the Lockbox service.

type ErrorAdditionalInfoInfo 

type ErrorAdditionalInfoInfo struct {
	// CurrentStatus - The current status/state of the request quired. Possible values include: 'Initializing', 'Pending', 'Approving', 'Denying', 'Approved', 'Denied', 'Expired', 'Revoking', 'Revoked', 'Error', 'Unknown', 'Completed', 'Completing'
	CurrentStatus Status `json:"currentStatus,omitempty"`
}

ErrorAdditionalInfoInfo ...

type ErrorBody 

type ErrorBody struct {
	// Code - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
	Code *string `json:"code,omitempty"`
	// Message - A message describing the error, intended to be suitable for display in a user interface.
	Message *string `json:"message,omitempty"`
	// Target - The target of the particular error. For example, the name of the property in error.
	Target *string `json:"target,omitempty"`
	// AdditionalInfo - A list of error details about the error.
	AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
}

ErrorBody an error response body from the Lockbox service.

type ErrorResponse 

type ErrorResponse struct {
	Error *ErrorBody `json:"error,omitempty"`
}

ErrorResponse an error response from the Lockbox service.

type LockboxRequestResponse 

type LockboxRequestResponse struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The Arm resource id of the Lockbox request.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the Lockbox request.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the Lockbox request.
	Type *string `json:"type,omitempty"`
	// Properties - The properties that are associated with a lockbox request.
	Properties *LockboxRequestResponseProperties `json:"properties,omitempty"`
}

LockboxRequestResponse a Lockbox request response object, containing all information associated with the request.

func (LockboxRequestResponse) MarshalJSON 

func (lrr LockboxRequestResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LockboxRequestResponse.

type LockboxRequestResponseProperties 

type LockboxRequestResponseProperties struct {
	// RequestID - READ-ONLY; The Lockbox request ID.
	RequestID *string `json:"requestId,omitempty"`
	// Justification - READ-ONLY; The justification of the requestor.
	Justification *string `json:"justification,omitempty"`
	// Status - The status of the request. Possible values include: 'Initializing', 'Pending', 'Approving', 'Denying', 'Approved', 'Denied', 'Expired', 'Revoking', 'Revoked', 'Error', 'Unknown', 'Completed', 'Completing'
	Status Status `json:"status,omitempty"`
	// CreatedDateTime - READ-ONLY; The creation time of the request.
	CreatedDateTime *date.Time `json:"createdDateTime,omitempty"`
	// ExpirationDateTime - READ-ONLY; The expiration time of the request.
	ExpirationDateTime *date.Time `json:"expirationDateTime,omitempty"`
	// Duration - READ-ONLY; The duration of the request in hours.
	Duration *int32 `json:"duration,omitempty"`
	// RequestedResourceIds - READ-ONLY; A list of resource IDs associated with the Lockbox request separated by ','.
	RequestedResourceIds *[]string `json:"requestedResourceIds,omitempty"`
	// ResourceType - READ-ONLY; The resource type of the requested resources.
	ResourceType *string `json:"resourceType,omitempty"`
	// SupportRequest - READ-ONLY; The id of the support request associated.
	SupportRequest *string `json:"supportRequest,omitempty"`
	// SupportCaseURL - READ-ONLY; The url of the support case.
	SupportCaseURL *string `json:"supportCaseUrl,omitempty"`
	// SubscriptionID - READ-ONLY; The subscription ID.
	SubscriptionID *string `json:"subscriptionId,omitempty"`
}

LockboxRequestResponseProperties the properties that are associated with a lockbox request.

func (LockboxRequestResponseProperties) MarshalJSON 

func (lrrp LockboxRequestResponseProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LockboxRequestResponseProperties.

type Operation 

type Operation struct {
	// Name - READ-ONLY; Gets or sets action name
	Name *string `json:"name,omitempty"`
	// IsDataAction - READ-ONLY; Gets or sets a value indicating whether it is a data plane action
	IsDataAction *string `json:"isDataAction,omitempty"`
	// Display - READ-ONLY; Contains the localized display information for this particular operation / action.
	Display *OperationDisplay `json:"display,omitempty"`
	// Properties - READ-ONLY; Gets or sets properties
	Properties *string `json:"properties,omitempty"`
	// Origin - READ-ONLY; Gets or sets origin
	Origin *string `json:"origin,omitempty"`
}

Operation operation result model for ARM RP

func (Operation) MarshalJSON 

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

MarshalJSON is the custom marshaler for Operation.

type OperationDisplay 

type OperationDisplay struct {
	// Provider - READ-ONLY; The localized friendly form of the resource provider name.
	Provider *string `json:"provider,omitempty"`
	// Resource - READ-ONLY; The localized friendly form of the resource type related to this action/operation.
	Resource *string `json:"resource,omitempty"`
	// Operation - READ-ONLY; The localized friendly name for the operation.
	Operation *string `json:"operation,omitempty"`
	// Description - READ-ONLY; The localized friendly description for the operation.
	Description *string `json:"description,omitempty"`
}

OperationDisplay contains the localized display information for this particular operation / action.

func (OperationDisplay) MarshalJSON 

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

MarshalJSON is the custom marshaler for OperationDisplay.

type OperationListResult 

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; List of Customer Lockbox operations supported by the Microsoft.StreamAnalytics resource provider.
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - READ-ONLY; URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationListResult result of the request to list Customer Lockbox operations. It contains a list of operations.

func (OperationListResult) IsEmpty 

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (OperationListResult) MarshalJSON 

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

MarshalJSON is the custom marshaler for OperationListResult.

type OperationListResultIterator 

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator 

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next 

func (iter *OperationListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultIterator) NextWithContext 

func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationListResultIterator) NotDone 

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response 

func (iter OperationListResultIterator) Response() OperationListResult

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

func (OperationListResultIterator) Value 

func (iter OperationListResultIterator) Value() Operation

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

type OperationListResultPage 

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage 

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

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next 

func (page *OperationListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListResultPage) NextWithContext 

func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationListResultPage) NotDone 

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response 

func (page OperationListResultPage) Response() OperationListResult

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

func (OperationListResultPage) Values 

func (page OperationListResultPage) Values() []Operation

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

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the azure Customer Lockbox API Reference

func NewOperationsClient 

func NewOperationsClient() OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List 

func (client OperationsClient) List(ctx context.Context, APIVersion string) (result OperationListResultPage, err error)

List lists all the available REST API operations. Parameters: APIVersion - the API version to be used with the HTTP request.

func (OperationsClient) ListComplete 

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

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

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer(ctx context.Context, APIVersion string) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)

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

func (OperationsClient) ListSender 

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

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

type RequestListResult 

type RequestListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; A list of Lockbox requests. Populated by a 'List' operation.
	Value *[]LockboxRequestResponse `json:"value,omitempty"`
	// NextLink - READ-ONLY; URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

RequestListResult object containing a list of streaming jobs.

func (RequestListResult) IsEmpty 

func (rlr RequestListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (RequestListResult) MarshalJSON 

func (rlr RequestListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RequestListResult.

type RequestListResultIterator 

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

RequestListResultIterator provides access to a complete listing of LockboxRequestResponse values.

func NewRequestListResultIterator 

func NewRequestListResultIterator(page RequestListResultPage) RequestListResultIterator

Creates a new instance of the RequestListResultIterator type.

func (*RequestListResultIterator) Next 

func (iter *RequestListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*RequestListResultIterator) NextWithContext 

func (iter *RequestListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (RequestListResultIterator) NotDone 

func (iter RequestListResultIterator) NotDone() bool

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

func (RequestListResultIterator) Response 

func (iter RequestListResultIterator) Response() RequestListResult

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

func (RequestListResultIterator) Value 

func (iter RequestListResultIterator) Value() LockboxRequestResponse

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

type RequestListResultPage 

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

RequestListResultPage contains a page of LockboxRequestResponse values.

func NewRequestListResultPage 

func NewRequestListResultPage(cur RequestListResult, getNextPage func(context.Context, RequestListResult) (RequestListResult, error)) RequestListResultPage

Creates a new instance of the RequestListResultPage type.

func (*RequestListResultPage) Next 

func (page *RequestListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*RequestListResultPage) NextWithContext 

func (page *RequestListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (RequestListResultPage) NotDone 

func (page RequestListResultPage) NotDone() bool

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

func (RequestListResultPage) Response 

func (page RequestListResultPage) Response() RequestListResult

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

func (RequestListResultPage) Values 

func (page RequestListResultPage) Values() []LockboxRequestResponse

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

type RequestsClient 

type RequestsClient struct {
	BaseClient
}

RequestsClient is the azure Customer Lockbox API Reference

func NewRequestsClient 

func NewRequestsClient() RequestsClient

NewRequestsClient creates an instance of the RequestsClient client.

func NewRequestsClientWithBaseURI 

func NewRequestsClientWithBaseURI(baseURI string) RequestsClient

NewRequestsClientWithBaseURI creates an instance of the RequestsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (RequestsClient) Get 

func (client RequestsClient) Get(ctx context.Context, requestID string, subscriptionID string, APIVersion string) (result LockboxRequestResponse, err error)

Get get Customer Lockbox request Parameters: requestID - the Lockbox request ID. subscriptionID - the Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) APIVersion - the API version to be used with the HTTP request.

func (RequestsClient) GetPreparer 

func (client RequestsClient) GetPreparer(ctx context.Context, requestID string, subscriptionID string, APIVersion string) (*http.Request, error)

GetPreparer prepares the Get request.

func (RequestsClient) GetResponder 

func (client RequestsClient) GetResponder(resp *http.Response) (result LockboxRequestResponse, err error)

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

func (RequestsClient) GetSender 

func (client RequestsClient) GetSender(req *http.Request) (*http.Response, error)

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

func (RequestsClient) List 

func (client RequestsClient) List(ctx context.Context, subscriptionID string, filter string) (result RequestListResultPage, err error)

List lists all of the Lockbox requests in the given subscription. Parameters: subscriptionID - the Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) filter - the $filter OData query parameter. Only filter by request status is supported, e.g $filter=properties/status eq 'Pending'

func (RequestsClient) ListComplete 

func (client RequestsClient) ListComplete(ctx context.Context, subscriptionID string, filter string) (result RequestListResultIterator, err error)

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

func (RequestsClient) ListPreparer 

func (client RequestsClient) ListPreparer(ctx context.Context, subscriptionID string, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (RequestsClient) ListResponder 

func (client RequestsClient) ListResponder(resp *http.Response) (result RequestListResult, err error)

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

func (RequestsClient) ListSender 

func (client RequestsClient) ListSender(req *http.Request) (*http.Response, error)

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

func (RequestsClient) UpdateStatus 

func (client RequestsClient) UpdateStatus(ctx context.Context, approval Approval, subscriptionID string, requestID string, APIVersion string) (result Approval, err error)

UpdateStatus update Customer Lockbox request approval status API Parameters: approval - the approval object to update request status. subscriptionID - the Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) requestID - the Lockbox request ID. APIVersion - the API version to be used with the HTTP request.

func (RequestsClient) UpdateStatusPreparer 

func (client RequestsClient) UpdateStatusPreparer(ctx context.Context, approval Approval, subscriptionID string, requestID string, APIVersion string) (*http.Request, error)

UpdateStatusPreparer prepares the UpdateStatus request.

func (RequestsClient) UpdateStatusResponder 

func (client RequestsClient) UpdateStatusResponder(resp *http.Response) (result Approval, err error)

UpdateStatusResponder handles the response to the UpdateStatus request. The method always closes the http.Response Body.

func (RequestsClient) UpdateStatusSender 

func (client RequestsClient) UpdateStatusSender(req *http.Request) (*http.Response, error)

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

type Status 

type Status string

Status enumerates the values for status. 

const (
	// Approved ...
	Approved Status = "Approved"
	// Approving ...
	Approving Status = "Approving"
	// Completed ...
	Completed Status = "Completed"
	// Completing ...
	Completing Status = "Completing"
	// Denied ...
	Denied Status = "Denied"
	// Denying ...
	Denying Status = "Denying"
	// Error ...
	Error Status = "Error"
	// Expired ...
	Expired Status = "Expired"
	// Initializing ...
	Initializing Status = "Initializing"
	// Pending ...
	Pending Status = "Pending"
	// Revoked ...
	Revoked Status = "Revoked"
	// Revoking ...
	Revoking Status = "Revoking"
	// Unknown ...
	Unknown Status = "Unknown"
)

func PossibleStatusValues 

func PossibleStatusValues() []Status

PossibleStatusValues returns an array of possible values for the Status const type.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.