Providers interface

Package:

@azure/arm-resources

Interface representing a Providers.

Methods

get(string, ProvidersGetOptionalParams)	Gets the specified resource provider.
getAtTenantScope(string, ProvidersGetAtTenantScopeOptionalParams)	Gets the specified resource provider at the tenant level.
list(ProvidersListOptionalParams)	Gets all resource providers for a subscription.
listAtTenantScope(ProvidersListAtTenantScopeOptionalParams)	Gets all resource providers for the tenant.
providerPermissions(string, ProvidersProviderPermissionsOptionalParams)	Get the provider permissions.
register(string, ProvidersRegisterOptionalParams)	Registers a subscription with a resource provider.
registerAtManagementGroupScope(string, string, ProvidersRegisterAtManagementGroupScopeOptionalParams)	Registers a management group with a resource provider.
unregister(string, ProvidersUnregisterOptionalParams)	Unregisters a subscription from a resource provider.

Method Details

get(string, ProvidersGetOptionalParams)

Gets the specified resource provider.

function get(resourceProviderNamespace: string, options?: ProvidersGetOptionalParams): Promise<Provider>

Parameters

resourceProviderNamespace

string

The namespace of the resource provider.

options

ProvidersGetOptionalParams

The options parameters.

Returns

Promise<Provider>

getAtTenantScope(string, ProvidersGetAtTenantScopeOptionalParams)

Gets the specified resource provider at the tenant level.

function getAtTenantScope(resourceProviderNamespace: string, options?: ProvidersGetAtTenantScopeOptionalParams): Promise<Provider>

Parameters

resourceProviderNamespace

string

The namespace of the resource provider.

options

ProvidersGetAtTenantScopeOptionalParams

The options parameters.

Returns

Promise<Provider>

list(ProvidersListOptionalParams)

Gets all resource providers for a subscription.

function list(options?: ProvidersListOptionalParams): PagedAsyncIterableIterator<Provider, Provider[], PageSettings>

Parameters

options

ProvidersListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Provider, Provider[], PageSettings>

listAtTenantScope(ProvidersListAtTenantScopeOptionalParams)

Gets all resource providers for the tenant.

function listAtTenantScope(options?: ProvidersListAtTenantScopeOptionalParams): PagedAsyncIterableIterator<Provider, Provider[], PageSettings>

Parameters

options

ProvidersListAtTenantScopeOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Provider, Provider[], PageSettings>

providerPermissions(string, ProvidersProviderPermissionsOptionalParams)

Get the provider permissions.

function providerPermissions(resourceProviderNamespace: string, options?: ProvidersProviderPermissionsOptionalParams): Promise<ProviderPermissionListResult>

Parameters

resourceProviderNamespace

string

The namespace of the resource provider.

options

ProvidersProviderPermissionsOptionalParams

The options parameters.

Returns

Promise<ProviderPermissionListResult>

register(string, ProvidersRegisterOptionalParams)

Registers a subscription with a resource provider.

function register(resourceProviderNamespace: string, options?: ProvidersRegisterOptionalParams): Promise<Provider>

Parameters

resourceProviderNamespace

string

The namespace of the resource provider to register.

options

ProvidersRegisterOptionalParams

The options parameters.

Returns

Promise<Provider>

registerAtManagementGroupScope(string, string, ProvidersRegisterAtManagementGroupScopeOptionalParams)

Registers a management group with a resource provider.

function registerAtManagementGroupScope(resourceProviderNamespace: string, groupId: string, options?: ProvidersRegisterAtManagementGroupScopeOptionalParams): Promise<void>

Parameters

resourceProviderNamespace

string

The namespace of the resource provider to register.

groupId

string

The management group ID.

options

ProvidersRegisterAtManagementGroupScopeOptionalParams

The options parameters.

Returns

Promise<void>

unregister(string, ProvidersUnregisterOptionalParams)

Unregisters a subscription from a resource provider.

function unregister(resourceProviderNamespace: string, options?: ProvidersUnregisterOptionalParams): Promise<Provider>

Parameters

resourceProviderNamespace

string

The namespace of the resource provider to unregister.

options

ProvidersUnregisterOptionalParams

The options parameters.

Returns

Promise<Provider>