ServiceGatewayResource 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 ServiceGateway along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a ServiceGatewayResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetServiceGateways method.
public class ServiceGatewayResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Network.ServiceGatewayData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Network.ServiceGatewayData>type ServiceGatewayResource = class
inherit ArmResource
interface IJsonModel<ServiceGatewayData>
interface IPersistableModel<ServiceGatewayData>Public Class ServiceGatewayResource
Inherits ArmResource
Implements IJsonModel(Of ServiceGatewayData), IPersistableModel(Of ServiceGatewayData)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| ServiceGatewayResource() |
Initializes a new instance of ServiceGatewayResource 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) |
Deletes the specified service gateway.
|
| DeleteAsync(WaitUntil, CancellationToken) |
Deletes the specified service gateway.
|
| Get(CancellationToken) |
Gets the specified service gateway.
|
| GetAddressLocations(CancellationToken) |
Get address locations in service gateway.
|
| GetAddressLocationsAsync(CancellationToken) |
Get address locations in service gateway.
|
| GetAsync(CancellationToken) |
Gets the specified service gateway.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| 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) |
| GetServices(CancellationToken) |
Get Services in service gateway.
|
| GetServicesAsync(CancellationToken) |
Get Services in service gateway.
|
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| 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(NetworkTagsObject, CancellationToken) |
Updates a service gateway tags.
|
| UpdateAddressLocations(WaitUntil, ServiceGatewayUpdateAddressLocationsContent, CancellationToken) |
Creates or updates address locations within the service gateway. The request supports both full and partial update modes at two levels: location and address. Full update replaces all existing data. Partial update modifies only the specified entries: For location-level partial updates, if no address is provided, the existing address will be deleted. For address-level partial updates, if no services are provided, the existing services will be considered for deletion.
|
| UpdateAddressLocationsAsync(WaitUntil, ServiceGatewayUpdateAddressLocationsContent, CancellationToken) |
Creates or updates address locations within the service gateway. The request supports both full and partial update modes at two levels: location and address. Full update replaces all existing data. Partial update modifies only the specified entries: For location-level partial updates, if no address is provided, the existing address will be deleted. For address-level partial updates, if no services are provided, the existing services will be considered for deletion.
|
| UpdateAsync(NetworkTagsObject, CancellationToken) |
Updates a service gateway tags.
|
| UpdateServices(WaitUntil, ServiceGatewayUpdateServicesContent, CancellationToken) |
Creates, updates, or deletes services within the service gateway. The request supports both full and partial update modes at the service level. Full update replaces all existing services with the new list provided in the request. Partial update modifies only the specified services.
|
| UpdateServicesAsync(WaitUntil, ServiceGatewayUpdateServicesContent, CancellationToken) |
Creates, updates, or deletes services within the service gateway. The request supports both full and partial update modes at the service level. Full update replaces all existing services with the new list provided in the request. Partial update modifies only the specified services.
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<ServiceGatewayData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<ServiceGatewayData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<ServiceGatewayData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<ServiceGatewayData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<ServiceGatewayData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
