你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
MongoClusterExtensions.GetMongoClusterAsync 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.
Gets information about a mongo cluster.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}
- Operation Id: MongoClusters_Get
- Default Api Version: 2024-07-01
- Resource: MongoClusterResource
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.MongoCluster.MongoClusterResource>> GetMongoClusterAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string mongoClusterName, System.Threading.CancellationToken cancellationToken = default);
static member GetMongoClusterAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.MongoCluster.MongoClusterResource>>
<Extension()>
Public Function GetMongoClusterAsync (resourceGroupResource As ResourceGroupResource, mongoClusterName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of MongoClusterResource))
Parameters
- resourceGroupResource
- ResourceGroupResource
The ResourceGroupResource instance the method will execute against.
- mongoClusterName
- String
The name of the mongo cluster.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
resourceGroupResource
or mongoClusterName
is null.
mongoClusterName
is an empty string, and was expected to be non-empty.