WebPubSubResource 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 WebPubSub along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a WebPubSubResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetWebPubSubs method.
public class WebPubSubResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.WebPubSub.WebPubSubData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.WebPubSub.WebPubSubData>type WebPubSubResource = class
inherit ArmResource
interface IJsonModel<WebPubSubData>
interface IPersistableModel<WebPubSubData>Public Class WebPubSubResource
Inherits ArmResource
Implements IJsonModel(Of WebPubSubData), IPersistableModel(Of WebPubSubData)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| WebPubSubResource() |
Initializes a new instance of WebPubSubResource 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 |
|---|---|
| AddTag(String, String, CancellationToken) |
Add a tag to the current resource. |
| AddTagAsync(String, String, CancellationToken) |
Add a tag to the current resource. |
| CanUseTagResource(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CanUseTagResourceAsync(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CreateResourceIdentifier(String, String, String) |
Generate the resource identifier for this resource. |
| Delete(WaitUntil, CancellationToken) |
Operation to delete a resource.
|
| DeleteAsync(WaitUntil, CancellationToken) |
Operation to delete a resource.
|
| Get(CancellationToken) |
Get the resource and its properties.
|
| GetAsync(CancellationToken) |
Get the resource and its properties.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetKeys(CancellationToken) |
Get the access keys of the resource.
|
| GetKeysAsync(CancellationToken) |
Get the access keys of the resource.
|
| 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) |
| 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) |
| GetSkus(CancellationToken) |
List all available skus of the resource.
|
| GetSkusAsync(CancellationToken) |
List all available skus of the resource.
|
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| GetWebPubSubCustomCertificate(String, CancellationToken) |
Get a custom certificate. |
| GetWebPubSubCustomCertificateAsync(String, CancellationToken) |
Get a custom certificate. |
| GetWebPubSubCustomCertificates() |
Gets a collection of WebPubSubCustomCertificates in the WebPubSubResource. |
| GetWebPubSubCustomDomain(String, CancellationToken) |
Get a custom domain. |
| GetWebPubSubCustomDomainAsync(String, CancellationToken) |
Get a custom domain. |
| GetWebPubSubCustomDomains() |
Gets a collection of WebPubSubCustomDomains in the WebPubSubResource. |
| GetWebPubSubHub(String, CancellationToken) |
Get a hub setting. |
| GetWebPubSubHubAsync(String, CancellationToken) |
Get a hub setting. |
| GetWebPubSubHubs() |
Gets a collection of WebPubSubHubs in the WebPubSubResource. |
| GetWebPubSubPrivateEndpointConnection(String, CancellationToken) |
Get the specified private endpoint connection. |
| GetWebPubSubPrivateEndpointConnectionAsync(String, CancellationToken) |
Get the specified private endpoint connection. |
| GetWebPubSubPrivateEndpointConnections() |
Gets a collection of WebPubSubPrivateEndpointConnections in the WebPubSubResource. |
| GetWebPubSubPrivateLinkResources(CancellationToken) |
Get the private link resources that need to be created for a resource.
|
| GetWebPubSubPrivateLinkResourcesAsync(CancellationToken) |
Get the private link resources that need to be created for a resource.
|
| GetWebPubSubReplica(String, CancellationToken) |
Get the replica and its properties. |
| GetWebPubSubReplicaAsync(String, CancellationToken) |
Get the replica and its properties. |
| GetWebPubSubReplicas() |
Gets a collection of WebPubSubReplicas in the WebPubSubResource. |
| GetWebPubSubSharedPrivateLink(String, CancellationToken) |
Get the specified shared private link resource. |
| GetWebPubSubSharedPrivateLinkAsync(String, CancellationToken) |
Get the specified shared private link resource. |
| GetWebPubSubSharedPrivateLinks() |
Gets a collection of WebPubSubSharedPrivateLinks in the WebPubSubResource. |
| RegenerateKey(WaitUntil, WebPubSubRegenerateKeyContent, CancellationToken) |
Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
|
| RegenerateKeyAsync(WaitUntil, WebPubSubRegenerateKeyContent, CancellationToken) |
Regenerate the access key for the resource. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
|
| RemoveTag(String, CancellationToken) |
Removes a tag by key from the resource. |
| RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource. |
| Restart(WaitUntil, CancellationToken) |
Operation to restart a resource.
|
| RestartAsync(WaitUntil, CancellationToken) |
Operation to restart a 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(WaitUntil, WebPubSubData, CancellationToken) |
Operation to update an exiting resource.
|
| UpdateAsync(WaitUntil, WebPubSubData, CancellationToken) |
Operation to update an exiting resource.
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<WebPubSubData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<WebPubSubData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<WebPubSubData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<WebPubSubData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<WebPubSubData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
