PolicyClient class

Package:

@azure/arm-policy

Extends

ServiceClient

Constructors

PolicyClient(TokenCredential, PolicyClientOptionalParams)
PolicyClient(TokenCredential, string, PolicyClientOptionalParams)	Initializes a new instance of the PolicyClient class.

Properties

$host
dataPolicyManifests
policyAssignments
policyDefinitions
policyExemptions
policySetDefinitions
subscriptionId

Inherited Properties

pipeline

The pipeline used by this client to make requests

Inherited Methods

sendOperationRequest<T>(OperationArguments, OperationSpec)	Send an HTTP request that is populated using the provided OperationSpec.
sendRequest(PipelineRequest)	Send the provided httpRequest.

Constructor Details

PolicyClient(TokenCredential, PolicyClientOptionalParams)

new PolicyClient(credentials: TokenCredential, options?: PolicyClientOptionalParams)

Parameters

credentials

TokenCredential

options

PolicyClientOptionalParams

PolicyClient(TokenCredential, string, PolicyClientOptionalParams)

Initializes a new instance of the PolicyClient class.

new PolicyClient(credentials: TokenCredential, subscriptionId: string, options?: PolicyClientOptionalParams)

Parameters

credentials

TokenCredential

Subscription credentials which uniquely identify client subscription.

subscriptionId

string

The ID of the target subscription.

options

PolicyClientOptionalParams

The parameter options

Property Details

$host

$host: string

Property Value

string

dataPolicyManifests

dataPolicyManifests: DataPolicyManifests

Property Value

DataPolicyManifests

policyAssignments

policyAssignments: PolicyAssignments

Property Value

PolicyAssignments

policyDefinitions

policyDefinitions: PolicyDefinitions

Property Value

PolicyDefinitions

policyExemptions

policyExemptions: PolicyExemptions

Property Value

PolicyExemptions

policySetDefinitions

policySetDefinitions: PolicySetDefinitions

Property Value

PolicySetDefinitions

subscriptionId

subscriptionId?: string

Property Value

string

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Pipeline

Inherited From coreClient.ServiceClient.pipeline

Inherited Method Details

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

Parameters

operationArguments

OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec

OperationSpec

The OperationSpec to use to populate the httpRequest.

Returns

Promise<T>

Inherited From coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Send the provided httpRequest.

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

Parameters

request

PipelineRequest

Returns

Promise<PipelineResponse>

Inherited From coreClient.ServiceClient.sendRequest