Share via

NetworkWatcherResource Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.Network
Assembly:
Azure.ResourceManager.Network.dll
Package:
Azure.ResourceManager.Network v1.9.0
Package:
Azure.ResourceManager.Network v1.6.0-beta.1
Source:
NetworkWatcherResource.cs
Source:
NetworkWatcherResource.cs

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

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

Constructors

NetworkWatcherResource()

Initializes a new instance of the NetworkWatcherResource 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.Network/networkWatchers/{networkWatcherName}
  • Operation Id: NetworkWatchers_Get
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}
  • Operation Id: NetworkWatchers_Get
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
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)
CheckConnectivity(WaitUntil, ConnectivityContent, CancellationToken)

Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint including another VM or an arbitrary remote server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectivityCheck
  • Operation Id: NetworkWatchers_CheckConnectivity
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
CheckConnectivityAsync(WaitUntil, ConnectivityContent, CancellationToken)

Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint including another VM or an arbitrary remote server.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectivityCheck
  • Operation Id: NetworkWatchers_CheckConnectivity
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
CreateResourceIdentifier(String, String, String)

Generate the resource identifier of a NetworkWatcherResource instance.
Delete(WaitUntil, CancellationToken)

Deletes the specified network watcher resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}
  • Operation Id: NetworkWatchers_Delete
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
DeleteAsync(WaitUntil, CancellationToken)

Deletes the specified network watcher resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}
  • Operation Id: NetworkWatchers_Delete
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
Get(CancellationToken)

Gets the specified network watcher by resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}
  • Operation Id: NetworkWatchers_Get
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
GetAsync(CancellationToken)

Gets the specified network watcher by resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}
  • Operation Id: NetworkWatchers_Get
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableProviders(WaitUntil, AvailableProvidersListContent, CancellationToken)

NOTE: This feature is currently in preview and still being tested for stability. Lists all available internet service providers for a specified Azure region.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/availableProvidersList
  • Operation Id: NetworkWatchers_ListAvailableProviders
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
GetAvailableProvidersAsync(WaitUntil, AvailableProvidersListContent, CancellationToken)

NOTE: This feature is currently in preview and still being tested for stability. Lists all available internet service providers for a specified Azure region.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/availableProvidersList
  • Operation Id: NetworkWatchers_ListAvailableProviders
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
GetAzureReachabilityReport(WaitUntil, AzureReachabilityReportContent, CancellationToken)

NOTE: This feature is currently in preview and still being tested for stability. Gets the relative latency score for internet service providers from a specified location to Azure regions.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/azureReachabilityReport
  • Operation Id: NetworkWatchers_GetAzureReachabilityReport
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
GetAzureReachabilityReportAsync(WaitUntil, AzureReachabilityReportContent, CancellationToken)

NOTE: This feature is currently in preview and still being tested for stability. Gets the relative latency score for internet service providers from a specified location to Azure regions.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/azureReachabilityReport
  • Operation Id: NetworkWatchers_GetAzureReachabilityReport
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
GetConnectionMonitor(String, CancellationToken)

Gets a connection monitor by name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}
  • Operation Id: ConnectionMonitors_Get
  • Default Api Version: 2024-03-01
  • Resource: ConnectionMonitorResource
GetConnectionMonitorAsync(String, CancellationToken)

Gets a connection monitor by name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}
  • Operation Id: ConnectionMonitors_Get
  • Default Api Version: 2024-03-01
  • Resource: ConnectionMonitorResource
GetConnectionMonitors()

Gets a collection of ConnectionMonitorResources in the NetworkWatcher.
GetFlowLog(String, CancellationToken)

Gets a flow log resource by name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs/{flowLogName}
  • Operation Id: FlowLogs_Get
  • Default Api Version: 2024-03-01
  • Resource: FlowLogResource
GetFlowLogAsync(String, CancellationToken)

Gets a flow log resource by name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs/{flowLogName}
  • Operation Id: FlowLogs_Get
  • Default Api Version: 2024-03-01
  • Resource: FlowLogResource
GetFlowLogs()

Gets a collection of FlowLogResources in the NetworkWatcher.
GetFlowLogStatus(WaitUntil, FlowLogStatusContent, CancellationToken)

Queries status of flow log and traffic analytics (optional) on a specified resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryFlowLogStatus
  • Operation Id: NetworkWatchers_GetFlowLogStatus
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
GetFlowLogStatusAsync(WaitUntil, FlowLogStatusContent, CancellationToken)

Queries status of flow log and traffic analytics (optional) on a specified resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryFlowLogStatus
  • Operation Id: NetworkWatchers_GetFlowLogStatus
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
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)
GetNetworkConfigurationDiagnostic(WaitUntil, NetworkConfigurationDiagnosticContent, CancellationToken)

Gets Network Configuration Diagnostic data to help customers understand and debug network behavior. It provides detailed information on what security rules were applied to a specified traffic flow and the result of evaluating these rules. Customers must provide details of a flow like source, destination, protocol, etc. The API returns whether traffic was allowed or denied, the rules evaluated for the specified flow and the evaluation results.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/networkConfigurationDiagnostic
  • Operation Id: NetworkWatchers_GetNetworkConfigurationDiagnostic
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
GetNetworkConfigurationDiagnosticAsync(WaitUntil, NetworkConfigurationDiagnosticContent, CancellationToken)

Gets Network Configuration Diagnostic data to help customers understand and debug network behavior. It provides detailed information on what security rules were applied to a specified traffic flow and the result of evaluating these rules. Customers must provide details of a flow like source, destination, protocol, etc. The API returns whether traffic was allowed or denied, the rules evaluated for the specified flow and the evaluation results.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/networkConfigurationDiagnostic
  • Operation Id: NetworkWatchers_GetNetworkConfigurationDiagnostic
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
GetNextHop(WaitUntil, NextHopContent, CancellationToken)

Gets the next hop from the specified VM.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/nextHop
  • Operation Id: NetworkWatchers_GetNextHop
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
GetNextHopAsync(WaitUntil, NextHopContent, CancellationToken)

Gets the next hop from the specified VM.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/nextHop
  • Operation Id: NetworkWatchers_GetNextHop
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
GetPacketCapture(String, CancellationToken)

Gets a packet capture session by name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}
  • Operation Id: PacketCaptures_Get
  • Default Api Version: 2024-03-01
  • Resource: PacketCaptureResource
GetPacketCaptureAsync(String, CancellationToken)

Gets a packet capture session by name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}
  • Operation Id: PacketCaptures_Get
  • Default Api Version: 2024-03-01
  • Resource: PacketCaptureResource
GetPacketCaptures()

Gets a collection of PacketCaptureResources in the NetworkWatcher.
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)
GetTopology(TopologyContent, CancellationToken)

Gets the current network topology by resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/topology
  • Operation Id: NetworkWatchers_GetTopology
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
GetTopologyAsync(TopologyContent, CancellationToken)

Gets the current network topology by resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/topology
  • Operation Id: NetworkWatchers_GetTopology
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
GetTroubleshooting(WaitUntil, TroubleshootingContent, CancellationToken)

Initiate troubleshooting on a specified resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/troubleshoot
  • Operation Id: NetworkWatchers_GetTroubleshooting
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
GetTroubleshootingAsync(WaitUntil, TroubleshootingContent, CancellationToken)

Initiate troubleshooting on a specified resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/troubleshoot
  • Operation Id: NetworkWatchers_GetTroubleshooting
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
GetTroubleshootingResult(WaitUntil, QueryTroubleshootingContent, CancellationToken)

Get the last completed troubleshooting result on a specified resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryTroubleshootResult
  • Operation Id: NetworkWatchers_GetTroubleshootingResult
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
GetTroubleshootingResultAsync(WaitUntil, QueryTroubleshootingContent, CancellationToken)

Get the last completed troubleshooting result on a specified resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryTroubleshootResult
  • Operation Id: NetworkWatchers_GetTroubleshootingResult
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
GetVmSecurityRules(WaitUntil, SecurityGroupViewContent, CancellationToken)

Gets the configured and effective security group rules on the specified VM.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/securityGroupView
  • Operation Id: NetworkWatchers_GetVmSecurityRules
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
GetVmSecurityRulesAsync(WaitUntil, SecurityGroupViewContent, CancellationToken)

Gets the configured and effective security group rules on the specified VM.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/securityGroupView
  • Operation Id: NetworkWatchers_GetVmSecurityRules
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}
  • Operation Id: NetworkWatchers_Get
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}
  • Operation Id: NetworkWatchers_Get
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
SetFlowLogConfiguration(WaitUntil, FlowLogInformation, CancellationToken)

Configures flow log and traffic analytics (optional) on a specified resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/configureFlowLog
  • Operation Id: NetworkWatchers_SetFlowLogConfiguration
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
SetFlowLogConfigurationAsync(WaitUntil, FlowLogInformation, CancellationToken)

Configures flow log and traffic analytics (optional) on a specified resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/configureFlowLog
  • Operation Id: NetworkWatchers_SetFlowLogConfiguration
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}
  • Operation Id: NetworkWatchers_Get
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}
  • Operation Id: NetworkWatchers_Get
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
TryGetApiVersion(ResourceType, String)

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

(Inherited from ArmResource)
Update(NetworkTagsObject, CancellationToken)

Updates a network watcher tags.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}
  • Operation Id: NetworkWatchers_UpdateTags
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
UpdateAsync(NetworkTagsObject, CancellationToken)

Updates a network watcher tags.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}
  • Operation Id: NetworkWatchers_UpdateTags
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
VerifyIPFlow(WaitUntil, VerificationIPFlowContent, CancellationToken)

Verify IP flow from the specified VM to a location given the currently configured NSG rules.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/ipFlowVerify
  • Operation Id: NetworkWatchers_VerifyIPFlow
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource
VerifyIPFlowAsync(WaitUntil, VerificationIPFlowContent, CancellationToken)

Verify IP flow from the specified VM to a location given the currently configured NSG rules.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/ipFlowVerify
  • Operation Id: NetworkWatchers_VerifyIPFlow
  • Default Api Version: 2024-03-01
  • Resource: NetworkWatcherResource

Explicit Interface Implementations

IJsonModel<NetworkWatcherData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

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

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