Arcus.Scripting.ApiManagement.psm1
|
<# .Synopsis Create an operation on an API in Azure API Management. .Description Create an operation on an existing API in Azure API Management. .Parameter ResourceGroup The resource group containing the API Management service. .Parameter ServiceName The name of the API Management service located in Azure. .Parameter ServiceName The name of the Azure API Management instance. .Parameter ApiId The ID to identify the API running in Azure API Management. .Parameter OperationId The ID to identify the to-be-created operation on the API. .Parameter Method The method of the to-be-created operation on the API. .Parameter UrlTemplate The URL-template, or endpoint-URL, of the to-be-created operation on the API. .Parameter OperationName The optional descriptive name to give to the to-be-created operation on the API. .Parameter Description The optional explanation to describe the to-be-created operation on the API. .Parameter PolicyFilePath The path to the file containing the optional policy of the to-be-created operation on the API. #> function Create-AzApiManagementApiOperation { param( [string][Parameter(Mandatory = $true)] $ResourceGroup = $(throw "Resource group is required"), [string][Parameter(Mandatory = $true)] $ServiceName = $(throw "Service name is required"), [string][Parameter(Mandatory = $true)] $ApiId = $(throw "API ID is required"), [string][Parameter(Mandatory = $true)] $OperationId = $(throw "Operation ID is required"), [string][Parameter(Mandatory = $true)] $Method = $(throw "Method is required"), [string][Parameter(Mandatory = $true)] $UrlTemplate = $(throw "URL template is required"), [string][Parameter(Mandatory = $false)] $OperationName = $OperationId, [string][Parameter(Mandatory = $false)] $Description = "", [string][Parameter(Mandatory = $false)] $PolicyFilePath = "" ) . $PSScriptRoot\Scripts\Create-AzApiManagementApiOperation.ps1 -ResourceGroup $ResourceGroup -ServiceName $ServiceName -ApiId $ApiId -OperationId $OperationId -Method $Method -UrlTemplate $UrlTemplate -OperationName $OperationName -Description $Description -PolicyFilePath $PolicyFilePath } Export-ModuleMember -Function Create-AzApiManagementApiOperation <# .Synopsis Import a policy to a product in Azure API Management. .Description Import a policy to a product in Azure API Management. .Parameter ResourceGroupName The resource group containing the Azure API Management instance. .Parameter ServiceName The name of the Azure API Management instance located in Azure. .Parameter ProductId The ID to identify the product in Azure API Management. .Parameter PolicyFilePath The path to the file containing the optional policy of the to-be-imported policy on the API. #> function Import-AzApiManagementProductPolicy { param( [string][parameter(Mandatory = $true)] $ResourceGroup = $(throw "Resource group is required"), [string][parameter(Mandatory = $true)] $ServiceName = $(throw = "Service name is required"), [string][parameter(Mandatory = $true)] $ProductId = $(throw "Product ID is required"), [string][parameter(Mandatory = $true)] $PolicyFilePath = $(throw "Policy file path is required") ) . $PSScriptRoot\Scripts\Import-AzApiManagementProductPolicy.ps1 -ResourceGroup $ResourceGroup -ServiceName $ServiceName -ProductId $ProductId -PolicyFilePath $PolicyFilePath } Export-ModuleMember -Function Import-AzApiManagementProductPolicy <# .Synopsis Remove all defaults from the API Management instance. .Description Remove all default API's and products from an Azure API Management instance ('echo-api' API, 'starter' & 'unlimited' products), including the subscriptions. .Parameter ResourceGroup The resource group containing the Azure API Management instance. .Parameter ServiceName The name of the Azure API Management instance. #> function Remove-AzApiManagementDefaults { param( [string][Parameter(Mandatory = $true)] $ResourceGroup = $(throw "Resource group is required"), [string][Parameter(Mandatory = $true)] $ServiceName = $(throw "Service name is required") ) . $PSScriptRoot\Scripts\Remove-AzApiManagementDefaults.ps1 -ResourceGroup $ResourceGroup -ServiceName $ServiceName } Export-ModuleMember -Function Remove-AzApiManagementDefaults <# .Synopsis Import a policy to an API in Azure API Management. .Description Import a base-policy to an API hosted in Azure API Management. .Parameter ResourceGroup The resource group containing the Azure API Management instance. .Parameter ServiceName The name of the Azure API Management service located in Azure. .Parameter ApiId The ID to identify the API running in API Management. .Parameter PolicyFilePath The path to the file containing the optional policy of the to-be-imported policy on the API. #> function Import-AzApiManagementApiPolicy { param( [string][parameter(Mandatory = $true)] $ResourceGroup = $(throw = "Resource group is required"), [string][parameter(Mandatory = $true)] $ServiceName = $(throw = "Service name is required"), [string][parameter(Mandatory = $true)] $ApiId = $(throw = "API ID is required"), [string][parameter(Mandatory = $true)] $PolicyFilePath = $(throw "Policy file path is required") ) . $PSScriptRoot\Scripts\Import-AzApiManagementApiPolicy.ps1 -ResourceGroup $ResourceGroup -ServiceName $ServiceName -ApiId $ApiId -PolicyFilePath $PolicyFilePath } Export-ModuleMember -Function Import-AzApiManagementApiPolicy <# .Synopsis Imports a policy to an operation in Azure API Management. .Description Imports a policy from a file to an API operation in Azure API Management. .Parameter ResourceGroup The resource group containing the Azure API Management instance. .Parameter ServiceName The name of the Azure API Management instance located in Azure. .Parameter ApiId The ID to identify the API running in Azure API Management. .Parameter OperationId The ID to identify the operation for which to import the policy. .Parameter PolicyFilePath The path to the file containing the to-be-imported policy. #> function Import-AzApiManagementOperationPolicy { param( [string][Parameter(Mandatory = $true)] $ResourceGroup = $(throw "Resource group is required"), [string][Parameter(Mandatory = $true)] $ServiceName = $(throw "API management service name is required"), [string][Parameter(Mandatory = $true)] $ApiId = $(throw "API ID is required"), [string][Parameter(Mandatory = $true)] $OperationId = $(throw "Operation ID is required"), [string][parameter(Mandatory = $true)] $PolicyFilePath = $(throw "Policy file path is required") ) . $PSScriptRoot\Scripts\Import-AzApiManagementOperationPolicy.ps1 -ResourceGroup $ResourceGroup -ServiceName $ServiceName -ApiId $ApiId -OperationId $OperationId -PolicyFilePath $PolicyFilePath } |