Share via


AppServiceEnvironmentResource Class

Definition

A Class representing an AppServiceEnvironment along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct an AppServiceEnvironmentResource from an instance of ArmClient using the GetAppServiceEnvironmentResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetAppServiceEnvironment method.

public class AppServiceEnvironmentResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.AppService.AppServiceEnvironmentData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.AppService.AppServiceEnvironmentData>
type AppServiceEnvironmentResource = class
    inherit ArmResource
    interface IJsonModel<AppServiceEnvironmentData>
    interface IPersistableModel<AppServiceEnvironmentData>
Public Class AppServiceEnvironmentResource
Inherits ArmResource
Implements IJsonModel(Of AppServiceEnvironmentData), IPersistableModel(Of AppServiceEnvironmentData)
Inheritance
AppServiceEnvironmentResource
Implements

Constructors

AppServiceEnvironmentResource()

Initializes a new instance of the AppServiceEnvironmentResource class for mocking.

Fields

ResourceType

Gets the resource type for the operations.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmResource)
Data

Gets the data representing this Feature.

Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmResource)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmResource)
HasData

Gets whether or not the current instance has data.

Id

Gets the resource identifier.

(Inherited from ArmResource)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmResource)

Methods

CanUseTagResource(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CreateResourceIdentifier(String, String, String)

Generate the resource identifier of a AppServiceEnvironmentResource instance.

Delete(WaitUntil, Nullable<Boolean>, CancellationToken)

Description for Delete an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
  • Operation Id: AppServiceEnvironments_Delete
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
DeleteAsync(WaitUntil, Nullable<Boolean>, CancellationToken)

Description for Delete an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
  • Operation Id: AppServiceEnvironments_Delete
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
DisableAllForHostingEnvironmentRecommendation(String, CancellationToken)

Description for Disable all recommendations for an app.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/disable
  • Operation Id: Recommendations_DisableAllForHostingEnvironment
  • Default Api Version: 2023-12-01
DisableAllForHostingEnvironmentRecommendationAsync(String, CancellationToken)

Description for Disable all recommendations for an app.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/disable
  • Operation Id: Recommendations_DisableAllForHostingEnvironment
  • Default Api Version: 2023-12-01
Get(CancellationToken)

Description for Get the properties of an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
  • Operation Id: AppServiceEnvironments_Get
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
GetAllWebAppData(String, CancellationToken)

Description for Get all apps in an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites
  • Operation Id: AppServiceEnvironments_ListWebApps
GetAllWebAppDataAsync(String, CancellationToken)

Description for Get all apps in an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites
  • Operation Id: AppServiceEnvironments_ListWebApps
GetAppServicePlans(CancellationToken)

Description for Get all App Service plans in an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms
  • Operation Id: AppServiceEnvironments_ListAppServicePlans
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
GetAppServicePlansAsync(CancellationToken)

Description for Get all App Service plans in an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms
  • Operation Id: AppServiceEnvironments_ListAppServicePlans
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
GetAseV3NetworkingConfiguration()

Gets an object representing a AseV3NetworkingConfigurationResource along with the instance operations that can be performed on it in the AppServiceEnvironment.

GetAsync(CancellationToken)

Description for Get the properties of an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
  • Operation Id: AppServiceEnvironments_Get
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetCapacities(CancellationToken)

Description for Get the used, available, and total worker capacity an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute
  • Operation Id: AppServiceEnvironments_ListCapacities
  • Default Api Version: 2023-12-01
GetCapacitiesAsync(CancellationToken)

Description for Get the used, available, and total worker capacity an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute
  • Operation Id: AppServiceEnvironments_ListCapacities
  • Default Api Version: 2023-12-01
GetCustomDnsSuffixConfiguration()

Gets an object representing a CustomDnsSuffixConfigurationResource along with the instance operations that can be performed on it in the AppServiceEnvironment.

GetDiagnostics(CancellationToken)

Description for Get diagnostic information for an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics
  • Operation Id: AppServiceEnvironments_ListDiagnostics
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
GetDiagnosticsAsync(CancellationToken)

Description for Get diagnostic information for an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics
  • Operation Id: AppServiceEnvironments_ListDiagnostics
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
GetDiagnosticsItem(String, CancellationToken)

Description for Get a diagnostics item for an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}
  • Operation Id: AppServiceEnvironments_GetDiagnosticsItem
  • Default Api Version: 2023-12-01
GetDiagnosticsItemAsync(String, CancellationToken)

Description for Get a diagnostics item for an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}
  • Operation Id: AppServiceEnvironments_GetDiagnosticsItem
  • Default Api Version: 2023-12-01
GetHistoryForHostingEnvironmentRecommendations(Nullable<Boolean>, String, CancellationToken)

Description for Get past recommendations for an app, optionally specified by the time range.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendationHistory
  • Operation Id: Recommendations_ListHistoryForHostingEnvironment
  • Default Api Version: 2023-12-01
GetHistoryForHostingEnvironmentRecommendationsAsync(Nullable<Boolean>, String, CancellationToken)

Description for Get past recommendations for an app, optionally specified by the time range.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendationHistory
  • Operation Id: Recommendations_ListHistoryForHostingEnvironment
  • Default Api Version: 2023-12-01
GetHostingEnvironmentDetector(String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, String, CancellationToken)

Description for Get Hosting Environment Detector Response

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors/{detectorName}
  • Operation Id: Diagnostics_GetHostingEnvironmentDetectorResponse
  • Default Api Version: 2023-12-01
  • Resource: HostingEnvironmentDetectorResource
GetHostingEnvironmentDetectorAsync(String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, String, CancellationToken)

Description for Get Hosting Environment Detector Response

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors/{detectorName}
  • Operation Id: Diagnostics_GetHostingEnvironmentDetectorResponse
  • Default Api Version: 2023-12-01
  • Resource: HostingEnvironmentDetectorResource
GetHostingEnvironmentDetectors()

Gets a collection of HostingEnvironmentDetectorResources in the AppServiceEnvironment.

GetHostingEnvironmentMultiRolePool()

Gets an object representing a HostingEnvironmentMultiRolePoolResource along with the instance operations that can be performed on it in the AppServiceEnvironment.

GetHostingEnvironmentPrivateEndpointConnection(String, CancellationToken)

Description for Gets a private endpoint connection

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: AppServiceEnvironments_GetPrivateEndpointConnection
  • Default Api Version: 2023-12-01
  • Resource: HostingEnvironmentPrivateEndpointConnectionResource
GetHostingEnvironmentPrivateEndpointConnectionAsync(String, CancellationToken)

Description for Gets a private endpoint connection

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: AppServiceEnvironments_GetPrivateEndpointConnection
  • Default Api Version: 2023-12-01
  • Resource: HostingEnvironmentPrivateEndpointConnectionResource
GetHostingEnvironmentPrivateEndpointConnections()

Gets a collection of HostingEnvironmentPrivateEndpointConnectionResources in the AppServiceEnvironment.

GetHostingEnvironmentRecommendation(String, Nullable<Boolean>, String, CancellationToken)

Description for Get a recommendation rule for an app.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/{name}
  • Operation Id: Recommendations_GetRuleDetailsByHostingEnvironment
  • Default Api Version: 2023-12-01
  • Resource: HostingEnvironmentRecommendationResource
GetHostingEnvironmentRecommendationAsync(String, Nullable<Boolean>, String, CancellationToken)

Description for Get a recommendation rule for an app.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/{name}
  • Operation Id: Recommendations_GetRuleDetailsByHostingEnvironment
  • Default Api Version: 2023-12-01
  • Resource: HostingEnvironmentRecommendationResource
GetHostingEnvironmentRecommendations()

Gets a collection of HostingEnvironmentRecommendationResources in the AppServiceEnvironment.

GetHostingEnvironmentWorkerPool(String, CancellationToken)

Description for Get properties of a worker pool.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
  • Operation Id: AppServiceEnvironments_GetWorkerPool
  • Default Api Version: 2023-12-01
  • Resource: HostingEnvironmentWorkerPoolResource
GetHostingEnvironmentWorkerPoolAsync(String, CancellationToken)

Description for Get properties of a worker pool.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
  • Operation Id: AppServiceEnvironments_GetWorkerPool
  • Default Api Version: 2023-12-01
  • Resource: HostingEnvironmentWorkerPoolResource
GetHostingEnvironmentWorkerPools()

Gets a collection of HostingEnvironmentWorkerPoolResources in the AppServiceEnvironment.

GetInboundNetworkDependenciesEndpoints(CancellationToken)

Description for Get the network endpoints of all inbound dependencies of an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundNetworkDependenciesEndpoints
  • Operation Id: AppServiceEnvironments_GetInboundNetworkDependenciesEndpoints
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
GetInboundNetworkDependenciesEndpointsAsync(CancellationToken)

Description for Get the network endpoints of all inbound dependencies of an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundNetworkDependenciesEndpoints
  • Operation Id: AppServiceEnvironments_GetInboundNetworkDependenciesEndpoints
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
GetManagementLock(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLocks()

Gets a collection of ManagementLockResources in the ArmResource.

(Inherited from ArmResource)
GetOperations(CancellationToken)

Description for List all currently running operations on the App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations
  • Operation Id: AppServiceEnvironments_ListOperations
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
GetOperationsAsync(CancellationToken)

Description for List all currently running operations on the App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations
  • Operation Id: AppServiceEnvironments_ListOperations
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
GetOutboundNetworkDependenciesEndpoints(CancellationToken)

Description for Get the network endpoints of all outbound dependencies of an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundNetworkDependenciesEndpoints
  • Operation Id: AppServiceEnvironments_GetOutboundNetworkDependenciesEndpoints
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
GetOutboundNetworkDependenciesEndpointsAsync(CancellationToken)

Description for Get the network endpoints of all outbound dependencies of an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundNetworkDependenciesEndpoints
  • Operation Id: AppServiceEnvironments_GetOutboundNetworkDependenciesEndpoints
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
GetPolicyAssignment(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignments()

Gets a collection of PolicyAssignmentResources in the ArmResource.

(Inherited from ArmResource)
GetPrivateLinkResources(CancellationToken)

Description for Gets the private link resources

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateLinkResources
  • Operation Id: AppServiceEnvironments_GetPrivateLinkResources
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
GetPrivateLinkResourcesAsync(CancellationToken)

Description for Gets the private link resources

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateLinkResources
  • Operation Id: AppServiceEnvironments_GetPrivateLinkResources
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
GetRecommendedRulesForHostingEnvironmentRecommendations(Nullable<Boolean>, String, CancellationToken)

Description for Get all recommendations for a hosting environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations
  • Operation Id: Recommendations_ListRecommendedRulesForHostingEnvironment
  • Default Api Version: 2023-12-01
  • Resource: HostingEnvironmentRecommendationResource
GetRecommendedRulesForHostingEnvironmentRecommendationsAsync(Nullable<Boolean>, String, CancellationToken)

Description for Get all recommendations for a hosting environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations
  • Operation Id: Recommendations_ListRecommendedRulesForHostingEnvironment
  • Default Api Version: 2023-12-01
  • Resource: HostingEnvironmentRecommendationResource
GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
GetUsages(String, CancellationToken)

Description for Get global usage metrics of an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages
  • Operation Id: AppServiceEnvironments_ListUsages
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
GetUsagesAsync(String, CancellationToken)

Description for Get global usage metrics of an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages
  • Operation Id: AppServiceEnvironments_ListUsages
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
GetVipInfo(CancellationToken)

Description for Get IP addresses assigned to an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip
  • Operation Id: AppServiceEnvironments_GetVipInfo
  • Default Api Version: 2023-12-01
GetVipInfoAsync(CancellationToken)

Description for Get IP addresses assigned to an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip
  • Operation Id: AppServiceEnvironments_GetVipInfo
  • Default Api Version: 2023-12-01
Reboot(CancellationToken)

Description for Reboot all machines in an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot
  • Operation Id: AppServiceEnvironments_Reboot
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
RebootAsync(CancellationToken)

Description for Reboot all machines in an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot
  • Operation Id: AppServiceEnvironments_Reboot
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
ResetAllFiltersForHostingEnvironmentRecommendation(String, CancellationToken)

Description for Reset all recommendation opt-out settings for an app.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/reset
  • Operation Id: Recommendations_ResetAllFiltersForHostingEnvironment
  • Default Api Version: 2023-12-01
ResetAllFiltersForHostingEnvironmentRecommendationAsync(String, CancellationToken)

Description for Reset all recommendation opt-out settings for an app.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/reset
  • Operation Id: Recommendations_ResetAllFiltersForHostingEnvironment
  • Default Api Version: 2023-12-01
TestUpgradeAvailableNotification(CancellationToken)

Send a test notification that an upgrade is available for this App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/testUpgradeAvailableNotification
  • Operation Id: AppServiceEnvironments_TestUpgradeAvailableNotification
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
TestUpgradeAvailableNotificationAsync(CancellationToken)

Send a test notification that an upgrade is available for this App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/testUpgradeAvailableNotification
  • Operation Id: AppServiceEnvironments_TestUpgradeAvailableNotification
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
Update(AppServiceEnvironmentPatch, CancellationToken)

Description for Create or update an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
  • Operation Id: AppServiceEnvironments_Update
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
UpdateAsync(AppServiceEnvironmentPatch, CancellationToken)

Description for Create or update an App Service Environment.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
  • Operation Id: AppServiceEnvironments_Update
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
Upgrade(WaitUntil, CancellationToken)

Description for Initiate an upgrade of an App Service Environment if one is available.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/upgrade
  • Operation Id: AppServiceEnvironments_Upgrade
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource
UpgradeAsync(WaitUntil, CancellationToken)

Description for Initiate an upgrade of an App Service Environment if one is available.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/upgrade
  • Operation Id: AppServiceEnvironments_Upgrade
  • Default Api Version: 2023-12-01
  • Resource: AppServiceEnvironmentResource

Explicit Interface Implementations

IJsonModel<AppServiceEnvironmentData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<AppServiceEnvironmentData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<AppServiceEnvironmentData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<AppServiceEnvironmentData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<AppServiceEnvironmentData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Extension Methods

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.

GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead.

GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead.

GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.

GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.

GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.

GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.

GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.

GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.

GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead.

GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.

GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead.

GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead.

Applies to