你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

ApiManagementGatewayResource 类

定义

一个表示 ApiManagementGateway 以及可对其进行执行的实例操作的类。 如果有 ,ResourceIdentifier则可以使用 GetApiManagementGatewayResource 方法从 实例ArmClient构造 ApiManagementGatewayResource 。 否则,可以使用 GetApiManagementGateway 方法从其父资源 ApiManagementServiceResource 获取一个。

public class ApiManagementGatewayResource : Azure.ResourceManager.ArmResource
type ApiManagementGatewayResource = class
    inherit ArmResource
Public Class ApiManagementGatewayResource
Inherits ArmResource
继承
ApiManagementGatewayResource

构造函数

ApiManagementGatewayResource()

初始化 类的新实例 ApiManagementGatewayResource 进行模拟。

字段

ResourceType

获取操作的资源类型。

属性

Client

获取 ArmClient 创建自的此资源客户端。

(继承自 ArmResource)
Data

获取表示此功能的数据。

Diagnostics

获取此资源客户端的诊断选项。

(继承自 ArmResource)
Endpoint

获取此资源客户端的基 URI。

(继承自 ArmResource)
HasData

获取当前实例是否具有数据。

Id

获取资源标识符。

(继承自 ArmResource)
Pipeline

获取此资源客户端的管道。

(继承自 ArmResource)

方法

CanUseTagResource(CancellationToken)

检查 TagResource API 是否部署在当前环境中。

(继承自 ArmResource)
CanUseTagResourceAsync(CancellationToken)

检查 TagResource API 是否部署在当前环境中。

(继承自 ArmResource)
CreateOrUpdateGatewayApi(String, AssociationContract, CancellationToken)

将 API 添加到指定的网关。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis/{apiId}
  • 操作IdGatewayApi_CreateOrUpdate
CreateOrUpdateGatewayApiAsync(String, AssociationContract, CancellationToken)

将 API 添加到指定的网关。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis/{apiId}
  • 操作IdGatewayApi_CreateOrUpdate
CreateResourceIdentifier(String, String, String, String)

生成实例的资源标识符 ApiManagementGatewayResource

Delete(WaitUntil, ETag, CancellationToken)

删除特定的网关。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
  • 操作IdGateway_Delete
DeleteAsync(WaitUntil, ETag, CancellationToken)

删除特定的网关。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
  • 操作IdGateway_Delete
DeleteGatewayApi(String, CancellationToken)

从指定的网关中删除指定的 API。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis/{apiId}
  • 操作IdGatewayApi_Delete
DeleteGatewayApiAsync(String, CancellationToken)

从指定的网关中删除指定的 API。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis/{apiId}
  • 操作IdGatewayApi_Delete
GenerateToken(GatewayTokenRequestContract, CancellationToken)

获取网关的共享访问授权令牌。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/generateToken
  • 操作IdGateway_GenerateToken
GenerateTokenAsync(GatewayTokenRequestContract, CancellationToken)

获取网关的共享访问授权令牌。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/generateToken
  • 操作IdGateway_GenerateToken
Get(CancellationToken)

获取由其标识符指定的网关的详细信息。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
  • 操作IdGateway_Get
GetApiManagementGatewayCertificateAuthorities()

获取 ApiManagementGatewayCertificateAuthorityResources 中的 ApiManagementGatewayCertificateAuthorityResources 的集合。

GetApiManagementGatewayCertificateAuthority(String, CancellationToken)

获取分配的网关证书颁发机构详细信息。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities/{certificateId}
  • 操作IdGatewayCertificateAuthority_Get
GetApiManagementGatewayCertificateAuthorityAsync(String, CancellationToken)

获取分配的网关证书颁发机构详细信息。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities/{certificateId}
  • 操作IdGatewayCertificateAuthority_Get
GetApiManagementGatewayHostnameConfiguration(String, CancellationToken)

获取主机名配置的详细信息

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gateways/{gatewayId}/hostnameConfigurations/{hcId}
  • 操作IdGatewayHostnameConfiguration_Get
GetApiManagementGatewayHostnameConfigurationAsync(String, CancellationToken)

获取主机名配置的详细信息

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gateways/{gatewayId}/hostnameConfigurations/{hcId}
  • 操作IdGatewayHostnameConfiguration_Get
GetApiManagementGatewayHostnameConfigurations()

获取 ApiManagementGateway 中 ApiManagementGatewayHostnameConfigurationResources 的集合。

GetAsync(CancellationToken)

获取由其标识符指定的网关的详细信息。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
  • 操作IdGateway_Get
GetAvailableLocations(CancellationToken)

列出所有可用的地理位置。

(继承自 ArmResource)
GetAvailableLocationsAsync(CancellationToken)

列出所有可用的地理位置。

(继承自 ArmResource)
GetEntityTag(CancellationToken)

获取实体状态 (Etag) 由其标识符指定的网关版本。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
  • 操作IdGateway_GetEntityTag
GetEntityTagAsync(CancellationToken)

获取实体状态 (Etag) 由其标识符指定的网关版本。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
  • 操作IdGateway_GetEntityTag
GetGatewayApiEntityTag(String, CancellationToken)

检查标识符指定的 API 实体是否与网关实体相关联。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis/{apiId}
  • 操作IdGatewayApi_GetEntityTag
GetGatewayApiEntityTagAsync(String, CancellationToken)

检查标识符指定的 API 实体是否与网关实体相关联。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis/{apiId}
  • 操作IdGatewayApi_GetEntityTag
GetGatewayApisByService(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

列出与网关关联的 API 集合。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis
  • 操作IdGatewayApi_ListByService
GetGatewayApisByServiceAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

列出与网关关联的 API 集合。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis
  • 操作IdGatewayApi_ListByService
GetKeys(CancellationToken)

检索网关密钥。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listKeys
  • 操作IdGateway_ListKeys
GetKeysAsync(CancellationToken)

检索网关密钥。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listKeys
  • 操作IdGateway_ListKeys
GetManagementLock(String, CancellationToken)

按范围获取管理锁。

  • 请求路径/{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • 操作IdManagementLocks_GetByScope
(继承自 ArmResource)
GetManagementLockAsync(String, CancellationToken)

按范围获取管理锁。

  • 请求路径/{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • 操作IdManagementLocks_GetByScope
(继承自 ArmResource)
GetManagementLocks()

获取 ArmResource 中 ManagementLockResources 的集合。

(继承自 ArmResource)
GetPolicyAssignment(String, CancellationToken)

此操作检索单个策略分配,给定其名称和创建范围。

  • 请求路径/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • 操作IdPolicyAssignments_Get
(继承自 ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

此操作检索单个策略分配,给定其名称和创建范围。

  • 请求路径/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • 操作IdPolicyAssignments_Get
(继承自 ArmResource)
GetPolicyAssignments()

获取 ArmResource 中 PolicyAssignmentResources 的集合。

(继承自 ArmResource)
GetTagResource()

获取一个 对象,该对象表示 TagResource 以及可在 ArmResource 中对其进行执行的实例操作。

(继承自 ArmResource)
RegenerateKey(GatewayKeyRegenerateContent, CancellationToken)

重新生成指定的网关密钥,使使用它创建的任何令牌无效。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/regenerateKey
  • 操作IdGateway_RegenerateKey
RegenerateKeyAsync(GatewayKeyRegenerateContent, CancellationToken)

重新生成指定的网关密钥,使使用它创建的任何令牌无效。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/regenerateKey
  • 操作IdGateway_RegenerateKey
TryGetApiVersion(ResourceType, String)

获取 API 版本替代(如果已为当前客户端选项设置)。

(继承自 ArmResource)
Update(ETag, ApiManagementGatewayData, CancellationToken)

汇报由其标识符指定的网关的详细信息。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
  • 操作IdGateway_Update
UpdateAsync(ETag, ApiManagementGatewayData, CancellationToken)

汇报由其标识符指定的网关的详细信息。

  • 请求路径/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
  • 操作IdGateway_Update

扩展方法

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

按名称 (GUID) 获取角色定义。

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • 操作IdRoleDefinitions_Get
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

按名称 (GUID) 获取角色定义。

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • 操作IdRoleDefinitions_Get
GetAuthorizationRoleDefinitions(ArmResource)

获取 ArmResource 中 AuthorizationRoleDefinitionResources 的集合。

GetDenyAssignment(ArmResource, String, CancellationToken)

获取指定的拒绝分配。

  • 请求路径/{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • 操作IdDenyAssignments_Get
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

获取指定的拒绝分配。

  • 请求路径/{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • 操作IdDenyAssignments_Get
GetDenyAssignments(ArmResource)

获取 ArmResource 中 DenyAssignmentResources 的集合。

GetRoleAssignment(ArmResource, String, String, CancellationToken)

按范围和名称获取角色分配。

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • 操作IdRoleAssignments_Get
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

按范围和名称获取角色分配。

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • 操作IdRoleAssignments_Get
GetRoleAssignments(ArmResource)

获取 ArmResource 中 RoleAssignmentResources 的集合。

GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

获取资源范围的指定角色分配计划

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • 操作IdRoleAssignmentSchedules_Get
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

获取资源范围的指定角色分配计划

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • 操作IdRoleAssignmentSchedules_Get
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

获取指定的角色分配计划实例。

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • 操作IdRoleAssignmentScheduleInstances_Get
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

获取指定的角色分配计划实例。

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • 操作IdRoleAssignmentScheduleInstances_Get
GetRoleAssignmentScheduleInstances(ArmResource)

获取 ArmResource 中 RoleAssignmentScheduleInstanceResources 的集合。

GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

获取指定的角色分配计划请求。

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • 操作IdRoleAssignmentScheduleRequests_Get
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

获取指定的角色分配计划请求。

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • 操作IdRoleAssignmentScheduleRequests_Get
GetRoleAssignmentScheduleRequests(ArmResource)

获取 ArmResource 中 RoleAssignmentScheduleRequestResources 的集合。

GetRoleAssignmentSchedules(ArmResource)

获取 ArmResource 中 RoleAssignmentScheduleResources 的集合。

GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

获取资源范围的指定角色资格计划

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • 操作IdRoleEligibilitySchedules_Get
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

获取资源范围的指定角色资格计划

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • 操作IdRoleEligibilitySchedules_Get
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

获取指定的角色资格计划实例。

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • 操作IdRoleEligibilityScheduleInstances_Get
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

获取指定的角色资格计划实例。

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • 操作IdRoleEligibilityScheduleInstances_Get
GetRoleEligibilityScheduleInstances(ArmResource)

获取 ArmResource 中 RoleEligibilityScheduleInstanceResources 的集合。

GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

获取指定的角色资格计划请求。

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • 操作IdRoleEligibilityScheduleRequests_Get
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

获取指定的角色资格计划请求。

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • 操作IdRoleEligibilityScheduleRequests_Get
GetRoleEligibilityScheduleRequests(ArmResource)

获取 ArmResource 中 RoleEligibilityScheduleRequestResources 的集合。

GetRoleEligibilitySchedules(ArmResource)

获取 ArmResource 中 RoleEligibilityScheduleResources 的集合。

GetRoleManagementPolicies(ArmResource)

获取 ArmResource 中 RoleManagementPolicyResources 的集合。

GetRoleManagementPolicy(ArmResource, String, CancellationToken)

获取资源范围的指定角色管理策略

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • 操作IdRoleManagementPolicies_Get
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

获取资源范围的指定角色管理策略分配

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • 操作IdRoleManagementPolicyAssignments_Get
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

获取资源范围的指定角色管理策略分配

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • 操作IdRoleManagementPolicyAssignments_Get
GetRoleManagementPolicyAssignments(ArmResource)

获取 ArmResource 中 RoleManagementPolicyAssignmentResources 的集合。

GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

获取资源范围的指定角色管理策略

  • 请求路径/{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • 操作IdRoleManagementPolicies_Get
GetSystemAssignedIdentity(ArmResource)

获取一个 对象,该对象表示 SystemAssignedIdentityResource 以及可在 ArmResource 中对它执行的实例操作。

GetLinkerResource(ArmResource, String, CancellationToken)

返回给定名称的链接器资源。

  • 请求路径/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • 操作IdLinker_Get
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

返回给定名称的链接器资源。

  • 请求路径/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • 操作IdLinker_Get
GetLinkerResources(ArmResource)

获取 ArmResource 中 LinkerResources 的集合。

适用于