Class ResourceProviderCollection

Namespace

Azure.ResourceManager.Resources

Assembly

Azure.ResourceManager.dll

A class representing collection of Provider and their operations over its parent.

public class ResourceProviderCollection : ArmCollection, IEnumerable<ResourceProviderResource>, IEnumerable, IAsyncEnumerable<ResourceProviderResource>

Inheritance

object

ArmCollection

ResourceProviderCollection

Implements

IEnumerable<ResourceProviderResource>

IEnumerable

IAsyncEnumerable<ResourceProviderResource>

Inherited Members

ArmCollection.TryGetApiVersion(ResourceType, out string)

ArmCollection.Id

ArmCollection.Client

ArmCollection.Diagnostics

ArmCollection.Pipeline

ArmCollection.Endpoint

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ResourceProviderCollection()

Initializes a new instance of the ResourceProviderCollection class for mocking.

protected ResourceProviderCollection()

Methods

Exists(string, string, CancellationToken)

Checks to see if the resource exists in azure.

• Request Path/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}
• Operation IdProviders_Get
• Default Api Version2022-09-01
• ResourceResourceProviderResource

public virtual Response<bool> Exists(string resourceProviderNamespace, string expand = null, CancellationToken cancellationToken = default)

Parameters

resourceProviderNamespace string

The namespace of the resource provider.

expand string

The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.

cancellationToken CancellationToken

The cancellation token to use.

Returns

Response<bool>

Exceptions

ArgumentException

resourceProviderNamespace is an empty string, and was expected to be non-empty.

ArgumentNullException

resourceProviderNamespace is null.

ExistsAsync(string, string, CancellationToken)

Checks to see if the resource exists in azure.

• Request Path/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}
• Operation IdProviders_Get
• Default Api Version2022-09-01
• ResourceResourceProviderResource

public virtual Task<Response<bool>> ExistsAsync(string resourceProviderNamespace, string expand = null, CancellationToken cancellationToken = default)

Parameters

resourceProviderNamespace string

The namespace of the resource provider.

expand string

The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.

cancellationToken CancellationToken

The cancellation token to use.

Returns

Task<Response<bool>>

Exceptions

ArgumentException

resourceProviderNamespace is an empty string, and was expected to be non-empty.

ArgumentNullException

resourceProviderNamespace is null.

Get(string, string, CancellationToken)

Gets the specified resource provider.

• Request Path/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}
• Operation IdProviders_Get
• Default Api Version2022-09-01
• ResourceResourceProviderResource

public virtual Response<ResourceProviderResource> Get(string resourceProviderNamespace, string expand = null, CancellationToken cancellationToken = default)

Parameters

resourceProviderNamespace string

The namespace of the resource provider.

expand string

The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.

cancellationToken CancellationToken

The cancellation token to use.

Returns

Response<ResourceProviderResource>

Exceptions

ArgumentException

resourceProviderNamespace is an empty string, and was expected to be non-empty.

ArgumentNullException

resourceProviderNamespace is null.

GetAll(string, CancellationToken)

Gets all resource providers for a subscription.

• Request Path/subscriptions/{subscriptionId}/providers
• Operation IdProviders_List
• Default Api Version2022-09-01
• ResourceResourceProviderResource

public virtual Pageable<ResourceProviderResource> GetAll(string expand = null, CancellationToken cancellationToken = default)

Parameters

expand string

The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases.

cancellationToken CancellationToken

The cancellation token to use.

Returns

Pageable<ResourceProviderResource>

A collection of ResourceProviderResource that may take multiple service requests to iterate over.

GetAllAsync(string, CancellationToken)

Gets all resource providers for a subscription.

• Request Path/subscriptions/{subscriptionId}/providers
• Operation IdProviders_List
• Default Api Version2022-09-01
• ResourceResourceProviderResource

public virtual AsyncPageable<ResourceProviderResource> GetAllAsync(string expand = null, CancellationToken cancellationToken = default)

Parameters

expand string

The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases.

cancellationToken CancellationToken

The cancellation token to use.

Returns

AsyncPageable<ResourceProviderResource>

An async collection of ResourceProviderResource that may take multiple service requests to iterate over.

GetAsync(string, string, CancellationToken)

Gets the specified resource provider.

• Request Path/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}
• Operation IdProviders_Get
• Default Api Version2022-09-01
• ResourceResourceProviderResource

public virtual Task<Response<ResourceProviderResource>> GetAsync(string resourceProviderNamespace, string expand = null, CancellationToken cancellationToken = default)

Parameters

resourceProviderNamespace string

The namespace of the resource provider.

expand string

The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.

cancellationToken CancellationToken

The cancellation token to use.

Returns

Task<Response<ResourceProviderResource>>

Exceptions

ArgumentException

resourceProviderNamespace is an empty string, and was expected to be non-empty.

ArgumentNullException

resourceProviderNamespace is null.

GetIfExists(string, string, CancellationToken)

Tries to get details for this resource from the service.

• Request Path/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}
• Operation IdProviders_Get
• Default Api Version2022-09-01
• ResourceResourceProviderResource

public virtual NullableResponse<ResourceProviderResource> GetIfExists(string resourceProviderNamespace, string expand = null, CancellationToken cancellationToken = default)

Parameters

resourceProviderNamespace string

The namespace of the resource provider.

expand string

The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.

cancellationToken CancellationToken

The cancellation token to use.

Returns

NullableResponse<ResourceProviderResource>

Exceptions

ArgumentException

resourceProviderNamespace is an empty string, and was expected to be non-empty.

ArgumentNullException

resourceProviderNamespace is null.

GetIfExistsAsync(string, string, CancellationToken)

Tries to get details for this resource from the service.

• Request Path/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}
• Operation IdProviders_Get
• Default Api Version2022-09-01
• ResourceResourceProviderResource

public virtual Task<NullableResponse<ResourceProviderResource>> GetIfExistsAsync(string resourceProviderNamespace, string expand = null, CancellationToken cancellationToken = default)

Parameters

resourceProviderNamespace string

The namespace of the resource provider.

expand string

The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases.

cancellationToken CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<ResourceProviderResource>>

Exceptions

ArgumentException

resourceProviderNamespace is an empty string, and was expected to be non-empty.

ArgumentNullException

resourceProviderNamespace is null.