@azure/arm-appcomplianceautomation package

Classes

AppComplianceAutomationToolForMicrosoft365

Interfaces

AppComplianceAutomationToolForMicrosoft365OptionalParams

Optional parameters.

Category

A class represent the compliance category.

CertSyncRecord

A class represent the certification record synchronized from app compliance.

CheckNameAvailabilityRequest

The check availability request body.

CheckNameAvailabilityResponse

The check availability result.

ComplianceReportItem

Object that includes all the content for single compliance result.

ComplianceResult

A class represent the compliance result.

Control

A class represent the control.

ControlFamily

A class represent the control family.

ControlSyncRecord

A class represent the control record synchronized from app compliance.

DownloadResponse

Object that includes all the possible response for the download operation.

DownloadResponseComplianceDetailedPdfReport

The detailed compliance pdf report

DownloadResponseCompliancePdfReport

Compliance pdf report

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

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.).

Evidence

Interface representing a Evidence.

EvidenceCreateOrUpdateOptionalParams

Optional parameters.

EvidenceDeleteOptionalParams

Optional parameters.

EvidenceDownloadOptionalParams

Optional parameters.

EvidenceFileDownloadRequest

Evidence file's download request.

EvidenceFileDownloadResponse

Object that includes all the possible response for the evidence file download operation.

EvidenceFileDownloadResponseEvidenceFile

The uri of evidence file

EvidenceGetOptionalParams

Optional parameters.

EvidenceListByReportNextOptionalParams

Optional parameters.

EvidenceListByReportOptionalParams

Optional parameters.

EvidenceProperties

Evidence's properties.

EvidenceResource

A class represent an AppComplianceAutomation evidence resource.

EvidenceResourceListResult

The response of a EvidenceResource list operation.

GetCollectionCountRequest

Get collection count's request object.

GetCollectionCountResponse

The get collection count response.

GetOverviewStatusRequest

Get overview status request object.

GetOverviewStatusResponse

The get overview status response.

ListInUseStorageAccountsRequest

Parameters for listing in use storage accounts operation. If subscription list is null, it will check the user's all subscriptions.

ListInUseStorageAccountsResponse

Parameters for listing in use storage accounts operation. If subscription list is null, it will check the user's all subscriptions.

OnboardRequest

Parameters for onboard operation

OnboardResponse

Success. The response indicates given subscriptions has been onboarded.

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

Localized display information for this particular 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.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

OverviewStatus

The overview of the compliance result for one report.

ProviderActions

Interface representing a ProviderActions.

ProviderActionsCheckNameAvailabilityOptionalParams

Optional parameters.

ProviderActionsGetCollectionCountOptionalParams

Optional parameters.

ProviderActionsGetOverviewStatusOptionalParams

Optional parameters.

ProviderActionsListInUseStorageAccountsOptionalParams

Optional parameters.

ProviderActionsOnboardHeaders

Defines headers for ProviderActions_onboard operation.

ProviderActionsOnboardOptionalParams

Optional parameters.

ProviderActionsTriggerEvaluationHeaders

Defines headers for ProviderActions_triggerEvaluation operation.

ProviderActionsTriggerEvaluationOptionalParams

Optional parameters.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

QuickAssessment

A class represent the quick assessment.

Recommendation

A class represent the recommendation.

RecommendationSolution

A class represent the recommendation solution.

Report

Interface representing a Report.

ReportComplianceStatus

A list which includes all the compliance result for one report.

ReportCreateOrUpdateHeaders

Defines headers for Report_createOrUpdate operation.

ReportCreateOrUpdateOptionalParams

Optional parameters.

ReportDeleteHeaders

Defines headers for Report_delete operation.

ReportDeleteOptionalParams

Optional parameters.

ReportFixHeaders

Defines headers for Report_fix operation.

ReportFixOptionalParams

Optional parameters.

ReportFixResult

Report fix result.

ReportGetOptionalParams

Optional parameters.

ReportGetScopingQuestionsOptionalParams

Optional parameters.

ReportListNextOptionalParams

Optional parameters.

ReportListOptionalParams

Optional parameters.

ReportNestedResourceCheckNameAvailabilityOptionalParams

Optional parameters.

ReportPatchProperties

Patch Report's properties.

ReportProperties

Create Report's properties.

ReportResource

A class represent an AppComplianceAutomation report resource.

ReportResourceListResult

The response of a ReportResource list operation.

ReportResourcePatch

A class represent a AppComplianceAutomation report resource update properties.

ReportSyncCertRecordHeaders

Defines headers for Report_syncCertRecord operation.

ReportSyncCertRecordOptionalParams

Optional parameters.

ReportUpdateHeaders

Defines headers for Report_update operation.

ReportUpdateOptionalParams

Optional parameters.

ReportVerificationResult

Report health status verification result.

ReportVerifyHeaders

Defines headers for Report_verify operation.

ReportVerifyOptionalParams

Optional parameters.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

ResourceItem

Resource Id.

ResourceMetadata

Single resource Id's metadata.

Responsibility

A class represent the customer responsibility.

ResponsibilityResource

A class represent the resource.

ScopingAnswer

Scoping answer.

ScopingConfiguration

Interface representing a ScopingConfiguration.

ScopingConfigurationCreateOrUpdateOptionalParams

Optional parameters.

ScopingConfigurationDeleteOptionalParams

Optional parameters.

ScopingConfigurationGetOptionalParams

Optional parameters.

ScopingConfigurationListNextOptionalParams

Optional parameters.

ScopingConfigurationListOptionalParams

Optional parameters.

ScopingConfigurationProperties

ScopingConfiguration's properties.

ScopingConfigurationResource

A class represent an AppComplianceAutomation scoping configuration resource.

ScopingConfigurationResourceListResult

The response of a ScopingConfigurationResource list operation.

ScopingQuestion

The definition of a scoping question.

ScopingQuestions

Scoping question list.

Snapshot

Interface representing a Snapshot.

SnapshotDownloadHeaders

Defines headers for Snapshot_download operation.

SnapshotDownloadOptionalParams

Optional parameters.

SnapshotDownloadRequest

Snapshot's download request.

SnapshotGetOptionalParams

Optional parameters.

SnapshotListNextOptionalParams

Optional parameters.

SnapshotListOptionalParams

Optional parameters.

SnapshotProperties

Snapshot's properties.

SnapshotResource

A class represent a AppComplianceAutomation snapshot resource.

SnapshotResourceListResult

The response of a SnapshotResource list operation.

StatusItem

Single status.

StorageInfo

The information of 'bring your own storage' account binding to the report

SyncCertRecordRequest

Synchronize certification record request.

SyncCertRecordResponse

Synchronize certification record response.

SystemData

Metadata pertaining to creation and last modification of the resource.

TriggerEvaluationProperty

Trigger evaluation response.

TriggerEvaluationRequest

Trigger evaluation request.

TriggerEvaluationResponse

Trigger evaluation response.

Webhook

Interface representing a Webhook.

WebhookCreateOrUpdateOptionalParams

Optional parameters.

WebhookDeleteOptionalParams

Optional parameters.

WebhookGetOptionalParams

Optional parameters.

WebhookListNextOptionalParams

Optional parameters.

WebhookListOptionalParams

Optional parameters.

WebhookProperties

Webhook properties.

WebhookResource

A class represent an AppComplianceAutomation webhook resource.

WebhookResourceListResult

The response of a WebhookResource list operation.

WebhookResourcePatch

A class represent a AppComplianceAutomation webhook resource update properties.

WebhookUpdateOptionalParams

Optional parameters.

Type Aliases

ActionType

Defines values for ActionType.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal

CategoryStatus

Defines values for CategoryStatus.
KnownCategoryStatus can be used interchangeably with CategoryStatus, this enum contains the known values that the service supports.

Known values supported by the service

Passed: The category is passed.
Failed: The category is failed.
NotApplicable: The category is not applicable.
PendingApproval: The category is pending for approval.

CheckNameAvailabilityReason

Defines values for CheckNameAvailabilityReason.
KnownCheckNameAvailabilityReason can be used interchangeably with CheckNameAvailabilityReason, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
AlreadyExists

ContentType

Defines values for ContentType.
KnownContentType can be used interchangeably with ContentType, this enum contains the known values that the service supports.

Known values supported by the service

application/json: The content type is application/json.

ControlFamilyStatus

Defines values for ControlFamilyStatus.
KnownControlFamilyStatus can be used interchangeably with ControlFamilyStatus, this enum contains the known values that the service supports.

Known values supported by the service

Passed: The control family is passed.
Failed: The control family is failed.
NotApplicable: The control family is not applicable.
PendingApproval: The control family is pending for approval.

ControlStatus

Defines values for ControlStatus.
KnownControlStatus can be used interchangeably with ControlStatus, this enum contains the known values that the service supports.

Known values supported by the service

Passed: The control is passed.
Failed: The control is failed.
NotApplicable: The control is not applicable.
PendingApproval: The control is pending for approval.

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

DeliveryStatus

Defines values for DeliveryStatus.
KnownDeliveryStatus can be used interchangeably with DeliveryStatus, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The webhook is delivered successfully.
Failed: The webhook is failed to deliver.
NotStarted: The webhook is not delivered.

DownloadType

Defines values for DownloadType.
KnownDownloadType can be used interchangeably with DownloadType, this enum contains the known values that the service supports.

Known values supported by the service

ComplianceReport: Download the compliance report.
CompliancePdfReport: Download the compliance pdf report.
ComplianceDetailedPdfReport: Download the detailed compliance pdf report.
ResourceList: Download the resource list of the report.

EnableSslVerification

Defines values for EnableSslVerification.
KnownEnableSslVerification can be used interchangeably with EnableSslVerification, this enum contains the known values that the service supports.

Known values supported by the service

true: The ssl verification is enabled.
false: The ssl verification is not enabled.

EvidenceCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

EvidenceDownloadResponse

Contains response data for the download operation.

EvidenceGetResponse

Contains response data for the get operation.

EvidenceListByReportNextResponse

Contains response data for the listByReportNext operation.

EvidenceListByReportResponse

Contains response data for the listByReport operation.

EvidenceType

Defines values for EvidenceType.
KnownEvidenceType can be used interchangeably with EvidenceType, this enum contains the known values that the service supports.

Known values supported by the service

File: The evidence is a file.
AutoCollectedEvidence: The evidence auto collected by App Compliance Automation.
Data: The evidence is data.

InputType

Defines values for InputType.
KnownInputType can be used interchangeably with InputType, this enum contains the known values that the service supports.

Known values supported by the service

None: The input type is a text box.
Text: The input content is text string.
Email: The input content should be an email address.
MultilineText: The input content should be multiline text.
Url: The input content should be a URL.
Number: The input content should be a number.
Boolean: The input content should be a boolean.
Telephone: The input content should be a telephone number.
YesNoNa: The input content should be Yes, No or Na.
Date: The input content should be a date.
YearPicker: The input content is a Year, pick from the dropdown list.
SingleSelection: The input content is a single result seleted from the options.
SingleSelectDropdown: The input content is a single result seleted from the dropdown options.
MultiSelectCheckbox: The input content are multiple results seleted from the checkboxes.
MultiSelectDropdown: The input content are multiple results seleted from the dropdown options.
MultiSelectDropdownCustom: The input content are result seleted from the custom dropdown options.
Group: The input content is a group of answers.
Upload: The input content is a uploaded file.

IsRecommendSolution

Defines values for IsRecommendSolution.
KnownIsRecommendSolution can be used interchangeably with IsRecommendSolution, this enum contains the known values that the service supports.

Known values supported by the service

true: This solution is the recommended.
false: This solution is not the recommended.

NotificationEvent

Defines values for NotificationEvent.
KnownNotificationEvent can be used interchangeably with NotificationEvent, this enum contains the known values that the service supports.

Known values supported by the service

generate_snapshot_success: The subscribed report's snapshot is successfully generated.
generate_snapshot_failed: The subscribed report's snapshot is failed to generate.
assessment_failure: The subscribed report failed while collecting the assessments.
report_configuration_changes: The subscribed report's configuration is changed.
report_deletion: The subscribed report is deleted.

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

Origin

Defines values for Origin.
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user
system
user,system

ProviderActionsCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

ProviderActionsGetCollectionCountResponse

Contains response data for the getCollectionCount operation.

ProviderActionsGetOverviewStatusResponse

Contains response data for the getOverviewStatus operation.

ProviderActionsListInUseStorageAccountsResponse

Contains response data for the listInUseStorageAccounts operation.

ProviderActionsOnboardResponse

Contains response data for the onboard operation.

ProviderActionsTriggerEvaluationResponse

Contains response data for the triggerEvaluation operation.

ProvisioningState

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The provision is succeeded.
Failed: The provision is failed.
Canceled: The provision is canceled.
Creating: The creation is in progress.
Deleting: The deletion is in progress.
Fixing: The fix of the resource in progress.
Verifying: The verification of the resource in progress.
Updating: The update of the resource in progress.

ReportCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ReportDeleteResponse

Contains response data for the delete operation.

ReportFixResponse

Contains response data for the fix operation.

ReportGetResponse

Contains response data for the get operation.

ReportGetScopingQuestionsResponse

Contains response data for the getScopingQuestions operation.

ReportListNextResponse

Contains response data for the listNext operation.

ReportListResponse

Contains response data for the list operation.

ReportNestedResourceCheckNameAvailabilityResponse

Contains response data for the nestedResourceCheckNameAvailability operation.

ReportStatus

Defines values for ReportStatus.
KnownReportStatus can be used interchangeably with ReportStatus, this enum contains the known values that the service supports.

Known values supported by the service

Active: The report is active.
Failed: The report is failed.
Reviewing: The report is under reviewing.
Disabled: The report is disabled.

ReportSyncCertRecordResponse

Contains response data for the syncCertRecord operation.

ReportUpdateResponse

Contains response data for the update operation.

ReportVerifyResponse

Contains response data for the verify operation.

ResourceOrigin

Defines values for ResourceOrigin.
KnownResourceOrigin can be used interchangeably with ResourceOrigin, this enum contains the known values that the service supports.

Known values supported by the service

Azure: The resource is from Azure.
AWS: The resource is from AWS.
GCP: The resource is from GCP.

ResourceStatus

Defines values for ResourceStatus.
KnownResourceStatus can be used interchangeably with ResourceStatus, this enum contains the known values that the service supports.

Known values supported by the service

Healthy: The resource is healthy.
Unhealthy: The resource is unhealthy.

ResponsibilityEnvironment

Defines values for ResponsibilityEnvironment.
KnownResponsibilityEnvironment can be used interchangeably with ResponsibilityEnvironment, this enum contains the known values that the service supports.

Known values supported by the service

Azure: The responsibility is supported in Azure.
AWS: The responsibility is supported in AWS.
GCP: The responsibility is supported in GCP.
General: The responsibility is general requirement of all environment.

ResponsibilitySeverity

Defines values for ResponsibilitySeverity.
KnownResponsibilitySeverity can be used interchangeably with ResponsibilitySeverity, this enum contains the known values that the service supports.

Known values supported by the service

High: The responsibility is high severity.
Medium: The responsibility is medium severity.
Low: The responsibility is low severity.

ResponsibilityStatus

Defines values for ResponsibilityStatus.
KnownResponsibilityStatus can be used interchangeably with ResponsibilityStatus, this enum contains the known values that the service supports.

Known values supported by the service

Passed: The responsibility is passed.
Failed: The responsibility is failed.
NotApplicable: The responsibility is not applicable.
PendingApproval: The responsibility is pending for approval.

ResponsibilityType

Defines values for ResponsibilityType.
KnownResponsibilityType can be used interchangeably with ResponsibilityType, this enum contains the known values that the service supports.

Known values supported by the service

Automated: The responsibility is automated.
ScopedManual: The responsibility is scoped manual.
Manual: The responsibility is manual.

Result

Defines values for Result.
KnownResult can be used interchangeably with Result, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The result is succeeded.
Failed: The result is failed.

Rule

Defines values for Rule.
KnownRule can be used interchangeably with Rule, this enum contains the known values that the service supports.

Known values supported by the service

Required: The question is required to answer.
CharLength: The question answer length is limited.
Url: The question answer should be an Url.
Urls: The question answer should be Urls.
Domains: The question answer should be domains.
USPrivacyShield: The question answer should be a UsPrivacyShield.
PublicSOX: The question answer should be a PublicSOX.
CreditCardPCI: The question answer should be a CreditCardPCI.
AzureApplication: The question answer should be an AzureApplication.
ValidGuid: The question answer should be a valid guid.
PublisherVerification: The question answer should be publisher verification.
DynamicDropdown: The question answer should be dynamic dropdown.
PreventNonEnglishChar: The question answer should prevent non-english char.
ValidEmail: The question answer should be a valid email.

ScopingConfigurationCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ScopingConfigurationGetResponse

Contains response data for the get operation.

ScopingConfigurationListNextResponse

Contains response data for the listNext operation.

ScopingConfigurationListResponse

Contains response data for the list operation.

SendAllEvents

Defines values for SendAllEvents.
KnownSendAllEvents can be used interchangeably with SendAllEvents, this enum contains the known values that the service supports.

Known values supported by the service

true: Need send notification under any event.
false: No need to send notification under any event.

SnapshotDownloadResponse

Contains response data for the download operation.

SnapshotGetResponse

Contains response data for the get operation.

SnapshotListNextResponse

Contains response data for the listNext operation.

SnapshotListResponse

Contains response data for the list operation.

UpdateWebhookKey

Defines values for UpdateWebhookKey.
KnownUpdateWebhookKey can be used interchangeably with UpdateWebhookKey, this enum contains the known values that the service supports.

Known values supported by the service

true: Need update the webhook key.
false: No need to update the webhook key.

WebhookCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

WebhookGetResponse

Contains response data for the get operation.

WebhookKeyEnabled

Defines values for WebhookKeyEnabled.
KnownWebhookKeyEnabled can be used interchangeably with WebhookKeyEnabled, this enum contains the known values that the service supports.

Known values supported by the service

true: The webhookKey is enabled.
false: The webhookKey is not enabled.

WebhookListNextResponse

Contains response data for the listNext operation.

WebhookListResponse

Contains response data for the list operation.

WebhookStatus

Defines values for WebhookStatus.
KnownWebhookStatus can be used interchangeably with WebhookStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: The webhook is enabled.
Disabled: The webhook is disabled.

WebhookUpdateResponse

Contains response data for the update operation.

Enums

KnownActionType

Known values of ActionType that the service accepts.

KnownCategoryStatus

Known values of CategoryStatus that the service accepts.

KnownCheckNameAvailabilityReason

Known values of CheckNameAvailabilityReason that the service accepts.

KnownContentType

Known values of ContentType that the service accepts.

KnownControlFamilyStatus

Known values of ControlFamilyStatus that the service accepts.

KnownControlStatus

Known values of ControlStatus that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownDeliveryStatus

Known values of DeliveryStatus that the service accepts.

KnownDownloadType

Known values of DownloadType that the service accepts.

KnownEnableSslVerification

Known values of EnableSslVerification that the service accepts.

KnownEvidenceType

Known values of EvidenceType that the service accepts.

KnownInputType

Known values of InputType that the service accepts.

KnownIsRecommendSolution

Known values of IsRecommendSolution that the service accepts.

KnownNotificationEvent

Known values of NotificationEvent that the service accepts.

KnownOrigin

Known values of Origin that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownReportStatus

Known values of ReportStatus that the service accepts.

KnownResourceOrigin

Known values of ResourceOrigin that the service accepts.

KnownResourceStatus

Known values of ResourceStatus that the service accepts.

KnownResponsibilityEnvironment

Known values of ResponsibilityEnvironment that the service accepts.

KnownResponsibilitySeverity

Known values of ResponsibilitySeverity that the service accepts.

KnownResponsibilityStatus

Known values of ResponsibilityStatus that the service accepts.

KnownResponsibilityType

Known values of ResponsibilityType that the service accepts.

KnownResult

Known values of Result that the service accepts.

KnownRule

Known values of Rule that the service accepts.

KnownSendAllEvents

Known values of SendAllEvents that the service accepts.

KnownUpdateWebhookKey

Known values of UpdateWebhookKey that the service accepts.

KnownWebhookKeyEnabled

Known values of WebhookKeyEnabled that the service accepts.

KnownWebhookStatus

Known values of WebhookStatus that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.