Providers interface
Interface representing a Providers.
Methods
| get(string, Providers |
Gets the specified resource provider. |
| get |
Gets the specified resource provider at the tenant level. |
| list(Providers |
Gets all resource providers for a subscription. |
| list |
Gets all resource providers for the tenant. |
| provider |
Get the provider permissions. |
| register(string, Providers |
Registers a subscription with a resource provider. |
| register |
Registers a management group with a resource provider. Use this operation to register a resource provider with resource types that can be deployed at the management group scope. It does not recursively register subscriptions within the management group. Instead, you must register subscriptions individually. |
| unregister(string, Providers |
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.
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
listAtTenantScope(ProvidersListAtTenantScopeOptionalParams)
Gets all resource providers for the tenant.
function listAtTenantScope(options?: ProvidersListAtTenantScopeOptionalParams): PagedAsyncIterableIterator<Provider, Provider[], PageSettings>Parameters
The options parameters.
Returns
providerPermissions(string, ProvidersProviderPermissionsOptionalParams)
Get the provider permissions.
function providerPermissions(resourceProviderNamespace: string, options?: ProvidersProviderPermissionsOptionalParams): Promise<ProviderPermissionListResult>Parameters
- resourceProviderNamespace
-
string
The namespace of the resource provider.
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. Use this operation to register a resource provider with resource types that can be deployed at the management group scope. It does not recursively register subscriptions within the management group. Instead, you must register subscriptions individually.
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.
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.
The options parameters.
Returns
Promise<Provider>