Alert Definitions - Get

Serviço:

Authorization

Versão da API:

2022-08-01-preview

Obtenha a definição de alerta especificada.

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleManagementAlertDefinitions/{alertDefinitionId}?api-version=2022-08-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
alertDefinitionId	path	True	string	O nome da definição de alerta a ser obtido.
scope	path	True	string	O identificador totalmente qualificado do Azure Resource Manager do recurso.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	AlertDefinition	Operação do Azure concluída com sucesso.
Other Status Codes	Microsoft.Common.CloudError	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

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

Exemplos

GetAlertDefinitionById

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlertDefinitions/TooManyPermanentOwnersAssignedToResource?api-version=2022-08-01-preview

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.authorization import AuthorizationManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-authorization
# USAGE
    python get_alert_definition_by_id.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AuthorizationManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.alert_definitions.get(
        scope="subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f",
        alert_definition_id="TooManyPermanentOwnersAssignedToResource",
    )
    print(response)


# x-ms-original-file: 2022-08-01-preview/GetAlertDefinitionById.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armauthorization_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization/v3"
)

// Generated from example definition: 2022-08-01-preview/GetAlertDefinitionById.json
func ExampleAlertDefinitionsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armauthorization.NewClientFactory("<subscriptionID>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAlertDefinitionsClient().Get(ctx, "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f", "TooManyPermanentOwnersAssignedToResource", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armauthorization.AlertDefinitionsClientGetResponse{
	// 	AlertDefinition: &armauthorization.AlertDefinition{
	// 		Name: to.Ptr("TooManyPermanentOwnersAssignedToResource"),
	// 		Type: to.Ptr("Microsoft.Authorization/roleManagementAlertDefinitions"),
	// 		ID: to.Ptr("/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlertDefinitions/TooManyPermanentOwnersAssignedToResource"),
	// 		Properties: &armauthorization.AlertDefinitionProperties{
	// 			Description: to.Ptr("The number of users set to never expire is too high. To enhance the security of your resources, we recommend requiring activation for role use. Take a moment to review the list of users, and suggested changes here."),
	// 			DisplayName: to.Ptr("Too many permanent owners assigned to a resource"),
	// 			HowToPrevent: to.Ptr("Enable “Activation Required” in the role settings menu. This will ensure newly added users must activate their role."),
	// 			IsConfigurable: to.Ptr(true),
	// 			IsRemediatable: to.Ptr(true),
	// 			MitigationSteps: to.Ptr("To mitigate this issue, require the user to activate the role before use."),
	// 			Scope: to.Ptr("subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f"),
	// 			SecurityImpact: to.Ptr("Providing users permanent access in a role may leave resources vulnerable to accidental or malicious activity."),
	// 			SeverityLevel: to.Ptr(armauthorization.SeverityLevelMedium),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AuthorizationManagementClient } = require("@azure/arm-authorization");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to get the specified alert definition.
 *
 * @summary get the specified alert definition.
 * x-ms-original-file: 2022-08-01-preview/GetAlertDefinitionById.json
 */
async function getAlertDefinitionById() {
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential);
  const result = await client.alertDefinitions.get(
    "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f",
    "TooManyPermanentOwnersAssignedToResource",
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:

200

{
  "name": "TooManyPermanentOwnersAssignedToResource",
  "type": "Microsoft.Authorization/roleManagementAlertDefinitions",
  "id": "/subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleManagementAlertDefinitions/TooManyPermanentOwnersAssignedToResource",
  "properties": {
    "description": "The number of users set to never expire is too high. To enhance the security of your resources, we recommend requiring activation for role use. Take a moment to review the list of users, and suggested changes here.",
    "displayName": "Too many permanent owners assigned to a resource",
    "howToPrevent": "Enable “Activation Required” in the role settings menu. This will ensure newly added users must activate their role.",
    "isConfigurable": true,
    "isRemediatable": true,
    "mitigationSteps": "To mitigate this issue, require the user to activate the role before use.",
    "scope": "subscriptions/afa2a084-766f-4003-8ae1-c4aeb893a99f",
    "securityImpact": "Providing users permanent access in a role may leave resources vulnerable to accidental or malicious activity.",
    "severityLevel": "Medium"
  }
}

Definições

Nome	Description
AlertDefinition	Definição de alerta
createdByType	O tipo de identidade que criou o recurso.
Microsoft.Common.CloudError	Uma resposta de erro do serviço.
Microsoft.Common.CloudErrorBody	Uma resposta de erro do serviço.
SeverityLevel	Nível de gravidade do alerta.
systemData	Metadados relativos à criação e última modificação do recurso.

AlertDefinition

Objeto

Definição de alerta

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.description	string	A descrição do alerta.
properties.displayName	string	O nome de exibição do alerta.
properties.howToPrevent	string	As maneiras de evitar o alerta.
properties.isConfigurable	boolean	True se a configuração de alerta puder ser configurada; false, caso contrário.
properties.isRemediatable	boolean	True se o alerta puder ser corrigido; false, caso contrário.
properties.mitigationSteps	string	Os métodos para atenuar o alerta.
properties.scope	string	O escopo do alerta.
properties.securityImpact	string	Impacto de segurança do alerta.
properties.severityLevel	SeverityLevel	Nível de gravidade do alerta.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft. Compute/virtualMachines" ou "Microsoft. ContasArmazenamento/Armazenamento"

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

Microsoft.Common.CloudError

Objeto

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	Microsoft.Common.CloudErrorBody	Uma resposta de erro do serviço.

Microsoft.Common.CloudErrorBody

Objeto

Uma resposta de erro do serviço.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.

SeverityLevel

Enumeração

Nível de gravidade do alerta.

Valor	Description
Low	Baixo
Medium	Medium
High	Alto

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.