次の方法で共有


ApiResource クラス

定義

Api を表すクラスと、それに対して実行できるインスタンス操作。 がある場合はResourceIdentifier、GetApiResource メソッドを使用して のArmClientインスタンスから を構築ApiResourceできます。 それ以外の場合は、GetApi メソッドを使用して親リソース ApiManagementServiceResource から取得できます。

public class ApiResource : Azure.ResourceManager.ArmResource
type ApiResource = class
    inherit ArmResource
Public Class ApiResource
Inherits ArmResource
継承
ApiResource

コンストラクター

ApiResource()

モック作成のために クラスの ApiResource 新しいインスタンスを初期化します。

フィールド

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)
CreateResourceIdentifier(String, String, String, String)

インスタンスのリソース識別子を ApiResource 生成します。

Delete(WaitUntil, ETag, Nullable<Boolean>, CancellationToken)

API Management サービス インスタンスの指定された API を削除します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
  • 操作IdApi_Delete
DeleteAsync(WaitUntil, ETag, Nullable<Boolean>, CancellationToken)

API Management サービス インスタンスの指定された API を削除します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
  • 操作IdApi_Delete
Get(CancellationToken)

識別子で指定された API の詳細を取得します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
  • 操作IdApi_Get
GetApiDiagnostic(String, CancellationToken)

識別子で指定された API の診断の詳細を取得します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/診断/{diagnosticId}
  • 操作IdApiDiagnostic_Get
GetApiDiagnosticAsync(String, CancellationToken)

識別子で指定された API の診断の詳細を取得します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/診断/{diagnosticId}
  • 操作IdApiDiagnostic_Get
GetApiDiagnostics()

Api 内の ApiDiagnosticResources のコレクションを取得します。

GetApiIssue(String, Nullable<Boolean>, CancellationToken)

識別子で指定された API の Issue の詳細を取得します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}
  • 操作IdApiIssue_Get
GetApiIssueAsync(String, Nullable<Boolean>, CancellationToken)

識別子で指定された API の Issue の詳細を取得します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}
  • 操作IdApiIssue_Get
GetApiIssues()

Api の ApiIssueResources のコレクションを取得します。

GetApiOperation(String, CancellationToken)

識別子で指定された API 操作の詳細を取得します。

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}
  • 操作IdApiOperation_Get
GetApiOperationAsync(String, CancellationToken)

識別子で指定された API 操作の詳細を取得します。

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}
  • 操作IdApiOperation_Get
GetApiOperations()

Api の ApiOperationResources のコレクションを取得します。

GetApiPolicies()

Api 内の ApiPolicyResources のコレクションを取得します。

GetApiPolicy(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)

API レベルでポリシー構成を取得します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}
  • 操作IdApiPolicy_Get
GetApiPolicyAsync(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)

API レベルでポリシー構成を取得します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}
  • 操作IdApiPolicy_Get
GetApiProducts(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

API が含まれるすべての製品を一覧表示します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/products
  • 操作IdApiProduct_ListByApis
GetApiProductsAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

API が含まれるすべての製品を一覧表示します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/products
  • 操作IdApiProduct_ListByApis
GetApiRelease(String, CancellationToken)

API リリースの詳細を返します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}
  • 操作IdApiRelease_Get
GetApiReleaseAsync(String, CancellationToken)

API リリースの詳細を返します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}
  • 操作IdApiRelease_Get
GetApiReleases()

Api の ApiReleaseResources のコレクションを取得します。

GetApiRevisionsByService(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

API のすべてのリビジョンを一覧表示します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/revisions
  • 操作IdApiRevision_ListByService
GetApiRevisionsByServiceAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

API のすべてのリビジョンを一覧表示します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/revisions
  • 操作IdApiRevision_ListByService
GetApiSchema(String, CancellationToken)

API レベルでスキーマ構成を取得します。

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}
  • 操作IdApiSchema_Get
GetApiSchemaAsync(String, CancellationToken)

API レベルでスキーマ構成を取得します。

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}
  • 操作IdApiSchema_Get
GetApiSchemas()

Api 内の ApiSchemaResources のコレクションを取得します。

GetApiTag(String, CancellationToken)

API に関連付けられているタグを取得します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}
  • 操作IdTag_GetByApi
GetApiTagAsync(String, CancellationToken)

API に関連付けられているタグを取得します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}
  • 操作IdTag_GetByApi
GetApiTagDescription(String, CancellationToken)

API のスコープでタグの説明を取得する

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}
  • 操作IdApiTagDescription_Get
GetApiTagDescriptionAsync(String, CancellationToken)

API のスコープでタグの説明を取得する

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}
  • 操作IdApiTagDescription_Get
GetApiTagDescriptions()

Api 内の ApiTagDescriptionResources のコレクションを取得します。

GetApiTags()

Api 内の ApiTagResources のコレクションを取得します。

GetAsync(CancellationToken)

識別子で指定された API の詳細を取得します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
  • 操作IdApi_Get
GetAvailableLocations(CancellationToken)

使用可能なすべての地域の場所を一覧表示します。

(継承元 ArmResource)
GetAvailableLocationsAsync(CancellationToken)

使用可能なすべての地域の場所を一覧表示します。

(継承元 ArmResource)
GetEntityTag(CancellationToken)

識別子で指定された API のエンティティ状態 (Etag) バージョンを取得します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
  • 操作IdApi_GetEntityTag
GetEntityTagAsync(CancellationToken)

識別子で指定された API のエンティティ状態 (Etag) バージョンを取得します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
  • 操作IdApi_GetEntityTag
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)
GetOperationsByTags(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, CancellationToken)

タグに関連付けられている操作のコレクションを一覧表示します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags
  • 操作IdOperation_ListByTags
GetOperationsByTagsAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, CancellationToken)

タグに関連付けられている操作のコレクションを一覧表示します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags
  • 操作IdOperation_ListByTags
GetPolicyAssignment(String, CancellationToken)

この操作では、名前と作成されたスコープを指定して、1 つのポリシー割り当てを取得します。

  • 要求パス/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • 操作IdPolicyAssignments_Get
(継承元 ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

この操作では、名前と作成されたスコープを指定して、1 つのポリシー割り当てを取得します。

  • 要求パス/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • 操作IdPolicyAssignments_Get
(継承元 ArmResource)
GetPolicyAssignments()

ArmResource 内の PolicyAssignmentResources のコレクションを取得します。

(継承元 ArmResource)
GetTagResource()

ArmResource で実行できるインスタンス操作と共に TagResource を表すオブジェクトを取得します。

(継承元 ArmResource)
TryGetApiVersion(ResourceType, String)

現在のクライアント オプションに対して設定されている場合は、API バージョンのオーバーライドを取得します。

(継承元 ArmResource)
Update(ETag, ApiPatch, CancellationToken)

API Management サービス インスタンスの指定した API を更新します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
  • 操作IdApi_Update
UpdateAsync(ETag, ApiPatch, CancellationToken)

API Management サービス インスタンスの指定した API を更新します。

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
  • 操作IdApi_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)

リソース スコープの指定されたロール割り当てスケジュールを取得する

  • Request Path/{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • 操作IdRoleAssignmentSchedules_Get
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

リソース スコープの指定されたロール割り当てスケジュールを取得する

  • Request Path/{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • 操作IdRoleAssignmentSchedules_Get
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

指定したロールの割り当てスケジュール インスタンスを取得します。

  • Request Path/{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • 操作IdRoleAssignmentScheduleInstances_Get
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

指定したロールの割り当てスケジュール インスタンスを取得します。

  • Request Path/{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)

指定したロールの適格性スケジュール インスタンスを取得します。

  • Request Path/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • 操作IdRoleEligibilityScheduleInstances_Get
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

指定したロールの適格性スケジュール インスタンスを取得します。

  • Request Path/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • 操作IdRoleEligibilityScheduleInstances_Get
GetRoleEligibilityScheduleInstances(ArmResource)

ArmResource 内の RoleEligibilityScheduleInstanceResources のコレクションを取得します。

GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

指定したロールの適格性スケジュール要求を取得します。

  • Request Path/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • 操作IdRoleEligibilityScheduleRequests_Get
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

指定したロールの適格性スケジュール要求を取得します。

  • Request Path/{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)

ArmResource で実行できるインスタンス操作と共に SystemAssignedIdentityResource を表すオブジェクトを取得します。

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 のコレクションを取得します。

適用対象