Auto Provisioning Settings - List

Service:

Defender for Cloud

API Version:

2017-08-01-preview

Exposes the auto provisioning settings of the subscriptions

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/autoProvisioningSettings?api-version=2017-08-01-preview

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	Azure subscription ID Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version	query	True	string	API version for the operation

Responses

Name	Type	Description
200 OK	AutoProvisioningSettingList	OK
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get auto provisioning settings for subscription

Sample Request

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/autoProvisioningSettings?api-version=2017-08-01-preview

Java

import com.azure.core.util.Context;

/** Samples for AutoProvisioningSettings List. */
public final class Main {
    /*
     * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingsSubscription_example.json
     */
    /**
     * Sample code: Get auto provisioning settings for subscription.
     *
     * @param manager Entry point to SecurityManager.
     */
    public static void getAutoProvisioningSettingsForSubscription(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.autoProvisioningSettings().list(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

Go

package armsecurity_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingsSubscription_example.json
func ExampleAutoProvisioningSettingsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armsecurity.NewAutoProvisioningSettingsClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

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

/**
 * This sample demonstrates how to Exposes the auto provisioning settings of the subscriptions
 *
 * @summary Exposes the auto provisioning settings of the subscriptions
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/AutoProvisioningSettings/GetAutoProvisioningSettingsSubscription_example.json
 */
async function getAutoProvisioningSettingsForSubscription() {
  const subscriptionId = "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.autoProvisioningSettings.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

getAutoProvisioningSettingsForSubscription().catch(console.error);

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": [
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/autoProvisioningSettings/default",
      "name": "default",
      "type": "Microsoft.Security/autoProvisioningSettings",
      "properties": {
        "autoProvision": "On"
      }
    }
  ]
}

Definitions

autoProvision	Describes what kind of security agent provisioning action to take
AutoProvisioningSetting	Auto provisioning setting
AutoProvisioningSettingList	List of all the auto provisioning settings response
CloudError	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
CloudErrorBody	The error detail.
ErrorAdditionalInfo	The resource management error additional info.

autoProvision

Describes what kind of security agent provisioning action to take

Name	Type	Description
Off	string	Do not install security agent on the VMs automatically
On	string	Install missing security agent on VMs automatically

AutoProvisioningSetting

Auto provisioning setting

Name	Type	Description
id	string	Resource Id
name	string	Resource name
properties.autoProvision	autoProvision	Describes what kind of security agent provisioning action to take
type	string	Resource type

AutoProvisioningSettingList

List of all the auto provisioning settings response

Name	Type	Description
nextLink	string	The URI to fetch the next page.
value	AutoProvisioningSetting[]	List of all the auto provisioning settings

CloudError

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Name	Type	Description
error.additionalInfo	ErrorAdditionalInfo[]	The error additional info.
error.code	string	The error code.
error.details	CloudErrorBody[]	The error details.
error.message	string	The error message.
error.target	string	The error target.

CloudErrorBody

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	CloudErrorBody[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.