ArmClientOptions Class

  • Reference

Definition

Namespace:
Azure.ResourceManager
Assembly:
Azure.ResourceManager.dll
Package:
Azure.ResourceManager v1.13.0
Package:
Azure.ResourceManager v1.12.0-beta.1
Source:
ArmClientOptions.cs
Source:
ArmClientOptions.cs

A class representing Azure resource manager client options.

public sealed class ArmClientOptions : Azure.Core.ClientOptions
type ArmClientOptions = class
    inherit ClientOptions
Public NotInheritable Class ArmClientOptions
Inherits ClientOptions
Inheritance
Object
ClientOptions
ArmClientOptions

Constructors

ArmClientOptions()

Initializes a new instance of the ArmClientOptions class.

Properties

Diagnostics

Gets the client diagnostic options.

(Inherited from ClientOptions)
Environment

Gets or sets Azure cloud environment.
Retry

Gets the client retry options.

(Inherited from ClientOptions)
RetryPolicy

Gets or sets the policy to use for retries. If a policy is specified, it will be used in place of the Retry property. The RetryPolicy type can be derived from to modify the default behavior without needing to fully implement the retry logic. If Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) is overridden or a custom HttpPipelinePolicy is specified, it is the implementer's responsibility to update the ProcessingContext values.

(Inherited from ClientOptions)
Transport

The HttpPipelineTransport to be used for this client. Defaults to an instance of HttpClientTransport.

(Inherited from ClientOptions)

Methods

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

Adds an HttpPipeline policy into the client pipeline. The position of policy in the pipeline is controlled by the position parameter. If you want the policy to execute once per client request use PerCall otherwise use PerRetry to run the policy for every retry. Note that the same instance of policy would be added to all pipelines of client constructed using this ClientOptions object.

(Inherited from ClientOptions)
SetApiVersion(ResourceType, String)

Sets the api version to use for a given resource type. To find which API Versions are available in your environment you can use the Get(String, CancellationToken) method for the provider namespace you are interested in.
SetApiVersionsFromProfile(AzureStackProfile)

Sets the api versions from an Azure Stack profile.

Applies to