azure.mgmt.cosmosdb.aio.operations.ServiceOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.cosmosdb.aio.operations.ServiceOperations
name: ServiceOperations
fullName: azure.mgmt.cosmosdb.aio.operations.ServiceOperations
module: azure.mgmt.cosmosdb.aio.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.cosmosdb.aio.CosmosDBManagementClient>'s\n\
  >\n> <xref:service> attribute.\n>"
constructor:
  syntax: ServiceOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.cosmosdb.aio.operations.ServiceOperations.begin_create
  name: begin_create
  summary: Creates a service.
  signature: 'async begin_create(resource_group_name: str, account_name: str, service_name:
    str, create_update_parameters: _models.ServiceResourceCreateUpdateParameters,
    *, content_type: str = ''application/json'', **kwargs: Any) -> AsyncLROPoller[_models.ServiceResource]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: service_name
    description: Cosmos DB service name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: create_update_parameters
    description: 'The Service resource parameters. Is either a

      ServiceResourceCreateUpdateParameters type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.cosmosdb.models.ServiceResourceCreateUpdateParameters>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: 'An instance of AsyncLROPoller that returns either ServiceResource
      or the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:azure.mgmt.cosmosdb.models.ServiceResource>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.ServiceOperations.begin_delete
  name: begin_delete
  summary: Deletes service with the given serviceName.
  signature: 'async begin_delete(resource_group_name: str, account_name: str, service_name:
    str, **kwargs: Any) -> AsyncLROPoller[None]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: service_name
    description: Cosmos DB service name. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An instance of AsyncLROPoller that returns either None or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.ServiceOperations.get
  name: get
  summary: Gets the status of service.
  signature: 'async get(resource_group_name: str, account_name: str, service_name:
    str, **kwargs: Any) -> ServiceResource'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: service_name
    description: Cosmos DB service name. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: ServiceResource or the result of cls(response)
    types:
    - <xref:azure.mgmt.cosmosdb.models.ServiceResource>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.ServiceOperations.list
  name: list
  summary: Gets the status of service.
  signature: 'list(resource_group_name: str, account_name: str, **kwargs: Any) ->
    AsyncIterable[ServiceResource]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An iterator like instance of either ServiceResource or the result
      of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.cosmosdb.models.ServiceResource>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.cosmosdb.aio.operations.ServiceOperations.models
  name: models
  signature: models = <module 'azure.mgmt.cosmosdb.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\cosmosdb\\models\\__init__.py'>