Providers - Provider Permissions

服務:

Resource Management

API 版本:

2021-04-01

取得提供者許可權。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/providerPermissions?api-version=2021-04-01

URI 參數

名稱	位於	必要	類型	Description
resourceProviderNamespace	path	True	string	資源提供者的命名空間。
subscriptionId	path	True	string	Microsoft Azure 訂用帳戶標識碼。
api-version	query	True	string	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	ProviderPermissionListResult	確定 - 傳回提供者許可權的相關信息。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Get provider resource types.

範例要求

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestRP/providerPermissions?api-version=2021-04-01

Go

package armresources_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4fd842fb73656039ec94ce367bcedee25a57bd18/specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/GetProviderPermissions.json
func ExampleProvidersClient_ProviderPermissions() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewProvidersClient().ProviderPermissions(ctx, "Microsoft.TestRP", 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.ProviderPermissionListResult = armresources.ProviderPermissionListResult{
	// 	Value: []*armresources.ProviderPermission{
	// 		{
	// 			ApplicationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 			ProviderAuthorizationConsentState: to.Ptr(armresources.ProviderAuthorizationConsentStateConsented),
	// 			RoleDefinition: &armresources.RoleDefinition{
	// 				Name: to.Ptr("Contoso service role"),
	// 				ID: to.Ptr("00000000000000000000000000000000"),
	// 				IsServiceRole: to.Ptr(true),
	// 				Permissions: []*armresources.Permission{
	// 					{
	// 						Actions: []*string{
	// 							to.Ptr("Microsoft.Contoso/*")},
	// 							DataActions: []*string{
	// 							},
	// 							NotActions: []*string{
	// 							},
	// 							NotDataActions: []*string{
	// 							},
	// 					}},
	// 					Scopes: []*string{
	// 						to.Ptr("/")},
	// 					},
	// 			}},
	// 		}
}

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

/**
 * This sample demonstrates how to Get the provider permissions.
 *
 * @summary Get the provider permissions.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/GetProviderPermissions.json
 */
async function getProviderResourceTypes() {
  const subscriptionId =
    process.env["RESOURCES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceProviderNamespace = "Microsoft.TestRP";
  const credential = new DefaultAzureCredential();
  const client = new ResourceManagementClient(credential, subscriptionId);
  const result = await client.providers.providerPermissions(resourceProviderNamespace);
  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

範例回覆

狀態碼:

200

{
  "value": [
    {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "roleDefinition": {
        "id": "00000000000000000000000000000000",
        "name": "Contoso service role",
        "isServiceRole": true,
        "permissions": [
          {
            "actions": [
              "Microsoft.Contoso/*"
            ],
            "notActions": [],
            "dataActions": [],
            "notDataActions": []
          }
        ],
        "scopes": [
          "/"
        ]
      },
      "providerAuthorizationConsentState": "Consented"
    }
  ]
}

定義

名稱	Description
CloudError	資源管理要求的錯誤回應。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorResponse	錯誤回應
Permission	角色定義許可權。
ProviderAuthorizationConsentState	提供者授權同意狀態。
ProviderPermission	提供者許可權
ProviderPermissionListResult	提供者許可權清單。
RoleDefinition	角色定義屬性。

CloudError

資源管理要求的錯誤回應。

名稱	類型	Description
error	ErrorResponse	錯誤回應 所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 (這也會遵循 OData 錯誤回應格式。)

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorResponse

錯誤回應

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorResponse[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

Permission

角色定義許可權。

名稱	類型	Description
actions	string[]	允許的動作。
dataActions	string[]	允許的數據動作。
notActions	string[]	拒絕的動作。
notDataActions	string[]	拒絕的數據動作。

ProviderAuthorizationConsentState

提供者授權同意狀態。

名稱	類型	Description
Consented	string
NotRequired	string
NotSpecified	string
Required	string

ProviderPermission

提供者許可權

名稱	類型	Description
applicationId	string	應用程式識別碼。
managedByRoleDefinition	RoleDefinition	角色定義屬性。
providerAuthorizationConsentState	ProviderAuthorizationConsentState	提供者授權同意狀態。
roleDefinition	RoleDefinition	角色定義屬性。

ProviderPermissionListResult

提供者許可權清單。

名稱	類型	Description
nextLink	string	用於取得下一組結果的 URL。
value	ProviderPermission[]	提供者許可權的陣列。

RoleDefinition

角色定義屬性。

名稱	類型	Description
id	string	角色定義識別碼。
isServiceRole	boolean	如果這是服務角色。
name	string	角色定義名稱。
permissions	Permission[]	角色定義許可權。
scopes	string[]	角色定義可指派的範圍。