DataShareResource Class

Definition

Namespace:: Azure.ResourceManager.DataShare

Assembly:: Azure.ResourceManager.DataShare.dll

Package:: Azure.ResourceManager.DataShare v1.1.2

Package:: Azure.ResourceManager.DataShare v1.1.0-beta.1

Source:: DataShareResource.cs

Source:: DataShareResource.cs

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 DataShare along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a DataShareResource from an instance of ArmClient using the GetDataShareResource method. Otherwise you can get one from its parent resource DataShareAccountResource using the GetDataShare method.

public class DataShareResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataShare.DataShareData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataShare.DataShareData>

public class DataShareResource : Azure.ResourceManager.ArmResource

type DataShareResource = class
    inherit ArmResource
    interface IJsonModel<DataShareData>
    interface IPersistableModel<DataShareData>

type DataShareResource = class
    inherit ArmResource

Public Class DataShareResource
Inherits ArmResource
Implements IJsonModel(Of DataShareData), IPersistableModel(Of DataShareData)

Public Class DataShareResource
Inherits ArmResource

Inheritance: Object

ArmResource
DataShareResource

Implements: IJsonModel<DataShareData> IPersistableModel<DataShareData> IPersistableModel<T>

Constructors

Name	Description
DataShareResource()	Initializes a new instance of the DataShareResource class for mocking.

Fields

Name	Description
ResourceType	Gets the resource type for the operations.

Properties

Name	Description
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

Name	Description
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, String)	Generate the resource identifier of a DataShareResource instance.
Delete(WaitUntil, CancellationToken)	Delete a share Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName} Operation Id: Shares_Delete Default Api Version: 2021-08-01 Resource: DataShareResource
DeleteAsync(WaitUntil, CancellationToken)	Delete a share Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName} Operation Id: Shares_Delete Default Api Version: 2021-08-01 Resource: DataShareResource
Get(CancellationToken)	Get a share Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName} Operation Id: Shares_Get Default Api Version: 2021-08-01 Resource: DataShareResource
GetAsync(CancellationToken)	Get a share Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName} Operation Id: Shares_Get Default Api Version: 2021-08-01 Resource: DataShareResource
GetAvailableLocations(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetDataShareInvitation(String, CancellationToken)	Get an invitation in a share Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations/{invitationName} Operation Id: Invitations_Get Default Api Version: 2021-08-01 Resource: DataShareInvitationResource
GetDataShareInvitationAsync(String, CancellationToken)	Get an invitation in a share Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations/{invitationName} Operation Id: Invitations_Get Default Api Version: 2021-08-01 Resource: DataShareInvitationResource
GetDataShareInvitations()	Gets a collection of DataShareInvitationResources in the DataShare.
GetDataShareSynchronizationSetting(String, CancellationToken)	Get a synchronizationSetting in a share Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/synchronizationSettings/{synchronizationSettingName} Operation Id: SynchronizationSettings_Get Default Api Version: 2021-08-01 Resource: DataShareSynchronizationSettingResource
GetDataShareSynchronizationSettingAsync(String, CancellationToken)	Get a synchronizationSetting in a share Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/synchronizationSettings/{synchronizationSettingName} Operation Id: SynchronizationSettings_Get Default Api Version: 2021-08-01 Resource: DataShareSynchronizationSettingResource
GetDataShareSynchronizationSettings()	Gets a collection of DataShareSynchronizationSettingResources in the DataShare.
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)
GetProviderShareSubscription(String, CancellationToken)	Get share subscription in a provider share Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId} Operation Id: ProviderShareSubscriptions_GetByShare Default Api Version: 2021-08-01 Resource: ProviderShareSubscriptionResource
GetProviderShareSubscriptionAsync(String, CancellationToken)	Get share subscription in a provider share Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId} Operation Id: ProviderShareSubscriptions_GetByShare Default Api Version: 2021-08-01 Resource: ProviderShareSubscriptionResource
GetProviderShareSubscriptions()	Gets a collection of ProviderShareSubscriptionResources in the DataShare.
GetShareDataSet(String, CancellationToken)	Get a DataSet in a share Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/dataSets/{dataSetName} Operation Id: DataSets_Get Default Api Version: 2021-08-01 Resource: ShareDataSetResource
GetShareDataSetAsync(String, CancellationToken)	Get a DataSet in a share Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/dataSets/{dataSetName} Operation Id: DataSets_Get Default Api Version: 2021-08-01 Resource: ShareDataSetResource
GetShareDataSets()	Gets a collection of ShareDataSetResources in the DataShare.
GetSynchronizationDetails(ShareSynchronization, String, String, String, CancellationToken)	List synchronization details Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizationDetails Operation Id: Shares_ListSynchronizationDetails Default Api Version: 2021-08-01 Resource: DataShareResource
GetSynchronizationDetailsAsync(ShareSynchronization, String, String, String, CancellationToken)	List synchronization details Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizationDetails Operation Id: Shares_ListSynchronizationDetails Default Api Version: 2021-08-01 Resource: DataShareResource
GetSynchronizations(String, String, String, CancellationToken)	List synchronizations of a share Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizations Operation Id: Shares_ListSynchronizations Default Api Version: 2021-08-01 Resource: DataShareResource
GetSynchronizationsAsync(String, String, String, CancellationToken)	List synchronizations of a share Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizations Operation Id: Shares_ListSynchronizations Default Api Version: 2021-08-01 Resource: DataShareResource
GetTagResource()	Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource)
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmResource)
Update(WaitUntil, DataShareData, CancellationToken)	Create a share Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName} Operation Id: Shares_Create Default Api Version: 2021-08-01 Resource: DataShareResource
UpdateAsync(WaitUntil, DataShareData, CancellationToken)	Create a share Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName} Operation Id: Shares_Create Default Api Version: 2021-08-01 Resource: DataShareResource

Explicit Interface Implementations

Name	Description
IJsonModel<DataShareData>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<DataShareData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<DataShareData>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<DataShareData>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<DataShareData>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Extension Methods

Name	Description
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitions(ArmResource)	Gets a collection of AuthorizationRoleDefinitionCollection objects within the specified scope.
GetDenyAssignment(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignments(ArmResource)	Gets a collection of DenyAssignmentCollection objects within the specified scope.
GetLinkerResource(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource <item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource <item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)	Gets a collection of LinkerResources in the ArmResource. <item>MockingTo mock this method, please mock GetLinkerResources() instead.</item>
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 RoleAssignmentCollection objects within the specified scope.
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 RoleAssignmentScheduleInstanceCollection objects within the specified scope.
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 RoleAssignmentScheduleRequestCollection objects within the specified scope.
GetRoleAssignmentSchedules(ArmResource)	Gets a collection of RoleAssignmentScheduleCollection objects within the specified scope.
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 RoleEligibilityScheduleInstanceCollection objects within the specified scope.
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 RoleEligibilityScheduleRequestCollection objects within the specified scope.
GetRoleEligibilitySchedules(ArmResource)	Gets a collection of RoleEligibilityScheduleCollection objects within the specified scope.
GetRoleManagementPolicies(ArmResource)	Gets a collection of RoleManagementPolicyCollection objects within the specified scope.
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 RoleManagementPolicyAssignmentCollection objects within the specified scope.
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 scope.

Applies to

Feedback

Was this page helpful?