Deny Assignments - List For Scope

Service:

Authorization

API Version:

2022-04-01

Obtém atribuições de negação para um âmbito.

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

With optional parameters:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
scope	path	True	string	O âmbito das atribuições de negação.
api-version	query	True	string	A versão da API a utilizar para esta operação.
$filter	query		string	O filtro a aplicar na operação. Utilize $filter=atScope() para devolver todas as atribuições de negação no âmbito ou acima. Utilize $filter=denyAssignmentName eq '{name}' para procurar atribuições de negação por nome no âmbito especificado. Utilize $filter=principalId eq '{id}' para devolver todas as atribuições de negação em, acima e abaixo do âmbito do principal especificado. Utilize $filter=gdprExportPrincipalId eq '{id}' para devolver todas as atribuições de negação em, acima e abaixo do âmbito do principal especificado. Este filtro é diferente do filtro principalId, uma vez que devolve não só as atribuições de negação que contêm o principal especificado são a lista Principais, mas também as atribuições de negação que contêm o principal especificado é a lista ExcludePrincipals. Além disso, quando o filtro gdprExportPrincipalId é utilizado, apenas são devolvidas as propriedades de descrição e nome da atribuição de negação.

Respostas

Name	Tipo	Description
200 OK	DenyAssignmentListResult	OK - Devolve uma matriz de atribuições de negação.
Other Status Codes	ErrorResponse	Resposta de erro que descreve o motivo pela qual a operação falhou.

Permissões

Para chamar esta API, tem de lhe ser atribuída uma função que tenha as seguintes permissões. Para obter mais informações, veja Funções incorporadas do Azure.

Microsoft.Authorization/denyAssignments/read

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

List deny assignments for scope

Sample Request

HTTP

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

Java

/** 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

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_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

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: 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

JavaScript

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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
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

Sample Response

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"
    }
  ]
}

Definições

Name	Description
DenyAssignment	Atribuição de Recusa
DenyAssignmentListResult	Negar o resultado da operação da lista de atribuições.
DenyAssignmentPermission	Negar permissões de atribuição.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
Principal	O nome da entidade modificou-a pela última vez

DenyAssignment

Atribuição de Recusa

Name	Tipo	Description
id	string	O ID da atribuição de negação.
name	string	O nome da atribuição de negação.
properties.condition	string	As condições na atribuição de negação. Isto limita os recursos aos quais pode ser atribuído. por exemplo: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion	string	Versão da condição.
properties.createdBy	string	ID do utilizador que criou a atribuição
properties.createdOn	string	Hora de criação
properties.denyAssignmentName	string	O nome a apresentar da atribuição de negação.
properties.description	string	A descrição da atribuição de negação.
properties.doNotApplyToChildScopes	boolean	Determina se a atribuição de negação se aplica aos âmbitos subordinados. O valor predefinido é falso.
properties.excludePrincipals	Principal[]	Matriz de principais aos quais a atribuição de negação não se aplica.
properties.isSystemProtected	boolean	Especifica se esta atribuição de negação foi criada pelo Azure e não pode ser editada ou eliminada.
properties.permissions	DenyAssignmentPermission[]	Uma matriz de permissões negadas pela atribuição de negação.
properties.principals	Principal[]	Matriz de principais aos quais se aplica a atribuição de negação.
properties.scope	string	O âmbito de atribuição de negação.
properties.updatedBy	string	ID do utilizador que atualizou a atribuição
properties.updatedOn	string	Hora em que foi atualizado
type	string	O tipo de atribuição de negação.

DenyAssignmentListResult

Negar o resultado da operação da lista de atribuições.

Name	Tipo	Description
nextLink	string	O URL a utilizar para obter o próximo conjunto de resultados.
value	DenyAssignment[]	Negar lista de atribuições.

DenyAssignmentPermission

Negar permissões de atribuição.

Name	Tipo	Description
actions	string[]	Ações às quais a atribuição de negação não concede acesso.
condition	string	As condições na permissão Negar atribuição. Isto limita os recursos a que se aplica.
conditionVersion	string	Versão da condição.
dataActions	string[]	Ações de dados às quais a atribuição de negação não concede acesso.
notActions	string[]	As ações a excluir dessa atribuição de negação não concedem acesso.
notDataActions	string[]	Ações de dados a excluir da atribuição de negação não concede acesso.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

Principal

O nome da entidade modificou-a pela última vez

Name	Tipo	Description
displayName	string	O nome do principal efetuou alterações
email	string	Email do principal
id	string	O ID do principal efetuou alterações
type	string	Tipo de principal, como utilizador, grupo, etc.