CosmosDBSqlContainerResource 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 CosmosDBSqlContainer along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a CosmosDBSqlContainerResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource CosmosDBSqlDatabaseResource using the GetCosmosDBSqlContainers method.
public class CosmosDBSqlContainerResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CosmosDB.CosmosDBSqlContainerData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CosmosDB.CosmosDBSqlContainerData>type CosmosDBSqlContainerResource = class
inherit ArmResource
interface IJsonModel<CosmosDBSqlContainerData>
interface IPersistableModel<CosmosDBSqlContainerData>Public Class CosmosDBSqlContainerResource
Inherits ArmResource
Implements IJsonModel(Of CosmosDBSqlContainerData), IPersistableModel(Of CosmosDBSqlContainerData)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| CosmosDBSqlContainerResource() |
Initializes a new instance of CosmosDBSqlContainerResource 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 |
|---|---|
| AddTag(String, String, CancellationToken) |
Add a tag to the current resource. |
| AddTagAsync(String, String, CancellationToken) |
Add a tag to the current resource. |
| 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) |
| CreateResourceIdentifier(String, String, String, String, String) |
Generate the resource identifier for this resource. |
| Delete(WaitUntil, CancellationToken) |
Deletes an existing Azure Cosmos DB SQL container.
|
| DeleteAsync(WaitUntil, CancellationToken) |
Deletes an existing Azure Cosmos DB SQL container.
|
| Get(CancellationToken) |
Gets the SQL container under an existing Azure Cosmos DB database account.
|
| GetAsync(CancellationToken) |
Gets the SQL container under an existing Azure Cosmos DB database account.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetCosmosDBSqlContainerThroughputSetting() |
Gets an object representing a CosmosDBSqlContainerThroughputSettingResource along with the instance operations that can be performed on it in the CosmosDBSqlContainerResource. |
| GetCosmosDBSqlStoredProcedure(String, CancellationToken) |
Gets the SQL storedProcedure under an existing Azure Cosmos DB database account. |
| GetCosmosDBSqlStoredProcedureAsync(String, CancellationToken) |
Gets the SQL storedProcedure under an existing Azure Cosmos DB database account. |
| GetCosmosDBSqlStoredProcedures() |
Gets a collection of CosmosDBSqlStoredProcedures in the CosmosDBSqlContainerResource. |
| GetCosmosDBSqlTrigger(String, CancellationToken) |
Gets the SQL trigger under an existing Azure Cosmos DB database account. |
| GetCosmosDBSqlTriggerAsync(String, CancellationToken) |
Gets the SQL trigger under an existing Azure Cosmos DB database account. |
| GetCosmosDBSqlTriggers() |
Gets a collection of CosmosDBSqlTriggers in the CosmosDBSqlContainerResource. |
| GetCosmosDBSqlUserDefinedFunction(String, CancellationToken) |
Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account. |
| GetCosmosDBSqlUserDefinedFunctionAsync(String, CancellationToken) |
Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account. |
| GetCosmosDBSqlUserDefinedFunctions() |
Gets a collection of CosmosDBSqlUserDefinedFunctions in the CosmosDBSqlContainerResource. |
| 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) |
| GetSqlContainerPartitionMerge(WaitUntil, MergeParameters, CancellationToken) |
Merges the partitions of a SQL Container
|
| GetSqlContainerPartitionMergeAsync(WaitUntil, MergeParameters, CancellationToken) |
Merges the partitions of a SQL Container
|
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| RemoveTag(String, CancellationToken) |
Removes a tag by key from the resource. |
| RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource. |
| RetrieveContinuousBackupInformation(WaitUntil, ContinuousBackupRestoreLocation, CancellationToken) |
Retrieves continuous backup information for a container resource.
|
| RetrieveContinuousBackupInformationAsync(WaitUntil, ContinuousBackupRestoreLocation, CancellationToken) |
Retrieves continuous backup information for a container resource.
|
| SetTags(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set. |
| SetTagsAsync(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set. |
| TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
| Update(WaitUntil, CosmosDBSqlContainerCreateOrUpdateContent, CancellationToken) |
Update a CosmosDBSqlContainer.
|
| UpdateAsync(WaitUntil, CosmosDBSqlContainerCreateOrUpdateContent, CancellationToken) |
Update a CosmosDBSqlContainer.
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<CosmosDBSqlContainerData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<CosmosDBSqlContainerData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<CosmosDBSqlContainerData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<CosmosDBSqlContainerData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<CosmosDBSqlContainerData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
