Az.ApiManagement
This topic displays help topics for the Azure API Management Cmdlets.
API Management
| Add-AzApiManagementApiToGateway |
Attaches an API to a gateway. |
| Add-AzApiManagementApiToProduct |
Adds an API to a product. |
| Add-AzApiManagementProductToGroup |
Adds a product to a group. |
| Add-AzApiManagementRegion |
Adds new deployment regions to a PsApiManagement instance. |
| Add-AzApiManagementUserToGroup |
Adds a user to a group. |
| Backup-AzApiManagement |
Backs up an API Management service. |
| Export-AzApiManagementApi |
Exports an API to a file. |
| Get-AzApiManagement |
Gets a list or a particular API Management Service description. |
| Get-AzApiManagementApi |
Gets an API. |
| Get-AzApiManagementApiRelease |
Get the API Release. |
| Get-AzApiManagementApiRevision |
Gets details of all the API Revisions of an API |
| Get-AzApiManagementApiSchema |
Get the details of the API Schema |
| Get-AzApiManagementApiVersionSet |
Get the details of the API Version Sets |
| Get-AzApiManagementAuthorizationServer |
Gets an API Management authorization server. |
| Get-AzApiManagementAuthorizationServerClientSecret |
Gets an API Management authorization server client secret. |
| Get-AzApiManagementBackend |
Get the details of the Backend. |
| Get-AzApiManagementCache |
Get the details of the Cache. |
| Get-AzApiManagementCertificate |
Gets API Management certificates configured for Mutual Authentication with Backend in the service. |
| 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. |
| Get-AzApiManagementGateway |
Gets all or specific API management Gateway. |
| Get-AzApiManagementGatewayHostnameConfiguration |
Gets all or specific hostname configuration for the existing Gateway. |
| Get-AzApiManagementGatewayKey |
Gets keys of the existing Gateway |
| Get-AzApiManagementGroup |
Gets all or specific API management groups. |
| Get-AzApiManagementIdentityProvider |
Get the identity provider configuration details. |
| Get-AzApiManagementIdentityProviderClientSecret |
Get the identity provider client secret. |
| Get-AzApiManagementLogger |
Gets API Management Logger objects. |
| Get-AzApiManagementNamedValue |
Gets a list or a particular Named Value. |
| Get-AzApiManagementNamedValueSecretValue |
Gets a secret value of the particular Named Value. |
| 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. |
| Get-AzApiManagementOpenIdConnectProvider |
Gets OpenID Connect providers. |
| Get-AzApiManagementOpenIdConnectProviderClientSecret |
Gets OpenID Connect provider client secret. |
| Get-AzApiManagementOperation |
Gets a list or a specified API Operation. |
| Get-AzApiManagementPolicy |
Gets the specified scope policy. |
| Get-AzApiManagementProduct |
Gets a list or a particular product. |
| Get-AzApiManagementSsoToken |
Gets a link with an SSO token to a deployed management portal of an API Management service. |
| Get-AzApiManagementSubscription |
Gets subscriptions. |
| Get-AzApiManagementSubscriptionKey |
Gets subscription keys. |
| Get-AzApiManagementTenantAccess |
Gets the access configuration for a tenant. |
| Get-AzApiManagementTenantAccessSecret |
Gets the access configuration keys for a tenant. |
| Get-AzApiManagementTenantGitAccess |
Gets the Git access configuration for a tenant. |
| Get-AzApiManagementTenantGitAccessSecret |
Gets the Git access configuration keys for a tenant. |
| Get-AzApiManagementTenantSyncState |
Gets the status of the most recent synchronization between the configuration database and the Git repository. |
| Get-AzApiManagementUser |
Gets a user or users. |
| Get-AzApiManagementUserSsoUrl |
Generates an SSO URL for a user. |
| Import-AzApiManagementApi |
Imports an API from a file or a URL. |
| New-AzApiManagement |
Creates an API Management deployment. |
| New-AzApiManagementApi |
Creates an API. |
| New-AzApiManagementApiRelease |
Creates an API Release of an API Revision |
| New-AzApiManagementApiRevision |
Creates a new Revision of an Existing API. |
| New-AzApiManagementApiSchema |
Creates the new API Schema in the ApiManagement service |
| New-AzApiManagementApiVersionSet |
Creates an API Version Set. |
| New-AzApiManagementAuthorizationServer |
Creates an authorization server. |
| New-AzApiManagementBackend |
Creates a new backend entity. |
| New-AzApiManagementBackendCredential |
Creates a new Backend Credential contract. |
| New-AzApiManagementBackendProxy |
Creates a new Backend Proxy Object. |
| New-AzApiManagementBackendServiceFabric |
Creates an object of |
| New-AzApiManagementCache |
Creates a new Cache entity |
| New-AzApiManagementCertificate |
Creates an API Management certificate to be used during Authentication with Backend. |
| New-AzApiManagementContext |
Creates an instance of PsAzureApiManagementContext. |
| New-AzApiManagementCustomHostnameConfiguration |
Creates an instance of |
| New-AzApiManagementDiagnostic |
Creates a new diagnostics at the Global scope or Api Scope. |
| New-AzApiManagementGateway |
Creates new Gateway entity. |
| New-AzApiManagementGatewayHostnameConfiguration |
Creates a hostname configuratin for the existing Gateway. |
| New-AzApiManagementGroup |
Creates an API management group. |
| New-AzApiManagementHttpMessageDiagnostic |
Creates an instance of PsApiManagementHttpMessageDiagnostic which is an Http Message diagnostic setting of the Diagnostic |
| New-AzApiManagementIdentityProvider |
Creates a new Identity Provider configuration. |
| New-AzApiManagementKeyVaultObject |
Creates an instance of PsApiManagementKeyVaultObject. |
| New-AzApiManagementLogger |
Creates an API Management Logger. |
| New-AzApiManagementNamedValue |
Creates new Named Value. |
| New-AzApiManagementOpenIdConnectProvider |
Creates an OpenID Connect provider. |
| New-AzApiManagementOperation |
Creates an API management operation. |
| New-AzApiManagementPipelineDiagnosticSetting |
Create Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. |
| New-AzApiManagementProduct |
Creates an API Management product. |
| New-AzApiManagementRegion |
Creates an instance of PsApiManagementRegion. |
| New-AzApiManagementResourceLocationObject |
Create a new resource location contract (used in Gateways). |
| New-AzApiManagementSamplingSetting |
Create a new sampling setting for the Diagnostic |
| New-AzApiManagementSslSetting |
Creates an instance of PsApiManagementSslSetting |
| New-AzApiManagementSubscription |
Creates a subscription. |
| New-AzApiManagementSystemCertificate |
Creates an instance of |
| New-AzApiManagementUser |
Registers a new user. |
| New-AzApiManagementUserToken |
Generates a Shared Access Token for the User. |
| New-AzApiManagementVirtualNetwork |
Creates an instance of PsApiManagementVirtualNetwork. |
| Publish-AzApiManagementTenantGitConfiguration |
Publishes changes from a Git branch to the configuration database. |
| Remove-AzApiManagement |
Removes an API Management service. |
| Remove-AzApiManagementApi |
Removes an API. |
| Remove-AzApiManagementApiFromGateway |
Attaches an API to a gateway. |
| Remove-AzApiManagementApiFromProduct |
Removes an API from a product. |
| Remove-AzApiManagementApiRelease |
Removes a particular API Release |
| Remove-AzApiManagementApiRevision |
Removed a particular API Revision |
| Remove-AzApiManagementApiSchema |
Removes the API Schema from the API. |
| Remove-AzApiManagementApiVersionSet |
Removes a particular Api Version Set |
| Remove-AzApiManagementAuthorizationServer |
Removes an authorization server. |
| Remove-AzApiManagementBackend |
Removes a Backend. |
| Remove-AzApiManagementCache |
Removes the cache entity. |
| Remove-AzApiManagementCertificate |
Removes an API Management certificate. |
| Remove-AzApiManagementDiagnostic |
Remove the Diagnostic entity from Global or API level scope. |
| Remove-AzApiManagementGateway |
Detaches an API from a Gateway. |
| Remove-AzApiManagementGatewayHostnameConfiguration |
Removes a hostname configuration from the existing Gateway. |
| Remove-AzApiManagementGroup |
Removes an existing API management group. |
| Remove-AzApiManagementIdentityProvider |
Removes an existing Identity Provider Configuration. |
| Remove-AzApiManagementLogger |
Removes an API Management Logger. |
| Remove-AzApiManagementNamedValue |
Removes an API Management Named Value. |
| Remove-AzApiManagementOpenIdConnectProvider |
Removes an OpenID Connect provider. |
| Remove-AzApiManagementOperation |
Removes an existing operation. |
| Remove-AzApiManagementPolicy |
Removes the API Management policy from a specified scope. |
| Remove-AzApiManagementProduct |
Removes an existing API Management product. |
| Remove-AzApiManagementProductFromGroup |
Removes a product from a group. |
| Remove-AzApiManagementRegion |
Removes an existing deployment region from PsApiManagement instance. |
| Remove-AzApiManagementSubscription |
Deletes an existing subscription. |
| Remove-AzApiManagementUser |
Deletes an existing user. |
| Remove-AzApiManagementUserFromGroup |
Removes a user from a group. |
| Restore-AzApiManagement |
Restores an API Management Service from the specified Azure Storage blob. |
| Save-AzApiManagementTenantGitConfiguration |
Saves changes by creating a commit for current configuration. |
| Set-AzApiManagement |
Updates an Azure Api Management service |
| Set-AzApiManagementApi |
Modifies an API. |
| Set-AzApiManagementApiRevision |
Modifies an API Revision |
| Set-AzApiManagementApiSchema |
Modifies an API Schema |
| Set-AzApiManagementApiVersionSet |
Updates an API Version Set in the API Management Context. |
| Set-AzApiManagementAuthorizationServer |
Modifies an authorization server. |
| Set-AzApiManagementBackend |
Updates a Backend. |
| Set-AzApiManagementCertificate |
Modifies an API Management certificate which is configured for mutual authentication with backend. |
| Set-AzApiManagementDiagnostic |
Modifies an API Management diagnostic at the Global or Api scope. |
| Set-AzApiManagementGroup |
Configures an API management group. |
| Set-AzApiManagementIdentityProvider |
Updates the Configuration of an existing Identity Provider. |
| Set-AzApiManagementLogger |
Modifies an API Management Logger. |
| Set-AzApiManagementNamedValue |
Modifies an API Management Named Value. |
| Set-AzApiManagementOpenIdConnectProvider |
Modifies an OpenID Connect provider. |
| Set-AzApiManagementOperation |
Sets API operation details. |
| Set-AzApiManagementPolicy |
Sets the specified scope policy for API Management. |
| Set-AzApiManagementProduct |
Sets the API Management product details. |
| Set-AzApiManagementSubscription |
Sets existing subscription details. |
| Set-AzApiManagementTenantAccess |
Enables or disables tenant access. |
| Set-AzApiManagementUser |
Sets user details. |
| Sync-AzApiManagementKeyVaultSecret |
Refreshes NamedValue or Certificate created by KeyVault. |
| Update-AzApiManagementApiRelease |
Updates a particular Api Release. |
| Update-AzApiManagementCache |
updates a cache in Api Management service. |
| Update-AzApiManagementGateway |
Configures an API management Gateway. |
| Update-AzApiManagementRegion |
Updates existing deployment region in PsApiManagement instance. |
