DataFactoryResource 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 a DataFactory along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a DataFactoryResource from an instance of ArmClient using the GetDataFactoryResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetDataFactory method.
public class DataFactoryResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.DataFactoryData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.DataFactoryData>
public class DataFactoryResource : Azure.ResourceManager.ArmResource
type DataFactoryResource = class
inherit ArmResource
interface IJsonModel<DataFactoryData>
interface IPersistableModel<DataFactoryData>
type DataFactoryResource = class
inherit ArmResource
Public Class DataFactoryResource
Inherits ArmResource
Implements IJsonModel(Of DataFactoryData), IPersistableModel(Of DataFactoryData)
Public Class DataFactoryResource
Inherits ArmResource
- Inheritance
- Implements
Constructors
DataFactoryResource() |
Initializes a new instance of the DataFactoryResource 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
AddDataFlowToDebugSession(DataFactoryDataFlowDebugPackageContent, CancellationToken) |
Add a data flow into debug session.
|
AddDataFlowToDebugSessionAsync(DataFactoryDataFlowDebugPackageContent, CancellationToken) |
Add a data flow into debug session.
|
AddTag(String, String, CancellationToken) |
Add a tag to the current resource.
|
AddTagAsync(String, String, CancellationToken) |
Add a tag to the current resource.
|
CancelPipelineRun(String, Nullable<Boolean>, CancellationToken) |
Cancel a pipeline run by its run ID.
|
CancelPipelineRunAsync(String, Nullable<Boolean>, CancellationToken) |
Cancel a pipeline run by its run ID.
|
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) |
CreateDataFlowDebugSession(WaitUntil, DataFactoryDataFlowDebugSessionContent, CancellationToken) |
Creates a data flow debug session.
|
CreateDataFlowDebugSessionAsync(WaitUntil, DataFactoryDataFlowDebugSessionContent, CancellationToken) |
Creates a data flow debug session.
|
CreateResourceIdentifier(String, String, String) |
Generate the resource identifier of a DataFactoryResource instance. |
Delete(WaitUntil, CancellationToken) |
Deletes a factory.
|
DeleteAsync(WaitUntil, CancellationToken) |
Deletes a factory.
|
DeleteDataFlowDebugSession(DeleteDataFlowDebugSessionContent, CancellationToken) |
Deletes a data flow debug session.
|
DeleteDataFlowDebugSessionAsync(DeleteDataFlowDebugSessionContent, CancellationToken) |
Deletes a data flow debug session.
|
ExecuteDataFlowDebugSessionCommand(WaitUntil, DataFlowDebugCommandContent, CancellationToken) |
Execute a data flow debug command.
|
ExecuteDataFlowDebugSessionCommandAsync(WaitUntil, DataFlowDebugCommandContent, CancellationToken) |
Execute a data flow debug command.
|
Get(String, CancellationToken) |
Gets a factory.
|
GetActivityRun(String, RunFilterContent, CancellationToken) |
Query activity runs based on input filter conditions.
|
GetActivityRunAsync(String, RunFilterContent, CancellationToken) |
Query activity runs based on input filter conditions.
|
GetAsync(String, CancellationToken) |
Gets a factory.
|
GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
GetDataFactoryChangeDataCapture(String, String, CancellationToken) |
Gets a change data capture.
|
GetDataFactoryChangeDataCaptureAsync(String, String, CancellationToken) |
Gets a change data capture.
|
GetDataFactoryChangeDataCaptures() |
Gets a collection of DataFactoryChangeDataCaptureResources in the DataFactory. |
GetDataFactoryDataFlow(String, String, CancellationToken) |
Gets a data flow.
|
GetDataFactoryDataFlowAsync(String, String, CancellationToken) |
Gets a data flow.
|
GetDataFactoryDataFlows() |
Gets a collection of DataFactoryDataFlowResources in the DataFactory. |
GetDataFactoryDataset(String, String, CancellationToken) |
Gets a dataset.
|
GetDataFactoryDatasetAsync(String, String, CancellationToken) |
Gets a dataset.
|
GetDataFactoryDatasets() |
Gets a collection of DataFactoryDatasetResources in the DataFactory. |
GetDataFactoryGlobalParameter(String, CancellationToken) |
Gets a Global parameter
|
GetDataFactoryGlobalParameterAsync(String, CancellationToken) |
Gets a Global parameter
|
GetDataFactoryGlobalParameters() |
Gets a collection of DataFactoryGlobalParameterResources in the DataFactory. |
GetDataFactoryIntegrationRuntime(String, String, CancellationToken) |
Gets an integration runtime.
|
GetDataFactoryIntegrationRuntimeAsync(String, String, CancellationToken) |
Gets an integration runtime.
|
GetDataFactoryIntegrationRuntimes() |
Gets a collection of DataFactoryIntegrationRuntimeResources in the DataFactory. |
GetDataFactoryLinkedService(String, String, CancellationToken) |
Gets a linked service.
|
GetDataFactoryLinkedServiceAsync(String, String, CancellationToken) |
Gets a linked service.
|
GetDataFactoryLinkedServices() |
Gets a collection of DataFactoryLinkedServiceResources in the DataFactory. |
GetDataFactoryManagedVirtualNetwork(String, String, CancellationToken) |
Gets a managed Virtual Network.
|
GetDataFactoryManagedVirtualNetworkAsync(String, String, CancellationToken) |
Gets a managed Virtual Network.
|
GetDataFactoryManagedVirtualNetworks() |
Gets a collection of DataFactoryManagedVirtualNetworkResources in the DataFactory. |
GetDataFactoryPipeline(String, String, CancellationToken) |
Gets a pipeline.
|
GetDataFactoryPipelineAsync(String, String, CancellationToken) |
Gets a pipeline.
|
GetDataFactoryPipelines() |
Gets a collection of DataFactoryPipelineResources in the DataFactory. |
GetDataFactoryPrivateEndpointConnection(String, String, CancellationToken) |
Gets a private endpoint connection
|
GetDataFactoryPrivateEndpointConnectionAsync(String, String, CancellationToken) |
Gets a private endpoint connection
|
GetDataFactoryPrivateEndpointConnections() |
Gets a collection of DataFactoryPrivateEndpointConnectionResources in the DataFactory. |
GetDataFactoryServiceCredential(String, String, CancellationToken) |
Gets a credential.
|
GetDataFactoryServiceCredentialAsync(String, String, CancellationToken) |
Gets a credential.
|
GetDataFactoryServiceCredentials() |
Gets a collection of DataFactoryServiceCredentialResources in the DataFactory. |
GetDataFactoryTrigger(String, String, CancellationToken) |
Gets a trigger.
|
GetDataFactoryTriggerAsync(String, String, CancellationToken) |
Gets a trigger.
|
GetDataFactoryTriggers() |
Gets a collection of DataFactoryTriggerResources in the DataFactory. |
GetDataFlowDebugSessions(CancellationToken) |
Query all active data flow debug sessions.
|
GetDataFlowDebugSessionsAsync(CancellationToken) |
Query all active data flow debug sessions.
|
GetDataPlaneAccess(DataFactoryDataPlaneUserAccessPolicy, CancellationToken) |
Get Data Plane access.
|
GetDataPlaneAccessAsync(DataFactoryDataPlaneUserAccessPolicy, CancellationToken) |
Get Data Plane access.
|
GetExposureControlFeature(ExposureControlContent, CancellationToken) |
Get exposure control feature for specific factory.
|
GetExposureControlFeatureAsync(ExposureControlContent, CancellationToken) |
Get exposure control feature for specific factory.
|
GetExposureControlFeatures(ExposureControlBatchContent, CancellationToken) |
Get list of exposure control features for specific factory.
|
GetExposureControlFeaturesAsync(ExposureControlBatchContent, CancellationToken) |
Get list of exposure control features for specific factory.
|
GetGitHubAccessToken(GitHubAccessTokenContent, CancellationToken) |
Get GitHub Access Token.
|
GetGitHubAccessTokenAsync(GitHubAccessTokenContent, CancellationToken) |
Get GitHub Access Token.
|
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) |
GetPipelineRun(String, CancellationToken) |
Get a pipeline run by its run ID.
|
GetPipelineRunAsync(String, CancellationToken) |
Get a pipeline run by its run ID.
|
GetPipelineRuns(RunFilterContent, CancellationToken) |
Query pipeline runs in the factory based on input filter conditions.
|
GetPipelineRunsAsync(RunFilterContent, CancellationToken) |
Query pipeline runs in the factory based on input filter conditions.
|
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) |
Gets the private link resources
|
GetPrivateLinkResourcesAsync(CancellationToken) |
Gets the private link resources
|
GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
GetTriggerRuns(RunFilterContent, CancellationToken) |
Query trigger runs.
|
GetTriggerRunsAsync(RunFilterContent, CancellationToken) |
Query trigger runs.
|
GetTriggers(TriggerFilterContent, CancellationToken) |
Query triggers.
|
GetTriggersAsync(TriggerFilterContent, CancellationToken) |
Query triggers.
|
RemoveTag(String, CancellationToken) |
Removes a tag by key from the resource.
|
RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource.
|
SetTags(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
SetTagsAsync(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
Update(DataFactoryPatch, CancellationToken) |
Updates a factory.
|
UpdateAsync(DataFactoryPatch, CancellationToken) |
Updates a factory.
|
Explicit Interface Implementations
IJsonModel<DataFactoryData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
IJsonModel<DataFactoryData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
IPersistableModel<DataFactoryData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
IPersistableModel<DataFactoryData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
IPersistableModel<DataFactoryData>.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. |