ApiGatewayResource Class

Definition

Namespace:: Azure.ResourceManager.ApiManagement

Assembly:: Azure.ResourceManager.ApiManagement.dll

Package:: Azure.ResourceManager.ApiManagement v1.3.0

Source:: ApiGatewayResource.cs

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 ApiGateway along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct an ApiGatewayResource from an instance of ArmClient using the GetApiGatewayResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetApiGateway method.

public class ApiGatewayResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ApiManagement.ApiGatewayData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ApiManagement.ApiGatewayData>

type ApiGatewayResource = class
    inherit ArmResource
    interface IJsonModel<ApiGatewayData>
    interface IPersistableModel<ApiGatewayData>

Public Class ApiGatewayResource
Inherits ArmResource
Implements IJsonModel(Of ApiGatewayData), IPersistableModel(Of ApiGatewayData)

Inheritance: Object

ArmResource
ApiGatewayResource

Implements: IJsonModel<ApiGatewayData> IPersistableModel<ApiGatewayData> IPersistableModel<T>

Constructors

ApiGatewayResource()

Initializes a new instance of the ApiGatewayResource 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

AddTag(String, String, CancellationToken)	Add a tag to the current resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName} Operation Id: ApiGateway_Get Default Api Version: 2024-05-01 Resource: ApiGatewayResource
AddTagAsync(String, String, CancellationToken)	Add a tag to the current resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName} Operation Id: ApiGateway_Get Default Api Version: 2024-05-01 Resource: ApiGatewayResource
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 of a ApiGatewayResource instance.
Delete(WaitUntil, CancellationToken)	Deletes an existing API Management gateway. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName} Operation Id: ApiGateway_Delete Default Api Version: 2024-05-01 Resource: ApiGatewayResource
DeleteAsync(WaitUntil, CancellationToken)	Deletes an existing API Management gateway. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName} Operation Id: ApiGateway_Delete Default Api Version: 2024-05-01 Resource: ApiGatewayResource
Get(CancellationToken)	Gets an API Management gateway resource description. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName} Operation Id: ApiGateway_Get Default Api Version: 2024-05-01 Resource: ApiGatewayResource
GetApiGatewayConfigConnection(String, CancellationToken)	Gets an API Management gateway config connection resource description. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/configConnections/{configConnectionName} Operation Id: ApiGatewayConfigConnection_Get Default Api Version: 2024-05-01 Resource: ApiGatewayConfigConnectionResource
GetApiGatewayConfigConnectionAsync(String, CancellationToken)	Gets an API Management gateway config connection resource description. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/configConnections/{configConnectionName} Operation Id: ApiGatewayConfigConnection_Get Default Api Version: 2024-05-01 Resource: ApiGatewayConfigConnectionResource
GetApiGatewayConfigConnections()	Gets a collection of ApiGatewayConfigConnectionResources in the ApiGateway.
GetAsync(CancellationToken)	Gets an API Management gateway resource description. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName} Operation Id: ApiGateway_Get Default Api Version: 2024-05-01 Resource: ApiGatewayResource
GetAvailableLocations(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetAvailableSkusApiManagementGatewaySkus(CancellationToken)	Gets all available SKU for a given API Management gateway Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/skus Operation Id: ApiManagementGatewaySkus_ListAvailableSkus Default Api Version: 2024-05-01
GetAvailableSkusApiManagementGatewaySkusAsync(CancellationToken)	Gets all available SKU for a given API Management gateway Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/skus Operation Id: ApiManagementGatewaySkus_ListAvailableSkus Default Api Version: 2024-05-01
GetManagementLock(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
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. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)	This operation retrieves a single policy assignment, given its name and the scope it was created at. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
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)
RemoveTag(String, CancellationToken)	Removes a tag by key from the resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName} Operation Id: ApiGateway_Get Default Api Version: 2024-05-01 Resource: ApiGatewayResource
RemoveTagAsync(String, CancellationToken)	Removes a tag by key from the resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName} Operation Id: ApiGateway_Get Default Api Version: 2024-05-01 Resource: ApiGatewayResource
SetTags(IDictionary<String,String>, CancellationToken)	Replace the tags on the resource with the given set. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName} Operation Id: ApiGateway_Get Default Api Version: 2024-05-01 Resource: ApiGatewayResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)	Replace the tags on the resource with the given set. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName} Operation Id: ApiGateway_Get Default Api Version: 2024-05-01 Resource: ApiGatewayResource
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmResource)
Update(WaitUntil, ApiGatewayPatch, CancellationToken)	Updates an existing API Management gateway. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName} Operation Id: ApiGateway_Update Default Api Version: 2024-05-01 Resource: ApiGatewayResource
UpdateAsync(WaitUntil, ApiGatewayPatch, CancellationToken)	Updates an existing API Management gateway. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName} Operation Id: ApiGateway_Update Default Api Version: 2024-05-01 Resource: ApiGatewayResource

Explicit Interface Implementations

IJsonModel<ApiGatewayData>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ApiGatewayData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ApiGatewayData>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<ApiGatewayData>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ApiGatewayData>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Extension Methods

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)	Get role definition by name (GUID). Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} Operation Id: RoleDefinitions_Get Default Api Version: 2022-04-01 Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)	Get role definition by name (GUID). Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} Operation Id: RoleDefinitions_Get Default Api Version: 2022-04-01 Resource: AuthorizationRoleDefinitionResource
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. Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId} Operation Id: DenyAssignments_Get Default Api Version: 2022-04-01 Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified deny assignment. Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId} Operation Id: DenyAssignments_Get Default Api Version: 2022-04-01 Resource: DenyAssignmentResource
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. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName} Operation Id: RoleAssignments_Get Default Api Version: 2022-04-01 Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName} Operation Id: RoleAssignments_Get Default Api Version: 2022-04-01 Resource: RoleAssignmentResource
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 Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName} Operation Id: RoleAssignmentSchedules_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName} Operation Id: RoleAssignmentSchedules_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName} Operation Id: RoleAssignmentScheduleInstances_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName} Operation Id: RoleAssignmentScheduleInstances_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleInstanceResource
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. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName} Operation Id: RoleAssignmentScheduleRequests_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName} Operation Id: RoleAssignmentScheduleRequests_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleRequestResource
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 Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName} Operation Id: RoleEligibilitySchedules_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName} Operation Id: RoleEligibilitySchedules_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance. Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName} Operation Id: RoleEligibilityScheduleInstances_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance. Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName} Operation Id: RoleEligibilityScheduleInstances_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleInstanceResource
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. Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName} Operation Id: RoleEligibilityScheduleRequests_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request. Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName} Operation Id: RoleEligibilityScheduleRequests_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleRequestResource
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 Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName} Operation Id: RoleManagementPolicies_Get Default Api Version: 2020-10-01 Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName} Operation Id: RoleManagementPolicyAssignments_Get Default Api Version: 2020-10-01 Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName} Operation Id: RoleManagementPolicyAssignments_Get Default Api Version: 2020-10-01 Resource: RoleManagementPolicyAssignmentResource
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 Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName} Operation Id: RoleManagementPolicies_Get Default Api Version: 2020-10-01 Resource: RoleManagementPolicyResource
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. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource
GetLinkerResourceAsync(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource
GetLinkerResources(ArmResource)	Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead.

Applies to

Share via