PurviewExtensions.GetDefaultAccountAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Get the default account for the scope.
- Request Path: /providers/Microsoft.Purview/getDefaultAccount
- Operation Id: DefaultAccounts_Get
- Default Api Version: 2023-05-01-preview
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Purview.Models.DefaultPurviewAccountPayload>> GetDefaultAccountAsync (this Azure.ResourceManager.Resources.TenantResource tenantResource, Guid scopeTenantId, Azure.ResourceManager.Purview.Models.PurviewAccountScopeType scopeType, string scope = default, System.Threading.CancellationToken cancellationToken = default);
static member GetDefaultAccountAsync : Azure.ResourceManager.Resources.TenantResource * Guid * Azure.ResourceManager.Purview.Models.PurviewAccountScopeType * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Purview.Models.DefaultPurviewAccountPayload>>
<Extension()>
Public Function GetDefaultAccountAsync (tenantResource As TenantResource, scopeTenantId As Guid, scopeType As PurviewAccountScopeType, Optional scope As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DefaultPurviewAccountPayload))
Parameters
- tenantResource
- TenantResource
The TenantResource instance the method will execute against.
- scopeTenantId
- Guid
The tenant ID.
- scopeType
- PurviewAccountScopeType
The scope for the default account.
- scope
- String
The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
tenantResource
is null.