Compartilhar via


Access Review History Definitions - Get By Id

Obter a definição do histórico de revisão de acesso por ID de definição

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewHistoryDefinitions/{historyDefinitionId}?api-version=2021-12-01-preview

Parâmetros de URI

Nome Em Obrigatório Tipo Description
historyDefinitionId
path True

string

A ID da definição do histórico de revisão de acesso.

subscriptionId
path True

string

A ID da assinatura de destino.

api-version
query True

string

A versão da API a ser usada com a solicitação HTTP.

Respostas

Nome Tipo Description
200 OK

AccessReviewHistoryDefinition

AccessReviewHistoryDefinition

Other Status Codes

ErrorDefinition

Erro inesperado

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Definições

Nome Description
AccessReviewActorIdentityType

O tipo de identidade : user/servicePrincipal

AccessReviewHistoryDefinition

Definição do histórico de revisão de acesso.

AccessReviewHistoryDefinitionStatus

Este campo somente leitura especifica o dos dados de histórico de revisão solicitados. Isso é solicitado, em andamento, feito ou erro.

AccessReviewHistoryInstance

Instância de Definição do Histórico de Revisão de Acesso.

AccessReviewRecurrencePatternType

O tipo de recorrência: semanal, mensal etc.

AccessReviewRecurrenceRangeType

O tipo de intervalo de recorrência. Os valores possíveis são: endDate, noEnd, numerado.

AccessReviewResult

Coleção de decisões de revisão nas quais os dados de histórico devem ser filtrados. Por exemplo, se Aprovar e Negar forem fornecidos, os dados conterão apenas os resultados de revisão nos quais o tomador de decisão aprovou ou negou uma solicitação de revisão.

AccessReviewScope

Descritor para o que precisa ser revisado

AccessReviewScopeAssignmentState

O estado de atribuição de função qualificado/ativo para revisão

AccessReviewScopePrincipalType

O tipo de identidade user/servicePrincipal a ser revisado

ErrorDefinition

Erro

ErrorDefinitionProperties

Erro

AccessReviewActorIdentityType

O tipo de identidade : user/servicePrincipal

Nome Tipo Description
servicePrincipal

string

user

string

AccessReviewHistoryDefinition

Definição do histórico de revisão de acesso.

Nome Tipo Description
id

string

A ID de definição do histórico de revisão de acesso.

name

string

A ID exclusiva da definição do histórico de revisão de acesso.

properties.createdBy.principalId

string

A ID de identidade

properties.createdBy.principalName

string

O nome de exibição de identidade

properties.createdBy.principalType

AccessReviewActorIdentityType

O tipo de identidade : user/servicePrincipal

properties.createdBy.userPrincipalName

string

O nome da entidade de usuário (se válido)

properties.createdDateTime

string

Data em que a definição de histórico foi criada

properties.decisions

AccessReviewResult[]

Coleção de decisões de revisão nas quais os dados de histórico devem ser filtrados. Por exemplo, se Aprovar e Negar forem fornecidos, os dados conterão apenas os resultados de revisão nos quais o tomador de decisão aprovou ou negou uma solicitação de revisão.

properties.displayName

string

O nome de exibição para a definição de histórico.

properties.instances

AccessReviewHistoryInstance[]

Conjunto de instâncias de histórico de revisão de acesso para essa definição de histórico.

properties.reviewHistoryPeriodEndDateTime

string

Data de data usada ao selecionar dados de revisão, todas as revisões incluídas nos dados terminam em ou antes dessa data. Para uso somente com relatórios únicos/não recorrentes.

properties.reviewHistoryPeriodStartDateTime

string

Data de data usada ao selecionar dados de revisão, todas as revisões incluídas nos dados começam em ou após essa data. Para uso somente com relatórios únicos/não recorrentes.

properties.scopes

AccessReviewScope[]

Uma coleção de escopos usados ao selecionar dados de histórico de revisão

properties.settings.pattern.interval

integer

O intervalo de recorrência. Para uma revisão trimestral, o intervalo é 3 para o tipo : absoluteMonthly.

properties.settings.pattern.type

AccessReviewRecurrencePatternType

O tipo de recorrência: semanal, mensal etc.

properties.settings.range.endDate

string

O DateTime quando a revisão está agendada para terminar. Obrigatório se o tipo for endDate

properties.settings.range.numberOfOccurrences

integer

O número de vezes para repetir a revisão de acesso. Obrigatório e deve ser positivo se o tipo estiver numerado.

properties.settings.range.startDate

string

O DateTime quando a revisão está agendada para ser iniciada. Isso pode ser uma data no futuro. Necessário na criação.

properties.settings.range.type

AccessReviewRecurrenceRangeType

O tipo de intervalo de recorrência. Os valores possíveis são: endDate, noEnd, numerado.

properties.status

AccessReviewHistoryDefinitionStatus

Este campo somente leitura especifica o dos dados de histórico de revisão solicitados. Isso é solicitado, em andamento, feito ou erro.

type

string

O tipo de recurso.

AccessReviewHistoryDefinitionStatus

Este campo somente leitura especifica o dos dados de histórico de revisão solicitados. Isso é solicitado, em andamento, feito ou erro.

Nome Tipo Description
Done

string

Error

string

InProgress

string

Requested

string

AccessReviewHistoryInstance

Instância de Definição do Histórico de Revisão de Acesso.

Nome Tipo Description
id

string

A ID da instância de definição do histórico de revisão de acesso.

name

string

A ID exclusiva da instância de definição do histórico de revisão de acesso.

properties.displayName

string

O nome de exibição para a definição do histórico pai.

properties.downloadUri

string

Uri que pode ser usado para recuperar dados de histórico de revisão. Para gerar esse Uri, generateDownloadUri() deve ser chamado para um accessReviewHistoryDefinitionInstance específico. O link expira após um período de 24 horas. Os chamadores podem ver a hora da data de validade examinando o parâmetro 'se' no uri gerado.

properties.expiration

string

Data em que o relatório de dados de histórico expira e os dados associados são excluídos.

properties.fulfilledDateTime

string

Data em que o relatório de dados de histórico está agendado para ser gerado.

properties.reviewHistoryPeriodEndDateTime

string

Data de data usada ao selecionar dados de revisão, todas as revisões incluídas nos dados terminam em ou antes dessa data. Para uso somente com relatórios únicos/não recorrentes.

properties.reviewHistoryPeriodStartDateTime

string

Data de data usada ao selecionar dados de revisão, todas as revisões incluídas nos dados começam em ou após essa data. Para uso somente com relatórios únicos/não recorrentes.

properties.runDateTime

string

Data em que o relatório de dados de histórico está agendado para ser gerado.

properties.status

AccessReviewHistoryDefinitionStatus

Status dos dados da instância de histórico de revisão solicitados. Isso é solicitado, em andamento, feito ou erro. As transições de estado são as seguintes - Solicitadas -> InProgress -> Concluído -> Expirado

type

string

O tipo de recurso.

AccessReviewRecurrencePatternType

O tipo de recorrência: semanal, mensal etc.

Nome Tipo Description
absoluteMonthly

string

weekly

string

AccessReviewRecurrenceRangeType

O tipo de intervalo de recorrência. Os valores possíveis são: endDate, noEnd, numerado.

Nome Tipo Description
endDate

string

noEnd

string

numbered

string

AccessReviewResult

Coleção de decisões de revisão nas quais os dados de histórico devem ser filtrados. Por exemplo, se Aprovar e Negar forem fornecidos, os dados conterão apenas os resultados de revisão nos quais o tomador de decisão aprovou ou negou uma solicitação de revisão.

Nome Tipo Description
Approve

string

Deny

string

DontKnow

string

NotNotified

string

NotReviewed

string

AccessReviewScope

Descritor para o que precisa ser revisado

Nome Tipo Description
assignmentState

AccessReviewScopeAssignmentState

O estado de atribuição de função qualificado/ativo para revisão

excludeResourceId

string

Isso é usado para indicar as IDs de recurso a serem excluídas

excludeRoleDefinitionId

string

Isso é usado para indicar as IDs de definição de função a serem excluídas

expandNestedMemberships

boolean

Sinalizador para indicar se as associações aninhadas devem ou não ser expandidas.

inactiveDuration

string

Duração para a qual os usuários estão inativos. O valor deve estar no formato ISO 8601 (http://en.wikipedia.org/wiki/ISO_8601#Durations). Esse código pode ser usado para converter TimeSpan em uma cadeia de caracteres de intervalo válida: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))

includeAccessBelowResource

boolean

Sinalizador para indicar se as associações aninhadas devem ou não ser expandidas.

includeInheritedAccess

boolean

Sinalizador para indicar se as associações aninhadas devem ou não ser expandidas.

principalType

AccessReviewScopePrincipalType

O tipo de identidade user/servicePrincipal a ser revisado

resourceId

string

ResourceId no qual esta revisão está sendo criada

roleDefinitionId

string

Isso é usado para indicar a função que está sendo revisada

AccessReviewScopeAssignmentState

O estado de atribuição de função qualificado/ativo para revisão

Nome Tipo Description
active

string

eligible

string

AccessReviewScopePrincipalType

O tipo de identidade user/servicePrincipal a ser revisado

Nome Tipo Description
guestUser

string

redeemedGuestUser

string

servicePrincipal

string

user

string

user,group

string

ErrorDefinition

Erro

Nome Tipo Description
error

ErrorDefinitionProperties

Erro
Erro do gateway de lista status.

ErrorDefinitionProperties

Erro

Nome Tipo Description
code

string

Código de erro do gateway de lista.

message

string

Descrição do erro.