Az.ApiManagement

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

API Management

Add-AzApiManagementApiToGateway

Attaches an API to a gateway.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Add-AzApiManagementApiToProduct

Adds an API to a product.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Add-AzApiManagementProductToGroup

Adds a product to a group.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Add-AzApiManagementRegion

Adds new deployment regions to a PsApiManagement instance.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Add-AzApiManagementUserToGroup

Adds a user to a group.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Backup-AzApiManagement

Backs up an API Management service.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Export-AzApiManagementApi

Exports an API to a file.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagement

Gets a list or a particular API Management Service description.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementApi

Gets an API.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementApiRelease

Get the API Release.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementApiRevision

Gets details of all the API Revisions of an API

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementApiSchema

Get the details of the API Schema

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementApiVersionSet

Get the details of the API Version Sets

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementAuthorizationServer

Gets an API Management authorization server.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementAuthorizationServerClientSecret

Gets an API Management authorization server client secret.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementBackend

Get the details of the Backend.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementCache

Get the details of the Cache.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementCertificate

Gets API Management certificates configured for Mutual Authentication with Backend in the service.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementDiagnostic

Get details of the Diagnostic configured at the service level or the Api Level. Diagnostics are used to log requests/responses from Api Management gateway.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementGateway

Gets all or specific API management Gateway.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementGatewayHostnameConfiguration

Gets all or specific hostname configuration for the existing Gateway.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementGatewayKey

Gets keys of the existing Gateway

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementGroup

Gets all or specific API management groups.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementIdentityProvider

Get the identity provider configuration details.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementIdentityProviderClientSecret

Get the identity provider client secret.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementLogger

Gets API Management Logger objects.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementNamedValue

Gets a list or a particular Named Value.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementNamedValueSecretValue

Gets a secret value of the particular Named Value.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementNetworkStatus

Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementOpenIdConnectProvider

Gets OpenID Connect providers.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementOpenIdConnectProviderClientSecret

Gets OpenID Connect provider client secret.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementOperation

Gets a list or a specified API Operation.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementPolicy

Gets the specified scope policy.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementProduct

Gets a list or a particular product.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementSsoToken

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

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementSubscription

Gets subscriptions.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementSubscriptionKey

Gets subscription keys.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementTenantAccess

Gets the access configuration for a tenant.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementTenantAccessSecret

Gets the access configuration keys for a tenant.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementTenantGitAccess

Gets the Git access configuration for a tenant.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementTenantGitAccessSecret

Gets the Git access configuration keys for a tenant.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementTenantSyncState

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

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementUser

Gets a user or users.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Get-AzApiManagementUserSsoUrl

Generates an SSO URL for a user.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Import-AzApiManagementApi

Imports an API from a file or a URL.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagement

Creates an API Management deployment.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementApi

Creates an API.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementApiRelease

Creates an API Release of an API Revision

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementApiRevision

Creates a new Revision of an Existing API.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementApiSchema

Creates the new API Schema in the ApiManagement service

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementApiVersionSet

Creates an API Version Set.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementAuthorizationServer

Creates an authorization server.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementBackend

Creates a new backend entity.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementBackendCredential

Creates a new Backend Credential contract.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementBackendProxy

Creates a new Backend Proxy Object.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementBackendServiceFabric

Creates an object of PsApiManagementServiceFabric

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementCache

Creates a new Cache entity

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementCertificate

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

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementContext

Creates an instance of PsAzureApiManagementContext.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementCustomHostnameConfiguration

Creates an instance of PsApiManagementCustomHostNameConfiguration.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementDiagnostic

Creates a new diagnostics at the Global scope or Api Scope.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementGateway

Creates new Gateway entity.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementGatewayHostnameConfiguration

Creates a hostname configuratin for the existing Gateway.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementGroup

Creates an API management group.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementHttpMessageDiagnostic

Creates an instance of PsApiManagementHttpMessageDiagnostic which is an Http Message diagnostic setting of the Diagnostic

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementIdentityProvider

Creates a new Identity Provider configuration.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementKeyVaultObject

Creates an instance of PsApiManagementKeyVaultObject.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementLogger

Creates an API Management Logger.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementNamedValue

Creates new Named Value.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementOpenIdConnectProvider

Creates an OpenID Connect provider.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementOperation

Creates an API management operation.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementPipelineDiagnosticSetting

Create Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementProduct

Creates an API Management product.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementRegion

Creates an instance of PsApiManagementRegion.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementResourceLocationObject

Create a new resource location contract (used in Gateways).

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementSamplingSetting

Create a new sampling setting for the Diagnostic

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementSslSetting

Creates an instance of PsApiManagementSslSetting

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementSubscription

Creates a subscription.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementSystemCertificate

Creates an instance of PsApiManagementSystemCertificate. The certificate can be issued by private CA's and will be installed on the API Management service into CertificateAuthority or Root store.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementUser

Registers a new user.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementUserToken

Generates a Shared Access Token for the User.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

New-AzApiManagementVirtualNetwork

Creates an instance of PsApiManagementVirtualNetwork.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Publish-AzApiManagementTenantGitConfiguration

Publishes changes from a Git branch to the configuration database.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagement

Removes an API Management service.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementApi

Removes an API.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementApiFromGateway

Attaches an API to a gateway.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementApiFromProduct

Removes an API from a product.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementApiRelease

Removes a particular API Release

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementApiRevision

Removed a particular API Revision

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementApiSchema

Removes the API Schema from the API.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementApiVersionSet

Removes a particular Api Version Set

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementAuthorizationServer

Removes an authorization server.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementBackend

Removes a Backend.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementCache

Removes the cache entity.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementCertificate

Removes an API Management certificate.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementDiagnostic

Remove the Diagnostic entity from Global or API level scope.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementGateway

Detaches an API from a Gateway.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementGatewayHostnameConfiguration

Removes a hostname configuration from the existing Gateway.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementGroup

Removes an existing API management group.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementIdentityProvider

Removes an existing Identity Provider Configuration.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementLogger

Removes an API Management Logger.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementNamedValue

Removes an API Management Named Value.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementOpenIdConnectProvider

Removes an OpenID Connect provider.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementOperation

Removes an existing operation.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementPolicy

Removes the API Management policy from a specified scope.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementProduct

Removes an existing API Management product.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementProductFromGroup

Removes a product from a group.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementRegion

Removes an existing deployment region from PsApiManagement instance.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementSubscription

Deletes an existing subscription.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementUser

Deletes an existing user.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Remove-AzApiManagementUserFromGroup

Removes a user from a group.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Restore-AzApiManagement

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

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Save-AzApiManagementTenantGitConfiguration

Saves changes by creating a commit for current configuration.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagement

Updates an Azure Api Management service

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagementApi

Modifies an API.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagementApiRevision

Modifies an API Revision

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagementApiSchema

Modifies an API Schema

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagementApiVersionSet

Updates an API Version Set in the API Management Context.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagementAuthorizationServer

Modifies an authorization server.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagementBackend

Updates a Backend.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagementCertificate

Modifies an API Management certificate which is configured for mutual authentication with backend.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagementDiagnostic

Modifies an API Management diagnostic at the Global or Api scope.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagementGroup

Configures an API management group.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagementIdentityProvider

Updates the Configuration of an existing Identity Provider.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagementLogger

Modifies an API Management Logger.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagementNamedValue

Modifies an API Management Named Value.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagementOpenIdConnectProvider

Modifies an OpenID Connect provider.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagementOperation

Sets API operation details.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagementPolicy

Sets the specified scope policy for API Management.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagementProduct

Sets the API Management product details.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagementSubscription

Sets existing subscription details.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagementTenantAccess

Enables or disables tenant access.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Set-AzApiManagementUser

Sets user details.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Sync-AzApiManagementKeyVaultSecret

Refreshes NamedValue or Certificate created by KeyVault.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Update-AzApiManagementApiRelease

Updates a particular Api Release.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Update-AzApiManagementCache

updates a cache in Api Management service.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Update-AzApiManagementGateway

Configures an API management Gateway.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Update-AzApiManagementRegion

Updates existing deployment region in PsApiManagement instance.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.