Billing Permissions - Check Access By Invoice Section

Dienst:

Billing

API-Version:

2024-04-01

Stellt eine Liste der Prüfzugriffsantwortobjekte für einen Rechnungsabschnitt bereit.

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/checkAccess?api-version=2024-04-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
billingAccountName	path	True	string pattern: ^([0-9]+|([Pp][Cc][Nn]\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$	Die ID, die ein Abrechnungskonto eindeutig identifiziert.
billingProfileName	path	True	string pattern: ^[a-zA-Z\d-_]{1,128}$	Die ID, die ein Abrechnungsprofil eindeutig identifiziert.
invoiceSectionName	path	True	string pattern: ^[a-zA-Z\d-_]{1,128}$	Die ID, die einen Rechnungsabschnitt eindeutig identifiziert.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
actions	string[]	Liste der Aktionen, die im Anforderungstext übergeben werden, auf die die Berechtigungen überprüft werden.

Antworten

Name	Typ	Beschreibung
200 OK	CheckAccessResponse[]	Azure-Operation erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

CheckAccessByInvoiceSection

Beispielanforderung

HTTP

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/Q7GV-UUVA-PJA-TGB/checkAccess?api-version=2024-04-01

{
  "actions": [
    "Microsoft.Billing/billingAccounts/read",
    "Microsoft.Subscription/subscriptions/write"
  ]
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python check_access_by_invoice_section.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 = BillingManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.billing_permissions.check_access_by_invoice_section(
        billing_account_name="10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        billing_profile_name="xxxx-xxxx-xxx-xxx",
        invoice_section_name="Q7GV-UUVA-PJA-TGB",
        parameters={
            "actions": ["Microsoft.Billing/billingAccounts/read", "Microsoft.Subscription/subscriptions/write"]
        },
    )
    print(response)


# x-ms-original-file: 2024-04-01/checkAccessByInvoiceSection.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 armbilling_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/billing/armbilling/v2"
)

// Generated from example definition: 2024-04-01/checkAccessByInvoiceSection.json
func ExamplePermissionsClient_CheckAccessByInvoiceSection() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbilling.NewClientFactory("<subscriptionID>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPermissionsClient().CheckAccessByInvoiceSection(ctx, "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "xxxx-xxxx-xxx-xxx", "Q7GV-UUVA-PJA-TGB", armbilling.CheckAccessRequest{
		Actions: []*string{
			to.Ptr("Microsoft.Billing/billingAccounts/read"),
			to.Ptr("Microsoft.Subscription/subscriptions/write"),
		},
	}, 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 = armbilling.PermissionsClientCheckAccessByInvoiceSectionResponse{
	// 	CheckAccessResponseArray: []*armbilling.CheckAccessResponse{
	// 		{
	// 			AccessDecision: to.Ptr(armbilling.AccessDecisionAllowed),
	// 			Action: to.Ptr("Microsoft.Billing/billingAccounts/read"),
	// 		},
	// 		{
	// 			AccessDecision: to.Ptr(armbilling.AccessDecisionNotAllowed),
	// 			Action: to.Ptr("Microsoft.Subscription/subscriptions/write"),
	// 		},
	// 	},
	// }
}

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 { BillingManagementClient } = require("@azure/arm-billing");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to provides a list of check access response objects for an invoice section.
 *
 * @summary provides a list of check access response objects for an invoice section.
 * x-ms-original-file: 2024-04-01/checkAccessByInvoiceSection.json
 */
async function checkAccessByInvoiceSection() {
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.billingPermissions.checkAccessByInvoiceSection(
    "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
    "xxxx-xxxx-xxx-xxx",
    "Q7GV-UUVA-PJA-TGB",
    {
      actions: [
        "Microsoft.Billing/billingAccounts/read",
        "Microsoft.Subscription/subscriptions/write",
      ],
    },
  );
  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

Beispiel für eine Antwort

Statuscode:

200

[
  {
    "accessDecision": "Allowed",
    "action": "Microsoft.Billing/billingAccounts/read"
  },
  {
    "accessDecision": "NotAllowed",
    "action": "Microsoft.Subscription/subscriptions/write"
  }
]

Definitionen

Name	Beschreibung
AccessDecision	Zugriffsentscheidung, gibt an, dass der Zugriff zulässig ist oder nicht.
CheckAccessRequest	Fordern Sie die Überprüfung des Zugriffs an.
CheckAccessResponse	Die Eigenschaften einer Überprüfungszugriffsantwort.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort

AccessDecision

Enumeration

Zugriffsentscheidung, gibt an, dass der Zugriff zulässig ist oder nicht.

Wert	Beschreibung
Other	Andere
Allowed	Zulässig
NotAllowed	Nicht erlaubt

CheckAccessRequest

Objekt

Fordern Sie die Überprüfung des Zugriffs an.

Name	Typ	Beschreibung
actions	string[]	Liste der Aktionen, die im Anforderungstext übergeben werden, auf die die Berechtigungen überprüft werden.

CheckAccessResponse

Objekt

Die Eigenschaften einer Überprüfungszugriffsantwort.

Name	Typ	Beschreibung
accessDecision	AccessDecision	Zugriffsentscheidung, gibt an, dass der Zugriff zulässig ist oder nicht.
action	string	Dient zum Abrufen oder Festlegen einer Aktion.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.