Services interface

Interface representing a Services.

Methods

beginCreateOrUpdate(string, string, ServicesDescription, ServicesCreateOrUpdateOptionalParams)

Create or update the metadata of a service instance.

beginCreateOrUpdateAndWait(string, string, ServicesDescription, ServicesCreateOrUpdateOptionalParams)

Create or update the metadata of a service instance.

beginDelete(string, string, ServicesDeleteOptionalParams)

Delete a service instance.

beginDeleteAndWait(string, string, ServicesDeleteOptionalParams)

Delete a service instance.

beginUpdate(string, string, ServicesPatchDescription, ServicesUpdateOptionalParams)

Update the metadata of a service instance.

beginUpdateAndWait(string, string, ServicesPatchDescription, ServicesUpdateOptionalParams)

Update the metadata of a service instance.

checkNameAvailability(CheckNameAvailabilityParameters, ServicesCheckNameAvailabilityOptionalParams)

Check if a service instance name is available.

get(string, string, ServicesGetOptionalParams)

Get the metadata of a service instance.

list(ServicesListOptionalParams)

Get all the service instances in a subscription.

listByResourceGroup(string, ServicesListByResourceGroupOptionalParams)

Get all the service instances in a resource group.

Method Details

beginCreateOrUpdate(string, string, ServicesDescription, ServicesCreateOrUpdateOptionalParams)

Create or update the metadata of a service instance.

function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, serviceDescription: ServicesDescription, options?: ServicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ServicesDescription>, ServicesDescription>>

Parameters

resourceGroupName

string

The name of the resource group that contains the service instance.

resourceName

string

The name of the service instance.

serviceDescription
ServicesDescription

The service instance metadata.

options
ServicesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ServicesDescription>, ServicesDescription>>

beginCreateOrUpdateAndWait(string, string, ServicesDescription, ServicesCreateOrUpdateOptionalParams)

Create or update the metadata of a service instance.

function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, serviceDescription: ServicesDescription, options?: ServicesCreateOrUpdateOptionalParams): Promise<ServicesDescription>

Parameters

resourceGroupName

string

The name of the resource group that contains the service instance.

resourceName

string

The name of the service instance.

serviceDescription
ServicesDescription

The service instance metadata.

options
ServicesCreateOrUpdateOptionalParams

The options parameters.

Returns

beginDelete(string, string, ServicesDeleteOptionalParams)

Delete a service instance.

function beginDelete(resourceGroupName: string, resourceName: string, options?: ServicesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group that contains the service instance.

resourceName

string

The name of the service instance.

options
ServicesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, ServicesDeleteOptionalParams)

Delete a service instance.

function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: ServicesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the service instance.

resourceName

string

The name of the service instance.

options
ServicesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, ServicesPatchDescription, ServicesUpdateOptionalParams)

Update the metadata of a service instance.

function beginUpdate(resourceGroupName: string, resourceName: string, servicePatchDescription: ServicesPatchDescription, options?: ServicesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ServicesDescription>, ServicesDescription>>

Parameters

resourceGroupName

string

The name of the resource group that contains the service instance.

resourceName

string

The name of the service instance.

servicePatchDescription
ServicesPatchDescription

The service instance metadata and security metadata.

options
ServicesUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ServicesDescription>, ServicesDescription>>

beginUpdateAndWait(string, string, ServicesPatchDescription, ServicesUpdateOptionalParams)

Update the metadata of a service instance.

function beginUpdateAndWait(resourceGroupName: string, resourceName: string, servicePatchDescription: ServicesPatchDescription, options?: ServicesUpdateOptionalParams): Promise<ServicesDescription>

Parameters

resourceGroupName

string

The name of the resource group that contains the service instance.

resourceName

string

The name of the service instance.

servicePatchDescription
ServicesPatchDescription

The service instance metadata and security metadata.

options
ServicesUpdateOptionalParams

The options parameters.

Returns

checkNameAvailability(CheckNameAvailabilityParameters, ServicesCheckNameAvailabilityOptionalParams)

Check if a service instance name is available.

function checkNameAvailability(checkNameAvailabilityInputs: CheckNameAvailabilityParameters, options?: ServicesCheckNameAvailabilityOptionalParams): Promise<ServicesNameAvailabilityInfo>

Parameters

checkNameAvailabilityInputs
CheckNameAvailabilityParameters

Set the name parameter in the CheckNameAvailabilityParameters structure to the name of the service instance to check.

options
ServicesCheckNameAvailabilityOptionalParams

The options parameters.

Returns

get(string, string, ServicesGetOptionalParams)

Get the metadata of a service instance.

function get(resourceGroupName: string, resourceName: string, options?: ServicesGetOptionalParams): Promise<ServicesDescription>

Parameters

resourceGroupName

string

The name of the resource group that contains the service instance.

resourceName

string

The name of the service instance.

options
ServicesGetOptionalParams

The options parameters.

Returns

list(ServicesListOptionalParams)

Get all the service instances in a subscription.

function list(options?: ServicesListOptionalParams): PagedAsyncIterableIterator<ServicesDescription, ServicesDescription[], PageSettings>

Parameters

options
ServicesListOptionalParams

The options parameters.

Returns

listByResourceGroup(string, ServicesListByResourceGroupOptionalParams)

Get all the service instances in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: ServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ServicesDescription, ServicesDescription[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the service instance.

options
ServicesListByResourceGroupOptionalParams

The options parameters.

Returns