@azure/arm-appcomplianceautomation package
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. Known values supported by the serviceInternal |
| CategoryStatus |
Defines values for CategoryStatus. Known values supported by the servicePassed: The category is passed. |
| CheckNameAvailabilityReason |
Defines values for CheckNameAvailabilityReason. Known values supported by the serviceInvalid |
| ContentType |
Defines values for ContentType. Known values supported by the serviceapplication/json: The content type is application/json. |
| ControlFamilyStatus |
Defines values for ControlFamilyStatus. Known values supported by the servicePassed: The control family is passed. |
| ControlStatus |
Defines values for ControlStatus. Known values supported by the servicePassed: The control is passed. |
| CreatedByType |
Defines values for CreatedByType. Known values supported by the serviceUser |
| DeliveryStatus |
Defines values for DeliveryStatus. Known values supported by the serviceSucceeded: The webhook is delivered successfully. |
| DownloadType |
Defines values for DownloadType. Known values supported by the serviceComplianceReport: Download the compliance report. |
| EnableSslVerification |
Defines values for EnableSslVerification. Known values supported by the servicetrue: The ssl verification is 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. Known values supported by the serviceFile: The evidence is a file. |
| InputType |
Defines values for InputType. Known values supported by the serviceNone: The input type is a text box. |
| IsRecommendSolution |
Defines values for IsRecommendSolution. Known values supported by the servicetrue: This solution is the recommended. |
| NotificationEvent |
Defines values for NotificationEvent. Known values supported by the servicegenerate_snapshot_success: The subscribed report's snapshot is successfully generated. |
| OperationsListNextResponse |
Contains response data for the listNext operation. |
| OperationsListResponse |
Contains response data for the list operation. |
| Origin |
Defines values for Origin. Known values supported by the serviceuser |
| 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. Known values supported by the serviceSucceeded: The provision is succeeded. |
| 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. Known values supported by the serviceActive: The report is active. |
| 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. Known values supported by the serviceAzure: The resource is from Azure. |
| ResourceStatus |
Defines values for ResourceStatus. Known values supported by the serviceHealthy: The resource is healthy. |
| ResponsibilityEnvironment |
Defines values for ResponsibilityEnvironment. Known values supported by the serviceAzure: The responsibility is supported in Azure. |
| ResponsibilitySeverity |
Defines values for ResponsibilitySeverity. Known values supported by the serviceHigh: The responsibility is high severity. |
| ResponsibilityStatus |
Defines values for ResponsibilityStatus. Known values supported by the servicePassed: The responsibility is passed. |
| ResponsibilityType |
Defines values for ResponsibilityType. Known values supported by the serviceAutomated: The responsibility is automated. |
| Result |
Defines values for Result. Known values supported by the serviceSucceeded: The result is succeeded. |
| Rule |
Defines values for Rule. Known values supported by the serviceRequired: The question is required to answer. |
| 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. Known values supported by the servicetrue: Need 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. Known values supported by the servicetrue: Need 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. Known values supported by the servicetrue: The webhookKey is enabled. |
| WebhookListNextResponse |
Contains response data for the listNext operation. |
| WebhookListResponse |
Contains response data for the list operation. |
| WebhookStatus |
Defines values for WebhookStatus. Known values supported by the serviceEnabled: The webhook is enabled. |
| 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
| get |
Given the last |
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.