Documentation ¶
Index ¶
- type ActionType
- type Assessment
- type AssessmentResource
- type AssessmentSeverity
- type Category
- type CategoryStatus
- type CategoryType
- type ClientFactory
- type ComplianceReportItem
- type ComplianceResult
- type ComplianceState
- type Control
- type ControlFamily
- type ControlFamilyStatus
- type ControlFamilyType
- type ControlStatus
- type ControlType
- type CreatedByType
- type DownloadResponse
- type DownloadResponseComplianceDetailedPDFReport
- type DownloadResponseCompliancePDFReport
- type DownloadType
- type IsPass
- type Operation
- type OperationDisplay
- type OperationListResult
- type OperationsClient
- type OperationsClientListOptions
- type OperationsClientListResponse
- type Origin
- type OverviewStatus
- type ProvisioningState
- type ReportClient
- func (client *ReportClient) BeginCreateOrUpdate(ctx context.Context, reportName string, parameters ReportResource, ...) (*runtime.Poller[ReportClientCreateOrUpdateResponse], error)
- func (client *ReportClient) BeginDelete(ctx context.Context, reportName string, ...) (*runtime.Poller[ReportClientDeleteResponse], error)
- func (client *ReportClient) BeginUpdate(ctx context.Context, reportName string, parameters ReportResourcePatch, ...) (*runtime.Poller[ReportClientUpdateResponse], error)
- func (client *ReportClient) Get(ctx context.Context, reportName string, options *ReportClientGetOptions) (ReportClientGetResponse, error)
- type ReportClientBeginCreateOrUpdateOptions
- type ReportClientBeginDeleteOptions
- type ReportClientBeginUpdateOptions
- type ReportClientCreateOrUpdateResponse
- type ReportClientDeleteResponse
- type ReportClientGetOptions
- type ReportClientGetResponse
- type ReportClientUpdateResponse
- type ReportComplianceStatus
- type ReportProperties
- type ReportResource
- type ReportResourceList
- type ReportResourcePatch
- type ReportStatus
- type ReportsClient
- type ReportsClientListOptions
- type ReportsClientListResponse
- type ResourceItem
- type ResourceMetadata
- type ResourceStatus
- type SnapshotClient
- func (client *SnapshotClient) BeginDownload(ctx context.Context, reportName string, snapshotName string, ...) (*runtime.Poller[SnapshotClientDownloadResponse], error)
- func (client *SnapshotClient) Get(ctx context.Context, reportName string, snapshotName string, ...) (SnapshotClientGetResponse, error)
- type SnapshotClientBeginDownloadOptions
- type SnapshotClientDownloadResponse
- type SnapshotClientGetOptions
- type SnapshotClientGetResponse
- type SnapshotDownloadRequest
- type SnapshotProperties
- type SnapshotResource
- type SnapshotResourceList
- type SnapshotsClient
- type SnapshotsClientListOptions
- type SnapshotsClientListResponse
- type SystemData
Examples ¶
- OperationsClient.NewListPager
- ReportClient.BeginCreateOrUpdate
- ReportClient.BeginDelete
- ReportClient.BeginUpdate
- ReportClient.Get
- ReportsClient.NewListPager
- SnapshotClient.BeginDownload (SnapshotDownloadComplianceDetailedPdfReport)
- SnapshotClient.BeginDownload (SnapshotDownloadCompliancePdfReport)
- SnapshotClient.BeginDownload (SnapshotDownloadComplianceReport)
- SnapshotClient.BeginDownload (SnapshotDownloadResourceList)
- SnapshotClient.Get
- SnapshotsClient.NewListPager
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActionType ¶
type ActionType string
ActionType - Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
const (
ActionTypeInternal ActionType = "Internal"
)
func PossibleActionTypeValues ¶
func PossibleActionTypeValues() []ActionType
PossibleActionTypeValues returns the possible values for the ActionType const type.
type Assessment ¶
type Assessment struct { // READ-ONLY; The description of the assessment. Description *string // READ-ONLY; Indicates whether all the resource(s) are compliant. IsPass *IsPass // READ-ONLY; The name of the assessment. Name *string // READ-ONLY; The policy id mapping to this assessment. PolicyID *string // READ-ONLY; The remediation of the assessment. Remediation *string // READ-ONLY; List of resource assessments. ResourceList []*AssessmentResource // READ-ONLY; The severity level of this assessment. Severity *AssessmentSeverity }
Assessment - A class represent the assessment.
func (Assessment) MarshalJSON ¶
func (a Assessment) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type Assessment.
func (*Assessment) UnmarshalJSON ¶
func (a *Assessment) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type Assessment.
type AssessmentResource ¶
type AssessmentResource struct { // READ-ONLY; The reason for the N/A resource. Reason *string // READ-ONLY; The Id of the resource. ResourceID *string // READ-ONLY; Resource status. ResourceStatus *ResourceStatus // READ-ONLY; The status change date for the resource. For unavailable date, set it as N/A. StatusChangeDate *string }
AssessmentResource - A class represent the assessment resource.
func (AssessmentResource) MarshalJSON ¶
func (a AssessmentResource) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AssessmentResource.
func (*AssessmentResource) UnmarshalJSON ¶
func (a *AssessmentResource) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AssessmentResource.
type AssessmentSeverity ¶
type AssessmentSeverity string
AssessmentSeverity - Indicates the assessment severity.
const ( AssessmentSeverityHigh AssessmentSeverity = "High" AssessmentSeverityLow AssessmentSeverity = "Low" AssessmentSeverityMedium AssessmentSeverity = "Medium" )
func PossibleAssessmentSeverityValues ¶
func PossibleAssessmentSeverityValues() []AssessmentSeverity
PossibleAssessmentSeverityValues returns the possible values for the AssessmentSeverity const type.
type Category ¶
type Category struct { // READ-ONLY; The name of the compliance category. e.g. "Operational Security" CategoryName *string // READ-ONLY; Category status. CategoryStatus *CategoryStatus // READ-ONLY; The category type CategoryType *CategoryType // READ-ONLY; List of control families. ControlFamilies []*ControlFamily }
Category - A class represent the compliance category.
func (Category) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type Category.
func (*Category) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type Category.
type CategoryStatus ¶
type CategoryStatus string
CategoryStatus - Indicates the category status.
const ( CategoryStatusHealthy CategoryStatus = "Healthy" CategoryStatusUnhealthy CategoryStatus = "Unhealthy" )
func PossibleCategoryStatusValues ¶
func PossibleCategoryStatusValues() []CategoryStatus
PossibleCategoryStatusValues returns the possible values for the CategoryStatus const type.
type CategoryType ¶
type CategoryType string
CategoryType - Indicates the compliance category type.
const ( CategoryTypeFullyAutomated CategoryType = "FullyAutomated" CategoryTypeManual CategoryType = "Manual" CategoryTypePartiallyAutomated CategoryType = "PartiallyAutomated" )
func PossibleCategoryTypeValues ¶
func PossibleCategoryTypeValues() []CategoryType
PossibleCategoryTypeValues returns the possible values for the CategoryType const type.
type ClientFactory ¶ added in v0.2.0
type ClientFactory struct {
// contains filtered or unexported fields
}
ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.
func NewClientFactory ¶ added in v0.2.0
func NewClientFactory(credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)
NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.
- credential - used to authorize requests. Usually a credential from azidentity.
- options - pass nil to accept the default values.
func (*ClientFactory) NewOperationsClient ¶ added in v0.2.0
func (c *ClientFactory) NewOperationsClient() *OperationsClient
NewOperationsClient creates a new instance of OperationsClient.
func (*ClientFactory) NewReportClient ¶ added in v0.2.0
func (c *ClientFactory) NewReportClient() *ReportClient
NewReportClient creates a new instance of ReportClient.
func (*ClientFactory) NewReportsClient ¶ added in v0.2.0
func (c *ClientFactory) NewReportsClient() *ReportsClient
NewReportsClient creates a new instance of ReportsClient.
func (*ClientFactory) NewSnapshotClient ¶ added in v0.2.0
func (c *ClientFactory) NewSnapshotClient() *SnapshotClient
NewSnapshotClient creates a new instance of SnapshotClient.
func (*ClientFactory) NewSnapshotsClient ¶ added in v0.2.0
func (c *ClientFactory) NewSnapshotsClient() *SnapshotsClient
NewSnapshotsClient creates a new instance of SnapshotsClient.
type ComplianceReportItem ¶
type ComplianceReportItem struct { // READ-ONLY; The category name. CategoryName *string // READ-ONLY; The compliance result's status. ComplianceState *ComplianceState // READ-ONLY; The control Id - e.g. "1". ControlID *string // READ-ONLY; The control name. ControlName *string // READ-ONLY; The control type. ControlType *ControlType // READ-ONLY; The policy's detail description. PolicyDescription *string // READ-ONLY; The policy's display name. PolicyDisplayName *string // READ-ONLY; The compliance result mapped policy Id. PolicyID *string // READ-ONLY; The compliance result mapped resource group. ResourceGroup *string // READ-ONLY; The compliance result mapped resource Id - e.g. "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1". ResourceID *string // READ-ONLY; The compliance result mapped resource type. ResourceType *string // READ-ONLY; The compliance result last changed date - e.g. "2022-10-24T02:55:16.3274379Z". For unavailable date, set it // as "N/A". StatusChangeDate *string // READ-ONLY; The compliance result mapped subscription Id. SubscriptionID *string }
ComplianceReportItem - Object that includes all the content for single compliance result.
func (ComplianceReportItem) MarshalJSON ¶
func (c ComplianceReportItem) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ComplianceReportItem.
func (*ComplianceReportItem) UnmarshalJSON ¶
func (c *ComplianceReportItem) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ComplianceReportItem.
type ComplianceResult ¶
type ComplianceResult struct { // READ-ONLY; List of categories. Categories []*Category // READ-ONLY; The name of the compliance. e.g. "M365" ComplianceName *string }
ComplianceResult - A class represent the compliance result.
func (ComplianceResult) MarshalJSON ¶
func (c ComplianceResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ComplianceResult.
func (*ComplianceResult) UnmarshalJSON ¶
func (c *ComplianceResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ComplianceResult.
type ComplianceState ¶
type ComplianceState string
ComplianceState - The compliance result's status.
const ( ComplianceStateHealthy ComplianceState = "Healthy" ComplianceStateUnhealthy ComplianceState = "Unhealthy" )
func PossibleComplianceStateValues ¶
func PossibleComplianceStateValues() []ComplianceState
PossibleComplianceStateValues returns the possible values for the ComplianceState const type.
type Control ¶
type Control struct { // READ-ONLY; List of assessments. Assessments []*Assessment // READ-ONLY; The control's description ControlDescription *string // READ-ONLY; The hyper link to the control's description'. ControlDescriptionHyperLink *string // READ-ONLY; The full name of the control. e.g. "Validate that unsupported operating systems and software components are // not in use." ControlFullName *string // READ-ONLY; The Id of the control. e.g. "Operational Security#10" ControlID *string // READ-ONLY; The short name of the control. e.g. "Unsupported OS and Software." ControlShortName *string // READ-ONLY; Control status. ControlStatus *ControlStatus // READ-ONLY; The control type ControlType *ControlType }
Control - A class represent the control.
func (Control) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type Control.
func (*Control) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type Control.
type ControlFamily ¶
type ControlFamily struct { // READ-ONLY; List of controls. Controls []*Control // READ-ONLY; The name of the control family. e.g. "Malware Protection - Anti-Virus" FamilyName *string // READ-ONLY; Control family status. FamilyStatus *ControlFamilyStatus // READ-ONLY; The control family type FamilyType *ControlFamilyType }
ControlFamily - A class represent the control family.
func (ControlFamily) MarshalJSON ¶
func (c ControlFamily) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ControlFamily.
func (*ControlFamily) UnmarshalJSON ¶
func (c *ControlFamily) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ControlFamily.
type ControlFamilyStatus ¶
type ControlFamilyStatus string
ControlFamilyStatus - Indicates the control family status.
const ( ControlFamilyStatusHealthy ControlFamilyStatus = "Healthy" ControlFamilyStatusUnhealthy ControlFamilyStatus = "Unhealthy" )
func PossibleControlFamilyStatusValues ¶
func PossibleControlFamilyStatusValues() []ControlFamilyStatus
PossibleControlFamilyStatusValues returns the possible values for the ControlFamilyStatus const type.
type ControlFamilyType ¶
type ControlFamilyType string
ControlFamilyType - Indicates the control family type.
const ( ControlFamilyTypeFullyAutomated ControlFamilyType = "FullyAutomated" ControlFamilyTypeManual ControlFamilyType = "Manual" ControlFamilyTypePartiallyAutomated ControlFamilyType = "PartiallyAutomated" )
func PossibleControlFamilyTypeValues ¶
func PossibleControlFamilyTypeValues() []ControlFamilyType
PossibleControlFamilyTypeValues returns the possible values for the ControlFamilyType const type.
type ControlStatus ¶
type ControlStatus string
ControlStatus - Indicates the control status.
const ( ControlStatusFailed ControlStatus = "Failed" ControlStatusNotApplicable ControlStatus = "NotApplicable" ControlStatusPassed ControlStatus = "Passed" )
func PossibleControlStatusValues ¶
func PossibleControlStatusValues() []ControlStatus
PossibleControlStatusValues returns the possible values for the ControlStatus const type.
type ControlType ¶
type ControlType string
ControlType - Indicates the control type.
const ( ControlTypeFullyAutomated ControlType = "FullyAutomated" ControlTypeManual ControlType = "Manual" ControlTypePartiallyAutomated ControlType = "PartiallyAutomated" )
func PossibleControlTypeValues ¶
func PossibleControlTypeValues() []ControlType
PossibleControlTypeValues returns the possible values for the ControlType const type.
type CreatedByType ¶
type CreatedByType string
CreatedByType - The type of identity that created the resource.
const ( CreatedByTypeApplication CreatedByType = "Application" CreatedByTypeKey CreatedByType = "Key" CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity" CreatedByTypeUser CreatedByType = "User" )
func PossibleCreatedByTypeValues ¶
func PossibleCreatedByTypeValues() []CreatedByType
PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.
type DownloadResponse ¶
type DownloadResponse struct { // READ-ONLY; compliance detailed pdf report ComplianceDetailedPDFReport *DownloadResponseComplianceDetailedPDFReport // READ-ONLY; compliance pdf report CompliancePDFReport *DownloadResponseCompliancePDFReport // READ-ONLY; List of the compliance result ComplianceReport []*ComplianceReportItem // READ-ONLY; List of the reports ResourceList []*ResourceItem }
DownloadResponse - Object that includes all the possible response for the download operation.
func (DownloadResponse) MarshalJSON ¶
func (d DownloadResponse) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type DownloadResponse.
func (*DownloadResponse) UnmarshalJSON ¶
func (d *DownloadResponse) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type DownloadResponse.
type DownloadResponseComplianceDetailedPDFReport ¶
type DownloadResponseComplianceDetailedPDFReport struct { // READ-ONLY; uri of compliance detailed pdf report SasURI *string }
DownloadResponseComplianceDetailedPDFReport - compliance detailed pdf report
func (DownloadResponseComplianceDetailedPDFReport) MarshalJSON ¶
func (d DownloadResponseComplianceDetailedPDFReport) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type DownloadResponseComplianceDetailedPDFReport.
func (*DownloadResponseComplianceDetailedPDFReport) UnmarshalJSON ¶
func (d *DownloadResponseComplianceDetailedPDFReport) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type DownloadResponseComplianceDetailedPDFReport.
type DownloadResponseCompliancePDFReport ¶
type DownloadResponseCompliancePDFReport struct { // READ-ONLY; uri of compliance pdf report SasURI *string }
DownloadResponseCompliancePDFReport - compliance pdf report
func (DownloadResponseCompliancePDFReport) MarshalJSON ¶
func (d DownloadResponseCompliancePDFReport) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type DownloadResponseCompliancePDFReport.
func (*DownloadResponseCompliancePDFReport) UnmarshalJSON ¶
func (d *DownloadResponseCompliancePDFReport) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type DownloadResponseCompliancePDFReport.
type DownloadType ¶
type DownloadType string
DownloadType - Indicates the download type.
const ( DownloadTypeComplianceDetailedPDFReport DownloadType = "ComplianceDetailedPdfReport" DownloadTypeCompliancePDFReport DownloadType = "CompliancePdfReport" DownloadTypeComplianceReport DownloadType = "ComplianceReport" DownloadTypeResourceList DownloadType = "ResourceList" )
func PossibleDownloadTypeValues ¶
func PossibleDownloadTypeValues() []DownloadType
PossibleDownloadTypeValues returns the possible values for the DownloadType const type.
type IsPass ¶
type IsPass string
IsPass - Indicates whether all the resource(s) are compliant.
func PossibleIsPassValues ¶
func PossibleIsPassValues() []IsPass
PossibleIsPassValues returns the possible values for the IsPass const type.
type Operation ¶
type Operation struct { // Localized display information for this particular operation. Display *OperationDisplay // READ-ONLY; Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ActionType *ActionType // READ-ONLY; Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane // operations. IsDataAction *bool // READ-ONLY; The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", // "Microsoft.Compute/virtualMachines/capture/action" Name *string // READ-ONLY; The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default // value is "user,system" Origin *Origin }
Operation - Details of a REST API operation, returned from the Resource Provider Operations API
func (Operation) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type Operation.
func (*Operation) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type Operation.
type OperationDisplay ¶
type OperationDisplay struct { // READ-ONLY; The short, localized friendly description of the operation; suitable for tool tips and detailed views. Description *string // READ-ONLY; The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual // Machine", "Restart Virtual Machine". Operation *string // READ-ONLY; The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft // Compute". Provider *string // READ-ONLY; The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job // Schedule Collections". Resource *string }
OperationDisplay - Localized display information for this particular operation.
func (OperationDisplay) MarshalJSON ¶
func (o OperationDisplay) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type OperationDisplay.
func (*OperationDisplay) UnmarshalJSON ¶
func (o *OperationDisplay) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.
type OperationListResult ¶
type OperationListResult struct { // READ-ONLY; URL to get the next set of operation list results (if there are any). NextLink *string // READ-ONLY; List of operations supported by the resource provider Value []*Operation }
OperationListResult - A list of REST API operations supported by an Azure Resource Provider. It contains an 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.
func (*OperationListResult) UnmarshalJSON ¶
func (o *OperationListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type OperationListResult.
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, error)
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) NewListPager ¶
func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]
NewListPager - Lists all of the available REST API operations of the Microsoft.AppComplianceAutomation provider.
Generated from API version 2022-11-16-preview
- options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
Example ¶
Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82ea406b73d671269217053d7ef336450d860345/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Operations_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/appcomplianceautomation/armappcomplianceautomation" ) func main() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armappcomplianceautomation.NewClientFactory(cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } pager := clientFactory.NewOperationsClient().NewListPager(nil) for pager.More() { page, err := pager.NextPage(ctx) if err != nil { log.Fatalf("failed to advance page: %v", err) } for _, v := range page.Value { // You could use page here. We use blank identifier for just demo purposes. _ = v } // If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes. // page.OperationListResult = armappcomplianceautomation.OperationListResult{ // Value: []*armappcomplianceautomation.Operation{ // { // Name: to.Ptr("Microsoft.AppComplianceAutomation/reports/write"), // Display: &armappcomplianceautomation.OperationDisplay{ // Description: to.Ptr("Create new reports."), // Operation: to.Ptr("Microsoft.AppComplianceAutomation/reports/write"), // Provider: to.Ptr("Microsoft AppComplianceAutomation"), // Resource: to.Ptr("Microsoft.AppComplianceAutomation/reports"), // }, // IsDataAction: to.Ptr(false), // }}, // } } }
Output:
type OperationsClientListOptions ¶
type OperationsClientListOptions struct { }
OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
type OperationsClientListResponse ¶
type OperationsClientListResponse struct { // A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. OperationListResult }
OperationsClientListResponse contains the response from method OperationsClient.NewListPager.
type Origin ¶
type Origin string
Origin - The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
func PossibleOriginValues ¶
func PossibleOriginValues() []Origin
PossibleOriginValues returns the possible values for the Origin const type.
type OverviewStatus ¶
type OverviewStatus struct { // The count of all failed full automation control. FailedCount *int32 // The count of all manual control. ManualCount *int32 // The count of all passed full automation control. PassedCount *int32 }
OverviewStatus - The overview of the compliance result for one report.
func (OverviewStatus) MarshalJSON ¶
func (o OverviewStatus) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type OverviewStatus.
func (*OverviewStatus) UnmarshalJSON ¶
func (o *OverviewStatus) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type OverviewStatus.
type ProvisioningState ¶
type ProvisioningState string
ProvisioningState - Resource provisioning states.
const ( ProvisioningStateCanceled ProvisioningState = "Canceled" ProvisioningStateCreating ProvisioningState = "Creating" ProvisioningStateDeleting ProvisioningState = "Deleting" ProvisioningStateFailed ProvisioningState = "Failed" ProvisioningStateSucceeded ProvisioningState = "Succeeded" ProvisioningStateUpdating ProvisioningState = "Updating" )
func PossibleProvisioningStateValues ¶
func PossibleProvisioningStateValues() []ProvisioningState
PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.
type ReportClient ¶
type ReportClient struct {
// contains filtered or unexported fields
}
ReportClient contains the methods for the Report group. Don't use this type directly, use NewReportClient() instead.
func NewReportClient ¶
func NewReportClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*ReportClient, error)
NewReportClient creates a new instance of ReportClient with the specified values.
- credential - used to authorize requests. Usually a credential from azidentity.
- options - pass nil to accept the default values.
func (*ReportClient) BeginCreateOrUpdate ¶
func (client *ReportClient) BeginCreateOrUpdate(ctx context.Context, reportName string, parameters ReportResource, options *ReportClientBeginCreateOrUpdateOptions) (*runtime.Poller[ReportClientCreateOrUpdateResponse], error)
BeginCreateOrUpdate - Create a new AppComplianceAutomation report or update an exiting AppComplianceAutomation report. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2022-11-16-preview
- reportName - Report Name.
- parameters - Parameters for the create or update operation
- options - ReportClientBeginCreateOrUpdateOptions contains the optional parameters for the ReportClient.BeginCreateOrUpdate method.
Example ¶
Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82ea406b73d671269217053d7ef336450d860345/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Report_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/appcomplianceautomation/armappcomplianceautomation" ) func main() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armappcomplianceautomation.NewClientFactory(cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } poller, err := clientFactory.NewReportClient().BeginCreateOrUpdate(ctx, "testReportName", armappcomplianceautomation.ReportResource{ Properties: &armappcomplianceautomation.ReportProperties{ OfferGUID: to.Ptr("0000"), Resources: []*armappcomplianceautomation.ResourceMetadata{ { ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"), Tags: map[string]*string{ "key1": to.Ptr("value1"), }, }}, TimeZone: to.Ptr("GMT Standard Time"), TriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-04T05:11:56.197Z"); return t }()), }, }, nil) if err != nil { log.Fatalf("failed to finish the request: %v", err) } res, err := poller.PollUntilDone(ctx, nil) if err != nil { log.Fatalf("failed to pull the result: %v", err) } // You could use response here. We use blank identifier for just demo purposes. _ = res // If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes. // res.ReportResource = armappcomplianceautomation.ReportResource{ // Name: to.Ptr("testReportName"), // Type: to.Ptr("Microsfot.AppComplianceAutomation/reports"), // ID: to.Ptr("/provider/Microsfot.AppComplianceAutomation/reports/testReportName"), // SystemData: &armappcomplianceautomation.SystemData{ // CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()), // CreatedBy: to.Ptr("00000000-0000-0000-0000-000000000000"), // CreatedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser), // LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()), // LastModifiedBy: to.Ptr("00000000-0000-0000-0000-000000000000"), // LastModifiedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser), // }, // Properties: &armappcomplianceautomation.ReportProperties{ // ComplianceStatus: &armappcomplianceautomation.ReportComplianceStatus{ // M365: &armappcomplianceautomation.OverviewStatus{ // FailedCount: to.Ptr[int32](0), // ManualCount: to.Ptr[int32](0), // PassedCount: to.Ptr[int32](0), // }, // }, // ID: to.Ptr("00000000-0000-0000-0000-000000000000"), // LastTriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T05:17:23.922Z"); return t}()), // NextTriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T05:17:23.922Z"); return t}()), // OfferGUID: to.Ptr("00000000-0000-0000-0000-000000000000"), // ProvisioningState: to.Ptr(armappcomplianceautomation.ProvisioningStateSucceeded), // ReportName: to.Ptr("testReportName"), // Resources: []*armappcomplianceautomation.ResourceMetadata{ // { // ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService"), // Tags: map[string]*string{ // "key1": to.Ptr("value1"), // }, // }}, // Status: to.Ptr(armappcomplianceautomation.ReportStatusActive), // Subscriptions: []*string{ // to.Ptr("00000000-0000-0000-0000-000000000000")}, // TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"), // TimeZone: to.Ptr("GMT Standard Time"), // TriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T05:17:23.922Z"); return t}()), // }, // } }
Output:
func (*ReportClient) BeginDelete ¶
func (client *ReportClient) BeginDelete(ctx context.Context, reportName string, options *ReportClientBeginDeleteOptions) (*runtime.Poller[ReportClientDeleteResponse], error)
BeginDelete - Delete an AppComplianceAutomation report. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2022-11-16-preview
- reportName - Report Name.
- options - ReportClientBeginDeleteOptions contains the optional parameters for the ReportClient.BeginDelete method.
Example ¶
Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82ea406b73d671269217053d7ef336450d860345/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Report_Delete.json
package main import ( "context" "log" "github.com/Azure/azure-sdk-for-go/sdk/azidentity" "github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcomplianceautomation/armappcomplianceautomation" ) func main() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armappcomplianceautomation.NewClientFactory(cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } poller, err := clientFactory.NewReportClient().BeginDelete(ctx, "testReportName", nil) if err != nil { log.Fatalf("failed to finish the request: %v", err) } _, err = poller.PollUntilDone(ctx, nil) if err != nil { log.Fatalf("failed to pull the result: %v", err) } }
Output:
func (*ReportClient) BeginUpdate ¶
func (client *ReportClient) BeginUpdate(ctx context.Context, reportName string, parameters ReportResourcePatch, options *ReportClientBeginUpdateOptions) (*runtime.Poller[ReportClientUpdateResponse], error)
BeginUpdate - Update an exiting AppComplianceAutomation report. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2022-11-16-preview
- reportName - Report Name.
- parameters - Parameters for the create or update operation
- options - ReportClientBeginUpdateOptions contains the optional parameters for the ReportClient.BeginUpdate method.
Example ¶
Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82ea406b73d671269217053d7ef336450d860345/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Report_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/appcomplianceautomation/armappcomplianceautomation" ) func main() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armappcomplianceautomation.NewClientFactory(cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } poller, err := clientFactory.NewReportClient().BeginUpdate(ctx, "testReportName", armappcomplianceautomation.ReportResourcePatch{ Properties: &armappcomplianceautomation.ReportProperties{ OfferGUID: to.Ptr("0000"), Resources: []*armappcomplianceautomation.ResourceMetadata{ { ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"), Tags: map[string]*string{ "key1": to.Ptr("value1"), }, }}, TimeZone: to.Ptr("GMT Standard Time"), TriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-04T05:11:56.197Z"); return t }()), }, }, nil) if err != nil { log.Fatalf("failed to finish the request: %v", err) } res, err := poller.PollUntilDone(ctx, nil) if err != nil { log.Fatalf("failed to pull the result: %v", err) } // You could use response here. We use blank identifier for just demo purposes. _ = res // If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes. // res.ReportResource = armappcomplianceautomation.ReportResource{ // Name: to.Ptr("testReportName"), // Type: to.Ptr("Microsfot.AppComplianceAutomation/reports"), // ID: to.Ptr("/provider/Microsfot.AppComplianceAutomation/reports/testReportName"), // SystemData: &armappcomplianceautomation.SystemData{ // CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()), // CreatedBy: to.Ptr("00000000-0000-0000-0000-000000000000"), // CreatedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser), // LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()), // LastModifiedBy: to.Ptr("00000000-0000-0000-0000-000000000000"), // LastModifiedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser), // }, // Properties: &armappcomplianceautomation.ReportProperties{ // ComplianceStatus: &armappcomplianceautomation.ReportComplianceStatus{ // M365: &armappcomplianceautomation.OverviewStatus{ // FailedCount: to.Ptr[int32](0), // ManualCount: to.Ptr[int32](0), // PassedCount: to.Ptr[int32](0), // }, // }, // ID: to.Ptr("00000000-0000-0000-0000-000000000000"), // LastTriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T05:17:23.922Z"); return t}()), // NextTriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T05:17:23.922Z"); return t}()), // OfferGUID: to.Ptr("00000000-0000-0000-0000-000000000000"), // ProvisioningState: to.Ptr(armappcomplianceautomation.ProvisioningStateSucceeded), // ReportName: to.Ptr("testReportName"), // Resources: []*armappcomplianceautomation.ResourceMetadata{ // { // ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService"), // Tags: map[string]*string{ // "key1": to.Ptr("value1"), // }, // }}, // Status: to.Ptr(armappcomplianceautomation.ReportStatusActive), // Subscriptions: []*string{ // to.Ptr("00000000-0000-0000-0000-000000000000")}, // TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"), // TimeZone: to.Ptr("GMT Standard Time"), // TriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T05:17:23.922Z"); return t}()), // }, // } }
Output:
func (*ReportClient) Get ¶
func (client *ReportClient) Get(ctx context.Context, reportName string, options *ReportClientGetOptions) (ReportClientGetResponse, error)
Get - Get the AppComplianceAutomation report and its properties. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2022-11-16-preview
- reportName - Report Name.
- options - ReportClientGetOptions contains the optional parameters for the ReportClient.Get method.
Example ¶
Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82ea406b73d671269217053d7ef336450d860345/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Report_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/appcomplianceautomation/armappcomplianceautomation" ) func main() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armappcomplianceautomation.NewClientFactory(cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } res, err := clientFactory.NewReportClient().Get(ctx, "testReport", nil) if err != nil { log.Fatalf("failed to finish the request: %v", err) } // You could use response here. We use blank identifier for just demo purposes. _ = res // If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes. // res.ReportResource = armappcomplianceautomation.ReportResource{ // Name: to.Ptr("testReportName"), // Type: to.Ptr("Microsfot.AppComplianceAutomation/reports"), // ID: to.Ptr("/provider/Microsfot.AppComplianceAutomation/reports/testReportName"), // SystemData: &armappcomplianceautomation.SystemData{ // CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()), // CreatedBy: to.Ptr("00000000-0000-0000-0000-000000000000"), // CreatedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser), // LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()), // LastModifiedBy: to.Ptr("00000000-0000-0000-0000-000000000000"), // LastModifiedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser), // }, // Properties: &armappcomplianceautomation.ReportProperties{ // ComplianceStatus: &armappcomplianceautomation.ReportComplianceStatus{ // M365: &armappcomplianceautomation.OverviewStatus{ // FailedCount: to.Ptr[int32](0), // ManualCount: to.Ptr[int32](0), // PassedCount: to.Ptr[int32](0), // }, // }, // ID: to.Ptr("00000000-0000-0000-0000-000000000000"), // LastTriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T05:17:23.922Z"); return t}()), // NextTriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T05:17:23.922Z"); return t}()), // OfferGUID: to.Ptr("00000000-0000-0000-0000-000000000000"), // ProvisioningState: to.Ptr(armappcomplianceautomation.ProvisioningStateSucceeded), // ReportName: to.Ptr("testReportName"), // Resources: []*armappcomplianceautomation.ResourceMetadata{ // { // ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService"), // Tags: map[string]*string{ // "key1": to.Ptr("value1"), // }, // }}, // Status: to.Ptr(armappcomplianceautomation.ReportStatusActive), // Subscriptions: []*string{ // to.Ptr("00000000-0000-0000-0000-000000000000")}, // TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"), // TimeZone: to.Ptr("GMT Standard Time"), // TriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T05:17:23.922Z"); return t}()), // }, // } }
Output:
type ReportClientBeginCreateOrUpdateOptions ¶
type ReportClientBeginCreateOrUpdateOptions struct { // Resumes the LRO from the provided token. ResumeToken string }
ReportClientBeginCreateOrUpdateOptions contains the optional parameters for the ReportClient.BeginCreateOrUpdate method.
type ReportClientBeginDeleteOptions ¶
type ReportClientBeginDeleteOptions struct { // Resumes the LRO from the provided token. ResumeToken string }
ReportClientBeginDeleteOptions contains the optional parameters for the ReportClient.BeginDelete method.
type ReportClientBeginUpdateOptions ¶
type ReportClientBeginUpdateOptions struct { // Resumes the LRO from the provided token. ResumeToken string }
ReportClientBeginUpdateOptions contains the optional parameters for the ReportClient.BeginUpdate method.
type ReportClientCreateOrUpdateResponse ¶
type ReportClientCreateOrUpdateResponse struct { // A class represent an AppComplianceAutomation report resource. ReportResource }
ReportClientCreateOrUpdateResponse contains the response from method ReportClient.BeginCreateOrUpdate.
type ReportClientDeleteResponse ¶
type ReportClientDeleteResponse struct { }
ReportClientDeleteResponse contains the response from method ReportClient.BeginDelete.
type ReportClientGetOptions ¶
type ReportClientGetOptions struct { }
ReportClientGetOptions contains the optional parameters for the ReportClient.Get method.
type ReportClientGetResponse ¶
type ReportClientGetResponse struct { // A class represent an AppComplianceAutomation report resource. ReportResource }
ReportClientGetResponse contains the response from method ReportClient.Get.
type ReportClientUpdateResponse ¶
type ReportClientUpdateResponse struct { // A class represent an AppComplianceAutomation report resource. ReportResource }
ReportClientUpdateResponse contains the response from method ReportClient.BeginUpdate.
type ReportComplianceStatus ¶
type ReportComplianceStatus struct { // The Microsoft 365 certification name. M365 *OverviewStatus }
ReportComplianceStatus - A list which includes all the compliance result for one report.
func (ReportComplianceStatus) MarshalJSON ¶
func (r ReportComplianceStatus) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ReportComplianceStatus.
func (*ReportComplianceStatus) UnmarshalJSON ¶
func (r *ReportComplianceStatus) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ReportComplianceStatus.
type ReportProperties ¶
type ReportProperties struct { // REQUIRED; List of resource data. Resources []*ResourceMetadata // REQUIRED; Report collection trigger time's time zone, the available list can be obtained by executing "Get-TimeZone -ListAvailable" // in PowerShell. An example of valid timezone id is "Pacific Standard Time". TimeZone *string // REQUIRED; Report collection trigger time. TriggerTime *time.Time // Report offer Guid. OfferGUID *string // READ-ONLY; Report compliance status. ComplianceStatus *ReportComplianceStatus // READ-ONLY; Report id in database. ID *string // READ-ONLY; Report last collection trigger time. LastTriggerTime *time.Time // READ-ONLY; Report next collection trigger time. NextTriggerTime *time.Time // READ-ONLY; Azure lifecycle management ProvisioningState *ProvisioningState // READ-ONLY; Report name. ReportName *string // READ-ONLY; Report status. Status *ReportStatus // READ-ONLY; List of subscription Ids. Subscriptions []*string // READ-ONLY; Report's tenant id. TenantID *string }
ReportProperties - Report's properties.
func (ReportProperties) MarshalJSON ¶
func (r ReportProperties) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ReportProperties.
func (*ReportProperties) UnmarshalJSON ¶
func (r *ReportProperties) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ReportProperties.
type ReportResource ¶
type ReportResource struct { // REQUIRED; Report property. Properties *ReportProperties // READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ID *string // READ-ONLY; The name of the resource Name *string // READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData *SystemData // READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string }
ReportResource - A class represent an AppComplianceAutomation report resource.
func (ReportResource) MarshalJSON ¶
func (r ReportResource) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ReportResource.
func (*ReportResource) UnmarshalJSON ¶
func (r *ReportResource) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ReportResource.
type ReportResourceList ¶
type ReportResourceList struct { // The URL the client should use to fetch the next page (per server side paging). It's null for now, added for future use. NextLink *string // READ-ONLY; List of the reports Value []*ReportResource }
ReportResourceList - Object that includes an array of resources and a possible link for next set.
func (ReportResourceList) MarshalJSON ¶
func (r ReportResourceList) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ReportResourceList.
func (*ReportResourceList) UnmarshalJSON ¶
func (r *ReportResourceList) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ReportResourceList.
type ReportResourcePatch ¶
type ReportResourcePatch struct { // Report property. Properties *ReportProperties }
ReportResourcePatch - A class represent a AppComplianceAutomation report resource update properties.
func (ReportResourcePatch) MarshalJSON ¶
func (r ReportResourcePatch) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ReportResourcePatch.
func (*ReportResourcePatch) UnmarshalJSON ¶
func (r *ReportResourcePatch) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ReportResourcePatch.
type ReportStatus ¶
type ReportStatus string
ReportStatus - Report status.
const ( ReportStatusActive ReportStatus = "Active" ReportStatusDisabled ReportStatus = "Disabled" ReportStatusFailed ReportStatus = "Failed" )
func PossibleReportStatusValues ¶
func PossibleReportStatusValues() []ReportStatus
PossibleReportStatusValues returns the possible values for the ReportStatus const type.
type ReportsClient ¶
type ReportsClient struct {
// contains filtered or unexported fields
}
ReportsClient contains the methods for the Reports group. Don't use this type directly, use NewReportsClient() instead.
func NewReportsClient ¶
func NewReportsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*ReportsClient, error)
NewReportsClient creates a new instance of ReportsClient with the specified values.
- credential - used to authorize requests. Usually a credential from azidentity.
- options - pass nil to accept the default values.
func (*ReportsClient) NewListPager ¶
func (client *ReportsClient) NewListPager(options *ReportsClientListOptions) *runtime.Pager[ReportsClientListResponse]
NewListPager - Get the AppComplianceAutomation report list for the tenant.
Generated from API version 2022-11-16-preview
- options - ReportsClientListOptions contains the optional parameters for the ReportsClient.NewListPager method.
Example ¶
Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82ea406b73d671269217053d7ef336450d860345/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Reports_List.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/appcomplianceautomation/armappcomplianceautomation" ) func main() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armappcomplianceautomation.NewClientFactory(cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } pager := clientFactory.NewReportsClient().NewListPager(&armappcomplianceautomation.ReportsClientListOptions{SkipToken: to.Ptr("1"), Top: to.Ptr[int32](100), Select: nil, OfferGUID: to.Ptr("00000000-0000-0000-0000-000000000000"), ReportCreatorTenantID: to.Ptr("00000000-0000-0000-0000-000000000000"), }) for pager.More() { page, err := pager.NextPage(ctx) if err != nil { log.Fatalf("failed to advance page: %v", err) } for _, v := range page.Value { // You could use page here. We use blank identifier for just demo purposes. _ = v } // If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes. // page.ReportResourceList = armappcomplianceautomation.ReportResourceList{ // Value: []*armappcomplianceautomation.ReportResource{ // { // Name: to.Ptr("testReportName"), // Type: to.Ptr("Microsfot.AppComplianceAutomation/reports"), // ID: to.Ptr("/provider/Microsfot.AppComplianceAutomation/reports/testReportName"), // SystemData: &armappcomplianceautomation.SystemData{ // CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()), // CreatedBy: to.Ptr("00000000-0000-0000-0000-000000000000"), // CreatedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser), // LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()), // LastModifiedBy: to.Ptr("00000000-0000-0000-0000-000000000000"), // LastModifiedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser), // }, // Properties: &armappcomplianceautomation.ReportProperties{ // ComplianceStatus: &armappcomplianceautomation.ReportComplianceStatus{ // M365: &armappcomplianceautomation.OverviewStatus{ // FailedCount: to.Ptr[int32](0), // ManualCount: to.Ptr[int32](0), // PassedCount: to.Ptr[int32](0), // }, // }, // ID: to.Ptr("00000000-0000-0000-0000-000000000000"), // LastTriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T05:17:23.922Z"); return t}()), // NextTriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T05:17:23.922Z"); return t}()), // OfferGUID: to.Ptr("00000000-0000-0000-0000-000000000000"), // ProvisioningState: to.Ptr(armappcomplianceautomation.ProvisioningStateSucceeded), // ReportName: to.Ptr("testReportName"), // Resources: []*armappcomplianceautomation.ResourceMetadata{ // { // ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService"), // Tags: map[string]*string{ // "key1": to.Ptr("value1"), // }, // }}, // Status: to.Ptr(armappcomplianceautomation.ReportStatusActive), // Subscriptions: []*string{ // to.Ptr("00000000-0000-0000-0000-000000000000")}, // TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"), // TimeZone: to.Ptr("GMT Standard Time"), // TriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T05:17:23.922Z"); return t}()), // }, // }}, // } } }
Output:
type ReportsClientListOptions ¶
type ReportsClientListOptions struct { // The offerGuid which mapping to the reports. OfferGUID *string // The tenant id of the report creator. ReportCreatorTenantID *string // OData Select statement. Limits the properties on each entry to just those requested, e.g. ?$select=reportName,id. Select *string // Skip over when retrieving results. SkipToken *string // Number of elements to return when retrieving results. Top *int32 }
ReportsClientListOptions contains the optional parameters for the ReportsClient.NewListPager method.
type ReportsClientListResponse ¶
type ReportsClientListResponse struct { // Object that includes an array of resources and a possible link for next set. ReportResourceList }
ReportsClientListResponse contains the response from method ReportsClient.NewListPager.
type ResourceItem ¶
type ResourceItem struct { // READ-ONLY; The resource group name of this resource. ResourceGroup *string // READ-ONLY; The resource Id - e.g. "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1". ResourceID *string // READ-ONLY; The resource type of this resource. ResourceType *string // READ-ONLY; The subscription Id of this resource. SubscriptionID *string }
ResourceItem - Resource Id.
func (ResourceItem) MarshalJSON ¶
func (r ResourceItem) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ResourceItem.
func (*ResourceItem) UnmarshalJSON ¶
func (r *ResourceItem) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ResourceItem.
type ResourceMetadata ¶
type ResourceMetadata struct { // REQUIRED; Resource Id - e.g. "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1". ResourceID *string // Resource kind. ResourceKind *string // Resource name. ResourceName *string // Resource type. ResourceType *string // Resource's tag type. Tags map[string]*string }
ResourceMetadata - Single resource Id's metadata.
func (ResourceMetadata) MarshalJSON ¶
func (r ResourceMetadata) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ResourceMetadata.
func (*ResourceMetadata) UnmarshalJSON ¶
func (r *ResourceMetadata) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ResourceMetadata.
type ResourceStatus ¶
type ResourceStatus string
ResourceStatus - Indicates the resource status.
const ( ResourceStatusHealthy ResourceStatus = "Healthy" ResourceStatusNotApplicable ResourceStatus = "NotApplicable" ResourceStatusUnhealthy ResourceStatus = "Unhealthy" )
func PossibleResourceStatusValues ¶
func PossibleResourceStatusValues() []ResourceStatus
PossibleResourceStatusValues returns the possible values for the ResourceStatus const type.
type SnapshotClient ¶
type SnapshotClient struct {
// contains filtered or unexported fields
}
SnapshotClient contains the methods for the Snapshot group. Don't use this type directly, use NewSnapshotClient() instead.
func NewSnapshotClient ¶
func NewSnapshotClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*SnapshotClient, error)
NewSnapshotClient creates a new instance of SnapshotClient with the specified values.
- credential - used to authorize requests. Usually a credential from azidentity.
- options - pass nil to accept the default values.
func (*SnapshotClient) BeginDownload ¶
func (client *SnapshotClient) BeginDownload(ctx context.Context, reportName string, snapshotName string, parameters SnapshotDownloadRequest, options *SnapshotClientBeginDownloadOptions) (*runtime.Poller[SnapshotClientDownloadResponse], error)
BeginDownload - Download compliance needs from snapshot, like: Compliance Report, Resource List. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2022-11-16-preview
- reportName - Report Name.
- snapshotName - Snapshot Name.
- parameters - Parameters for the query operation
- options - SnapshotClientBeginDownloadOptions contains the optional parameters for the SnapshotClient.BeginDownload method.
Example (SnapshotDownloadComplianceDetailedPdfReport) ¶
Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82ea406b73d671269217053d7ef336450d860345/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Snapshot_ComplianceDetailedPdfReport_Download.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/appcomplianceautomation/armappcomplianceautomation" ) func main() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armappcomplianceautomation.NewClientFactory(cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } poller, err := clientFactory.NewSnapshotClient().BeginDownload(ctx, "testReportName", "testSnapshotName", armappcomplianceautomation.SnapshotDownloadRequest{ DownloadType: to.Ptr(armappcomplianceautomation.DownloadTypeComplianceDetailedPDFReport), OfferGUID: to.Ptr("00000000-0000-0000-0000-000000000000"), ReportCreatorTenantID: to.Ptr("00000000-0000-0000-0000-000000000000"), }, nil) if err != nil { log.Fatalf("failed to finish the request: %v", err) } res, err := poller.PollUntilDone(ctx, nil) if err != nil { log.Fatalf("failed to pull the result: %v", err) } // You could use response here. We use blank identifier for just demo purposes. _ = res // If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes. // res.DownloadResponse = armappcomplianceautomation.DownloadResponse{ // ComplianceDetailedPDFReport: &armappcomplianceautomation.DownloadResponseComplianceDetailedPDFReport{ // SasURI: to.Ptr("this is a uri"), // }, // } }
Output:
Example (SnapshotDownloadCompliancePdfReport) ¶
Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82ea406b73d671269217053d7ef336450d860345/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Snapshot_CompliancePdfReport_Download.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/appcomplianceautomation/armappcomplianceautomation" ) func main() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armappcomplianceautomation.NewClientFactory(cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } poller, err := clientFactory.NewSnapshotClient().BeginDownload(ctx, "testReportName", "testSnapshotName", armappcomplianceautomation.SnapshotDownloadRequest{ DownloadType: to.Ptr(armappcomplianceautomation.DownloadTypeCompliancePDFReport), OfferGUID: to.Ptr("00000000-0000-0000-0000-000000000000"), ReportCreatorTenantID: to.Ptr("00000000-0000-0000-0000-000000000000"), }, nil) if err != nil { log.Fatalf("failed to finish the request: %v", err) } res, err := poller.PollUntilDone(ctx, nil) if err != nil { log.Fatalf("failed to pull the result: %v", err) } // You could use response here. We use blank identifier for just demo purposes. _ = res // If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes. // res.DownloadResponse = armappcomplianceautomation.DownloadResponse{ // CompliancePDFReport: &armappcomplianceautomation.DownloadResponseCompliancePDFReport{ // SasURI: to.Ptr("this is uri of report"), // }, // } }
Output:
Example (SnapshotDownloadComplianceReport) ¶
Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82ea406b73d671269217053d7ef336450d860345/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Snapshot_ComplianceReport_Download.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/appcomplianceautomation/armappcomplianceautomation" ) func main() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armappcomplianceautomation.NewClientFactory(cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } poller, err := clientFactory.NewSnapshotClient().BeginDownload(ctx, "testReportName", "testSnapshotName", armappcomplianceautomation.SnapshotDownloadRequest{ DownloadType: to.Ptr(armappcomplianceautomation.DownloadTypeComplianceReport), OfferGUID: to.Ptr("00000000-0000-0000-0000-000000000000"), ReportCreatorTenantID: to.Ptr("00000000-0000-0000-0000-000000000000"), }, nil) if err != nil { log.Fatalf("failed to finish the request: %v", err) } res, err := poller.PollUntilDone(ctx, nil) if err != nil { log.Fatalf("failed to pull the result: %v", err) } // You could use response here. We use blank identifier for just demo purposes. _ = res // If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes. // res.DownloadResponse = armappcomplianceautomation.DownloadResponse{ // ComplianceReport: []*armappcomplianceautomation.ComplianceReportItem{ // { // CategoryName: to.Ptr("Data Security & Privacy"), // ComplianceState: to.Ptr(armappcomplianceautomation.ComplianceStateHealthy), // ControlID: to.Ptr("1"), // ControlName: to.Ptr("Validate that TLS Configuration meets or exceeds the TLS Profile Configuration Requirements"), // ControlType: to.Ptr(armappcomplianceautomation.ControlTypeFullyAutomated), // PolicyDescription: to.Ptr("policy description"), // PolicyDisplayName: to.Ptr("policy name"), // PolicyID: to.Ptr("00000000-0000-0000-0000-000000000000"), // ResourceGroup: to.Ptr("testGroup"), // ResourceID: to.Ptr("testResourceId"), // ResourceType: to.Ptr("storageaccounts"), // StatusChangeDate: to.Ptr("2021-09-01T17:26:57.4971616Z"), // SubscriptionID: to.Ptr("00000000-0000-0000-0000-000000000000"), // }}, // } }
Output:
Example (SnapshotDownloadResourceList) ¶
Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82ea406b73d671269217053d7ef336450d860345/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Snapshot_ResourceList_Download.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/appcomplianceautomation/armappcomplianceautomation" ) func main() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armappcomplianceautomation.NewClientFactory(cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } poller, err := clientFactory.NewSnapshotClient().BeginDownload(ctx, "testReportName", "testSnapshotName", armappcomplianceautomation.SnapshotDownloadRequest{ DownloadType: to.Ptr(armappcomplianceautomation.DownloadTypeResourceList), OfferGUID: to.Ptr("00000000-0000-0000-0000-000000000000"), ReportCreatorTenantID: to.Ptr("00000000-0000-0000-0000-000000000000"), }, nil) if err != nil { log.Fatalf("failed to finish the request: %v", err) } res, err := poller.PollUntilDone(ctx, nil) if err != nil { log.Fatalf("failed to pull the result: %v", err) } // You could use response here. We use blank identifier for just demo purposes. _ = res // If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes. // res.DownloadResponse = armappcomplianceautomation.DownloadResponse{ // ResourceList: []*armappcomplianceautomation.ResourceItem{ // { // ResourceGroup: to.Ptr("myResourceGroup"), // ResourceID: to.Ptr("mySignalRService"), // ResourceType: to.Ptr("SignalR"), // SubscriptionID: to.Ptr("00000000-0000-0000-0000-000000000000"), // }}, // } }
Output:
func (*SnapshotClient) Get ¶
func (client *SnapshotClient) Get(ctx context.Context, reportName string, snapshotName string, options *SnapshotClientGetOptions) (SnapshotClientGetResponse, error)
Get - Get the AppComplianceAutomation snapshot and its properties. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2022-11-16-preview
- reportName - Report Name.
- snapshotName - Snapshot Name.
- options - SnapshotClientGetOptions contains the optional parameters for the SnapshotClient.Get method.
Example ¶
Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82ea406b73d671269217053d7ef336450d860345/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Snapshot_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/appcomplianceautomation/armappcomplianceautomation" ) func main() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armappcomplianceautomation.NewClientFactory(cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } res, err := clientFactory.NewSnapshotClient().Get(ctx, "testReportName", "testSnapshot", nil) if err != nil { log.Fatalf("failed to finish the request: %v", err) } // You could use response here. We use blank identifier for just demo purposes. _ = res // If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes. // res.SnapshotResource = armappcomplianceautomation.SnapshotResource{ // Name: to.Ptr("testSnapshot"), // Type: to.Ptr("Microsfot.AppComplianceAutomation/reports/snapshots"), // ID: to.Ptr("/provider/Microsfot.AppComplianceAutomation/reports/testReportName/snapshots/testSnapshot"), // SystemData: &armappcomplianceautomation.SystemData{ // CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()), // CreatedBy: to.Ptr("00000000-0000-0000-0000-000000000000"), // CreatedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser), // LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()), // LastModifiedBy: to.Ptr("00000000-0000-0000-0000-000000000000"), // LastModifiedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser), // }, // Properties: &armappcomplianceautomation.SnapshotProperties{ // ComplianceResults: []*armappcomplianceautomation.ComplianceResult{ // { // Categories: []*armappcomplianceautomation.Category{ // { // CategoryName: to.Ptr("Operational Security"), // CategoryStatus: to.Ptr(armappcomplianceautomation.CategoryStatusHealthy), // CategoryType: to.Ptr(armappcomplianceautomation.CategoryTypePartiallyAutomated), // ControlFamilies: []*armappcomplianceautomation.ControlFamily{ // { // Controls: []*armappcomplianceautomation.Control{ // { // Assessments: []*armappcomplianceautomation.Assessment{ // { // Name: to.Ptr("AssessmentName"), // Description: to.Ptr("Assessment Description"), // IsPass: to.Ptr(armappcomplianceautomation.IsPassTrue), // PolicyID: to.Ptr("00000000-0000-0000-0000-000000000000"), // Remediation: to.Ptr("Remediation"), // ResourceList: []*armappcomplianceautomation.AssessmentResource{ // { // Reason: to.Ptr("N/A"), // ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService"), // ResourceStatus: to.Ptr(armappcomplianceautomation.ResourceStatusHealthy), // StatusChangeDate: to.Ptr("2022-03-04"), // }}, // Severity: to.Ptr(armappcomplianceautomation.AssessmentSeverityHigh), // }}, // ControlDescription: to.Ptr("Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise"), // ControlDescriptionHyperLink: to.Ptr("https://doc.microsoft.com"), // ControlFullName: to.Ptr("Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise"), // ControlID: to.Ptr("Operational Security#75"), // ControlShortName: to.Ptr("Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise"), // ControlStatus: to.Ptr(armappcomplianceautomation.ControlStatusPassed), // ControlType: to.Ptr(armappcomplianceautomation.ControlTypeManual), // }}, // FamilyName: to.Ptr("Incident Response"), // FamilyStatus: to.Ptr(armappcomplianceautomation.ControlFamilyStatusHealthy), // FamilyType: to.Ptr(armappcomplianceautomation.ControlFamilyTypePartiallyAutomated), // }}, // }}, // ComplianceName: to.Ptr("M365"), // }}, // CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-04T15:33:59.160Z"); return t}()), // ID: to.Ptr("00000000-0000-0000-0000-000000000000"), // ProvisioningState: to.Ptr(armappcomplianceautomation.ProvisioningStateSucceeded), // ReportProperties: &armappcomplianceautomation.ReportProperties{ // ComplianceStatus: &armappcomplianceautomation.ReportComplianceStatus{ // M365: &armappcomplianceautomation.OverviewStatus{ // FailedCount: to.Ptr[int32](0), // ManualCount: to.Ptr[int32](0), // PassedCount: to.Ptr[int32](0), // }, // }, // ID: to.Ptr("00000000-0000-0000-0000-000000000000"), // LastTriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-04T15:33:59.160Z"); return t}()), // NextTriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-04T15:33:59.160Z"); return t}()), // OfferGUID: to.Ptr("00000000-0000-0000-0000-000000000000"), // ProvisioningState: to.Ptr(armappcomplianceautomation.ProvisioningStateSucceeded), // ReportName: to.Ptr("testReportName"), // Resources: []*armappcomplianceautomation.ResourceMetadata{ // { // ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService"), // Tags: map[string]*string{ // "key1": to.Ptr("value1"), // }, // }}, // Status: to.Ptr(armappcomplianceautomation.ReportStatusActive), // Subscriptions: []*string{ // to.Ptr("00000000-0000-0000-0000-000000000000")}, // TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"), // TimeZone: to.Ptr("GMT Standard Time"), // TriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-04T15:33:59.160Z"); return t}()), // }, // ReportSystemData: &armappcomplianceautomation.SystemData{ // CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()), // CreatedBy: to.Ptr("00000000-0000-0000-0000-000000000000"), // CreatedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser), // LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()), // LastModifiedBy: to.Ptr("00000000-0000-0000-0000-000000000000"), // LastModifiedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser), // }, // SnapshotName: to.Ptr("testSnapshot"), // }, // } }
Output:
type SnapshotClientBeginDownloadOptions ¶
type SnapshotClientBeginDownloadOptions struct { // Resumes the LRO from the provided token. ResumeToken string }
SnapshotClientBeginDownloadOptions contains the optional parameters for the SnapshotClient.BeginDownload method.
type SnapshotClientDownloadResponse ¶
type SnapshotClientDownloadResponse struct { // Object that includes all the possible response for the download operation. DownloadResponse }
SnapshotClientDownloadResponse contains the response from method SnapshotClient.BeginDownload.
type SnapshotClientGetOptions ¶
type SnapshotClientGetOptions struct { }
SnapshotClientGetOptions contains the optional parameters for the SnapshotClient.Get method.
type SnapshotClientGetResponse ¶
type SnapshotClientGetResponse struct { // A class represent a AppComplianceAutomation snapshot resource. SnapshotResource }
SnapshotClientGetResponse contains the response from method SnapshotClient.Get.
type SnapshotDownloadRequest ¶
type SnapshotDownloadRequest struct { // REQUIRED; Indicates the download type. DownloadType *DownloadType // The offerGuid which mapping to the reports. OfferGUID *string // Tenant id. ReportCreatorTenantID *string }
SnapshotDownloadRequest - Snapshot's download request.
func (SnapshotDownloadRequest) MarshalJSON ¶
func (s SnapshotDownloadRequest) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type SnapshotDownloadRequest.
func (*SnapshotDownloadRequest) UnmarshalJSON ¶
func (s *SnapshotDownloadRequest) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type SnapshotDownloadRequest.
type SnapshotProperties ¶
type SnapshotProperties struct { // READ-ONLY; List of compliance results. ComplianceResults []*ComplianceResult // READ-ONLY; The timestamp of resource creation (UTC). CreatedAt *time.Time // READ-ONLY; Snapshot id in the database. ID *string // READ-ONLY; Azure lifecycle management ProvisioningState *ProvisioningState // READ-ONLY; The report essential info. ReportProperties *ReportProperties // READ-ONLY; Metadata pertaining to creation and last modification of the resource. ReportSystemData *SystemData // READ-ONLY; Snapshot name. SnapshotName *string }
SnapshotProperties - Snapshot's properties.
func (SnapshotProperties) MarshalJSON ¶
func (s SnapshotProperties) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type SnapshotProperties.
func (*SnapshotProperties) UnmarshalJSON ¶
func (s *SnapshotProperties) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type SnapshotProperties.
type SnapshotResource ¶
type SnapshotResource struct { // READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ID *string // READ-ONLY; The name of the resource Name *string // READ-ONLY; Snapshot's property'. Properties *SnapshotProperties // READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData *SystemData // READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string }
SnapshotResource - A class represent a AppComplianceAutomation snapshot resource.
func (SnapshotResource) MarshalJSON ¶
func (s SnapshotResource) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type SnapshotResource.
func (*SnapshotResource) UnmarshalJSON ¶
func (s *SnapshotResource) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type SnapshotResource.
type SnapshotResourceList ¶
type SnapshotResourceList struct { // The URL the client should use to fetch the next page (per server side paging). It's null for now, added for future use. NextLink *string // READ-ONLY; List of the snapshots Value []*SnapshotResource }
SnapshotResourceList - Object that includes an array of resources and a possible link for next set.
func (SnapshotResourceList) MarshalJSON ¶
func (s SnapshotResourceList) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type SnapshotResourceList.
func (*SnapshotResourceList) UnmarshalJSON ¶
func (s *SnapshotResourceList) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type SnapshotResourceList.
type SnapshotsClient ¶
type SnapshotsClient struct {
// contains filtered or unexported fields
}
SnapshotsClient contains the methods for the Snapshots group. Don't use this type directly, use NewSnapshotsClient() instead.
func NewSnapshotsClient ¶
func NewSnapshotsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*SnapshotsClient, error)
NewSnapshotsClient creates a new instance of SnapshotsClient with the specified values.
- credential - used to authorize requests. Usually a credential from azidentity.
- options - pass nil to accept the default values.
func (*SnapshotsClient) NewListPager ¶
func (client *SnapshotsClient) NewListPager(reportName string, options *SnapshotsClientListOptions) *runtime.Pager[SnapshotsClientListResponse]
NewListPager - Get the AppComplianceAutomation snapshot list.
Generated from API version 2022-11-16-preview
- reportName - Report Name.
- options - SnapshotsClientListOptions contains the optional parameters for the SnapshotsClient.NewListPager method.
Example ¶
Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82ea406b73d671269217053d7ef336450d860345/specification/appcomplianceautomation/resource-manager/Microsoft.AppComplianceAutomation/preview/2022-11-16-preview/examples/Snapshots_List.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/appcomplianceautomation/armappcomplianceautomation" ) func main() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armappcomplianceautomation.NewClientFactory(cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } pager := clientFactory.NewSnapshotsClient().NewListPager("testReportName", &armappcomplianceautomation.SnapshotsClientListOptions{SkipToken: to.Ptr("1"), Top: to.Ptr[int32](100), Select: nil, ReportCreatorTenantID: to.Ptr("00000000-0000-0000-0000-000000000000"), OfferGUID: to.Ptr("00000000-0000-0000-0000-000000000000"), }) for pager.More() { page, err := pager.NextPage(ctx) if err != nil { log.Fatalf("failed to advance page: %v", err) } for _, v := range page.Value { // You could use page here. We use blank identifier for just demo purposes. _ = v } // If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes. // page.SnapshotResourceList = armappcomplianceautomation.SnapshotResourceList{ // Value: []*armappcomplianceautomation.SnapshotResource{ // { // Name: to.Ptr("testSnapshot"), // Type: to.Ptr("Microsfot.AppComplianceAutomation/reports/snapshots"), // ID: to.Ptr("/provider/Microsfot.AppComplianceAutomation/reports/testReportName/snapshots/testSnapshot"), // SystemData: &armappcomplianceautomation.SystemData{ // CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()), // CreatedBy: to.Ptr("00000000-0000-0000-0000-000000000000"), // CreatedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser), // LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()), // LastModifiedBy: to.Ptr("00000000-0000-0000-0000-000000000000"), // LastModifiedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser), // }, // Properties: &armappcomplianceautomation.SnapshotProperties{ // ComplianceResults: []*armappcomplianceautomation.ComplianceResult{ // { // Categories: []*armappcomplianceautomation.Category{ // { // CategoryName: to.Ptr("Operational Security"), // CategoryStatus: to.Ptr(armappcomplianceautomation.CategoryStatusHealthy), // CategoryType: to.Ptr(armappcomplianceautomation.CategoryTypePartiallyAutomated), // ControlFamilies: []*armappcomplianceautomation.ControlFamily{ // { // Controls: []*armappcomplianceautomation.Control{ // { // Assessments: []*armappcomplianceautomation.Assessment{ // { // Name: to.Ptr("AssessmentName"), // Description: to.Ptr("Assessment Description"), // IsPass: to.Ptr(armappcomplianceautomation.IsPassTrue), // PolicyID: to.Ptr("00000000-0000-0000-0000-000000000000"), // Remediation: to.Ptr("Remediation"), // ResourceList: []*armappcomplianceautomation.AssessmentResource{ // { // Reason: to.Ptr("N/A"), // ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService"), // ResourceStatus: to.Ptr(armappcomplianceautomation.ResourceStatusHealthy), // StatusChangeDate: to.Ptr("2022-03-04"), // }}, // Severity: to.Ptr(armappcomplianceautomation.AssessmentSeverityHigh), // }}, // ControlDescription: to.Ptr("Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise"), // ControlDescriptionHyperLink: to.Ptr("https://doc.microsoft.com"), // ControlFullName: to.Ptr("Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise"), // ControlID: to.Ptr("Operational Security#75"), // ControlShortName: to.Ptr("Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise"), // ControlStatus: to.Ptr(armappcomplianceautomation.ControlStatusPassed), // ControlType: to.Ptr(armappcomplianceautomation.ControlTypeManual), // }}, // FamilyName: to.Ptr("Incident Response"), // FamilyStatus: to.Ptr(armappcomplianceautomation.ControlFamilyStatusHealthy), // FamilyType: to.Ptr(armappcomplianceautomation.ControlFamilyTypePartiallyAutomated), // }}, // }}, // ComplianceName: to.Ptr("M365"), // }}, // CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-04T15:33:59.160Z"); return t}()), // ID: to.Ptr("00000000-0000-0000-0000-000000000000"), // ProvisioningState: to.Ptr(armappcomplianceautomation.ProvisioningStateSucceeded), // ReportProperties: &armappcomplianceautomation.ReportProperties{ // ComplianceStatus: &armappcomplianceautomation.ReportComplianceStatus{ // M365: &armappcomplianceautomation.OverviewStatus{ // FailedCount: to.Ptr[int32](0), // ManualCount: to.Ptr[int32](0), // PassedCount: to.Ptr[int32](0), // }, // }, // ID: to.Ptr("00000000-0000-0000-0000-000000000000"), // LastTriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-04T15:33:59.160Z"); return t}()), // NextTriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-04T15:33:59.160Z"); return t}()), // OfferGUID: to.Ptr("00000000-0000-0000-0000-000000000000"), // ProvisioningState: to.Ptr(armappcomplianceautomation.ProvisioningStateSucceeded), // ReportName: to.Ptr("testReportName"), // Resources: []*armappcomplianceautomation.ResourceMetadata{ // { // ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService"), // Tags: map[string]*string{ // "key1": to.Ptr("value1"), // }, // }}, // Status: to.Ptr(armappcomplianceautomation.ReportStatusActive), // Subscriptions: []*string{ // to.Ptr("00000000-0000-0000-0000-000000000000")}, // TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"), // TimeZone: to.Ptr("GMT Standard Time"), // TriggerTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-04T15:33:59.160Z"); return t}()), // }, // ReportSystemData: &armappcomplianceautomation.SystemData{ // CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()), // CreatedBy: to.Ptr("00000000-0000-0000-0000-000000000000"), // CreatedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser), // LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-05-14T22:34:55.449Z"); return t}()), // LastModifiedBy: to.Ptr("00000000-0000-0000-0000-000000000000"), // LastModifiedByType: to.Ptr(armappcomplianceautomation.CreatedByTypeUser), // }, // SnapshotName: to.Ptr("testSnapshot"), // }, // }}, // } } }
Output:
type SnapshotsClientListOptions ¶
type SnapshotsClientListOptions struct { // The offerGuid which mapping to the reports. OfferGUID *string // The tenant id of the report creator. ReportCreatorTenantID *string // OData Select statement. Limits the properties on each entry to just those requested, e.g. ?$select=reportName,id. Select *string // Skip over when retrieving results. SkipToken *string // Number of elements to return when retrieving results. Top *int32 }
SnapshotsClientListOptions contains the optional parameters for the SnapshotsClient.NewListPager method.
type SnapshotsClientListResponse ¶
type SnapshotsClientListResponse struct { // Object that includes an array of resources and a possible link for next set. SnapshotResourceList }
SnapshotsClientListResponse contains the response from method SnapshotsClient.NewListPager.
type SystemData ¶
type SystemData struct { // The timestamp of resource creation (UTC). CreatedAt *time.Time // The identity that created the resource. CreatedBy *string // The type of identity that created the resource. CreatedByType *CreatedByType // The timestamp of resource last modification (UTC) LastModifiedAt *time.Time // The identity that last modified the resource. LastModifiedBy *string // The type of identity that last modified the resource. LastModifiedByType *CreatedByType }
SystemData - Metadata pertaining to creation and last modification of the 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.