Deny Assignments - List

Tjänst:

Authorization

API-version:

2022-04-01

Hämtar alla neka tilldelningar för prenumerationen.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.
$filter	query		string	Filtret som ska tillämpas på åtgärden. Använd $filter=atScope() för att returnera alla neka tilldelningar vid eller över omfånget. Använd $filter=denyAssignmentName eq {name} för att söka efter neka tilldelningar efter namn i angivet omfång. Använd $filter=principalId eq {id} för att returnera alla nekande tilldelningar vid, ovanför och under omfånget för det angivna huvudkontot. Använd $filter=gdprExportPrincipalId eq {id} för att returnera alla nekande tilldelningar vid, ovanför och under omfånget för det angivna huvudkontot. Det här filtret skiljer sig från principalId-filtret eftersom det inte bara returnerar de nekande tilldelningar som innehåller det angivna huvudnamnet är listan Principals utan även de nekande tilldelningar som innehåller det angivna huvudkontot är listan ExcludePrincipals. När filtret gdprExportPrincipalId används returneras dessutom endast egenskaperna neka tilldelningsnamn och beskrivning.

Svar

Name	Typ	Description
200 OK	DenyAssignmentListResult	OK – Returnerar en matris med nekandetilldelningar.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Behörigheter

För att anropa detta API måste du ha tilldelats en roll som har följande behörigheter. Mer information finns i Inbyggda roller i Azure.

Microsoft.Authorization/denyAssignments/read

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

List deny assignments for subscription

Exempelbegäran

HTTP

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

Java

/**
 * Samples for DenyAssignments List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/
     * GetAllDenyAssignments.json
     */
    /**
     * Sample code: List deny assignments for subscription.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listDenyAssignmentsForSubscription(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.accessManagement().roleAssignments().manager().roleServiceClient().getDenyAssignments().list(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_all_deny_assignments.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="subId",
    )

    response = client.deny_assignments.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetAllDenyAssignments.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/GetAllDenyAssignments.json
func ExampleDenyAssignmentsClient_NewListPager() {
	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().NewListPager(&armauthorization.DenyAssignmentsClientListOptions{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 all deny assignments for the subscription.
 *
 * @summary Gets all deny assignments for the subscription.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetAllDenyAssignments.json
 */
async function listDenyAssignmentsForSubscription() {
  const subscriptionId = process.env["AUTHORIZATION_SUBSCRIPTION_ID"] || "subId";
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.denyAssignments.list()) {
    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/GetAllDenyAssignments.json
// this example is just showing the usage of "DenyAssignments_List" 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 subscriptionId = "subId";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/subscriptions/{0}", subscriptionId));
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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
DenyAssignment	Neka tilldelning
DenyAssignmentListResult	Neka resultat av tilldelningslistans åtgärd.
DenyAssignmentPermission	Neka tilldelningsbehörigheter.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
Principal	Namnet på den entitet som senast ändrades

DenyAssignment

Objekt

Neka tilldelning

Name	Typ	Description
id	string	Neka tilldelnings-ID.
name	string	Namnet på deny-tilldelningen.
properties.condition	string	Villkoren för neka-tilldelningen. Detta begränsar de resurser som den kan tilldelas till. t.ex. @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container"
properties.conditionVersion	string	Version av villkoret.
properties.createdBy	string	ID för användaren som skapade tilldelningen
properties.createdOn	string (date-time)	Tiden då den skapades
properties.denyAssignmentName	string	Visningsnamnet för neka-tilldelningen.
properties.description	string	Beskrivningen av neka-tilldelningen.
properties.doNotApplyToChildScopes	boolean	Avgör om neka-tilldelningen gäller för underordnade omfång. Standardvärdet är falskt.
properties.excludePrincipals	Principal[]	Matris med huvudnamn som neka tilldelningen inte gäller för.
properties.isSystemProtected	boolean	Anger om den här neka-tilldelningen skapades av Azure och inte kan redigeras eller tas bort.
properties.permissions	DenyAssignmentPermission[]	En matris med behörigheter som nekas av neka-tilldelningen.
properties.principals	Principal[]	Matris med huvudnamn som neka-tilldelningen gäller för.
properties.scope	string	Omfånget neka tilldelning.
properties.updatedBy	string	ID för användaren som uppdaterade tilldelningen
properties.updatedOn	string (date-time)	Tid då den uppdaterades
type	string	Tilldelningstypen Neka.

DenyAssignmentListResult

Objekt

Neka resultat av tilldelningslistans åtgärd.

Name	Typ	Description
nextLink	string	Den URL som ska användas för att hämta nästa uppsättning resultat.
value	DenyAssignment[]	Neka tilldelningslista.

DenyAssignmentPermission

Objekt

Neka tilldelningsbehörigheter.

Name	Typ	Description
actions	string[]	Åtgärder som neka tilldelningen inte beviljar åtkomst till.
condition	string	Villkoren för behörigheten Neka tilldelning. Detta begränsar de resurser som den gäller för.
conditionVersion	string	Version av villkoret.
dataActions	string[]	Dataåtgärder som neka tilldelningen inte beviljar åtkomst till.
notActions	string[]	Åtgärder som ska undantas från den nekandetilldelningen beviljar inte åtkomst.
notDataActions	string[]	Dataåtgärder som ska undantas från det nekandetilldelningen beviljar inte åtkomst.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

Principal

Objekt

Namnet på den entitet som senast ändrades

Name	Typ	Description
displayName	string	Namnet på huvudkontot har gjort ändringar
email	string	E-post för huvudnamn
id	string	ID:t för huvudkontot har gjort ändringar
type	string	Typ av huvudnamn, till exempel användare, grupp osv.