Share via

AppPlatformServiceResource Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.AppPlatform
Assembly:
Azure.ResourceManager.AppPlatform.dll
Package:
Azure.ResourceManager.AppPlatform v1.1.1
Package:
Azure.ResourceManager.AppPlatform v1.1.0-beta.2
Source:
AppPlatformServiceResource.cs
Source:
AppPlatformServiceResource.cs

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

public class AppPlatformServiceResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.AppPlatform.AppPlatformServiceData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.AppPlatform.AppPlatformServiceData>
public class AppPlatformServiceResource : Azure.ResourceManager.ArmResource
type AppPlatformServiceResource = class
    inherit ArmResource
    interface IJsonModel<AppPlatformServiceData>
    interface IPersistableModel<AppPlatformServiceData>
type AppPlatformServiceResource = class
    inherit ArmResource
Public Class AppPlatformServiceResource
Inherits ArmResource
Implements IJsonModel(Of AppPlatformServiceData), IPersistableModel(Of AppPlatformServiceData)
Public Class AppPlatformServiceResource
Inherits ArmResource
Inheritance
Object
ArmResource
AppPlatformServiceResource
Implements
IJsonModel<AppPlatformServiceData> IPersistableModel<AppPlatformServiceData> IPersistableModel<T>

Constructors

AppPlatformServiceResource()

Initializes a new instance of the AppPlatformServiceResource 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

AddTag(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}
  • Operation Id: Services_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}
  • Operation Id: Services_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
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 AppPlatformServiceResource instance.
Delete(WaitUntil, CancellationToken)

Operation to delete a Service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}
  • Operation Id: Services_Delete
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
DeleteAsync(WaitUntil, CancellationToken)

Operation to delete a Service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}
  • Operation Id: Services_Delete
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
DisableTestEndpoint(CancellationToken)

Disable test endpoint functionality for a Service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/disableTestEndpoint
  • Operation Id: Services_DisableTestEndpoint
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
DisableTestEndpointAsync(CancellationToken)

Disable test endpoint functionality for a Service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/disableTestEndpoint
  • Operation Id: Services_DisableTestEndpoint
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
EnableTestEndpoint(CancellationToken)

Enable test endpoint functionality for a Service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/enableTestEndpoint
  • Operation Id: Services_EnableTestEndpoint
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
EnableTestEndpointAsync(CancellationToken)

Enable test endpoint functionality for a Service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/enableTestEndpoint
  • Operation Id: Services_EnableTestEndpoint
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
Get(CancellationToken)

Get a Service and its properties.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}
  • Operation Id: Services_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
GetAppPlatformApiPortal(String, CancellationToken)

Get the API portal and its properties.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}
  • Operation Id: ApiPortals_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformApiPortalResource
GetAppPlatformApiPortalAsync(String, CancellationToken)

Get the API portal and its properties.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apiPortals/{apiPortalName}
  • Operation Id: ApiPortals_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformApiPortalResource
GetAppPlatformApiPortals()

Gets a collection of AppPlatformApiPortalResources in the AppPlatformService.
GetAppPlatformApp(String, String, CancellationToken)

Get an App and its properties.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}
  • Operation Id: Apps_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformAppResource
GetAppPlatformAppAsync(String, String, CancellationToken)

Get an App and its properties.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}
  • Operation Id: Apps_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformAppResource
GetAppPlatformApps()

Gets a collection of AppPlatformAppResources in the AppPlatformService.
GetAppPlatformBuildService(String, CancellationToken)

Get a build service resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}
  • Operation Id: BuildService_GetBuildService
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformBuildServiceResource
GetAppPlatformBuildServiceAsync(String, CancellationToken)

Get a build service resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/buildServices/{buildServiceName}
  • Operation Id: BuildService_GetBuildService
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformBuildServiceResource
GetAppPlatformBuildServices()

Gets a collection of AppPlatformBuildServiceResources in the AppPlatformService.
GetAppPlatformCertificate(String, CancellationToken)

Get the certificate resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates/{certificateName}
  • Operation Id: Certificates_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformCertificateResource
GetAppPlatformCertificateAsync(String, CancellationToken)

Get the certificate resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates/{certificateName}
  • Operation Id: Certificates_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformCertificateResource
GetAppPlatformCertificates()

Gets a collection of AppPlatformCertificateResources in the AppPlatformService.
GetAppPlatformConfigServer()

Gets an object representing a AppPlatformConfigServerResource along with the instance operations that can be performed on it in the AppPlatformService.
GetAppPlatformConfigurationService(String, CancellationToken)

Get the Application Configuration Service and its properties.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices/{configurationServiceName}
  • Operation Id: ConfigurationServices_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformConfigurationServiceResource
GetAppPlatformConfigurationServiceAsync(String, CancellationToken)

Get the Application Configuration Service and its properties.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configurationServices/{configurationServiceName}
  • Operation Id: ConfigurationServices_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformConfigurationServiceResource
GetAppPlatformConfigurationServices()

Gets a collection of AppPlatformConfigurationServiceResources in the AppPlatformService.
GetAppPlatformGateway(String, CancellationToken)

Get the Spring Cloud Gateway and its properties.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}
  • Operation Id: Gateways_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformGatewayResource
GetAppPlatformGatewayAsync(String, CancellationToken)

Get the Spring Cloud Gateway and its properties.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}
  • Operation Id: Gateways_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformGatewayResource
GetAppPlatformGateways()

Gets a collection of AppPlatformGatewayResources in the AppPlatformService.
GetAppPlatformMonitoringSetting()

Gets an object representing a AppPlatformMonitoringSettingResource along with the instance operations that can be performed on it in the AppPlatformService.
GetAppPlatformServiceRegistries()

Gets a collection of AppPlatformServiceRegistryResources in the AppPlatformService.
GetAppPlatformServiceRegistry(String, CancellationToken)

Get the Service Registry and its properties.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/serviceRegistries/{serviceRegistryName}
  • Operation Id: ServiceRegistries_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceRegistryResource
GetAppPlatformServiceRegistryAsync(String, CancellationToken)

Get the Service Registry and its properties.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/serviceRegistries/{serviceRegistryName}
  • Operation Id: ServiceRegistries_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceRegistryResource
GetAppPlatformStorage(String, CancellationToken)

Get the storage resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/storages/{storageName}
  • Operation Id: Storages_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformStorageResource
GetAppPlatformStorageAsync(String, CancellationToken)

Get the storage resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/storages/{storageName}
  • Operation Id: Storages_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformStorageResource
GetAppPlatformStorages()

Gets a collection of AppPlatformStorageResources in the AppPlatformService.
GetAsync(CancellationToken)

Get a Service and its properties.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}
  • Operation Id: Services_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetDeployments(IEnumerable<String>, CancellationToken)

List deployments for a certain service

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/deployments
  • Operation Id: Deployments_ListForCluster
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformDeploymentResource
GetDeploymentsAsync(IEnumerable<String>, CancellationToken)

List deployments for a certain service

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/deployments
  • Operation Id: Deployments_ListForCluster
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformDeploymentResource
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)
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)
GetTagResource()

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

(Inherited from ArmResource)
GetTestKeys(CancellationToken)

List test keys for a Service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/listTestKeys
  • Operation Id: Services_ListTestKeys
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
GetTestKeysAsync(CancellationToken)

List test keys for a Service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/listTestKeys
  • Operation Id: Services_ListTestKeys
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
RegenerateTestKey(RegenerateAppPlatformServiceTestKeyContent, CancellationToken)

Regenerate a test key for a Service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/regenerateTestKey
  • Operation Id: Services_RegenerateTestKey
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
RegenerateTestKeyAsync(RegenerateAppPlatformServiceTestKeyContent, CancellationToken)

Regenerate a test key for a Service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/regenerateTestKey
  • Operation Id: Services_RegenerateTestKey
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}
  • Operation Id: Services_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}
  • Operation Id: Services_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}
  • Operation Id: Services_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}
  • Operation Id: Services_Get
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
Start(WaitUntil, CancellationToken)

Start a Service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/start
  • Operation Id: Services_Start
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
StartAsync(WaitUntil, CancellationToken)

Start a Service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/start
  • Operation Id: Services_Start
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
Stop(WaitUntil, CancellationToken)

Stop a Service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/stop
  • Operation Id: Services_Stop
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
StopAsync(WaitUntil, CancellationToken)

Stop a Service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/stop
  • Operation Id: Services_Stop
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
TryGetApiVersion(ResourceType, String)

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

(Inherited from ArmResource)
Update(WaitUntil, AppPlatformServiceData, CancellationToken)

Operation to update an exiting Service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}
  • Operation Id: Services_Update
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
UpdateAsync(WaitUntil, AppPlatformServiceData, CancellationToken)

Operation to update an exiting Service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}
  • Operation Id: Services_Update
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformServiceResource
ValidateConfigServer(WaitUntil, ConfigServerSettings, CancellationToken)

Check if the config server settings are valid.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configServers/validate
  • Operation Id: ConfigServers_Validate
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformConfigServerResource
ValidateConfigServerAsync(WaitUntil, ConfigServerSettings, CancellationToken)

Check if the config server settings are valid.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/configServers/validate
  • Operation Id: ConfigServers_Validate
  • Default Api Version: 2022-12-01
  • Resource: AppPlatformConfigServerResource

Explicit Interface Implementations

IJsonModel<AppPlatformServiceData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<AppPlatformServiceData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<AppPlatformServiceData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<AppPlatformServiceData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<AppPlatformServiceData>.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