Fleet interface
界面代表舰队。
方法
| begin |
删除现有的 Azure Cosmos DB 队列。 |
| begin |
删除现有的 Azure Cosmos DB 队列。 |
| create(string, string, Fleet |
在订阅下创建 Azure Cosmos DB 队列。 |
| get(string, string, Fleet |
检索订阅下现有 Azure Cosmos DB 队列的属性 |
| list(Fleet |
列出订阅下的所有队列。 |
| list |
列出指定订阅和资源组下的所有队列。 |
| update(string, string, Fleet |
更新现有 Azure Cosmos DB 队列的属性。 |
方法详细信息
beginDelete(string, string, FleetDeleteOptionalParams)
删除现有的 Azure Cosmos DB 队列。
function beginDelete(resourceGroupName: string, fleetName: string, options?: FleetDeleteOptionalParams): Promise<SimplePollerLike<OperationState<FleetDeleteHeaders>, FleetDeleteHeaders>>
参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- fleetName
-
string
Cosmos DB 队列名称。 在订阅下需要是唯一的。
- options
- FleetDeleteOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<FleetDeleteHeaders>, FleetDeleteHeaders>>
beginDeleteAndWait(string, string, FleetDeleteOptionalParams)
删除现有的 Azure Cosmos DB 队列。
function beginDeleteAndWait(resourceGroupName: string, fleetName: string, options?: FleetDeleteOptionalParams): Promise<FleetDeleteHeaders>
参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- fleetName
-
string
Cosmos DB 队列名称。 在订阅下需要是唯一的。
- options
- FleetDeleteOptionalParams
选项参数。
返回
Promise<FleetDeleteHeaders>
create(string, string, FleetResource, FleetCreateOptionalParams)
在订阅下创建 Azure Cosmos DB 队列。
function create(resourceGroupName: string, fleetName: string, body: FleetResource, options?: FleetCreateOptionalParams): Promise<FleetResource>
参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- fleetName
-
string
Cosmos DB 队列名称。 在订阅下需要是唯一的。
- body
- FleetResource
为当前舰队提供参数。
- options
- FleetCreateOptionalParams
选项参数。
返回
Promise<FleetResource>
get(string, string, FleetGetOptionalParams)
检索订阅下现有 Azure Cosmos DB 队列的属性
function get(resourceGroupName: string, fleetName: string, options?: FleetGetOptionalParams): Promise<FleetResource>
参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- fleetName
-
string
Cosmos DB 队列名称。 在订阅下需要是唯一的。
- options
- FleetGetOptionalParams
选项参数。
返回
Promise<FleetResource>
list(FleetListOptionalParams)
列出订阅下的所有队列。
function list(options?: FleetListOptionalParams): PagedAsyncIterableIterator<FleetResource, FleetResource[], PageSettings>
参数
- options
- FleetListOptionalParams
选项参数。
返回
listByResourceGroup(string, FleetListByResourceGroupOptionalParams)
列出指定订阅和资源组下的所有队列。
function listByResourceGroup(resourceGroupName: string, options?: FleetListByResourceGroupOptionalParams): PagedAsyncIterableIterator<FleetResource, FleetResource[], PageSettings>
参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
选项参数。
返回
update(string, string, FleetUpdateOptionalParams)
更新现有 Azure Cosmos DB 队列的属性。
function update(resourceGroupName: string, fleetName: string, options?: FleetUpdateOptionalParams): Promise<FleetResource>
参数
- resourceGroupName
-
string
资源组的名称。 此名称不区分大小写。
- fleetName
-
string
Cosmos DB 队列名称。 在订阅下需要是唯一的。
- options
- FleetUpdateOptionalParams
选项参数。
返回
Promise<FleetResource>