Compartir a través de


Snapshot - Download

Descargue las necesidades de cumplimiento de instantáneas, como: Informe de cumplimiento, Lista de recursos.

POST https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/{reportName}/snapshots/{snapshotName}/download?api-version=2024-06-27

Parámetros de identificador URI

Nombre En Requerido Tipo Description
reportName
path True

string

pattern: ^[-a-zA-Z0-9_]{1,50}$

Nombre del informe.

snapshotName
path True

string

pattern: ^[a-zA-Z0-9-_]{1,64}$

Nombre de instantánea.

api-version
query True

string

minLength: 1

Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
downloadType True

DownloadType

Indica el tipo de descarga.

offerGuid

string

minLength: 1

OfferGuid que se asigna a los informes.

reportCreatorTenantId

string

Id. de inquilino.

Respuestas

Nombre Tipo Description
200 OK

DownloadResponse

La operación de Azure se completó correctamente.

202 Accepted

Operación de recurso aceptada.

Encabezados

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

Snapshot_Download_ComplianceDetailedPdfReport
Snapshot_Download_CompliancePdfReport
Snapshot_Download_ComplianceReport
Snapshot_Download_ResourceList

Snapshot_Download_ComplianceDetailedPdfReport

Solicitud de ejemplo

POST https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/testReportName/snapshots/testSnapshotName/download?api-version=2024-06-27

{
  "downloadType": "ComplianceDetailedPdfReport",
  "offerGuid": "00000000-0000-0000-0000-000000000000",
  "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000"
}

Respuesta de muestra

{
  "complianceDetailedPdfReport": {
    "sasUri": "this is a uri"
  }
}
Azure-AsyncOperation: https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}
Location: https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}

Snapshot_Download_CompliancePdfReport

Solicitud de ejemplo

POST https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/testReportName/snapshots/testSnapshotName/download?api-version=2024-06-27

{
  "downloadType": "CompliancePdfReport",
  "offerGuid": "00000000-0000-0000-0000-000000000001",
  "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000"
}

Respuesta de muestra

{
  "compliancePdfReport": {
    "sasUri": "this is uri of report"
  }
}
Azure-AsyncOperation: https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}
Location: https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}

Snapshot_Download_ComplianceReport

Solicitud de ejemplo

POST https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/testReportName/snapshots/testSnapshotName/download?api-version=2024-06-27

{
  "downloadType": "ComplianceReport",
  "offerGuid": "00000000-0000-0000-0000-000000000001",
  "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000"
}

Respuesta de muestra

{
  "complianceReport": [
    {
      "categoryName": "Data Security & Privacy",
      "controlFamilyName": "Incident Response",
      "controlId": "Operational_Security_75",
      "controlName": "Provide demonstrable evidence that all member of the incident response team have completed annual training or a table top exercise",
      "controlStatus": "Passed",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService",
      "resourceOrigin": "Azure",
      "resourceStatus": "Healthy",
      "resourceStatusChangeDate": "2023-01-12T16:17:20.150Z",
      "resourceType": "Microsoft.SignalRService/SignalR",
      "responsibilityDescription": "Restrict access to the Kubernetes Service Management API by granting API access only to IP addresses in specific ranges. It is recommended to limit access to authorized IP ranges to ensure that only applications from allowed networks can access the cluster.",
      "responsibilityTitle": "Authorized IP ranges should be defined on Kubernetes Services"
    }
  ]
}
Azure-AsyncOperation: https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}
Location: https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}

Snapshot_Download_ResourceList

Solicitud de ejemplo

POST https://management.azure.com/providers/Microsoft.AppComplianceAutomation/reports/testReportName/snapshots/testSnapshotName/download?api-version=2024-06-27

{
  "downloadType": "ResourceList",
  "offerGuid": "00000000-0000-0000-0000-000000000001",
  "reportCreatorTenantId": "00000000-0000-0000-0000-000000000000"
}

Respuesta de muestra

{
  "resourceList": [
    {
      "resourceGroup": "myResourceGroup",
      "resourceId": "mySignalRService",
      "resourceType": "SignalR",
      "subscriptionId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}
Azure-AsyncOperation: https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationStatuses/{operationId}
Location: https://management.azure.com/providers/Microsoft.AppComplianceAutomation/operationResults/{operationId}

Definiciones

Nombre Description
ComplianceReportItem

Objeto que incluye todo el contenido para el resultado de cumplimiento único.

ControlStatus

Indica el estado del control.

DownloadResponse

Objeto que incluye toda la respuesta posible para la operación de descarga.

DownloadResponseComplianceDetailedPdfReport

Informe pdf de cumplimiento detallado

DownloadResponseCompliancePdfReport

Informe pdf de cumplimiento

DownloadType

Indica el tipo de descarga.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta de error

ResourceItem

Identificador de recurso.

ResourceOrigin

Origen del recurso.

ResourceStatus

Indica el estado del recurso.

SnapshotDownloadRequest

Solicitud de descarga de instantánea.

ComplianceReportItem

Objeto que incluye todo el contenido para el resultado de cumplimiento único.

Nombre Tipo Description
categoryName

string

Nombre de categoría.

controlFamilyName

string

Nombre de familia del control.

controlId

string

Identificador de control, por ejemplo, "1".

controlName

string

Nombre del control.

controlStatus

ControlStatus

Estado del control.

resourceId

string

Identificador del recurso.

resourceOrigin

ResourceOrigin

Origen del recurso.

resourceStatus

ResourceStatus

Estado del recurso.

resourceStatusChangeDate

string (date-time)

Fecha de cambio de estado para el recurso.

resourceType

string

Tipo del recurso. Por ejemplo, "Microsoft.SignalRService/SignalR"

responsibilityDescription

string

Descripción de la responsabilidad del cliente.

responsibilityTitle

string

Título de la responsabilidad del cliente.

ControlStatus

Indica el estado del control.

Valor Description
Failed

Error en el control.

NotApplicable

El control no es aplicable.

Passed

El control se pasa.

PendingApproval

El control está pendiente de aprobación.

DownloadResponse

Objeto que incluye toda la respuesta posible para la operación de descarga.

Nombre Tipo Description
complianceDetailedPdfReport

DownloadResponseComplianceDetailedPdfReport

Informe pdf de cumplimiento detallado

compliancePdfReport

DownloadResponseCompliancePdfReport

Informe pdf de cumplimiento

complianceReport

ComplianceReportItem[]

Lista del resultado de cumplimiento

resourceList

ResourceItem[]

Lista de recursos del informe

DownloadResponseComplianceDetailedPdfReport

Informe pdf de cumplimiento detallado

Nombre Tipo Description
sasUri

string

El URI del informe pdf de cumplimiento detallado

DownloadResponseCompliancePdfReport

Informe pdf de cumplimiento

Nombre Tipo Description
sasUri

string

El URI del informe pdf de cumplimiento

DownloadType

Indica el tipo de descarga.

Valor Description
ComplianceDetailedPdfReport

Descargue el informe pdf de cumplimiento detallado.

CompliancePdfReport

Descargue el informe pdf de cumplimiento.

ComplianceReport

Descargue el informe de cumplimiento.

ResourceList

Descargue la lista de recursos del informe.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.

type

string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorDetail[]

Detalles del error.

message

string

Mensaje de error.

target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

ResourceItem

Identificador de recurso.

Nombre Tipo Description
resourceGroup

string

Nombre del grupo de recursos de este recurso.

resourceId

string

Identificador de recurso: por ejemplo, "/subscriptions/000000000-0000-0000-00000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1".

resourceType

string

Tipo de recurso de este recurso. Por ejemplo, "Microsoft.SignalRService/SignalR"

subscriptionId

string

Identificador de suscripción de este recurso.

ResourceOrigin

Origen del recurso.

Valor Description
AWS

El recurso procede de AWS.

Azure

El recurso procede de Azure.

GCP

El recurso procede de GCP.

ResourceStatus

Indica el estado del recurso.

Valor Description
Healthy

El recurso es correcto.

Unhealthy

El recurso es incorrecto.

SnapshotDownloadRequest

Solicitud de descarga de instantánea.

Nombre Tipo Description
downloadType

DownloadType

Indica el tipo de descarga.

offerGuid

string

minLength: 1

OfferGuid que se asigna a los informes.

reportCreatorTenantId

string

Id. de inquilino.