Microsoft.Authorization accessReviewScheduleDefinitions 2021-11-16-preview
Definição de recurso do Bicep
O tipo de recurso accessReviewScheduleDefinitions pode ser implementado com operações que visam:
- Subscrições - Veja os comandos de implementação da subscrição
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Authorization/accessReviewScheduleDefinitions, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.Authorization/accessReviewScheduleDefinitions@2021-11-16-preview' = {
name: 'string'
backupReviewers: [
{
principalId: 'string'
}
]
descriptionForAdmins: 'string'
descriptionForReviewers: 'string'
displayName: 'string'
instances: [
{
properties: {
backupReviewers: [
{
principalId: 'string'
}
]
endDateTime: 'string'
reviewers: [
{
principalId: 'string'
}
]
startDateTime: 'string'
}
}
]
reviewers: [
{
principalId: 'string'
}
]
settings: {
autoApplyDecisionsEnabled: bool
defaultDecision: 'string'
defaultDecisionEnabled: bool
instanceDurationInDays: int
justificationRequiredOnApproval: bool
mailNotificationsEnabled: bool
recommendationLookBackDuration: 'string'
recommendationsEnabled: bool
recurrence: {
pattern: {
interval: int
type: 'string'
}
range: {
endDate: 'string'
numberOfOccurrences: int
startDate: 'string'
type: 'string'
}
}
reminderNotificationsEnabled: bool
}
}
Valores de propriedade
accessReviewScheduleDefinitions
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome do recurso | cadeia (obrigatório) |
| backupReviewers | Esta é a coleção de revisores de cópias de segurança. | AccessReviewReviewer[] |
| descriptionForAdmins | A descrição fornecida pelo criador da revisão de acesso e visível para os administradores. | string |
| descriptionForReviewers | A descrição fornecida pelo criador da revisão de acesso a mostrar aos revisores. | string |
| displayName | O nome a apresentar da definição de agenda. | string |
| instâncias | Esta é a coleção de instâncias devolvidas quando se faz uma expansão. | AccessReviewInstance[] |
| revisores | Esta é a coleção de revisores. | AccessReviewReviewer[] |
| definições | Definições de Revisão do Access. | AccessReviewScheduleSettings |
AccessReviewReviewer
| Nome | Descrição | Valor |
|---|---|---|
| principalId | O ID do revisor(utilizador/servicePrincipal) | string |
AccessReviewInstance
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Propriedades da Revisão do Access. | AccessReviewInstanceProperties |
AccessReviewInstanceProperties
| Nome | Descrição | Valor |
|---|---|---|
| backupReviewers | Esta é a coleção de revisores de cópias de segurança. | AccessReviewReviewer[] |
| endDateTime | O DateTime quando a instância de revisão está agendada para terminar. | string |
| revisores | Esta é a coleção de revisores. | AccessReviewReviewer[] |
| startDateTime | O DateTime quando a instância de revisão está agendada para ser iniciada. | string |
AccessReviewScheduleSettings
| Nome | Descrição | Valor |
|---|---|---|
| autoApplyDecisionsEnabled | Sinalizar para indicar se a capacidade de aplicação automática, para alterar automaticamente o recurso de acesso a objetos de destino, está ativada. Se não estiver ativado, um utilizador tem de, após a revisão ser concluída, aplicar a revisão de acesso. | bool |
| defaultDecision | Isto especifica o comportamento da funcionalidade de Descrição Automática quando uma revisão de acesso é concluída. | "Aprovar" 'Negar' "Recomendação" |
| defaultDecisionEnabled | Sinalizar para indicar se os revisores são obrigados a fornecer uma justificação ao rever o acesso. | bool |
| instanceDurationInDays | A duração em dias para uma instância. | int |
| justificationRequiredOnApproval | Sinalize para indicar se o revisor é obrigado a transmitir justificação ao registar uma decisão. | bool |
| mailNotificationsEnabled | Sinalize para indicar se o envio de e-mails para revisores e para o criador da revisão está ativado. | bool |
| recommendationLookBackDuration | As recomendações para revisões de acesso são calculadas ao analisar 30 dias de dados (w.r.t a data de início da revisão) por predefinição. No entanto, em alguns cenários, os clientes querem alterar até que ponto e querem configurar 60 dias, 90 dias, etc. em vez disso. Esta definição permite que os clientes configurem esta duração. O valor deve estar no formato ISO 8601 (http://en.wikipedia.org/wiki/ISO_8601#Durations). Este código pode ser utilizado para converter TimeSpan numa cadeia de intervalo válida: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) | string |
| recommendationsEnabled | Sinalizador para indicar se a apresentação de recomendações aos revisores está ativada. | bool |
| recurrence | Definições de Revisão de Acesso. | AccessReviewRecurrenceSettings |
| reminderNotificationsEnabled | Sinalizar para indicar se o envio de e-mails de lembrete para revisores está ativado. | bool |
AccessReviewRecurrenceSettings
| Nome | Descrição | Valor |
|---|---|---|
| padrão | Access Review schedule definition recurrence pattern. | AccessReviewRecurrencePattern |
| intervalo | Intervalo de periodicidade da definição de agendamento do Access Review. | AccessReviewRecurrenceRange |
AccessReviewRecurrencePattern
| Nome | Descrição | Valor |
|---|---|---|
| interval | O intervalo de periodicidade. Para uma revisão trimestral, o intervalo é 3 para o tipo : absoluteMonthly. | int |
| tipo | O tipo de periodicidade: semanal, mensal, etc. | 'absoluteMonthly' 'semanal' |
AccessReviewRecurrenceRange
| Nome | Descrição | Valor |
|---|---|---|
| endDate | O DateTime quando a revisão está agendada para terminar. Necessário se o tipo for endDate | string |
| numberOfOccurrences | O número de vezes que pretende repetir a revisão de acesso. Necessário e tem de ser positivo se o tipo for numerado. | int |
| startDate | O DateTime quando a revisão está agendada para ser iniciada. Esta pode ser uma data no futuro. Necessário na criação. | string |
| tipo | O tipo de intervalo de periodicidade. Os valores possíveis são: endDate, noEnd, numbered. | "endDate" "noEnd" "numerado" |
Definição de recurso do modelo arm
O tipo de recurso accessReviewScheduleDefinitions pode ser implementado com operações que visam:
- Subscrições – veja os comandos de implementação da subscrição
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Authorization/accessReviewScheduleDefinitions, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.Authorization/accessReviewScheduleDefinitions",
"apiVersion": "2021-11-16-preview",
"name": "string",
"backupReviewers": [
{
"principalId": "string"
}
],
"descriptionForAdmins": "string",
"descriptionForReviewers": "string",
"displayName": "string",
"instances": [
{
"properties": {
"backupReviewers": [
{
"principalId": "string"
}
],
"endDateTime": "string",
"reviewers": [
{
"principalId": "string"
}
],
"startDateTime": "string"
}
}
],
"reviewers": [
{
"principalId": "string"
}
],
"settings": {
"autoApplyDecisionsEnabled": "bool",
"defaultDecision": "string",
"defaultDecisionEnabled": "bool",
"instanceDurationInDays": "int",
"justificationRequiredOnApproval": "bool",
"mailNotificationsEnabled": "bool",
"recommendationLookBackDuration": "string",
"recommendationsEnabled": "bool",
"recurrence": {
"pattern": {
"interval": "int",
"type": "string"
},
"range": {
"endDate": "string",
"numberOfOccurrences": "int",
"startDate": "string",
"type": "string"
}
},
"reminderNotificationsEnabled": "bool"
}
}
Valores de propriedade
accessReviewScheduleDefinitions
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.Authorization/accessReviewScheduleDefinitions" |
| apiVersion | A versão da API de recursos | '2021-11-16-preview' |
| name | O nome do recurso | cadeia (obrigatório) |
| backupReviewers | Esta é a coleção de revisores de cópias de segurança. | AccessReviewReviewer[] |
| descriptionForAdmins | A descrição fornecida pelo criador da revisão de acesso e visível para os administradores. | string |
| descriptionForReviewers | A descrição fornecida pelo criador da revisão de acesso a mostrar aos revisores. | string |
| displayName | O nome a apresentar para a definição de agenda. | string |
| instâncias | Esta é a coleção de instâncias devolvidas quando se faz uma expansão. | AccessReviewInstance[] |
| revisores | Esta é a coleção de revisores. | AccessReviewReviewer[] |
| definições | Definições de Revisão de Acesso. | AccessReviewScheduleSettings |
AccessReviewReviewer
| Nome | Descrição | Valor |
|---|---|---|
| principalId | O ID do revisor (user/servicePrincipal) | string |
AccessReviewInstance
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Propriedades da Revisão de Acesso. | AccessReviewInstanceProperties |
AccessReviewInstanceProperties
| Nome | Descrição | Valor |
|---|---|---|
| backupReviewers | Esta é a coleção de revisores de cópias de segurança. | AccessReviewReviewer[] |
| endDateTime | O DateTime quando a instância de revisão está agendada para terminar. | string |
| revisores | Esta é a coleção de revisores. | AccessReviewReviewer[] |
| startDateTime | O DateTime quando a instância de revisão está agendada para ser iniciada. | string |
AccessReviewScheduleSettings
| Nome | Descrição | Valor |
|---|---|---|
| autoApplyDecisionsEnabled | Sinalizador para indicar se a capacidade de aplicação automática, para alterar automaticamente o recurso de acesso ao objeto de destino, está ativada. Se não estiver ativada, um utilizador tem de aplicar a revisão de acesso após a conclusão da revisão de acesso. | bool |
| defaultDecision | Isto especifica o comportamento da funcionalidade de Descrição Automática quando uma revisão de acesso é concluída. | "Aprovar" "Negar" "Recomendação" |
| defaultDecisionEnabled | Sinalizador para indicar se os revisores são obrigados a fornecer uma justificação ao rever o acesso. | bool |
| instanceDurationInDays | A duração em dias para uma instância. | int |
| justificationRequiredOnApproval | Sinalizar para indicar se o revisor é obrigado a transmitir justificação ao registar uma decisão. | bool |
| mailNotificationsEnabled | Sinalizar para indicar se o envio de e-mails para revisores e o criador da revisão está ativado. | bool |
| recommendationLookBackDuration | As recomendações para revisões de acesso são calculadas ao analisar 30 dias de dados (w.r.t a data de início da revisão) por predefinição. No entanto, em alguns cenários, os clientes querem alterar até que ponto e querem configurar 60 dias, 90 dias, etc. em vez disso. Esta definição permite que os clientes configurem esta duração. O valor deve estar no formato ISO 8601 (http://en.wikipedia.org/wiki/ISO_8601#Durations). Este código pode ser utilizado para converter TimeSpan numa cadeia de intervalo válida: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) | string |
| recommendationsEnabled | Sinalizador para indicar se a apresentação de recomendações aos revisores está ativada. | bool |
| recurrence | Definições de Revisão de Acesso. | AccessReviewRecurrenceSettings |
| reminderNotificationsEnabled | Sinalizar para indicar se o envio de e-mails de lembrete para revisores está ativado. | bool |
AccessReviewRecurrenceSettings
| Nome | Descrição | Valor |
|---|---|---|
| padrão | Access Review schedule definition recurrence pattern. | AccessReviewRecurrencePattern |
| intervalo | Intervalo de periodicidade da definição de agendamento do Access Review. | AccessReviewRecurrenceRange |
AccessReviewRecurrencePattern
| Nome | Descrição | Valor |
|---|---|---|
| interval | O intervalo de periodicidade. Para uma revisão trimestral, o intervalo é 3 para o tipo : absoluteMonthly. | int |
| tipo | O tipo de periodicidade: semanal, mensal, etc. | 'absoluteMonthly' 'semanal' |
AccessReviewRecurrenceRange
| Nome | Descrição | Valor |
|---|---|---|
| endDate | O DateTime quando a revisão está agendada para terminar. Necessário se o tipo for endDate | string |
| numberOfOccurrences | O número de vezes que pretende repetir a revisão de acesso. Necessário e tem de ser positivo se o tipo for numerado. | int |
| startDate | O DateTime quando a revisão está agendada para ser iniciada. Esta pode ser uma data no futuro. Necessário na criação. | string |
| tipo | O tipo de intervalo de periodicidade. Os valores possíveis são: endDate, noEnd, numbered. | "endDate" "noEnd" "numerado" |
Definição de recurso terraform (fornecedor AzAPI)
O tipo de recurso accessReviewScheduleDefinitions pode ser implementado com operações que visam:
- Subscrições
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Authorization/accessReviewScheduleDefinitions, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Authorization/accessReviewScheduleDefinitions@2021-11-16-preview"
name = "string"
parent_id = "string"
body = jsonencode({
backupReviewers = [
{
principalId = "string"
}
]
descriptionForAdmins = "string"
descriptionForReviewers = "string"
displayName = "string"
instances = [
{
properties = {
backupReviewers = [
{
principalId = "string"
}
]
endDateTime = "string"
reviewers = [
{
principalId = "string"
}
]
startDateTime = "string"
}
}
]
reviewers = [
{
principalId = "string"
}
]
settings = {
autoApplyDecisionsEnabled = bool
defaultDecision = "string"
defaultDecisionEnabled = bool
instanceDurationInDays = int
justificationRequiredOnApproval = bool
mailNotificationsEnabled = bool
recommendationLookBackDuration = "string"
recommendationsEnabled = bool
recurrence = {
pattern = {
interval = int
type = "string"
}
range = {
endDate = "string"
numberOfOccurrences = int
startDate = "string"
type = "string"
}
}
reminderNotificationsEnabled = bool
}
})
}
Valores de propriedade
accessReviewScheduleDefinitions
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.Authorization/accessReviewScheduleDefinitions@2021-11-16-preview" |
| name | O nome do recurso | cadeia (obrigatório) |
| parent_id | Para implementar numa subscrição, utilize o ID dessa subscrição. | cadeia (obrigatório) |
| backupReviewers | Esta é a coleção de revisores de cópias de segurança. | AccessReviewReviewer[] |
| descriptionForAdmins | A descrição fornecida pelo criador da revisão de acesso e visível para os administradores. | string |
| descriptionForReviewers | A descrição fornecida pelo criador da revisão de acesso a mostrar aos revisores. | string |
| displayName | O nome a apresentar para a definição de agenda. | string |
| instâncias | Esta é a coleção de instâncias devolvidas quando se faz uma expansão. | AccessReviewInstance[] |
| revisores | Esta é a coleção de revisores. | AccessReviewReviewer[] |
| definições | Definições de Revisão de Acesso. | AccessReviewScheduleSettings |
AccessReviewReviewer
| Nome | Descrição | Valor |
|---|---|---|
| principalId | O ID do revisor (user/servicePrincipal) | string |
AccessReviewInstance
| Nome | Descrição | Valor |
|---|---|---|
| propriedades | Propriedades da Revisão de Acesso. | AccessReviewInstanceProperties |
AccessReviewInstanceProperties
| Nome | Descrição | Valor |
|---|---|---|
| backupReviewers | Esta é a coleção de revisores de cópias de segurança. | AccessReviewReviewer[] |
| endDateTime | O DateTime quando a instância de revisão está agendada para terminar. | string |
| revisores | Esta é a coleção de revisores. | AccessReviewReviewer[] |
| startDateTime | O DateTime quando a instância de revisão está agendada para ser iniciada. | string |
AccessReviewScheduleSettings
| Nome | Descrição | Valor |
|---|---|---|
| autoApplyDecisionsEnabled | Sinalizador para indicar se a capacidade de aplicação automática, para alterar automaticamente o recurso de acesso ao objeto de destino, está ativada. Se não estiver ativada, um utilizador tem de aplicar a revisão de acesso após a conclusão da revisão de acesso. | bool |
| defaultDecision | Isto especifica o comportamento da funcionalidade de Descrição Automática quando uma revisão de acesso é concluída. | "Aprovar" "Negar" "Recomendação" |
| defaultDecisionEnabled | Sinalizador para indicar se os revisores são obrigados a fornecer uma justificação ao rever o acesso. | bool |
| instanceDurationInDays | A duração em dias para uma instância. | int |
| justificationRequiredOnApproval | Sinalizar para indicar se o revisor é obrigado a transmitir justificação ao registar uma decisão. | bool |
| mailNotificationsEnabled | Sinalizar para indicar se o envio de e-mails para revisores e o criador da revisão está ativado. | bool |
| recommendationLookBackDuration | As recomendações para revisões de acesso são calculadas ao analisar 30 dias de dados (w.r.t a data de início da revisão) por predefinição. No entanto, em alguns cenários, os clientes querem alterar até que ponto e querem configurar 60 dias, 90 dias, etc. em vez disso. Esta definição permite que os clientes configurem esta duração. O valor deve estar no formato ISO 8601 (http://en.wikipedia.org/wiki/ISO_8601#Durations). Este código pode ser utilizado para converter TimeSpan numa cadeia de intervalo válida: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) | string |
| recommendationsEnabled | Sinalizador para indicar se a apresentação de recomendações aos revisores está ativada. | bool |
| recurrence | Definições de Revisão de Acesso. | AccessReviewRecurrenceSettings |
| reminderNotificationsEnabled | Sinalizar para indicar se o envio de e-mails de lembrete para revisores está ativado. | bool |
AccessReviewRecurrenceSettings
| Nome | Descrição | Valor |
|---|---|---|
| padrão | Access Review schedule definition recurrence pattern. | AccessReviewRecurrencePattern |
| intervalo | Intervalo de periodicidade da definição de agendamento do Access Review. | AccessReviewRecurrenceRange |
AccessReviewRecurrencePattern
| Nome | Descrição | Valor |
|---|---|---|
| interval | O intervalo de periodicidade. Para uma revisão trimestral, o intervalo é 3 para o tipo : absoluteMonthly. | int |
| tipo | O tipo de periodicidade: semanal, mensal, etc. | "absoluteMonthly" "semanal" |
AccessReviewRecurrenceRange
| Nome | Descrição | Valor |
|---|---|---|
| endDate | O DateTime quando a revisão está agendada para terminar. Necessário se o tipo for endDate | string |
| numberOfOccurrences | O número de vezes que pretende repetir a revisão de acesso. Necessário e tem de ser positivo se o tipo for numerado. | int |
| startDate | O DateTime quando a revisão está agendada para ser iniciada. Esta pode ser uma data no futuro. Necessário na criação. | string |
| tipo | O tipo de intervalo de periodicidade. Os valores possíveis são: endDate, noEnd, numbered. | "endDate" "noEnd" "numerado" |