Class ResourceProviderResource

Namespace

Azure.ResourceManager.Resources

Assembly

Azure.ResourceManager.dll

A Class representing a Provider along with the instance operations that can be performed on it.

public class ResourceProviderResource : ArmResource, IJsonModel<ResourceProviderData>, IPersistableModel<ResourceProviderData>

Inheritance

object

ArmResource

ResourceProviderResource

Implements

IJsonModel<ResourceProviderData>

IPersistableModel<ResourceProviderData>

Inherited Members

ArmResource.TryGetApiVersion(ResourceType, out string)

ArmResource.GetAvailableLocations(CancellationToken)

ArmResource.GetAvailableLocationsAsync(CancellationToken)

ArmResource.CanUseTagResource(CancellationToken)

ArmResource.CanUseTagResourceAsync(CancellationToken)

ArmResource.GetTagResource()

ArmResource.GetPolicyAssignments()

ArmResource.GetPolicyAssignmentAsync(string, CancellationToken)

ArmResource.GetPolicyAssignment(string, CancellationToken)

ArmResource.GetManagementLocks()

ArmResource.GetManagementLockAsync(string, CancellationToken)

ArmResource.GetManagementLock(string, CancellationToken)

ArmResource.Id

ArmResource.Client

ArmResource.Diagnostics

ArmResource.Pipeline

ArmResource.Endpoint

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ResourceProviderResource()

Initializes a new instance of the ResourceProviderResource class for mocking.

protected ResourceProviderResource()

Fields

ResourceType

Gets the resource type for the operations.

public static readonly ResourceType ResourceType

Field Value

ResourceType

Properties

Data

Gets the data representing this Feature.

public virtual ResourceProviderData Data { get; }

Property Value

ResourceProviderData

Exceptions

InvalidOperationException

Throws if there is no data loaded in the current instance.

HasData

Gets whether or not the current instance has data.

public virtual bool HasData { get; }

Property Value

bool

Methods

CreateResourceIdentifier(string, string)

Generate the resource identifier of a ResourceProviderResource instance.

public static ResourceIdentifier CreateResourceIdentifier(string subscriptionId, string resourceProviderNamespace)

Parameters

subscriptionId string

The subscriptionId.

resourceProviderNamespace string

The resourceProviderNamespace.

Returns

ResourceIdentifier

Get(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 expand = null, CancellationToken cancellationToken = default)

Parameters

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>

GetAsync(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 expand = null, CancellationToken cancellationToken = default)

Parameters

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>>

GetFeature(string, CancellationToken)

Gets the preview feature with the specified name.

• Request Path/subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features/{featureName}
• Operation IdFeatures_Get
• Default Api Version2021-07-01
• ResourceFeatureResource

public virtual Response<FeatureResource> GetFeature(string featureName, CancellationToken cancellationToken = default)

Parameters

featureName string

The name of the feature to get.

cancellationToken CancellationToken

The cancellation token to use.

Returns

Response<FeatureResource>

Exceptions

ArgumentNullException

featureName is null.

ArgumentException

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

GetFeatureAsync(string, CancellationToken)

Gets the preview feature with the specified name.

• Request Path/subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features/{featureName}
• Operation IdFeatures_Get
• Default Api Version2021-07-01
• ResourceFeatureResource

public virtual Task<Response<FeatureResource>> GetFeatureAsync(string featureName, CancellationToken cancellationToken = default)

Parameters

featureName string

The name of the feature to get.

cancellationToken CancellationToken

The cancellation token to use.

Returns

Task<Response<FeatureResource>>

Exceptions

ArgumentNullException

featureName is null.

ArgumentException

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

GetFeatures()

Gets a collection of FeatureResources in the ResourceProvider.

public virtual FeatureCollection GetFeatures()

Returns

FeatureCollection

An object representing collection of FeatureResources and their operations over a FeatureResource.

GetProviderResourceTypes(string, CancellationToken)

List the resource types for a specified resource provider.

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

public virtual Pageable<ProviderResourceType> GetProviderResourceTypes(string expand = null, CancellationToken cancellationToken = default)

Parameters

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

Pageable<ProviderResourceType>

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

GetProviderResourceTypesAsync(string, CancellationToken)

List the resource types for a specified resource provider.

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

public virtual AsyncPageable<ProviderResourceType> GetProviderResourceTypesAsync(string expand = null, CancellationToken cancellationToken = default)

Parameters

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

AsyncPageable<ProviderResourceType>

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

ProviderPermissions(CancellationToken)

Get the provider permissions.

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

public virtual Pageable<ProviderPermission> ProviderPermissions(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token to use.

Returns

Pageable<ProviderPermission>

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

ProviderPermissionsAsync(CancellationToken)

Get the provider permissions.

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

public virtual AsyncPageable<ProviderPermission> ProviderPermissionsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token to use.

Returns

AsyncPageable<ProviderPermission>

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

Register(ProviderRegistrationContent, CancellationToken)

Registers a subscription with a resource provider.

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

public virtual Response<ResourceProviderResource> Register(ProviderRegistrationContent content = null, CancellationToken cancellationToken = default)

Parameters

content ProviderRegistrationContent

The third party consent for S2S.

cancellationToken CancellationToken

The cancellation token to use.

Returns

Response<ResourceProviderResource>

RegisterAsync(ProviderRegistrationContent, CancellationToken)

Registers a subscription with a resource provider.

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

public virtual Task<Response<ResourceProviderResource>> RegisterAsync(ProviderRegistrationContent content = null, CancellationToken cancellationToken = default)

Parameters

content ProviderRegistrationContent

The third party consent for S2S.

cancellationToken CancellationToken

The cancellation token to use.

Returns

Task<Response<ResourceProviderResource>>

Unregister(CancellationToken)

Unregisters a subscription from a resource provider.

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

public virtual Response<ResourceProviderResource> Unregister(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token to use.

Returns

Response<ResourceProviderResource>

UnregisterAsync(CancellationToken)

Unregisters a subscription from a resource provider.

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

public virtual Task<Response<ResourceProviderResource>> UnregisterAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token to use.

Returns

Task<Response<ResourceProviderResource>>