Deny Assignments - List For Scope

Service:

Authorization

API-versie:

2022-04-01

Hiermee worden weigeringstoewijzingen voor een bereik opgehaald.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
scope	path	True	string	Het bereik van de weigeringstoewijzingen.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.
$filter	query		string	Het filter dat moet worden toegepast op de bewerking. Gebruik $filter=atScope() om alle weigeringstoewijzingen binnen of boven het bereik te retourneren. Gebruik $filter=denyAssignmentName eq {name} om weigeringstoewijzingen te zoeken op naam binnen het opgegeven bereik. Gebruik $filter=principalId eq {id} om alle weigeringstoewijzingen op, boven en onder het bereik voor de opgegeven principal te retourneren. Gebruik $filter=avgExportPrincipalId eq {id} om alle weigeringstoewijzingen op, boven en onder het bereik voor de opgegeven principal te retourneren. Dit filter verschilt van het filter principalId, omdat het niet alleen de weigeringstoewijzingen retourneert die de opgegeven principal bevatten in de lijst Principals, maar ook de weigeringstoewijzingen die de opgegeven principal bevatten, is de lijst ExcludePrincipals. Wanneer het avgExportPrincipalId-filter wordt gebruikt, worden bovendien alleen de eigenschappen voor de naam en beschrijving van de toewijzing weigeren geretourneerd.

Antwoorden

Name	Type	Description
200 OK	DenyAssignmentListResult	OK: retourneert een matrix met weigeringstoewijzingen.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Machtigingen

Als u deze API wilt aanroepen, moet er aan u een rol zijn toegewezen met de volgende machtigingen. Zie Ingebouwde rollen in Azure voor meer informatie.

Microsoft.Authorization/denyAssignments/read

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

List deny assignments for scope

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
DenyAssignment	Toewijzing weigeren
DenyAssignmentListResult	Resultaat van bewerking van toewijzingslijst weigeren.
DenyAssignmentPermission	Toewijzingsmachtigingen weigeren.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
Principal	De naam van de entiteit die het laatst is gewijzigd

DenyAssignment

Toewijzing weigeren

Name	Type	Description
id	string	De toewijzings-id weigeren.
name	string	De naam van de toewijzing weigeren.
properties.condition	string	De voorwaarden voor de weigeringstoewijzing. Dit beperkt de resources waaraan het kan worden toegewezen. bijvoorbeeld: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion	string	Versie van de voorwaarde.
properties.createdBy	string	Id van de gebruiker die de toewijzing heeft gemaakt
properties.createdOn	string	Tijdstip waarop deze is gemaakt
properties.denyAssignmentName	string	De weergavenaam van de weigeringstoewijzing.
properties.description	string	De beschrijving van de weigeringstoewijzing.
properties.doNotApplyToChildScopes	boolean	Bepaalt of de weigeringstoewijzing van toepassing is op onderliggende bereiken. De standaardwaarde is false.
properties.excludePrincipals	Principal[]	Matrix van principals waarop de weigeringstoewijzing niet van toepassing is.
properties.isSystemProtected	boolean	Hiermee geeft u op of deze weigeringstoewijzing is gemaakt door Azure en niet kan worden bewerkt of verwijderd.
properties.permissions	DenyAssignmentPermission[]	Een matrix met machtigingen die worden geweigerd door de weigeringstoewijzing.
properties.principals	Principal[]	Matrix van principals waarop de weigeringstoewijzing van toepassing is.
properties.scope	string	Het toewijzingsbereik weigeren.
properties.updatedBy	string	Id van de gebruiker die de toewijzing heeft bijgewerkt
properties.updatedOn	string	Tijdstip waarop deze is bijgewerkt
type	string	Het toewijzingstype weigeren.

DenyAssignmentListResult

Resultaat van bewerking van toewijzingslijst weigeren.

Name	Type	Description
nextLink	string	De URL die moet worden gebruikt voor het ophalen van de volgende set resultaten.
value	DenyAssignment[]	Lijst met toewijzingen weigeren.

DenyAssignmentPermission

Toewijzingsmachtigingen weigeren.

Name	Type	Description
actions	string[]	Acties waartoe de weigeringstoewijzing geen toegang verleent.
condition	string	De voorwaarden voor de machtiging Toewijzing weigeren. Dit beperkt de resources die het van toepassing is.
conditionVersion	string	Versie van de voorwaarde.
dataActions	string[]	Gegevensacties waartoe de weigeringstoewijzing geen toegang verleent.
notActions	string[]	Acties die moeten worden uitgesloten van dat de weigeringstoewijzing geen toegang verleent.
notDataActions	string[]	Gegevensacties die moeten worden uitgesloten van dat de weigeringstoewijzing geen toegang verleent.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

Principal

De naam van de entiteit die het laatst is gewijzigd

Name	Type	Description
displayName	string	De naam van de principal die wijzigingen heeft aangebracht
email	string	Email van principal
id	string	De id van de principal is gewijzigd
type	string	Type principal, zoals gebruiker, groep, enzovoort