Class HealthcareApisServiceResource

A Class representing a HealthcareApisService along with the instance operations that can be performed on it. If you have a Azure.Core.ResourceIdentifier you can construct a HealthcareApisServiceResource from an instance of Azure.ResourceManager.ArmClient using the GetHealthcareApisServiceResource method. Otherwise you can get one from its parent resource Azure.ResourceManager.Resources.ResourceGroupResource using the GetHealthcareApisService method.

Inheritance
Azure.ResourceManager.ArmResource
HealthcareApisServiceResource
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.HealthcareApis.dll
Syntax
public class HealthcareApisServiceResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.HealthcareApis.HealthcareApisServiceData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.HealthcareApis.HealthcareApisServiceData>

Constructors

HealthcareApisServiceResource()

Initializes a new instance of the HealthcareApisServiceResource class for mocking.

Declaration
protected HealthcareApisServiceResource ();

Fields

ResourceType

Gets the resource type for the operations.

Declaration
public static readonly Azure.Core.ResourceType ResourceType;
Field Value
Azure.Core.ResourceType

Properties

Data

Gets the data representing this Feature.

Declaration
public virtual Azure.ResourceManager.HealthcareApis.HealthcareApisServiceData Data { get; }
Property Value
HealthcareApisServiceData

Exceptions
System.InvalidOperationException

Throws if there is no data loaded in the current instance.

HasData

Gets whether or not the current instance has data.

Declaration
public virtual bool HasData { get; }
Property Value
System.Boolean

Methods

AddTag(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
  • Operation IdServices_Get
  • Default Api Version2024-03-31
  • ResourceHealthcareApisServiceResource
Declaration
public virtual Azure.Response<Azure.ResourceManager.HealthcareApis.HealthcareApisServiceResource> AddTag (string key, string value, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String key

The key for the tag.
System.String value

The value for the tag.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
Azure.Response<HealthcareApisServiceResource>

Exceptions
System.ArgumentNullException

key or value is null.

AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
  • Operation IdServices_Get
  • Default Api Version2024-03-31
  • ResourceHealthcareApisServiceResource
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.HealthcareApis.HealthcareApisServiceResource>> AddTagAsync (string key, string value, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String key

The key for the tag.
System.String value

The value for the tag.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
System.Threading.Tasks.Task<Azure.Response<HealthcareApisServiceResource>>

Exceptions
System.ArgumentNullException

key or value is null.

CreateResourceIdentifier(String, String, String)

Generate the resource identifier of a HealthcareApisServiceResource instance.

Declaration
public static Azure.Core.ResourceIdentifier CreateResourceIdentifier (string subscriptionId, string resourceGroupName, string resourceName);
Parameters
System.String subscriptionId

The subscriptionId.
System.String resourceGroupName

The resourceGroupName.
System.String resourceName

The resourceName.
Returns
Azure.Core.ResourceIdentifier

Delete(WaitUntil, CancellationToken)

Delete a service instance.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
  • Operation IdServices_Delete
  • Default Api Version2024-03-31
  • ResourceHealthcareApisServiceResource
Declaration
public virtual Azure.ResourceManager.ArmOperation Delete (Azure.WaitUntil waitUntil, System.Threading.CancellationToken cancellationToken = null);
Parameters
Azure.WaitUntil waitUntil

Azure.WaitUntil.Completed if the method should wait to return until the long-running operation has completed on the service; Azure.WaitUntil.Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
Azure.ResourceManager.ArmOperation

DeleteAsync(WaitUntil, CancellationToken)

Delete a service instance.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
  • Operation IdServices_Delete
  • Default Api Version2024-03-31
  • ResourceHealthcareApisServiceResource
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> DeleteAsync (Azure.WaitUntil waitUntil, System.Threading.CancellationToken cancellationToken = null);
Parameters
Azure.WaitUntil waitUntil

Azure.WaitUntil.Completed if the method should wait to return until the long-running operation has completed on the service; Azure.WaitUntil.Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>

Get(CancellationToken)

Get the metadata of a service instance.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
  • Operation IdServices_Get
  • Default Api Version2024-03-31
  • ResourceHealthcareApisServiceResource
Declaration
public virtual Azure.Response<Azure.ResourceManager.HealthcareApis.HealthcareApisServiceResource> Get (System.Threading.CancellationToken cancellationToken = null);
Parameters
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
Azure.Response<HealthcareApisServiceResource>

GetAsync(CancellationToken)

Get the metadata of a service instance.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
  • Operation IdServices_Get
  • Default Api Version2024-03-31
  • ResourceHealthcareApisServiceResource
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.HealthcareApis.HealthcareApisServiceResource>> GetAsync (System.Threading.CancellationToken cancellationToken = null);
Parameters
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
System.Threading.Tasks.Task<Azure.Response<HealthcareApisServiceResource>>

GetHealthcareApisServicePrivateEndpointConnection(String, CancellationToken)

Gets the specified private endpoint connection associated with the service.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation IdPrivateEndpointConnections_Get
  • Default Api Version2024-03-31
  • ResourceHealthcareApisServicePrivateEndpointConnectionResource
Declaration
public virtual Azure.Response<Azure.ResourceManager.HealthcareApis.HealthcareApisServicePrivateEndpointConnectionResource> GetHealthcareApisServicePrivateEndpointConnection (string privateEndpointConnectionName, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String privateEndpointConnectionName

The name of the private endpoint connection associated with the Azure resource.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
Azure.Response<HealthcareApisServicePrivateEndpointConnectionResource>

Exceptions
System.ArgumentNullException

privateEndpointConnectionName is null.
System.ArgumentException

privateEndpointConnectionName is an empty string, and was expected to be non-empty.

GetHealthcareApisServicePrivateEndpointConnectionAsync(String, CancellationToken)

Gets the specified private endpoint connection associated with the service.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation IdPrivateEndpointConnections_Get
  • Default Api Version2024-03-31
  • ResourceHealthcareApisServicePrivateEndpointConnectionResource
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.HealthcareApis.HealthcareApisServicePrivateEndpointConnectionResource>> GetHealthcareApisServicePrivateEndpointConnectionAsync (string privateEndpointConnectionName, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String privateEndpointConnectionName

The name of the private endpoint connection associated with the Azure resource.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
System.Threading.Tasks.Task<Azure.Response<HealthcareApisServicePrivateEndpointConnectionResource>>

Exceptions
System.ArgumentNullException

privateEndpointConnectionName is null.
System.ArgumentException

privateEndpointConnectionName is an empty string, and was expected to be non-empty.

GetHealthcareApisServicePrivateEndpointConnections()

Gets a collection of HealthcareApisServicePrivateEndpointConnectionResources in the HealthcareApisService.

Declaration
public virtual Azure.ResourceManager.HealthcareApis.HealthcareApisServicePrivateEndpointConnectionCollection GetHealthcareApisServicePrivateEndpointConnections ();
Returns
HealthcareApisServicePrivateEndpointConnectionCollection

An object representing collection of HealthcareApisServicePrivateEndpointConnectionResources and their operations over a HealthcareApisServicePrivateEndpointConnectionResource.

GetHealthcareApisServicePrivateLinkResource(String, CancellationToken)

Gets a private link resource that need to be created for a service.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateLinkResources/{groupName}
  • Operation IdPrivateLinkResources_Get
  • Default Api Version2024-03-31
  • ResourceHealthcareApisServicePrivateLinkResource
Declaration
public virtual Azure.Response<Azure.ResourceManager.HealthcareApis.HealthcareApisServicePrivateLinkResource> GetHealthcareApisServicePrivateLinkResource (string groupName, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String groupName

The name of the private link resource group.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
Azure.Response<HealthcareApisServicePrivateLinkResource>

Exceptions
System.ArgumentNullException

groupName is null.
System.ArgumentException

groupName is an empty string, and was expected to be non-empty.

GetHealthcareApisServicePrivateLinkResourceAsync(String, CancellationToken)

Gets a private link resource that need to be created for a service.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}/privateLinkResources/{groupName}
  • Operation IdPrivateLinkResources_Get
  • Default Api Version2024-03-31
  • ResourceHealthcareApisServicePrivateLinkResource
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.HealthcareApis.HealthcareApisServicePrivateLinkResource>> GetHealthcareApisServicePrivateLinkResourceAsync (string groupName, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String groupName

The name of the private link resource group.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
System.Threading.Tasks.Task<Azure.Response<HealthcareApisServicePrivateLinkResource>>

Exceptions
System.ArgumentNullException

groupName is null.
System.ArgumentException

groupName is an empty string, and was expected to be non-empty.

GetHealthcareApisServicePrivateLinkResources()

Gets a collection of HealthcareApisServicePrivateLinkResources in the HealthcareApisService.

Declaration
public virtual Azure.ResourceManager.HealthcareApis.HealthcareApisServicePrivateLinkResourceCollection GetHealthcareApisServicePrivateLinkResources ();
Returns
HealthcareApisServicePrivateLinkResourceCollection

An object representing collection of HealthcareApisServicePrivateLinkResources and their operations over a HealthcareApisServicePrivateLinkResource.

RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
  • Operation IdServices_Get
  • Default Api Version2024-03-31
  • ResourceHealthcareApisServiceResource
Declaration
public virtual Azure.Response<Azure.ResourceManager.HealthcareApis.HealthcareApisServiceResource> RemoveTag (string key, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String key

The key for the tag.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
Azure.Response<HealthcareApisServiceResource>

Exceptions
System.ArgumentNullException

key is null.

RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
  • Operation IdServices_Get
  • Default Api Version2024-03-31
  • ResourceHealthcareApisServiceResource
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.HealthcareApis.HealthcareApisServiceResource>> RemoveTagAsync (string key, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String key

The key for the tag.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
System.Threading.Tasks.Task<Azure.Response<HealthcareApisServiceResource>>

Exceptions
System.ArgumentNullException

key is null.

SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
  • Operation IdServices_Get
  • Default Api Version2024-03-31
  • ResourceHealthcareApisServiceResource
Declaration
public virtual Azure.Response<Azure.ResourceManager.HealthcareApis.HealthcareApisServiceResource> SetTags (System.Collections.Generic.IDictionary<string,string> tags, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.Collections.Generic.IDictionary<System.String,System.String> tags

The set of tags to use as replacement.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
Azure.Response<HealthcareApisServiceResource>

Exceptions
System.ArgumentNullException

tags is null.

SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
  • Operation IdServices_Get
  • Default Api Version2024-03-31
  • ResourceHealthcareApisServiceResource
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.HealthcareApis.HealthcareApisServiceResource>> SetTagsAsync (System.Collections.Generic.IDictionary<string,string> tags, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.Collections.Generic.IDictionary<System.String,System.String> tags

The set of tags to use as replacement.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
System.Threading.Tasks.Task<Azure.Response<HealthcareApisServiceResource>>

Exceptions
System.ArgumentNullException

tags is null.

Update(WaitUntil, HealthcareApisServicePatch, CancellationToken)

Update the metadata of a service instance.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
  • Operation IdServices_Update
  • Default Api Version2024-03-31
  • ResourceHealthcareApisServiceResource
Declaration
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.HealthcareApis.HealthcareApisServiceResource> Update (Azure.WaitUntil waitUntil, Azure.ResourceManager.HealthcareApis.Models.HealthcareApisServicePatch patch, System.Threading.CancellationToken cancellationToken = null);
Parameters
Azure.WaitUntil waitUntil

Azure.WaitUntil.Completed if the method should wait to return until the long-running operation has completed on the service; Azure.WaitUntil.Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
HealthcareApisServicePatch patch

The service instance metadata and security metadata.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
Azure.ResourceManager.ArmOperation<HealthcareApisServiceResource>

Exceptions
System.ArgumentNullException

patch is null.

UpdateAsync(WaitUntil, HealthcareApisServicePatch, CancellationToken)

Update the metadata of a service instance.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}
  • Operation IdServices_Update
  • Default Api Version2024-03-31
  • ResourceHealthcareApisServiceResource
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.HealthcareApis.HealthcareApisServiceResource>> UpdateAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.HealthcareApis.Models.HealthcareApisServicePatch patch, System.Threading.CancellationToken cancellationToken = null);
Parameters
Azure.WaitUntil waitUntil

Azure.WaitUntil.Completed if the method should wait to return until the long-running operation has completed on the service; Azure.WaitUntil.Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
HealthcareApisServicePatch patch

The service instance metadata and security metadata.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<HealthcareApisServiceResource>>

Exceptions
System.ArgumentNullException

patch is null.

Explicit Interface Implementations

IJsonModel<HealthcareApisServiceData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

Declaration
Azure.ResourceManager.HealthcareApis.HealthcareApisServiceData IJsonModel<HealthcareApisServiceData>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonReader reader

The System.Text.Json.Utf8JsonReader to read.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
HealthcareApisServiceData

A T representation of the JSON value.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IJsonModel<HealthcareApisServiceData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration
void IJsonModel<HealthcareApisServiceData>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The System.Text.Json.Utf8JsonWriter to write into.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<HealthcareApisServiceData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration
Azure.ResourceManager.HealthcareApis.HealthcareApisServiceData IPersistableModel<HealthcareApisServiceData>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.BinaryData data

The System.BinaryData to parse.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
HealthcareApisServiceData

A T representation of the data.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<HealthcareApisServiceData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

Declaration
string IPersistableModel<HealthcareApisServiceData>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model.
Returns
System.String

The format that the model uses when communicating with the serivce.

IPersistableModel<HealthcareApisServiceData>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration
BinaryData IPersistableModel<HealthcareApisServiceData>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
System.BinaryData

A binary representation of the written model.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.