ApiManagementBackendResource 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 an ApiManagementBackend along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct an ApiManagementBackendResource from an instance of ArmClient using the GetApiManagementBackendResource method. Otherwise you can get one from its parent resource ApiManagementServiceResource using the GetApiManagementBackend method.
public class ApiManagementBackendResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ApiManagement.ApiManagementBackendData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ApiManagement.ApiManagementBackendData>type ApiManagementBackendResource = class
inherit ArmResource
interface IJsonModel<ApiManagementBackendData>
interface IPersistableModel<ApiManagementBackendData>Public Class ApiManagementBackendResource
Inherits ArmResource
Implements IJsonModel(Of ApiManagementBackendData), IPersistableModel(Of ApiManagementBackendData)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| ApiManagementBackendResource() |
Initializes a new instance of the ApiManagementBackendResource 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 ApiManagementBackendResource instance. |
| Delete(WaitUntil, ETag, CancellationToken) |
Deletes the specified backend.
|
| DeleteAsync(WaitUntil, ETag, CancellationToken) |
Deletes the specified backend.
|
| Get(CancellationToken) |
Gets the details of the backend specified by its identifier.
|
| GetAsync(CancellationToken) |
Gets the details of the backend specified by its identifier.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetEntityTag(CancellationToken) |
Gets the entity state (Etag) version of the backend specified by its identifier.
|
| GetEntityTagAsync(CancellationToken) |
Gets the entity state (Etag) version of the backend specified by its identifier.
|
| 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) |
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| Reconnect(BackendReconnectContract, CancellationToken) |
Notifies the API Management gateway to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used.
|
| ReconnectAsync(BackendReconnectContract, CancellationToken) |
Notifies the API Management gateway to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used.
|
| TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
| Update(ETag, ApiManagementBackendPatch, CancellationToken) |
Updates an existing backend.
|
| UpdateAsync(ETag, ApiManagementBackendPatch, CancellationToken) |
Updates an existing backend.
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<ApiManagementBackendData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<ApiManagementBackendData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<ApiManagementBackendData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<ApiManagementBackendData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<ApiManagementBackendData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
