Share via


ServiceWorkspaceApiPolicyCollection Class

Definition

A class representing a collection of ServiceWorkspaceApiPolicyResource and their operations. Each ServiceWorkspaceApiPolicyResource in the collection will belong to the same instance of ServiceWorkspaceApiResource. To get a ServiceWorkspaceApiPolicyCollection instance call the GetServiceWorkspaceApiPolicies method from an instance of ServiceWorkspaceApiResource.

public class ServiceWorkspaceApiPolicyCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.ApiManagement.ServiceWorkspaceApiPolicyResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ApiManagement.ServiceWorkspaceApiPolicyResource>
type ServiceWorkspaceApiPolicyCollection = class
    inherit ArmCollection
    interface seq<ServiceWorkspaceApiPolicyResource>
    interface IEnumerable
    interface IAsyncEnumerable<ServiceWorkspaceApiPolicyResource>
Public Class ServiceWorkspaceApiPolicyCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of ServiceWorkspaceApiPolicyResource), IEnumerable(Of ServiceWorkspaceApiPolicyResource)
Inheritance
ServiceWorkspaceApiPolicyCollection
Implements

Constructors

ServiceWorkspaceApiPolicyCollection()

Initializes a new instance of the ServiceWorkspaceApiPolicyCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, PolicyName, PolicyContractData, Nullable<ETag>, CancellationToken)

Creates or updates policy configuration for the API.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies/{policyId}
  • Operation Id: WorkspaceApiPolicy_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ServiceWorkspaceApiPolicyResource
CreateOrUpdateAsync(WaitUntil, PolicyName, PolicyContractData, Nullable<ETag>, CancellationToken)

Creates or updates policy configuration for the API.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies/{policyId}
  • Operation Id: WorkspaceApiPolicy_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ServiceWorkspaceApiPolicyResource
Exists(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies/{policyId}
  • Operation Id: WorkspaceApiPolicy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ServiceWorkspaceApiPolicyResource
ExistsAsync(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies/{policyId}
  • Operation Id: WorkspaceApiPolicy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ServiceWorkspaceApiPolicyResource
Get(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)

Get the policy configuration at the API level.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies/{policyId}
  • Operation Id: WorkspaceApiPolicy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ServiceWorkspaceApiPolicyResource
GetAll(CancellationToken)

Get the policy configuration at the API level.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies
  • Operation Id: WorkspaceApiPolicy_ListByApi
  • Default Api Version: 2023-03-01-preview
  • Resource: ServiceWorkspaceApiPolicyResource
GetAllAsync(CancellationToken)

Get the policy configuration at the API level.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies
  • Operation Id: WorkspaceApiPolicy_ListByApi
  • Default Api Version: 2023-03-01-preview
  • Resource: ServiceWorkspaceApiPolicyResource
GetAsync(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)

Get the policy configuration at the API level.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies/{policyId}
  • Operation Id: WorkspaceApiPolicy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ServiceWorkspaceApiPolicyResource
GetIfExists(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies/{policyId}
  • Operation Id: WorkspaceApiPolicy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ServiceWorkspaceApiPolicyResource
GetIfExistsAsync(PolicyName, Nullable<PolicyExportFormat>, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies/{policyId}
  • Operation Id: WorkspaceApiPolicy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ServiceWorkspaceApiPolicyResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<ServiceWorkspaceApiPolicyResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ServiceWorkspaceApiPolicyResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to