ServicesImpl | @azure/arm-appplatform

Class containing Services operations.

Hierarchy

ServicesImpl

Implements

Services

Index

Constructors

constructor

Methods

Constructors

constructor

new ServicesImpl(client: AppPlatformManagementClient): ServicesImpl

- Defined in operations/services.ts:52
Initialize a new instance of the class Services class.

Parameters
- client: AppPlatformManagementClient
  
  Reference to the service client
Returns ServicesImpl

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serviceName: string, resource: ServiceResource, options?: ServicesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ServicesCreateOrUpdateResponse>, ServicesCreateOrUpdateResponse>>

Implementation of Services.beginCreateOrUpdate
- Defined in operations/services.ts:181
Create a new Service or update an exiting Service.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- resource: ServiceResource
  
  Parameters for the create or update operation
- Optional options: ServicesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ServicesCreateOrUpdateResponse>, ServicesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, resource: ServiceResource, options?: ServicesCreateOrUpdateOptionalParams): Promise<ServicesCreateOrUpdateResponse>

Implementation of Services.beginCreateOrUpdateAndWait
- Defined in operations/services.ts:252
Create a new Service or update an exiting Service.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- resource: ServiceResource
  
  Parameters for the create or update operation
- Optional options: ServicesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ServicesCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, serviceName: string, options?: ServicesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of Services.beginDelete
- Defined in operations/services.ts:274
Operation to delete a Service.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- Optional options: ServicesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

Implementation of Services.beginDeleteAndWait
- Defined in operations/services.ts:338
Operation to delete a Service.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- Optional options: ServicesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginStart

beginStart(resourceGroupName: string, serviceName: string, options?: ServicesStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of Services.beginStart
- Defined in operations/services.ts:610
Start a Service.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- Optional options: ServicesStartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStartAndWait

beginStartAndWait(resourceGroupName: string, serviceName: string, options?: ServicesStartOptionalParams): Promise<void>

Implementation of Services.beginStartAndWait
- Defined in operations/services.ts:674
Start a Service.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- Optional options: ServicesStartOptionalParams
  
  The options parameters.
Returns Promise<void>

beginStop

beginStop(resourceGroupName: string, serviceName: string, options?: ServicesStopOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of Services.beginStop
- Defined in operations/services.ts:526
Stop a Service.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- Optional options: ServicesStopOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStopAndWait

beginStopAndWait(resourceGroupName: string, serviceName: string, options?: ServicesStopOptionalParams): Promise<void>

Implementation of Services.beginStopAndWait
- Defined in operations/services.ts:590
Stop a Service.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- Optional options: ServicesStopOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, serviceName: string, resource: ServiceResource, options?: ServicesUpdateOptionalParams): Promise<PollerLike<PollOperationState<ServicesUpdateResponse>, ServicesUpdateResponse>>

Implementation of Services.beginUpdate
- Defined in operations/services.ts:359
Operation to update an exiting Service.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- resource: ServiceResource
  
  Parameters for the update operation
- Optional options: ServicesUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ServicesUpdateResponse>, ServicesUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, serviceName: string, resource: ServiceResource, options?: ServicesUpdateOptionalParams): Promise<ServicesUpdateResponse>

Implementation of Services.beginUpdateAndWait
- Defined in operations/services.ts:430
Operation to update an exiting Service.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- resource: ServiceResource
  
  Parameters for the update operation
- Optional options: ServicesUpdateOptionalParams
  
  The options parameters.
Returns Promise<ServicesUpdateResponse>

checkNameAvailability

checkNameAvailability(location: string, availabilityParameters: NameAvailabilityParameters, options?: ServicesCheckNameAvailabilityOptionalParams): Promise<ServicesCheckNameAvailabilityResponse>

Implementation of Services.checkNameAvailability
- Defined in operations/services.ts:693
Checks that the resource name is valid and is not already in use.

Parameters
- location: string
  
  the region
- availabilityParameters: NameAvailabilityParameters
  
  Parameters supplied to the operation.
- Optional options: ServicesCheckNameAvailabilityOptionalParams
  
  The options parameters.
Returns Promise<ServicesCheckNameAvailabilityResponse>

disableTestEndpoint

disableTestEndpoint(resourceGroupName: string, serviceName: string, options?: ServicesDisableTestEndpointOptionalParams): Promise<void>

Implementation of Services.disableTestEndpoint
- Defined in operations/services.ts:490
Disable test endpoint functionality for a Service.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- Optional options: ServicesDisableTestEndpointOptionalParams
  
  The options parameters.
Returns Promise<void>

enableTestEndpoint

enableTestEndpoint(resourceGroupName: string, serviceName: string, options?: ServicesEnableTestEndpointOptionalParams): Promise<ServicesEnableTestEndpointResponse>

Implementation of Services.enableTestEndpoint
- Defined in operations/services.ts:508
Enable test endpoint functionality for a Service.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- Optional options: ServicesEnableTestEndpointOptionalParams
  
  The options parameters.
Returns Promise<ServicesEnableTestEndpointResponse>

get

get(resourceGroupName: string, serviceName: string, options?: ServicesGetOptionalParams): Promise<ServicesGetResponse>

Implementation of Services.get
- Defined in operations/services.ts:162
Get a Service and its properties.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- Optional options: ServicesGetOptionalParams
  
  The options parameters.
Returns Promise<ServicesGetResponse>

list

list(resourceGroupName: string, options?: ServicesListOptionalParams): PagedAsyncIterableIterator<ServiceResource>

Implementation of Services.list
- Defined in operations/services.ts:110
Handles requests to list all resources in a resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- Optional options: ServicesListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ServiceResource>

listBySubscription

listBySubscription(options?: ServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ServiceResource>

Implementation of Services.listBySubscription
- Defined in operations/services.ts:66
Handles requests to list all resources in a subscription.

Parameters
- Optional options: ServicesListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ServiceResource>

listTestKeys

listTestKeys(resourceGroupName: string, serviceName: string, options?: ServicesListTestKeysOptionalParams): Promise<ServicesListTestKeysResponse>

Implementation of Services.listTestKeys
- Defined in operations/services.ts:452
List test keys for a Service.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- Optional options: ServicesListTestKeysOptionalParams
  
  The options parameters.
Returns Promise<ServicesListTestKeysResponse>

regenerateTestKey

regenerateTestKey(resourceGroupName: string, serviceName: string, regenerateTestKeyRequest: RegenerateTestKeyRequestPayload, options?: ServicesRegenerateTestKeyOptionalParams): Promise<ServicesRegenerateTestKeyResponse>

Implementation of Services.regenerateTestKey
- Defined in operations/services.ts:471
Regenerate a test key for a Service.

Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serviceName: string
  
  The name of the Service resource.
- regenerateTestKeyRequest: RegenerateTestKeyRequestPayload
  
  Parameters for the operation
- Optional options: ServicesRegenerateTestKeyOptionalParams
  
  The options parameters.
Returns Promise<ServicesRegenerateTestKeyResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: AppPlatformManagementClient

Returns ServicesImpl

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serviceName: string

resource: ServiceResource

Optional options: ServicesCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ServicesCreateOrUpdateResponse>, ServicesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

resource: ServiceResource

Optional options: ServicesCreateOrUpdateOptionalParams

Returns Promise<ServicesCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

serviceName: string

Optional options: ServicesDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

serviceName: string

Optional options: ServicesDeleteOptionalParams

Returns Promise<void>

beginStart

Parameters

resourceGroupName: string

serviceName: string

Optional options: ServicesStartOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStartAndWait

Parameters

resourceGroupName: string

serviceName: string

Optional options: ServicesStartOptionalParams

Returns Promise<void>

beginStop

Parameters

resourceGroupName: string

serviceName: string

Optional options: ServicesStopOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStopAndWait

Parameters

resourceGroupName: string

serviceName: string

Optional options: ServicesStopOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

serviceName: string

resource: ServiceResource

Optional options: ServicesUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ServicesUpdateResponse>, ServicesUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

resource: ServiceResource

Optional options: ServicesUpdateOptionalParams

Returns Promise<ServicesUpdateResponse>

checkNameAvailability

Parameters

location: string

availabilityParameters: NameAvailabilityParameters

Optional options: ServicesCheckNameAvailabilityOptionalParams