AppServiceEnvironmentResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
- 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.
|
DeleteAsync(WaitUntil, Nullable<Boolean>, CancellationToken) |
Description for Delete an App Service Environment.
|
DisableAllForHostingEnvironmentRecommendation(String, CancellationToken) |
Description for Disable all recommendations for an app.
|
DisableAllForHostingEnvironmentRecommendationAsync(String, CancellationToken) |
Description for Disable all recommendations for an app.
|
Get(CancellationToken) |
Description for Get the properties of an App Service Environment.
|
GetAllWebAppData(String, CancellationToken) |
Description for Get all apps in an App Service Environment.
|
GetAllWebAppDataAsync(String, CancellationToken) |
Description for Get all apps in an App Service Environment.
|
GetAppServicePlans(CancellationToken) |
Description for Get all App Service plans in an App Service Environment.
|
GetAppServicePlansAsync(CancellationToken) |
Description for Get all App Service plans in an App Service Environment.
|
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.
|
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.
|
GetCapacitiesAsync(CancellationToken) |
Description for Get the used, available, and total worker capacity an App Service Environment.
|
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.
|
GetDiagnosticsAsync(CancellationToken) |
Description for Get diagnostic information for an App Service Environment.
|
GetDiagnosticsItem(String, CancellationToken) |
Description for Get a diagnostics item for an App Service Environment.
|
GetDiagnosticsItemAsync(String, CancellationToken) |
Description for Get a diagnostics item for an App Service Environment.
|
GetHistoryForHostingEnvironmentRecommendations(Nullable<Boolean>, String, CancellationToken) |
Description for Get past recommendations for an app, optionally specified by the time range.
|
GetHistoryForHostingEnvironmentRecommendationsAsync(Nullable<Boolean>, String, CancellationToken) |
Description for Get past recommendations for an app, optionally specified by the time range.
|
GetHostingEnvironmentDetector(String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, String, CancellationToken) |
Description for Get Hosting Environment Detector Response
|
GetHostingEnvironmentDetectorAsync(String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, String, CancellationToken) |
Description for Get Hosting Environment Detector Response
|
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
|
GetHostingEnvironmentPrivateEndpointConnectionAsync(String, CancellationToken) |
Description for Gets a private endpoint connection
|
GetHostingEnvironmentPrivateEndpointConnections() |
Gets a collection of HostingEnvironmentPrivateEndpointConnectionResources in the AppServiceEnvironment. |
GetHostingEnvironmentRecommendation(String, Nullable<Boolean>, String, CancellationToken) |
Description for Get a recommendation rule for an app.
|
GetHostingEnvironmentRecommendationAsync(String, Nullable<Boolean>, String, CancellationToken) |
Description for Get a recommendation rule for an app.
|
GetHostingEnvironmentRecommendations() |
Gets a collection of HostingEnvironmentRecommendationResources in the AppServiceEnvironment. |
GetHostingEnvironmentWorkerPool(String, CancellationToken) |
Description for Get properties of a worker pool.
|
GetHostingEnvironmentWorkerPoolAsync(String, CancellationToken) |
Description for Get properties of a worker pool.
|
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.
|
GetInboundNetworkDependenciesEndpointsAsync(CancellationToken) |
Description for Get the network endpoints of all inbound dependencies of an App Service Environment.
|
GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
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.
|
GetOperationsAsync(CancellationToken) |
Description for List all currently running operations on the App Service Environment.
|
GetOutboundNetworkDependenciesEndpoints(CancellationToken) |
Description for Get the network endpoints of all outbound dependencies of an App Service Environment.
|
GetOutboundNetworkDependenciesEndpointsAsync(CancellationToken) |
Description for Get the network endpoints of all outbound dependencies of an App Service Environment.
|
GetPolicyAssignment(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
GetPolicyAssignments() |
Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource) |
GetPrivateLinkResources(CancellationToken) |
Description for Gets the private link resources
|
GetPrivateLinkResourcesAsync(CancellationToken) |
Description for Gets the private link resources
|
GetRecommendedRulesForHostingEnvironmentRecommendations(Nullable<Boolean>, String, CancellationToken) |
Description for Get all recommendations for a hosting environment.
|
GetRecommendedRulesForHostingEnvironmentRecommendationsAsync(Nullable<Boolean>, String, CancellationToken) |
Description for Get all recommendations for a hosting environment.
|
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.
|
GetUsagesAsync(String, CancellationToken) |
Description for Get global usage metrics of an App Service Environment.
|
GetVipInfo(CancellationToken) |
Description for Get IP addresses assigned to an App Service Environment.
|
GetVipInfoAsync(CancellationToken) |
Description for Get IP addresses assigned to an App Service Environment.
|
Reboot(CancellationToken) |
Description for Reboot all machines in an App Service Environment.
|
RebootAsync(CancellationToken) |
Description for Reboot all machines in an App Service Environment.
|
ResetAllFiltersForHostingEnvironmentRecommendation(String, CancellationToken) |
Description for Reset all recommendation opt-out settings for an app.
|
ResetAllFiltersForHostingEnvironmentRecommendationAsync(String, CancellationToken) |
Description for Reset all recommendation opt-out settings for an app.
|
TestUpgradeAvailableNotification(CancellationToken) |
Send a test notification that an upgrade is available for this App Service Environment.
|
TestUpgradeAvailableNotificationAsync(CancellationToken) |
Send a test notification that an upgrade is available for this App Service Environment.
|
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.
|
UpdateAsync(AppServiceEnvironmentPatch, CancellationToken) |
Description for Create or update an App Service Environment.
|
Upgrade(WaitUntil, CancellationToken) |
Description for Initiate an upgrade of an App Service Environment if one is available.
|
UpgradeAsync(WaitUntil, CancellationToken) |
Description for Initiate an upgrade of an App Service Environment if one is available.
|
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).
|
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
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.
|
GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
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.
|
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
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
|
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
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.
|
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
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
|
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
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.
|
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
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
|
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
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
|
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.
|
GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResources(ArmResource) |
Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead. |