ApiManagementGatewayResource 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 ApiManagementGateway along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct an ApiManagementGatewayResource from an instance of ArmClient using the GetApiManagementGatewayResource method. Otherwise you can get one from its parent resource ApiManagementServiceResource using the GetApiManagementGateway method.
public class ApiManagementGatewayResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ApiManagement.ApiManagementGatewayData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ApiManagement.ApiManagementGatewayData>
type ApiManagementGatewayResource = class
inherit ArmResource
interface IJsonModel<ApiManagementGatewayData>
interface IPersistableModel<ApiManagementGatewayData>
Public Class ApiManagementGatewayResource
Inherits ArmResource
Implements IJsonModel(Of ApiManagementGatewayData), IPersistableModel(Of ApiManagementGatewayData)
- Inheritance
- Implements
Constructors
ApiManagementGatewayResource() |
Initializes a new instance of the ApiManagementGatewayResource class for mocking. |
Fields
ResourceType |
Gets the resource type for the operations. |
Properties
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
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) |
CreateOrUpdateGatewayApi(String, AssociationContract, CancellationToken) |
Adds an API to the specified Gateway.
|
CreateOrUpdateGatewayApiAsync(String, AssociationContract, CancellationToken) |
Adds an API to the specified Gateway.
|
CreateResourceIdentifier(String, String, String, String) |
Generate the resource identifier of a ApiManagementGatewayResource instance. |
Delete(WaitUntil, ETag, CancellationToken) |
Deletes specific Gateway.
|
DeleteAsync(WaitUntil, ETag, CancellationToken) |
Deletes specific Gateway.
|
DeleteGatewayApi(String, CancellationToken) |
Deletes the specified API from the specified Gateway.
|
DeleteGatewayApiAsync(String, CancellationToken) |
Deletes the specified API from the specified Gateway.
|
GenerateToken(GatewayTokenRequestContract, CancellationToken) |
Gets the Shared Access Authorization Token for the gateway.
|
GenerateTokenAsync(GatewayTokenRequestContract, CancellationToken) |
Gets the Shared Access Authorization Token for the gateway.
|
Get(CancellationToken) |
Gets the details of the Gateway specified by its identifier.
|
GetApiManagementGatewayCertificateAuthorities() |
Gets a collection of ApiManagementGatewayCertificateAuthorityResources in the ApiManagementGateway. |
GetApiManagementGatewayCertificateAuthority(String, CancellationToken) |
Get assigned Gateway Certificate Authority details.
|
GetApiManagementGatewayCertificateAuthorityAsync(String, CancellationToken) |
Get assigned Gateway Certificate Authority details.
|
GetApiManagementGatewayHostnameConfiguration(String, CancellationToken) |
Get details of a hostname configuration
|
GetApiManagementGatewayHostnameConfigurationAsync(String, CancellationToken) |
Get details of a hostname configuration
|
GetApiManagementGatewayHostnameConfigurations() |
Gets a collection of ApiManagementGatewayHostnameConfigurationResources in the ApiManagementGateway. |
GetAsync(CancellationToken) |
Gets the details of the Gateway specified by its identifier.
|
GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
GetDebugCredentials(GatewayListDebugCredentialsContract, CancellationToken) |
Create new debug credentials for gateway.
|
GetDebugCredentialsAsync(GatewayListDebugCredentialsContract, CancellationToken) |
Create new debug credentials for gateway.
|
GetEntityTag(CancellationToken) |
Gets the entity state (Etag) version of the Gateway specified by its identifier.
|
GetEntityTagAsync(CancellationToken) |
Gets the entity state (Etag) version of the Gateway specified by its identifier.
|
GetGatewayApiEntityTag(String, CancellationToken) |
Checks that API entity specified by identifier is associated with the Gateway entity.
|
GetGatewayApiEntityTagAsync(String, CancellationToken) |
Checks that API entity specified by identifier is associated with the Gateway entity.
|
GetGatewayApisByService(String, Nullable<Int32>, Nullable<Int32>, CancellationToken) |
Lists a collection of the APIs associated with a gateway.
|
GetGatewayApisByServiceAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken) |
Lists a collection of the APIs associated with a gateway.
|
GetKeys(CancellationToken) |
Retrieves gateway keys.
|
GetKeysAsync(CancellationToken) |
Retrieves gateway keys.
|
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) |
GetTrace(GatewayListTraceContract, CancellationToken) |
Fetches trace collected by gateway.
|
GetTraceAsync(GatewayListTraceContract, CancellationToken) |
Fetches trace collected by gateway.
|
InvalidateDebugCredentials(CancellationToken) |
Action is invalidating all debug credentials issued for gateway.
|
InvalidateDebugCredentialsAsync(CancellationToken) |
Action is invalidating all debug credentials issued for gateway.
|
RegenerateKey(GatewayKeyRegenerateContent, CancellationToken) |
Regenerates specified gateway key invalidating any tokens created with it.
|
RegenerateKeyAsync(GatewayKeyRegenerateContent, CancellationToken) |
Regenerates specified gateway key invalidating any tokens created with it.
|
TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
Update(ETag, ApiManagementGatewayData, CancellationToken) |
Updates the details of the gateway specified by its identifier.
|
UpdateAsync(ETag, ApiManagementGatewayData, CancellationToken) |
Updates the details of the gateway specified by its identifier.
|
Explicit Interface Implementations
IJsonModel<ApiManagementGatewayData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
IJsonModel<ApiManagementGatewayData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
IPersistableModel<ApiManagementGatewayData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
IPersistableModel<ApiManagementGatewayData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
IPersistableModel<ApiManagementGatewayData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
Extension Methods
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
GetAuthorizationRoleDefinitions(ArmResource) |
Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead. |
GetDenyAssignment(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
GetDenyAssignments(ArmResource) |
Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead. |
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 RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead. |
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 RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead. |
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 RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead. |
GetRoleAssignmentSchedules(ArmResource) |
Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead. |
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 RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead. |
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 RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead. |
GetRoleEligibilitySchedules(ArmResource) |
Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead. |
GetRoleManagementPolicies(ArmResource) |
Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead. |
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 RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead. |
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. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead. |
GetLinkerResource(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResources(ArmResource) |
Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead. |