Deny Assignments - List For Scope

Referencia

Servicio:: Authorization

Versión de la API:: 2022-04-01

Obtiene las asignaciones de denegación de un ámbito.

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/denyAssignments?api-version=2022-04-01

Con parámetros opcionales:

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/denyAssignments?api-version=2022-04-01&$filter={$filter}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
scope	path	True	string	Ámbito de las asignaciones de denegación.
api-version	query	True	string	Versión de API que se usará para la operación.
$filter	query		string	Filtro que se va a aplicar en la operación. Use $filter=atScope() para devolver todas las asignaciones de denegación en o por encima del ámbito. Use $filter=denyAssignmentName eq '{name}' para buscar asignaciones de denegación por nombre en el ámbito especificado. Use $filter=principalId eq '{id}' para devolver todas las asignaciones de denegación en, encima y debajo del ámbito de la entidad de seguridad especificada. Use $filter=rgpdExportPrincipalId eq '{id}' para devolver todas las asignaciones de denegación en, arriba y por debajo del ámbito de la entidad de seguridad especificada. Este filtro es diferente del filtro principalId, ya que no solo devuelve las asignaciones de denegación que contienen la entidad de seguridad especificada es la lista Entidades de seguridad, sino también las asignaciones de denegación que contienen la entidad de seguridad especificada es la lista ExcludePrincipals. Además, cuando se usa el filtro gdprExportPrincipalId, solo se devuelven las propiedades de nombre de asignación de denegación y descripción.

Respuestas

Nombre	Tipo	Description
200 OK	DenyAssignmentListResult	Ok: devuelve una matriz de asignaciones de denegación.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Permisos

Para llamar a esta API, debe tener asignado un rol con los siguientes permisos. Para más información, consulte Roles integrados en Azure.

Microsoft.Authorization/denyAssignments/read

Seguridad

azure_auth

Flujo 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	suplantación de su cuenta de usuario

Ejemplos

List deny assignments for scope

Solicitud de ejemplo

GET https://management.azure.com/subscriptions/subId/providers/Microsoft.Authorization/denyAssignments?api-version=2022-04-01


/**
 * Samples for DenyAssignments ListForScope.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/
     * GetDenyAssignmentByScope.json
     */
    /**
     * Sample code: List deny assignments for scope.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listDenyAssignmentsForScope(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.accessManagement().roleAssignments().manager().roleServiceClient().getDenyAssignments()
            .listForScope("subscriptions/subId", null, com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.authorization import AuthorizationManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-authorization
# USAGE
    python get_deny_assignment_by_scope.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.deny_assignments.list_for_scope(
        scope="subscriptions/subId",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetDenyAssignmentByScope.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

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: https://github.com/Azure/azure-rest-api-specs/blob/310a0100f5b020c1900c527a6aa70d21992f078a/specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetDenyAssignmentByScope.json
func ExampleDenyAssignmentsClient_NewListForScopePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armauthorization.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDenyAssignmentsClient().NewListForScopePager("subscriptions/subId", &armauthorization.DenyAssignmentsClientListForScopeOptions{Filter: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DenyAssignmentListResult = armauthorization.DenyAssignmentListResult{
		// 	Value: []*armauthorization.DenyAssignment{
		// 		{
		// 			Name: to.Ptr("denyAssignmentId"),
		// 			Type: to.Ptr("Microsoft.Authorization/denyAssignments"),
		// 			ID: to.Ptr("/subscriptions/subId/providers/Microsoft.Authorization/denyAssignments/denyAssignmentId"),
		// 			Properties: &armauthorization.DenyAssignmentProperties{
		// 				Description: to.Ptr("Deny assignment description"),
		// 				DenyAssignmentName: to.Ptr("Deny assignment name"),
		// 				DoNotApplyToChildScopes: to.Ptr(false),
		// 				ExcludePrincipals: []*armauthorization.Principal{
		// 					{
		// 						Type: to.Ptr("principalType2"),
		// 						ID: to.Ptr("principalId2"),
		// 				}},
		// 				IsSystemProtected: to.Ptr(true),
		// 				Permissions: []*armauthorization.DenyAssignmentPermission{
		// 					{
		// 						Actions: []*string{
		// 							to.Ptr("action")},
		// 							DataActions: []*string{
		// 								to.Ptr("action")},
		// 								NotActions: []*string{
		// 								},
		// 								NotDataActions: []*string{
		// 								},
		// 						}},
		// 						Principals: []*armauthorization.Principal{
		// 							{
		// 								Type: to.Ptr("principalType1"),
		// 								ID: to.Ptr("principalId1"),
		// 						}},
		// 						Scope: to.Ptr("/subscriptions/subId"),
		// 					},
		// 			}},
		// 		}
	}
}

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

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

/**
 * This sample demonstrates how to Gets deny assignments for a scope.
 *
 * @summary Gets deny assignments for a scope.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetDenyAssignmentByScope.json
 */
async function listDenyAssignmentsForScope() {
  const scope = "subscriptions/subId";
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.denyAssignments.listForScope(scope)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Authorization;

// Generated from example definition: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetDenyAssignmentByScope.json
// this example is just showing the usage of "DenyAssignments_ListForScope" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ArmResource created on azure
// for more information of creating ArmResource, please refer to the document of ArmResource

// get the collection of this DenyAssignmentResource
string scope = "subscriptions/subId";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", scope));
DenyAssignmentCollection collection = client.GetDenyAssignments(scopeId);

// invoke the operation and iterate over the result
await foreach (DenyAssignmentResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    DenyAssignmentData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "properties": {
        "denyAssignmentName": "Deny assignment name",
        "description": "Deny assignment description",
        "permissions": [
          {
            "actions": [
              "action"
            ],
            "notActions": [],
            "dataActions": [
              "action"
            ],
            "notDataActions": []
          }
        ],
        "scope": "/subscriptions/subId",
        "doNotApplyToChildScopes": false,
        "principals": [
          {
            "id": "principalId1",
            "type": "principalType1"
          }
        ],
        "excludePrincipals": [
          {
            "id": "principalId2",
            "type": "principalType2"
          }
        ],
        "isSystemProtected": true
      },
      "id": "/subscriptions/subId/providers/Microsoft.Authorization/denyAssignments/denyAssignmentId",
      "type": "Microsoft.Authorization/denyAssignments",
      "name": "denyAssignmentId"
    }
  ]
}

Definiciones

Nombre	Description
DenyAssignment	Asignación de denegación
DenyAssignmentListResult	Resultado de la operación de la lista de asignación de denegación.
DenyAssignmentPermission	Denegar permisos de asignación.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
Principal	El nombre de la entidad lo modificó por última vez.

DenyAssignment

Asignación de denegación

Nombre	Tipo	Description
id	string	Identificador de asignación de denegación.
name	string	Nombre de la asignación de denegación.
properties.condition	string	Condiciones de la asignación de denegación. Esto limita los recursos a los que se puede asignar. Por ejemplo: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion	string	Versión de la condición.
properties.createdBy	string	Identificador del usuario que creó la asignación
properties.createdOn	string	Hora en que se creó
properties.denyAssignmentName	string	El nombre para mostrar de la asignación de denegación.
properties.description	string	La descripción de la asignación de denegación.
properties.doNotApplyToChildScopes	boolean	Determina si la asignación de denegación se aplica a los ámbitos secundarios. El valor predeterminado es False.
properties.excludePrincipals	Principal[]	Matriz de entidades de seguridad a las que no se aplica la asignación de denegación.
properties.isSystemProtected	boolean	Especifica si Azure ha creado esta asignación de denegación y no se puede editar ni eliminar.
properties.permissions	DenyAssignmentPermission[]	Matriz de permisos denegados por la asignación de denegación.
properties.principals	Principal[]	Matriz de entidades de seguridad a las que se aplica la asignación de denegación.
properties.scope	string	Ámbito de asignación de denegación.
properties.updatedBy	string	Identificador del usuario que actualizó la asignación
properties.updatedOn	string	Hora en que se actualizó
type	string	Tipo de asignación de denegación.

DenyAssignmentListResult

Resultado de la operación de la lista de asignación de denegación.

Nombre	Tipo	Description
nextLink	string	Dirección URL que se va a usar para obtener el siguiente conjunto de resultados.
value	DenyAssignment[]	Lista de asignaciones de denegación.

DenyAssignmentPermission

Denegar permisos de asignación.

Nombre	Tipo	Description
actions	string[]	Acciones a las que la asignación de denegación no concede acceso.
condition	string	Condiciones del permiso de asignación Denegar. Esto limita los recursos a los que se aplica.
conditionVersion	string	Versión de la condición.
dataActions	string[]	Acciones de datos a las que la asignación de denegación no concede acceso.
notActions	string[]	Las acciones que se excluirán de esa asignación de denegación no conceden acceso.
notDataActions	string[]	Las acciones de datos que se excluirán de que la asignación de denegación no concede acceso.

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[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Principal

El nombre de la entidad lo modificó por última vez.

Nombre	Tipo	Description
displayName	string	El nombre de la entidad de seguridad realizó cambios.
email	string	Email de entidad de seguridad
id	string	El identificador de la entidad de seguridad realizó cambios.
type	string	Tipo de entidad de seguridad, como usuario, grupo, etc.