Share via


ServiceWorkspacePolicyCollection Class

Definition

A class representing a collection of ServiceWorkspacePolicyResource and their operations. Each ServiceWorkspacePolicyResource in the collection will belong to the same instance of WorkspaceContractResource. To get a ServiceWorkspacePolicyCollection instance call the GetServiceWorkspacePolicies method from an instance of WorkspaceContractResource.

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

Constructors

ServiceWorkspacePolicyCollection()

Initializes a new instance of the ServiceWorkspacePolicyCollection 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 workspace.

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

Creates or updates policy configuration for the workspace.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policies/{policyId}
  • Operation Id: WorkspacePolicy_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: ServiceWorkspacePolicyResource
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}/policies/{policyId}
  • Operation Id: WorkspacePolicy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ServiceWorkspacePolicyResource
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}/policies/{policyId}
  • Operation Id: WorkspacePolicy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ServiceWorkspacePolicyResource
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}/policies/{policyId}
  • Operation Id: WorkspacePolicy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ServiceWorkspacePolicyResource
GetAll(CancellationToken)

Get the policy configuration at the workspace level.

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

Get the policy configuration at the workspace level.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policies
  • Operation Id: WorkspacePolicy_ListByApi
  • Default Api Version: 2023-03-01-preview
  • Resource: ServiceWorkspacePolicyResource
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}/policies/{policyId}
  • Operation Id: WorkspacePolicy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ServiceWorkspacePolicyResource
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}/policies/{policyId}
  • Operation Id: WorkspacePolicy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ServiceWorkspacePolicyResource
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}/policies/{policyId}
  • Operation Id: WorkspacePolicy_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: ServiceWorkspacePolicyResource
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<ServiceWorkspacePolicyResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ServiceWorkspacePolicyResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to