AzureRM.ApiManagement

This topic displays help topics for the Azure API Management Cmdlets.

API Management

Add-AzureRmApiManagementApiToProduct

Adds an API to a product.

Add-AzureRmApiManagementProductToGroup

Adds a product to a group.

Add-AzureRmApiManagementRegion

Adds new deployment regions to a PsApiManagement instance.

Add-AzureRmApiManagementUserToGroup

Adds a user to a group.

Backup-AzureRmApiManagement

Backs up an API Management service.

Export-AzureRmApiManagementApi

Exports an API to a file.

Get-AzureRmApiManagement

Gets a list or a particular API Management Service description.

Get-AzureRmApiManagementApi

Gets an API.

Get-AzureRmApiManagementAuthorizationServer

Gets an API Management authorization server.

Get-AzureRmApiManagementBackend

Get the details of the Backend.

Get-AzureRmApiManagementCertificate

Gets API Management certificates.

Get-AzureRmApiManagementGroup

Gets all or specific API management groups.

Get-AzureRmApiManagementIdentityProvider

Get the identity provider configuration details.

Get-AzureRmApiManagementLogger

Gets API Management Logger objects.

Get-AzureRmApiManagementOpenIdConnectProvider

Gets OpenID Connect providers.

Get-AzureRmApiManagementOperation

Gets a list or a specified API Operation.

Get-AzureRmApiManagementPolicy

Gets the specified scope policy.

Get-AzureRmApiManagementProduct

Gets a list or a particular product.

Get-AzureRmApiManagementProperty

Get-AzureRmApiManagementSsoToken

Gets a link with an SSO token to a deployed management portal of an API Management service.

Get-AzureRmApiManagementSubscription

Gets subscriptions.

Get-AzureRmApiManagementTenantAccess

Gets the access configuration for a tenant.

Get-AzureRmApiManagementTenantGitAccess

Gets the Git access configuration for a tenant.

Get-AzureRmApiManagementTenantSyncState

Gets the status of the most recent synchronization between the configuration database and the Git repository.

Get-AzureRmApiManagementUser

Gets a user or users.

Get-AzureRmApiManagementUserSsoUrl

Generates an SSO URL for a user.

Import-AzureRmApiManagementApi

Imports an API from a file or a URL.

Import-AzureRmApiManagementHostnameCertificate

Imports a certificate in a PFX format for an API Management Service.

New-AzureRmApiManagement

Creates an API Management deployment.

New-AzureRmApiManagementApi

Creates an API.

New-AzureRmApiManagementAuthorizationServer

Creates an authorization server.

New-AzureRmApiManagementBackend

Creates a new backend entity.

New-AzureRmApiManagementBackendCredential

Creates a new Backend Credential contract.

New-AzureRmApiManagementBackendProxy

Creates a new Backend Proxy Object.

New-AzureRmApiManagementCertificate

Creates an API Management certificate to be used during Authentication with Backend.

New-AzureRmApiManagementContext

Creates an instance of PsAzureApiManagementContext.

New-AzureRmApiManagementGroup

Creates an API management group.

New-AzureRmApiManagementHostnameConfiguration

Creates an instance of PsApiManagementHostnameConfiguration.

New-AzureRmApiManagementIdentityProvider

Creates a new Identity Provider configuration.

New-AzureRmApiManagementLogger

Creates an API Management Logger.

New-AzureRmApiManagementOpenIdConnectProvider

Creates an OpenID Connect provider.

New-AzureRmApiManagementOperation

Creates an API management operation.

New-AzureRmApiManagementProduct

Creates an API Management product.

New-AzureRmApiManagementProperty

Creates a new Property.

New-AzureRmApiManagementRegion

Creates an instance of PsApiManagementRegion.

New-AzureRmApiManagementSubscription

Creates a subscription.

New-AzureRmApiManagementUser

Registers a new user.

New-AzureRmApiManagementVirtualNetwork

Creates an instance of PsApiManagementVirtualNetwork.

Publish-AzureRmApiManagementTenantGitConfiguration

Publishes changes from a Git branch to the configuration database.

Remove-AzureRmApiManagement

Removes an API Management service.

Remove-AzureRmApiManagementApi

Removes an API.

Remove-AzureRmApiManagementApiFromProduct

Removes an API from a product.

Remove-AzureRmApiManagementAuthorizationServer

Removes an authorization server.

Remove-AzureRmApiManagementBackend

Removes a Backend.

Remove-AzureRmApiManagementCertificate

Removes an API Management certificate.

Remove-AzureRmApiManagementGroup

Removes an existing API management group.

Remove-AzureRmApiManagementIdentityProvider

Removes an existing Identity Provider Configuration.

Remove-AzureRmApiManagementLogger

Removes an API Management Logger.

Remove-AzureRmApiManagementOpenIdConnectProvider

Removes an OpenID Connect provider.

Remove-AzureRmApiManagementOperation

Removes an existing operation.

Remove-AzureRmApiManagementPolicy

Removes the API Management policy from a specified scope.

Remove-AzureRmApiManagementProduct

Removes an existing API Management product.

Remove-AzureRmApiManagementProductFromGroup

Removes a product from a group.

Remove-AzureRmApiManagementProperty

Removes an API Management Property.

Remove-AzureRmApiManagementRegion

Removes an existing deployment region from PsApiManagement instance.

Remove-AzureRmApiManagementSubscription

Deletes an existing subscription.

Remove-AzureRmApiManagementUser

Deletes an existing user.

Remove-AzureRmApiManagementUserFromGroup

Removes a user from a group.

Restore-AzureRmApiManagement

Restores an API Management Service from the specified Azure storage blob.

Save-AzureRmApiManagementTenantGitConfiguration

Saves changes by creating a commit for current configuration.

Set-AzureRmApiManagementApi

Modifies an API.

Set-AzureRmApiManagementAuthorizationServer

Modifies an authorization server.

Set-AzureRmApiManagementBackend

Updates a Backend.

Set-AzureRmApiManagementCertificate

Modifies an API Management certificate.

Set-AzureRmApiManagementGroup

Configures an API management group.

Set-AzureRmApiManagementHostnames

Sets a custom hostname configuration for an API Management service proxy or portal.

Set-AzureRmApiManagementIdentityProvider

Updates the Configuration of an existing Identity Provider.

Set-AzureRmApiManagementLogger

Modifies an API Management Logger.

Set-AzureRmApiManagementOpenIdConnectProvider

Modifies an OpenID Connect provider.

Set-AzureRmApiManagementOperation

Sets API operation details.

Set-AzureRmApiManagementPolicy

Sets the specified scope policy for API Management.

Set-AzureRmApiManagementProduct

Sets the API Management product details.

Set-AzureRmApiManagementProperty

Modifies an API Management Property.

Set-AzureRmApiManagementSubscription

Sets existing subscription details.

Set-AzureRmApiManagementTenantAccess

Enables or disables tenant access.

Set-AzureRmApiManagementUser

Sets user details.

Update-AzureRmApiManagementDeployment

Updates deployment of an API Management Service.

Update-AzureRmApiManagementRegion

Updates existing deployment region in PsApiManagement instance.