Services interface
Interface representing a Services.
Methods
Method Details
beginCreateOrUpdate(string, string, ServiceResource, ServicesCreateOrUpdateOptionalParams)
Create a new Service or update an exiting Service.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, resource: ServiceResource, options?: ServicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ServiceResource>, ServiceResource>>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
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ServiceResource>, ServiceResource>>
beginCreateOrUpdateAndWait(string, string, ServiceResource, ServicesCreateOrUpdateOptionalParams)
Create a new Service or update an exiting Service.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, resource: ServiceResource, options?: ServicesCreateOrUpdateOptionalParams): Promise<ServiceResource>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
The options parameters.
Returns
Promise<ServiceResource>
beginDelete(string, string, ServicesDeleteOptionalParams)
Operation to delete a Service.
function beginDelete(resourceGroupName: string, serviceName: string, options?: ServicesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
- options
- ServicesDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, ServicesDeleteOptionalParams)
Operation to delete a Service.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, options?: ServicesDeleteOptionalParams): Promise<void>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.
- options
- ServicesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginDisableApmGlobally(string, string, ApmReference, ServicesDisableApmGloballyOptionalParams)
Disable an APM globally.
function beginDisableApmGlobally(resourceGroupName: string, serviceName: string, apm: ApmReference, options?: ServicesDisableApmGloballyOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
- apm
- ApmReference
The target APM for the disable operation
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDisableApmGloballyAndWait(string, string, ApmReference, ServicesDisableApmGloballyOptionalParams)
Disable an APM globally.
function beginDisableApmGloballyAndWait(resourceGroupName: string, serviceName: string, apm: ApmReference, options?: ServicesDisableApmGloballyOptionalParams): Promise<void>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.
- apm
- ApmReference
The target APM for the disable operation
The options parameters.
Returns
Promise<void>
beginEnableApmGlobally(string, string, ApmReference, ServicesEnableApmGloballyOptionalParams)
Enable an APM globally.
function beginEnableApmGlobally(resourceGroupName: string, serviceName: string, apm: ApmReference, options?: ServicesEnableApmGloballyOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
- apm
- ApmReference
The target APM for the enable operation
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginEnableApmGloballyAndWait(string, string, ApmReference, ServicesEnableApmGloballyOptionalParams)
Enable an APM globally.
function beginEnableApmGloballyAndWait(resourceGroupName: string, serviceName: string, apm: ApmReference, options?: ServicesEnableApmGloballyOptionalParams): Promise<void>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.
- apm
- ApmReference
The target APM for the enable operation
The options parameters.
Returns
Promise<void>
beginFlushVnetDnsSetting(string, string, ServicesFlushVnetDnsSettingOptionalParams)
Flush Virtual Network DNS settings for a VNET injected Service.
function beginFlushVnetDnsSetting(resourceGroupName: string, serviceName: string, options?: ServicesFlushVnetDnsSettingOptionalParams): Promise<SimplePollerLike<OperationState<ServicesFlushVnetDnsSettingHeaders>, ServicesFlushVnetDnsSettingHeaders>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ServicesFlushVnetDnsSettingHeaders>, ServicesFlushVnetDnsSettingHeaders>>
beginFlushVnetDnsSettingAndWait(string, string, ServicesFlushVnetDnsSettingOptionalParams)
Flush Virtual Network DNS settings for a VNET injected Service.
function beginFlushVnetDnsSettingAndWait(resourceGroupName: string, serviceName: string, options?: ServicesFlushVnetDnsSettingOptionalParams): Promise<ServicesFlushVnetDnsSettingHeaders>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.
The options parameters.
Returns
Promise<ServicesFlushVnetDnsSettingHeaders>
beginStart(string, string, ServicesStartOptionalParams)
Start a Service.
function beginStart(resourceGroupName: string, serviceName: string, options?: ServicesStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
- options
- ServicesStartOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginStartAndWait(string, string, ServicesStartOptionalParams)
Start a Service.
function beginStartAndWait(resourceGroupName: string, serviceName: string, options?: ServicesStartOptionalParams): Promise<void>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.
- options
- ServicesStartOptionalParams
The options parameters.
Returns
Promise<void>
beginStop(string, string, ServicesStopOptionalParams)
Stop a Service.
function beginStop(resourceGroupName: string, serviceName: string, options?: ServicesStopOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
- options
- ServicesStopOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginStopAndWait(string, string, ServicesStopOptionalParams)
Stop a Service.
function beginStopAndWait(resourceGroupName: string, serviceName: string, options?: ServicesStopOptionalParams): Promise<void>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.
- options
- ServicesStopOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, ServiceResource, ServicesUpdateOptionalParams)
Operation to update an exiting Service.
function beginUpdate(resourceGroupName: string, serviceName: string, resource: ServiceResource, options?: ServicesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ServiceResource>, ServiceResource>>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
- options
- ServicesUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ServiceResource>, ServiceResource>>
beginUpdateAndWait(string, string, ServiceResource, ServicesUpdateOptionalParams)
Operation to update an exiting Service.
function beginUpdateAndWait(resourceGroupName: string, serviceName: string, resource: ServiceResource, options?: ServicesUpdateOptionalParams): Promise<ServiceResource>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
- options
- ServicesUpdateOptionalParams
The options parameters.
Returns
Promise<ServiceResource>
checkNameAvailability(string, NameAvailabilityParameters, ServicesCheckNameAvailabilityOptionalParams)
Checks that the resource name is valid and is not already in use.
function checkNameAvailability(location: string, availabilityParameters: NameAvailabilityParameters, options?: ServicesCheckNameAvailabilityOptionalParams): Promise<NameAvailability>Parameters
- location
-
string
the region
- availabilityParameters
- NameAvailabilityParameters
Parameters supplied to the operation.
The options parameters.
Returns
Promise<NameAvailability>
disableTestEndpoint(string, string, ServicesDisableTestEndpointOptionalParams)
Disable test endpoint functionality for a Service.
function disableTestEndpoint(resourceGroupName: string, serviceName: string, options?: ServicesDisableTestEndpointOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
enableTestEndpoint(string, string, ServicesEnableTestEndpointOptionalParams)
Enable test endpoint functionality for a Service.
function enableTestEndpoint(resourceGroupName: string, serviceName: string, options?: ServicesEnableTestEndpointOptionalParams): Promise<TestKeys>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.
The options parameters.
Returns
Promise<TestKeys>
get(string, string, ServicesGetOptionalParams)
Get a Service and its properties.
function get(resourceGroupName: string, serviceName: string, options?: ServicesGetOptionalParams): Promise<ServiceResource>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.
- options
- ServicesGetOptionalParams
The options parameters.
Returns
Promise<ServiceResource>
list(string, ServicesListOptionalParams)
Handles requests to list all resources in a resource group.
function list(resourceGroupName: string, options?: ServicesListOptionalParams): PagedAsyncIterableIterator<ServiceResource, ServiceResource[], PageSettings>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.
- options
- ServicesListOptionalParams
The options parameters.
Returns
listBySubscription(ServicesListBySubscriptionOptionalParams)
Handles requests to list all resources in a subscription.
function listBySubscription(options?: ServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ServiceResource, ServiceResource[], PageSettings>Parameters
The options parameters.
Returns
listGloballyEnabledApms(string, string, ServicesListGloballyEnabledApmsOptionalParams)
List globally enabled APMs for a Service.
function listGloballyEnabledApms(resourceGroupName: string, serviceName: string, options?: ServicesListGloballyEnabledApmsOptionalParams): Promise<GloballyEnabledApms>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.
The options parameters.
Returns
Promise<GloballyEnabledApms>
listSupportedApmTypes(string, string, ServicesListSupportedApmTypesOptionalParams)
List supported APM types for a Service.
function listSupportedApmTypes(resourceGroupName: string, serviceName: string, options?: ServicesListSupportedApmTypesOptionalParams): PagedAsyncIterableIterator<SupportedApmType, SupportedApmType[], PageSettings>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.
The options parameters.
Returns
listSupportedServerVersions(string, string, ServicesListSupportedServerVersionsOptionalParams)
Lists all of the available server versions supported by Microsoft.AppPlatform provider.
function listSupportedServerVersions(resourceGroupName: string, serviceName: string, options?: ServicesListSupportedServerVersionsOptionalParams): PagedAsyncIterableIterator<SupportedServerVersion, SupportedServerVersion[], PageSettings>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.
The options parameters.
Returns
listTestKeys(string, string, ServicesListTestKeysOptionalParams)
List test keys for a Service.
function listTestKeys(resourceGroupName: string, serviceName: string, options?: ServicesListTestKeysOptionalParams): Promise<TestKeys>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.
The options parameters.
Returns
Promise<TestKeys>
regenerateTestKey(string, string, RegenerateTestKeyRequestPayload, ServicesRegenerateTestKeyOptionalParams)
Regenerate a test key for a Service.
function regenerateTestKey(resourceGroupName: string, serviceName: string, regenerateTestKeyRequest: RegenerateTestKeyRequestPayload, options?: ServicesRegenerateTestKeyOptionalParams): Promise<TestKeys>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
The options parameters.
Returns
Promise<TestKeys>