Service interface
Interface representing a Service.
Methods
| begin |
Creates a service. |
| begin |
Creates a service. |
| begin |
Deletes service with the given serviceName. |
| begin |
Deletes service with the given serviceName. |
| get(string, string, string, Service |
Gets the status of service. |
| list(string, string, Service |
Gets the status of service. |
Method Details
beginCreate(string, string, string, ServiceResourceCreateUpdateParameters, ServiceCreateOptionalParams)
Creates a service.
function beginCreate(resourceGroupName: string, accountName: string, serviceName: string, createUpdateParameters: ServiceResourceCreateUpdateParameters, options?: ServiceCreateOptionalParams): Promise<SimplePollerLike<OperationState<ServiceResource>, ServiceResource>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- serviceName
-
string
Cosmos DB service name.
- createUpdateParameters
- ServiceResourceCreateUpdateParameters
The Service resource parameters.
- options
- ServiceCreateOptionalParams
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<ServiceResource>, ServiceResource>>
beginCreateAndWait(string, string, string, ServiceResourceCreateUpdateParameters, ServiceCreateOptionalParams)
Creates a service.
function beginCreateAndWait(resourceGroupName: string, accountName: string, serviceName: string, createUpdateParameters: ServiceResourceCreateUpdateParameters, options?: ServiceCreateOptionalParams): Promise<ServiceResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- serviceName
-
string
Cosmos DB service name.
- createUpdateParameters
- ServiceResourceCreateUpdateParameters
The Service resource parameters.
- options
- ServiceCreateOptionalParams
The options parameters.
Returns
Promise<ServiceResource>
beginDelete(string, string, string, ServiceDeleteOptionalParams)
Deletes service with the given serviceName.
function beginDelete(resourceGroupName: string, accountName: string, serviceName: string, options?: ServiceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- serviceName
-
string
Cosmos DB service name.
- options
- ServiceDeleteOptionalParams
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, ServiceDeleteOptionalParams)
Deletes service with the given serviceName.
function beginDeleteAndWait(resourceGroupName: string, accountName: string, serviceName: string, options?: ServiceDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- serviceName
-
string
Cosmos DB service name.
- options
- ServiceDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, ServiceGetOptionalParams)
Gets the status of service.
function get(resourceGroupName: string, accountName: string, serviceName: string, options?: ServiceGetOptionalParams): Promise<ServiceResource>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- serviceName
-
string
Cosmos DB service name.
- options
- ServiceGetOptionalParams
The options parameters.
Returns
Promise<ServiceResource>
list(string, string, ServiceListOptionalParams)
Gets the status of service.
function list(resourceGroupName: string, accountName: string, options?: ServiceListOptionalParams): PagedAsyncIterableIterator<ServiceResource, ServiceResource[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- accountName
-
string
Cosmos DB database account name.
- options
- ServiceListOptionalParams
The options parameters.
Returns
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for