Documentation ¶
Overview ¶
Package confidentialledger implements the Azure ARM Confidentialledger service API version 2020-12-01-preview.
Microsoft Azure Confidential Compute Ledger Control Plane REST API version 2020-12-01-preview.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type AADBasedSecurityPrincipal
- type BaseClient
- type CertBasedSecurityPrincipal
- type CreatedByType
- type ErrorAdditionalInfo
- type ErrorDetail
- type ErrorResponse
- type LedgerClient
- func (client LedgerClient) Create(ctx context.Context, resourceGroupName string, ledgerName string, ...) (result LedgerCreateFuture, err error)
- func (client LedgerClient) CreatePreparer(ctx context.Context, resourceGroupName string, ledgerName string, ...) (*http.Request, error)
- func (client LedgerClient) CreateResponder(resp *http.Response) (result Model, err error)
- func (client LedgerClient) CreateSender(req *http.Request) (future LedgerCreateFuture, err error)
- func (client LedgerClient) Delete(ctx context.Context, resourceGroupName string, ledgerName string) (result LedgerDeleteFuture, err error)
- func (client LedgerClient) DeletePreparer(ctx context.Context, resourceGroupName string, ledgerName string) (*http.Request, error)
- func (client LedgerClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client LedgerClient) DeleteSender(req *http.Request) (future LedgerDeleteFuture, err error)
- func (client LedgerClient) Get(ctx context.Context, resourceGroupName string, ledgerName string) (result Model, err error)
- func (client LedgerClient) GetPreparer(ctx context.Context, resourceGroupName string, ledgerName string) (*http.Request, error)
- func (client LedgerClient) GetResponder(resp *http.Response) (result Model, err error)
- func (client LedgerClient) GetSender(req *http.Request) (*http.Response, error)
- func (client LedgerClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, filter string) (result ListPage, err error)
- func (client LedgerClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, filter string) (result ListIterator, err error)
- func (client LedgerClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, filter string) (*http.Request, error)
- func (client LedgerClient) ListByResourceGroupResponder(resp *http.Response) (result List, err error)
- func (client LedgerClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client LedgerClient) ListBySubscription(ctx context.Context, filter string) (result ListPage, err error)
- func (client LedgerClient) ListBySubscriptionComplete(ctx context.Context, filter string) (result ListIterator, err error)
- func (client LedgerClient) ListBySubscriptionPreparer(ctx context.Context, filter string) (*http.Request, error)
- func (client LedgerClient) ListBySubscriptionResponder(resp *http.Response) (result List, err error)
- func (client LedgerClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
- func (client LedgerClient) Update(ctx context.Context, resourceGroupName string, ledgerName string, ...) (result LedgerUpdateFuture, err error)
- func (client LedgerClient) UpdatePreparer(ctx context.Context, resourceGroupName string, ledgerName string, ...) (*http.Request, error)
- func (client LedgerClient) UpdateResponder(resp *http.Response) (result Model, err error)
- func (client LedgerClient) UpdateSender(req *http.Request) (future LedgerUpdateFuture, err error)
- type LedgerCreateFuture
- type LedgerDeleteFuture
- type LedgerProperties
- type LedgerRoleName
- type LedgerType
- type LedgerUpdateFuture
- type List
- type ListIterator
- type ListPage
- type Location
- type Model
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result ResourceProviderOperationListPage, err error)
- func (client OperationsClient) ListComplete(ctx context.Context) (result ResourceProviderOperationListIterator, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result ResourceProviderOperationList, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type ProvisioningState
- type Resource
- type ResourceProviderOperationDefinition
- type ResourceProviderOperationDisplay
- type ResourceProviderOperationList
- type ResourceProviderOperationListIterator
- func (iter *ResourceProviderOperationListIterator) Next() error
- func (iter *ResourceProviderOperationListIterator) NextWithContext(ctx context.Context) (err error)
- func (iter ResourceProviderOperationListIterator) NotDone() bool
- func (iter ResourceProviderOperationListIterator) Response() ResourceProviderOperationList
- func (iter ResourceProviderOperationListIterator) Value() ResourceProviderOperationDefinition
- type ResourceProviderOperationListPage
- func (page *ResourceProviderOperationListPage) Next() error
- func (page *ResourceProviderOperationListPage) NextWithContext(ctx context.Context) (err error)
- func (page ResourceProviderOperationListPage) NotDone() bool
- func (page ResourceProviderOperationListPage) Response() ResourceProviderOperationList
- func (page ResourceProviderOperationListPage) Values() []ResourceProviderOperationDefinition
- type SystemData
- type Tags
Constants ¶
const (
// DefaultBaseURI is the default URI used for the service Confidentialledger
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 AADBasedSecurityPrincipal ¶
type AADBasedSecurityPrincipal struct { // PrincipalID - UUID/GUID based Principal Id of the Security Principal PrincipalID *string `json:"principalId,omitempty"` // TenantID - UUID/GUID based Tenant Id of the Security Principal TenantID *string `json:"tenantId,omitempty"` // LedgerRoleName - Possible values include: 'LedgerRoleNameReader', 'LedgerRoleNameContributor', 'LedgerRoleNameAdministrator' LedgerRoleName LedgerRoleName `json:"ledgerRoleName,omitempty"` }
AADBasedSecurityPrincipal AAD based security principal with associated Ledger RoleName
type BaseClient ¶
BaseClient is the base client for Confidentialledger.
func New ¶
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
type CertBasedSecurityPrincipal ¶
type CertBasedSecurityPrincipal struct { // Cert - Base64 encoded public key of the user cert (.pem or .cer) Cert *string `json:"cert,omitempty"` // LedgerRoleName - Possible values include: 'LedgerRoleNameReader', 'LedgerRoleNameContributor', 'LedgerRoleNameAdministrator' LedgerRoleName LedgerRoleName `json:"ledgerRoleName,omitempty"` }
CertBasedSecurityPrincipal cert based security principal with Ledger RoleName
type CreatedByType ¶
type CreatedByType string
CreatedByType enumerates the values for created by type.
const ( // CreatedByTypeApplication ... CreatedByTypeApplication CreatedByType = "Application" // CreatedByTypeKey ... CreatedByTypeKey CreatedByType = "Key" // CreatedByTypeManagedIdentity ... CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity" // CreatedByTypeUser ... CreatedByTypeUser CreatedByType = "User" )
func PossibleCreatedByTypeValues ¶
func PossibleCreatedByTypeValues() []CreatedByType
PossibleCreatedByTypeValues returns an array of possible values for the CreatedByType const type.
type ErrorAdditionalInfo ¶
type ErrorAdditionalInfo struct { // Type - READ-ONLY; The additional info type. Type *string `json:"type,omitempty"` // Info - READ-ONLY; The additional info. Info interface{} `json:"info,omitempty"` }
ErrorAdditionalInfo the resource management error additional info.
func (ErrorAdditionalInfo) MarshalJSON ¶
func (eai ErrorAdditionalInfo) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ErrorAdditionalInfo.
type ErrorDetail ¶
type ErrorDetail struct { // Code - READ-ONLY; The error code. Code *string `json:"code,omitempty"` // Message - READ-ONLY; The error message. Message *string `json:"message,omitempty"` // Target - READ-ONLY; The error target. Target *string `json:"target,omitempty"` // Details - READ-ONLY; The error details. Details *[]ErrorDetail `json:"details,omitempty"` // AdditionalInfo - READ-ONLY; The error additional info. AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"` }
ErrorDetail the error detail.
func (ErrorDetail) MarshalJSON ¶
func (ed ErrorDetail) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ErrorDetail.
type ErrorResponse ¶
type ErrorResponse struct { // Error - The error object. Error *ErrorDetail `json:"error,omitempty"` }
ErrorResponse common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
type LedgerClient ¶
type LedgerClient struct {
BaseClient
}
LedgerClient is the microsoft Azure Confidential Compute Ledger Control Plane REST API version 2020-12-01-preview.
func NewLedgerClient ¶
func NewLedgerClient(subscriptionID string) LedgerClient
NewLedgerClient creates an instance of the LedgerClient client.
func NewLedgerClientWithBaseURI ¶
func NewLedgerClientWithBaseURI(baseURI string, subscriptionID string) LedgerClient
NewLedgerClientWithBaseURI creates an instance of the LedgerClient 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 (LedgerClient) Create ¶
func (client LedgerClient) Create(ctx context.Context, resourceGroupName string, ledgerName string, confidentialLedger Model) (result LedgerCreateFuture, err error)
Create creates a Confidential Ledger with the specified ledger parameters. Parameters: resourceGroupName - the name of the resource group. ledgerName - name of the Confidential Ledger confidentialLedger - confidential Ledger Create Request Body
func (LedgerClient) CreatePreparer ¶
func (client LedgerClient) CreatePreparer(ctx context.Context, resourceGroupName string, ledgerName string, confidentialLedger Model) (*http.Request, error)
CreatePreparer prepares the Create request.
func (LedgerClient) CreateResponder ¶
func (client LedgerClient) CreateResponder(resp *http.Response) (result Model, err error)
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (LedgerClient) CreateSender ¶
func (client LedgerClient) CreateSender(req *http.Request) (future LedgerCreateFuture, err error)
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (LedgerClient) Delete ¶
func (client LedgerClient) Delete(ctx context.Context, resourceGroupName string, ledgerName string) (result LedgerDeleteFuture, err error)
Delete deletes an existing Confidential Ledger. Parameters: resourceGroupName - the name of the resource group. ledgerName - name of the Confidential Ledger
func (LedgerClient) DeletePreparer ¶
func (client LedgerClient) DeletePreparer(ctx context.Context, resourceGroupName string, ledgerName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (LedgerClient) DeleteResponder ¶
func (client LedgerClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (LedgerClient) DeleteSender ¶
func (client LedgerClient) DeleteSender(req *http.Request) (future LedgerDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (LedgerClient) Get ¶
func (client LedgerClient) Get(ctx context.Context, resourceGroupName string, ledgerName string) (result Model, err error)
Get retrieves the properties of a Confidential Ledger. Parameters: resourceGroupName - the name of the resource group. ledgerName - name of the Confidential Ledger
func (LedgerClient) GetPreparer ¶
func (client LedgerClient) GetPreparer(ctx context.Context, resourceGroupName string, ledgerName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (LedgerClient) GetResponder ¶
func (client LedgerClient) GetResponder(resp *http.Response) (result Model, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (LedgerClient) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (LedgerClient) ListByResourceGroup ¶
func (client LedgerClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, filter string) (result ListPage, err error)
ListByResourceGroup retrieves the properties of all Confidential Ledgers. Parameters: resourceGroupName - the name of the resource group. filter - the filter to apply on the list operation. eg. $filter=ledgerType eq 'Public'
func (LedgerClient) ListByResourceGroupComplete ¶
func (client LedgerClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, filter string) (result ListIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (LedgerClient) ListByResourceGroupPreparer ¶
func (client LedgerClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, filter string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (LedgerClient) ListByResourceGroupResponder ¶
func (client LedgerClient) ListByResourceGroupResponder(resp *http.Response) (result List, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (LedgerClient) ListByResourceGroupSender ¶
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (LedgerClient) ListBySubscription ¶
func (client LedgerClient) ListBySubscription(ctx context.Context, filter string) (result ListPage, err error)
ListBySubscription retrieves the properties of all Confidential Ledgers. Parameters: filter - the filter to apply on the list operation. eg. $filter=ledgerType eq 'Public'
func (LedgerClient) ListBySubscriptionComplete ¶
func (client LedgerClient) ListBySubscriptionComplete(ctx context.Context, filter string) (result ListIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (LedgerClient) ListBySubscriptionPreparer ¶
func (client LedgerClient) ListBySubscriptionPreparer(ctx context.Context, filter string) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (LedgerClient) ListBySubscriptionResponder ¶
func (client LedgerClient) ListBySubscriptionResponder(resp *http.Response) (result List, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (LedgerClient) ListBySubscriptionSender ¶
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (LedgerClient) Update ¶
func (client LedgerClient) Update(ctx context.Context, resourceGroupName string, ledgerName string, confidentialLedger Model) (result LedgerUpdateFuture, err error)
Update updates properties of Confidential Ledger Parameters: resourceGroupName - the name of the resource group. ledgerName - name of the Confidential Ledger confidentialLedger - confidential Ledger request body for Updating Ledger
func (LedgerClient) UpdatePreparer ¶
func (client LedgerClient) UpdatePreparer(ctx context.Context, resourceGroupName string, ledgerName string, confidentialLedger Model) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (LedgerClient) UpdateResponder ¶
func (client LedgerClient) UpdateResponder(resp *http.Response) (result Model, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (LedgerClient) UpdateSender ¶
func (client LedgerClient) UpdateSender(req *http.Request) (future LedgerUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type LedgerCreateFuture ¶
type LedgerCreateFuture struct { azure.FutureAPI // Result returns the result of the asynchronous operation. // If the operation has not completed it will return an error. Result func(LedgerClient) (Model, error) }
LedgerCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*LedgerCreateFuture) UnmarshalJSON ¶
func (future *LedgerCreateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
type LedgerDeleteFuture ¶
type LedgerDeleteFuture struct { azure.FutureAPI // Result returns the result of the asynchronous operation. // If the operation has not completed it will return an error. Result func(LedgerClient) (autorest.Response, error) }
LedgerDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*LedgerDeleteFuture) UnmarshalJSON ¶
func (future *LedgerDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
type LedgerProperties ¶
type LedgerProperties struct { // LedgerName - READ-ONLY; Unique name for the Confidential Ledger. LedgerName *string `json:"ledgerName,omitempty"` // LedgerURI - READ-ONLY; Endpoint for calling Ledger Service. LedgerURI *string `json:"ledgerUri,omitempty"` // IdentityServiceURI - READ-ONLY; Endpoint for accessing network identity. IdentityServiceURI *string `json:"identityServiceUri,omitempty"` // LedgerInternalNamespace - READ-ONLY; Internal namespace for the Ledger LedgerInternalNamespace *string `json:"ledgerInternalNamespace,omitempty"` // LedgerStorageAccount - Name of the Blob Storage Account for saving ledger files LedgerStorageAccount *string `json:"ledgerStorageAccount,omitempty"` // LedgerType - Type of Confidential Ledger. Possible values include: 'LedgerTypeUnknown', 'LedgerTypePublic', 'LedgerTypePrivate' LedgerType LedgerType `json:"ledgerType,omitempty"` // ProvisioningState - READ-ONLY; Provisioning state of Ledger Resource. Possible values include: 'ProvisioningStateUnknown', 'ProvisioningStateSucceeded', 'ProvisioningStateFailed', 'ProvisioningStateCanceled', 'ProvisioningStateCreating', 'ProvisioningStateDeleting', 'ProvisioningStateUpdating' ProvisioningState ProvisioningState `json:"provisioningState,omitempty"` // AadBasedSecurityPrincipals - Array of all AAD based Security Principals. AadBasedSecurityPrincipals *[]AADBasedSecurityPrincipal `json:"aadBasedSecurityPrincipals,omitempty"` // CertBasedSecurityPrincipals - Array of all cert based Security Principals. CertBasedSecurityPrincipals *[]CertBasedSecurityPrincipal `json:"certBasedSecurityPrincipals,omitempty"` }
LedgerProperties additional Confidential Ledger properties.
func (LedgerProperties) MarshalJSON ¶
func (lp LedgerProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LedgerProperties.
type LedgerRoleName ¶
type LedgerRoleName string
LedgerRoleName enumerates the values for ledger role name.
const ( // LedgerRoleNameAdministrator ... LedgerRoleNameAdministrator LedgerRoleName = "Administrator" // LedgerRoleNameContributor ... LedgerRoleNameContributor LedgerRoleName = "Contributor" // LedgerRoleNameReader ... LedgerRoleNameReader LedgerRoleName = "Reader" )
func PossibleLedgerRoleNameValues ¶
func PossibleLedgerRoleNameValues() []LedgerRoleName
PossibleLedgerRoleNameValues returns an array of possible values for the LedgerRoleName const type.
type LedgerType ¶
type LedgerType string
LedgerType enumerates the values for ledger type.
const ( // LedgerTypePrivate ... LedgerTypePrivate LedgerType = "Private" // LedgerTypePublic ... LedgerTypePublic LedgerType = "Public" // LedgerTypeUnknown ... LedgerTypeUnknown LedgerType = "Unknown" )
func PossibleLedgerTypeValues ¶
func PossibleLedgerTypeValues() []LedgerType
PossibleLedgerTypeValues returns an array of possible values for the LedgerType const type.
type LedgerUpdateFuture ¶
type LedgerUpdateFuture struct { azure.FutureAPI // Result returns the result of the asynchronous operation. // If the operation has not completed it will return an error. Result func(LedgerClient) (Model, error) }
LedgerUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*LedgerUpdateFuture) UnmarshalJSON ¶
func (future *LedgerUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
type List ¶
type List struct { autorest.Response `json:"-"` // Value - List of Confidential Ledgers Value *[]Model `json:"value,omitempty"` // NextLink - The URL the client should use to fetch the next page (per server side paging). NextLink *string `json:"nextLink,omitempty"` }
List object that includes an array of Confidential Ledgers and a possible link for next set.
type ListIterator ¶
type ListIterator struct {
// contains filtered or unexported fields
}
ListIterator provides access to a complete listing of Model values.
func NewListIterator ¶
func NewListIterator(page ListPage) ListIterator
Creates a new instance of the ListIterator type.
func (*ListIterator) Next ¶
func (iter *ListIterator) 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 (*ListIterator) NextWithContext ¶
func (iter *ListIterator) 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 (ListIterator) NotDone ¶
func (iter ListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (ListIterator) Response ¶
func (iter ListIterator) Response() List
Response returns the raw server response from the last page request.
func (ListIterator) Value ¶
func (iter ListIterator) Value() Model
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ListPage ¶
type ListPage struct {
// contains filtered or unexported fields
}
ListPage contains a page of Model values.
func NewListPage ¶
Creates a new instance of the ListPage type.
func (*ListPage) Next ¶
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 (*ListPage) NextWithContext ¶
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 (ListPage) NotDone ¶
NotDone returns true if the page enumeration should be started or is not yet complete.
type Location ¶
type Location struct { // Location - The Azure location where the Confidential Ledger is running. Location *string `json:"location,omitempty"` }
Location location of the ARM Resource
type Model ¶
type Model struct { autorest.Response `json:"-"` // Name - READ-ONLY; Name of the Resource. Name *string `json:"name,omitempty"` // ID - READ-ONLY; Fully qualified resource Id for the resource. ID *string `json:"id,omitempty"` // Type - READ-ONLY; The type of the resource. Type *string `json:"type,omitempty"` // SystemData - READ-ONLY; Metadata pertaining to creation and last modification of the resource SystemData *SystemData `json:"systemData,omitempty"` // Location - The Azure location where the Confidential Ledger is running. Location *string `json:"location,omitempty"` // Tags - Additional tags for Confidential Ledger Tags map[string]*string `json:"tags"` // Properties - Properties of Confidential Ledger Resource. Properties *LedgerProperties `json:"properties,omitempty"` }
Model confidential Ledger. Contains the properties of Confidential Ledger Resource.
func (Model) MarshalJSON ¶
MarshalJSON is the custom marshaler for Model.
type OperationsClient ¶
type OperationsClient struct {
BaseClient
}
OperationsClient is the microsoft Azure Confidential Compute Ledger Control Plane REST API version 2020-12-01-preview.
func NewOperationsClient ¶
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI ¶
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (OperationsClient) List ¶
func (client OperationsClient) List(ctx context.Context) (result ResourceProviderOperationListPage, err error)
List retrieves a list of available API operations
func (OperationsClient) ListComplete ¶
func (client OperationsClient) ListComplete(ctx context.Context) (result ResourceProviderOperationListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (OperationsClient) ListPreparer ¶
ListPreparer prepares the List request.
func (OperationsClient) ListResponder ¶
func (client OperationsClient) ListResponder(resp *http.Response) (result ResourceProviderOperationList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (OperationsClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type ProvisioningState ¶
type ProvisioningState string
ProvisioningState enumerates the values for provisioning state.
const ( // ProvisioningStateCanceled ... ProvisioningStateCanceled ProvisioningState = "Canceled" // ProvisioningStateCreating ... ProvisioningStateCreating ProvisioningState = "Creating" // ProvisioningStateDeleting ... ProvisioningStateDeleting ProvisioningState = "Deleting" // ProvisioningStateFailed ... ProvisioningStateFailed ProvisioningState = "Failed" // ProvisioningStateSucceeded ... ProvisioningStateSucceeded ProvisioningState = "Succeeded" // ProvisioningStateUnknown ... ProvisioningStateUnknown ProvisioningState = "Unknown" // ProvisioningStateUpdating ... ProvisioningStateUpdating ProvisioningState = "Updating" )
func PossibleProvisioningStateValues ¶
func PossibleProvisioningStateValues() []ProvisioningState
PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.
type Resource ¶
type Resource struct { // Name - READ-ONLY; Name of the Resource. Name *string `json:"name,omitempty"` // ID - READ-ONLY; Fully qualified resource Id for the resource. ID *string `json:"id,omitempty"` // Type - READ-ONLY; The type of the resource. Type *string `json:"type,omitempty"` // SystemData - READ-ONLY; Metadata pertaining to creation and last modification of the resource SystemData *SystemData `json:"systemData,omitempty"` }
Resource an Azure resource.
func (Resource) MarshalJSON ¶
MarshalJSON is the custom marshaler for Resource.
type ResourceProviderOperationDefinition ¶
type ResourceProviderOperationDefinition struct { // Name - Resource provider operation name. Name *string `json:"name,omitempty"` // IsDataAction - Indicates whether the operation is data action or not. IsDataAction *bool `json:"isDataAction,omitempty"` // Display - Details about the operations Display *ResourceProviderOperationDisplay `json:"display,omitempty"` }
ResourceProviderOperationDefinition describes the Resource Provider Operation.
type ResourceProviderOperationDisplay ¶
type ResourceProviderOperationDisplay struct { // Provider - Name of the resource provider. Provider *string `json:"provider,omitempty"` // Resource - Name of the resource type. Resource *string `json:"resource,omitempty"` // Operation - Name of the resource provider operation. Operation *string `json:"operation,omitempty"` // Description - Description of the resource provider operation. Description *string `json:"description,omitempty"` }
ResourceProviderOperationDisplay describes the properties of the Operation.
type ResourceProviderOperationList ¶
type ResourceProviderOperationList struct { autorest.Response `json:"-"` // Value - READ-ONLY; Resource provider operations list. Value *[]ResourceProviderOperationDefinition `json:"value,omitempty"` // NextLink - READ-ONLY; The URI that can be used to request the next page for list of Azure operations. NextLink *string `json:"nextLink,omitempty"` }
ResourceProviderOperationList list containing this Resource Provider's available operations.
func (ResourceProviderOperationList) IsEmpty ¶
func (rpol ResourceProviderOperationList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (ResourceProviderOperationList) MarshalJSON ¶
func (rpol ResourceProviderOperationList) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ResourceProviderOperationList.
type ResourceProviderOperationListIterator ¶
type ResourceProviderOperationListIterator struct {
// contains filtered or unexported fields
}
ResourceProviderOperationListIterator provides access to a complete listing of ResourceProviderOperationDefinition values.
func NewResourceProviderOperationListIterator ¶
func NewResourceProviderOperationListIterator(page ResourceProviderOperationListPage) ResourceProviderOperationListIterator
Creates a new instance of the ResourceProviderOperationListIterator type.
func (*ResourceProviderOperationListIterator) Next ¶
func (iter *ResourceProviderOperationListIterator) 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 (*ResourceProviderOperationListIterator) NextWithContext ¶
func (iter *ResourceProviderOperationListIterator) 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 (ResourceProviderOperationListIterator) NotDone ¶
func (iter ResourceProviderOperationListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (ResourceProviderOperationListIterator) Response ¶
func (iter ResourceProviderOperationListIterator) Response() ResourceProviderOperationList
Response returns the raw server response from the last page request.
func (ResourceProviderOperationListIterator) Value ¶
func (iter ResourceProviderOperationListIterator) Value() ResourceProviderOperationDefinition
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ResourceProviderOperationListPage ¶
type ResourceProviderOperationListPage struct {
// contains filtered or unexported fields
}
ResourceProviderOperationListPage contains a page of ResourceProviderOperationDefinition values.
func NewResourceProviderOperationListPage ¶
func NewResourceProviderOperationListPage(cur ResourceProviderOperationList, getNextPage func(context.Context, ResourceProviderOperationList) (ResourceProviderOperationList, error)) ResourceProviderOperationListPage
Creates a new instance of the ResourceProviderOperationListPage type.
func (*ResourceProviderOperationListPage) Next ¶
func (page *ResourceProviderOperationListPage) 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 (*ResourceProviderOperationListPage) NextWithContext ¶
func (page *ResourceProviderOperationListPage) 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 (ResourceProviderOperationListPage) NotDone ¶
func (page ResourceProviderOperationListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (ResourceProviderOperationListPage) Response ¶
func (page ResourceProviderOperationListPage) Response() ResourceProviderOperationList
Response returns the raw server response from the last page request.
func (ResourceProviderOperationListPage) Values ¶
func (page ResourceProviderOperationListPage) Values() []ResourceProviderOperationDefinition
Values returns the slice of values for the current page or nil if there are no values.
type SystemData ¶
type SystemData struct { // CreatedBy - The identity that created the resource. CreatedBy *string `json:"createdBy,omitempty"` // CreatedByType - The type of identity that created the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey' CreatedByType CreatedByType `json:"createdByType,omitempty"` // CreatedAt - The timestamp of resource creation (UTC). CreatedAt *date.Time `json:"createdAt,omitempty"` // LastModifiedBy - The identity that last modified the resource. LastModifiedBy *string `json:"lastModifiedBy,omitempty"` // LastModifiedByType - The type of identity that last modified the resource. Possible values include: 'CreatedByTypeUser', 'CreatedByTypeApplication', 'CreatedByTypeManagedIdentity', 'CreatedByTypeKey' LastModifiedByType CreatedByType `json:"lastModifiedByType,omitempty"` // LastModifiedAt - The timestamp of resource last modification (UTC) LastModifiedAt *date.Time `json:"lastModifiedAt,omitempty"` }
SystemData metadata pertaining to creation and last modification of the resource.