WorkspacePolicy interface
Interface representing a WorkspacePolicy.
Methods
| create |
Creates or updates policy configuration for the workspace. |
| delete(string, string, string, string, string, Workspace |
Deletes the policy configuration at the workspace. |
| get(string, string, string, string, Workspace |
Get the policy configuration at the API level. |
| get |
Gets the entity state (Etag) version of the workspace policy specified by its identifier. |
| list |
Get the policy configuration at the workspace level. |
Method Details
createOrUpdate(string, string, string, string, PolicyContract, WorkspacePolicyCreateOrUpdateOptionalParams)
Creates or updates policy configuration for the workspace.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, policyId: string, parameters: PolicyContract, options?: WorkspacePolicyCreateOrUpdateOptionalParams): Promise<WorkspacePolicyCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- policyId
-
string
The identifier of the Policy.
- parameters
- PolicyContract
The policy contents to apply.
The options parameters.
Returns
delete(string, string, string, string, string, WorkspacePolicyDeleteOptionalParams)
Deletes the policy configuration at the workspace.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, policyId: string, ifMatch: string, options?: WorkspacePolicyDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- policyId
-
string
The identifier of the Policy.
- ifMatch
-
string
ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
The options parameters.
Returns
Promise<void>
get(string, string, string, string, WorkspacePolicyGetOptionalParams)
Get the policy configuration at the API level.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, policyId: string, options?: WorkspacePolicyGetOptionalParams): Promise<WorkspacePolicyGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- policyId
-
string
The identifier of the Policy.
- options
- WorkspacePolicyGetOptionalParams
The options parameters.
Returns
Promise<WorkspacePolicyGetResponse>
getEntityTag(string, string, string, string, WorkspacePolicyGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the workspace policy specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, policyId: string, options?: WorkspacePolicyGetEntityTagOptionalParams): Promise<WorkspacePolicyGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- policyId
-
string
The identifier of the Policy.
The options parameters.
Returns
Promise<WorkspacePolicyGetEntityTagHeaders>
listByApi(string, string, string, WorkspacePolicyListByApiOptionalParams)
Get the policy configuration at the workspace level.
function listByApi(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspacePolicyListByApiOptionalParams): PagedAsyncIterableIterator<PolicyContract, PolicyContract[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
The options parameters.