KustoDatabaseResource Class
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.
A Class representing a KustoDatabase along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a KustoDatabaseResource from an instance of ArmClient using the GetKustoDatabaseResource method. Otherwise you can get one from its parent resource KustoClusterResource using the GetKustoDatabase method.
public class KustoDatabaseResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Kusto.KustoDatabaseData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Kusto.KustoDatabaseData>type KustoDatabaseResource = class
inherit ArmResource
interface IJsonModel<KustoDatabaseData>
interface IPersistableModel<KustoDatabaseData>Public Class KustoDatabaseResource
Inherits ArmResource
Implements IJsonModel(Of KustoDatabaseData), IPersistableModel(Of KustoDatabaseData)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| KustoDatabaseResource() |
Initializes a new instance of the KustoDatabaseResource class for mocking. |
Fields
| Name | Description |
|---|---|
| ResourceType |
Gets the resource type for the operations. |
Properties
| Name | Description |
|---|---|
| Client |
Gets the ArmClient this resource client was created from. (Inherited from ArmResource) |
| Data |
Gets the data representing this Feature. |
| Diagnostics |
Gets the diagnostic options for this resource client. (Inherited from ArmResource) |
| Endpoint |
Gets the base uri for this resource client. (Inherited from ArmResource) |
| HasData |
Gets whether or not the current instance has data. |
| Id |
Gets the resource identifier. (Inherited from ArmResource) |
| Pipeline |
Gets the pipeline for this resource client. (Inherited from ArmResource) |
Methods
| Name | Description |
|---|---|
| AddPrincipals(DatabasePrincipalList, CancellationToken) |
Add Database principals permissions.
|
| AddPrincipalsAsync(DatabasePrincipalList, CancellationToken) |
Add Database principals permissions.
|
| CanUseTagResource(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CanUseTagResourceAsync(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CheckKustoDatabasePrincipalAssignmentNameAvailability(KustoDatabasePrincipalAssignmentNameAvailabilityContent, CancellationToken) |
Checks that the database principal assignment is valid and is not already in use.
|
| CheckKustoDatabasePrincipalAssignmentNameAvailabilityAsync(KustoDatabasePrincipalAssignmentNameAvailabilityContent, CancellationToken) |
Checks that the database principal assignment is valid and is not already in use.
|
| CheckKustoDataConnectionNameAvailability(KustoDataConnectionNameAvailabilityContent, CancellationToken) |
Checks that the data connection name is valid and is not already in use.
|
| CheckKustoDataConnectionNameAvailabilityAsync(KustoDataConnectionNameAvailabilityContent, CancellationToken) |
Checks that the data connection name is valid and is not already in use.
|
| CheckKustoScriptNameAvailability(KustoScriptNameAvailabilityContent, CancellationToken) |
Checks that the script name is valid and is not already in use.
|
| CheckKustoScriptNameAvailabilityAsync(KustoScriptNameAvailabilityContent, CancellationToken) |
Checks that the script name is valid and is not already in use.
|
| CreateResourceIdentifier(String, String, String, String) |
Generate the resource identifier of a KustoDatabaseResource instance. |
| Delete(WaitUntil, CancellationToken) |
Deletes the database with the given name.
|
| DeleteAsync(WaitUntil, CancellationToken) |
Deletes the database with the given name.
|
| Get(CancellationToken) |
Returns a database.
|
| GetAsync(CancellationToken) |
Returns a database.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetKustoDatabasePrincipalAssignment(String, CancellationToken) |
Gets a Kusto cluster database principalAssignment.
|
| GetKustoDatabasePrincipalAssignmentAsync(String, CancellationToken) |
Gets a Kusto cluster database principalAssignment.
|
| GetKustoDatabasePrincipalAssignments() |
Gets a collection of KustoDatabasePrincipalAssignmentResources in the KustoDatabase. |
| GetKustoDataConnection(String, CancellationToken) |
Returns a data connection.
|
| GetKustoDataConnectionAsync(String, CancellationToken) |
Returns a data connection.
|
| GetKustoDataConnections() |
Gets a collection of KustoDataConnectionResources in the KustoDatabase. |
| GetKustoScript(String, CancellationToken) |
Gets a Kusto cluster database script.
|
| GetKustoScriptAsync(String, CancellationToken) |
Gets a Kusto cluster database script.
|
| GetKustoScripts() |
Gets a collection of KustoScriptResources in the KustoDatabase. |
| GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLocks() |
Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource) |
| GetPolicyAssignment(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignments() |
Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource) |
| GetPrincipals(CancellationToken) |
Returns a list of database principals of the given Kusto cluster and database.
|
| GetPrincipalsAsync(CancellationToken) |
Returns a list of database principals of the given Kusto cluster and database.
|
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| InviteFollowerDatabase(DatabaseInviteFollowerContent, CancellationToken) |
Generates an invitation token that allows attaching a follower database to this database.
|
| InviteFollowerDatabaseAsync(DatabaseInviteFollowerContent, CancellationToken) |
Generates an invitation token that allows attaching a follower database to this database.
|
| RemovePrincipals(DatabasePrincipalList, CancellationToken) |
Remove Database principals permissions.
|
| RemovePrincipalsAsync(DatabasePrincipalList, CancellationToken) |
Remove Database principals permissions.
|
| TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
| Update(WaitUntil, KustoDatabaseData, CancellationToken) |
Updates a database.
|
| Update(WaitUntil, KustoDatabaseData, Nullable<KustoDatabaseCallerRole>, CancellationToken) |
Updates a database.
|
| UpdateAsync(WaitUntil, KustoDatabaseData, CancellationToken) |
Updates a database.
|
| UpdateAsync(WaitUntil, KustoDatabaseData, Nullable<KustoDatabaseCallerRole>, CancellationToken) |
Updates a database.
|
| ValidateDataConnection(WaitUntil, DataConnectionValidationContent, CancellationToken) |
Checks that the data connection parameters are valid.
|
| ValidateDataConnectionAsync(WaitUntil, DataConnectionValidationContent, CancellationToken) |
Checks that the data connection parameters are valid.
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<KustoDatabaseData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<KustoDatabaseData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<KustoDatabaseData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<KustoDatabaseData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<KustoDatabaseData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
