Attestations - Create Or Update At Subscription

Служба:
Policy
Версия API:
2024-10-01

Создает или обновляет аттестацию в области подписки.

PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/attestations/{attestationName}?api-version=2024-10-01

Параметры URI

Имя В Обязательно Тип Описание
attestationName
 path True

string

Имя аттестации.
subscriptionId
 path True

string

minLength: 1

Идентификатор целевой подписки.
api-version
 query True

string

minLength: 1

Версия API, используемая для данной операции.

Текст запроса

Имя Обязательно Тип Описание
properties.policyAssignmentId True

string

Идентификатор ресурса назначения политики, для которому задано состояние аттестации.
properties.assessmentDate

string (date-time)

Время оценки доказательств
properties.comments

string

Комментарии, описывающие, почему была создана аттестация.
properties.complianceState

ComplianceState

Состояние соответствия, которое должно быть задано в ресурсе.
properties.evidence

AttestationEvidence[]

Доказательства, поддерживающие состояние соответствия требованиям, заданные в этой аттестации.
properties.expiresOn

string (date-time)

Время истечения срока действия состояния соответствия.
properties.metadata

object

Дополнительные метаданные для этой аттестации
properties.owner

string

Лицо, ответственное за настройку состояния ресурса. Это значение обычно является идентификатором объекта Azure Active Directory.
properties.policyDefinitionReferenceId

string

Идентификатор ссылки на определение политики из определения набора политик, для которому задано состояние аттестации. Если назначение политики назначает определение набора политик, аттестация может выбрать определение в определении набора с этим свойством или опустить это и задать состояние для всего определения набора.

Ответы

Имя Тип Описание
200 OK

Attestation

Обновленная аттестация.
201 Created

Attestation

Созданная аттестация.
Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Create attestation at subscription scope
Create attestation at subscription scope with all properties

Create attestation at subscription scope

Образец запроса

PUT https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/Microsoft.PolicyInsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e?api-version=2024-10-01

{
  "properties": {
    "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
    "complianceState": "Compliant"
  }
}

Пример ответа

Код состояния:
200 
{
  "properties": {
    "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
    "complianceState": "Compliant",
    "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z",
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
    "createdByType": "User",
    "createdAt": "2020-06-15T18:52:27Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-15T18:52:27Z"
  },
  "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
  "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
  "type": "Microsoft.PolicyInsights/attestations"
}
Код состояния:
201 
{
  "properties": {
    "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
    "complianceState": "Compliant",
    "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z",
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
    "createdByType": "User",
    "createdAt": "2020-06-15T18:52:27Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-15T18:52:27Z"
  },
  "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
  "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
  "type": "Microsoft.PolicyInsights/attestations"
}

Create attestation at subscription scope with all properties

Образец запроса

PUT https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/Microsoft.PolicyInsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e?api-version=2024-10-01

{
  "properties": {
    "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
    "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551",
    "complianceState": "Compliant",
    "expiresOn": "2021-06-15T00:00:00Z",
    "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966",
    "comments": "This subscription has passed a security audit.",
    "evidence": [
      {
        "description": "The results of the security audit.",
        "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011"
      }
    ],
    "assessmentDate": "2021-06-10T00:00:00Z",
    "metadata": {
      "departmentId": "NYC-MARKETING-1"
    }
  }
}

Пример ответа

Код состояния:
200 
{
  "properties": {
    "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
    "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551",
    "complianceState": "Compliant",
    "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z",
    "expiresOn": "2021-06-15T00:00:00Z",
    "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966",
    "comments": "This subscription has passed a security audit.",
    "evidence": [
      {
        "description": "The results of the security audit.",
        "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011"
      }
    ],
    "assessmentDate": "2021-06-10T00:00:00Z",
    "metadata": {
      "departmentId": "NYC-MARKETING-1"
    },
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
    "createdByType": "User",
    "createdAt": "2020-06-15T18:52:27Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-15T18:52:27Z"
  },
  "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
  "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
  "type": "Microsoft.PolicyInsights/attestations"
}
Код состояния:
201 
{
  "properties": {
    "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
    "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551",
    "complianceState": "Compliant",
    "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z",
    "expiresOn": "2021-06-15T00:00:00Z",
    "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966",
    "comments": "This subscription has passed a security audit.",
    "evidence": [
      {
        "description": "The results of the security audit.",
        "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011"
      }
    ],
    "assessmentDate": "2021-06-10T00:00:00Z",
    "metadata": {
      "departmentId": "NYC-MARKETING-1"
    },
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
    "createdByType": "User",
    "createdAt": "2020-06-15T18:52:27Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-15T18:52:27Z"
  },
  "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
  "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
  "type": "Microsoft.PolicyInsights/attestations"
}

Определения

Имя Описание
Attestation

Ресурс аттестации.
AttestationEvidence

Часть доказательств, поддерживающих состояние соответствия требованиям, заданное в аттестации.
ComplianceState

Состояние соответствия, которое должно быть задано в ресурсе.
createdByType

Тип удостоверения, создавшего ресурс.
ErrorDefinition

Определение ошибки.
ErrorResponse

Ответ на ошибку.
systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.
TypedErrorInfo

Сведения о конкретной ошибке сценария.

Attestation

Объект

Ресурс аттестации.

Имя Тип Описание
id

string

Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Имя ресурса
properties.assessmentDate

string (date-time)

Время оценки доказательств
properties.comments

string

Комментарии, описывающие, почему была создана аттестация.
properties.complianceState

ComplianceState

Состояние соответствия, которое должно быть задано в ресурсе.
properties.evidence

AttestationEvidence[]

Доказательства, поддерживающие состояние соответствия требованиям, заданные в этой аттестации.
properties.expiresOn

string (date-time)

Время истечения срока действия состояния соответствия.
properties.lastComplianceStateChangeAt

string (date-time)

Время последнего изменения состояния соответствия в этой аттестации.
properties.metadata

object

Дополнительные метаданные для этой аттестации
properties.owner

string

Лицо, ответственное за настройку состояния ресурса. Это значение обычно является идентификатором объекта Azure Active Directory.
properties.policyAssignmentId

string

Идентификатор ресурса назначения политики, для которому задано состояние аттестации.
properties.policyDefinitionReferenceId

string

Идентификатор ссылки на определение политики из определения набора политик, для которому задано состояние аттестации. Если назначение политики назначает определение набора политик, аттестация может выбрать определение в определении набора с этим свойством или опустить это и задать состояние для всего определения набора.
properties.provisioningState

string

Состояние аттестации.
systemData

systemData

Azure Resource Manager метаданные, содержащие информацию createdBy и modifiedBy.
type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

AttestationEvidence

Объект

Часть доказательств, поддерживающих состояние соответствия требованиям, заданное в аттестации.

Имя Тип Описание
description

string

Описание этого фрагмента доказательств.
sourceUri

string

Расположение URI доказательства.

ComplianceState

Перечисление

Состояние соответствия, которое должно быть задано в ресурсе.

Значение Описание
Compliant

Ресурс соответствует политике.
NonCompliant

Ресурс не соответствует политике.
Unknown

Состояние соответствия ресурса неизвестно.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение Описание
User
Application
ManagedIdentity
Key

ErrorDefinition

Объект

Определение ошибки.

Имя Тип Описание
additionalInfo

TypedErrorInfo[]

Дополнительные сведения об ошибке для конкретного сценария.
code

string

Код ошибки конкретной службы, который служит подстатусом для кода ошибки HTTP.
details

ErrorDefinition[]

Сведения о внутренней ошибке.
message

string

Описание ошибки.
target

string

Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку.

Имя Тип Описание
error

ErrorDefinition

Сведения об ошибке.

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя Тип Описание
createdAt

string (date-time)

Метка времени создания ресурса (UTC).
createdBy

string

Удостоверение, создающее ресурс.
createdByType

createdByType

Тип удостоверения, создавшего ресурс.
lastModifiedAt

string (date-time)

Метка времени последнего изменения ресурса (UTC)
lastModifiedBy

string

Идентификатор, который последний раз изменил ресурс.
lastModifiedByType

createdByType

Тип удостоверения, который последний раз изменил ресурс.

TypedErrorInfo

Объект

Сведения о конкретной ошибке сценария.

Имя Тип Описание
info

Сведения о конкретной ошибке сценария.
type

string

Тип включенных сведений об ошибке.