222 строки
21 KiB
YAML
222 строки
21 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices"
|
|
name: "ApiManagementServices"
|
|
nameWithType: "ApiManagementServices"
|
|
summary: "Type representing Api<wbr>Management<wbr>Services."
|
|
syntax: "public interface **ApiManagementServices**"
|
|
methods:
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.applyNetworkConfigurationUpdatesAsync(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.applyNetworkConfigurationUpdatesAsync(String resourceGroupName, String serviceName)"
|
|
name: "applyNetworkConfigurationUpdatesAsync(String resourceGroupName, String serviceName)"
|
|
nameWithType: "ApiManagementServices.applyNetworkConfigurationUpdatesAsync(String resourceGroupName, String serviceName)"
|
|
summary: "Updates the Microsoft.<wbr>Api<wbr>Management resource running in the Virtual network to pick the updated network settings."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group."
|
|
name: "resourceGroupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the API Management service."
|
|
name: "serviceName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Observable<ApiManagementServiceResource> applyNetworkConfigurationUpdatesAsync(String resourceGroupName, String serviceName)"
|
|
desc: "Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated network settings."
|
|
returns:
|
|
description: "the observable for the request"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceResource?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceResource&text=ApiManagementServiceResource\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.backupAsync(java.lang.String,java.lang.String,com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceBackupRestoreParameters)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.backupAsync(String resourceGroupName, String serviceName, ApiManagementServiceBackupRestoreParameters parameters)"
|
|
name: "backupAsync(String resourceGroupName, String serviceName, ApiManagementServiceBackupRestoreParameters parameters)"
|
|
nameWithType: "ApiManagementServices.backupAsync(String resourceGroupName, String serviceName, ApiManagementServiceBackupRestoreParameters parameters)"
|
|
summary: "Creates a backup of the API Management service to the given Azure Storage Account."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group."
|
|
name: "resourceGroupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the API Management service."
|
|
name: "serviceName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Parameters supplied to the ApiManagementService_Backup operation."
|
|
name: "parameters"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceBackupRestoreParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceBackupRestoreParameters&text=ApiManagementServiceBackupRestoreParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Observable<ApiManagementServiceResource> backupAsync(String resourceGroupName, String serviceName, ApiManagementServiceBackupRestoreParameters parameters)"
|
|
desc: "Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete."
|
|
returns:
|
|
description: "the observable for the request"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceResource?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceResource&text=ApiManagementServiceResource\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.checkNameAvailabilityAsync(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.checkNameAvailabilityAsync(String name)"
|
|
name: "checkNameAvailabilityAsync(String name)"
|
|
nameWithType: "ApiManagementServices.checkNameAvailabilityAsync(String name)"
|
|
summary: "Checks availability and correctness of a name for an API Management service."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name to check for availability."
|
|
name: "name"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Observable<ApiManagementServiceNameAvailabilityResult> checkNameAvailabilityAsync(String name)"
|
|
desc: "Checks availability and correctness of a name for an API Management service."
|
|
returns:
|
|
description: "the observable for the request"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceNameAvailabilityResult?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceNameAvailabilityResult&text=ApiManagementServiceNameAvailabilityResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.createOrUpdateAsync(java.lang.String,java.lang.String,com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.ApiManagementServiceResourceInner)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.createOrUpdateAsync(String resourceGroupName, String serviceName, ApiManagementServiceResourceInner parameters)"
|
|
name: "createOrUpdateAsync(String resourceGroupName, String serviceName, ApiManagementServiceResourceInner parameters)"
|
|
nameWithType: "ApiManagementServices.createOrUpdateAsync(String resourceGroupName, String serviceName, ApiManagementServiceResourceInner parameters)"
|
|
summary: "Creates or updates an API Management service."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group."
|
|
name: "resourceGroupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the API Management service."
|
|
name: "serviceName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Parameters supplied to the CreateOrUpdate API Management service operation."
|
|
name: "parameters"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.ApiManagementServiceResourceInner?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.ApiManagementServiceResourceInner&text=ApiManagementServiceResourceInner\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Observable<ApiManagementServiceResource> createOrUpdateAsync(String resourceGroupName, String serviceName, ApiManagementServiceResourceInner parameters)"
|
|
desc: "Creates or updates an API Management service. This is long running operation and could take several minutes to complete."
|
|
returns:
|
|
description: "the observable for the request"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceResource?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceResource&text=ApiManagementServiceResource\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.deleteAsync(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.deleteAsync(String resourceGroupName, String serviceName)"
|
|
name: "deleteAsync(String resourceGroupName, String serviceName)"
|
|
nameWithType: "ApiManagementServices.deleteAsync(String resourceGroupName, String serviceName)"
|
|
summary: "Deletes an existing API Management service."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group."
|
|
name: "resourceGroupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the API Management service."
|
|
name: "serviceName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Observable<ApiManagementServiceResource> deleteAsync(String resourceGroupName, String serviceName)"
|
|
desc: "Deletes an existing API Management service."
|
|
returns:
|
|
description: "the observable for the request"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceResource?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceResource&text=ApiManagementServiceResource\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.getByResourceGroupAsync(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.getByResourceGroupAsync(String resourceGroupName, String serviceName)"
|
|
name: "getByResourceGroupAsync(String resourceGroupName, String serviceName)"
|
|
nameWithType: "ApiManagementServices.getByResourceGroupAsync(String resourceGroupName, String serviceName)"
|
|
summary: "Gets an API Management service resource description."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group."
|
|
name: "resourceGroupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the API Management service."
|
|
name: "serviceName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Observable<ApiManagementServiceResource> getByResourceGroupAsync(String resourceGroupName, String serviceName)"
|
|
desc: "Gets an API Management service resource description."
|
|
returns:
|
|
description: "the observable for the request"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceResource?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceResource&text=ApiManagementServiceResource\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.getSsoTokenAsync(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.getSsoTokenAsync(String resourceGroupName, String serviceName)"
|
|
name: "getSsoTokenAsync(String resourceGroupName, String serviceName)"
|
|
nameWithType: "ApiManagementServices.getSsoTokenAsync(String resourceGroupName, String serviceName)"
|
|
summary: "Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group."
|
|
name: "resourceGroupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the API Management service."
|
|
name: "serviceName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Observable<ApiManagementServiceGetSsoTokenResult> getSsoTokenAsync(String resourceGroupName, String serviceName)"
|
|
desc: "Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes."
|
|
returns:
|
|
description: "the observable for the request"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceGetSsoTokenResult?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceGetSsoTokenResult&text=ApiManagementServiceGetSsoTokenResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.listAsync()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.listAsync()"
|
|
name: "listAsync()"
|
|
nameWithType: "ApiManagementServices.listAsync()"
|
|
summary: "Lists all API Management services within an Azure subscription."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Observable<ApiManagementServiceResource> listAsync()"
|
|
desc: "Lists all API Management services within an Azure subscription."
|
|
returns:
|
|
description: "the observable for the request"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceResource?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceResource&text=ApiManagementServiceResource\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.listByResourceGroupAsync(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.listByResourceGroupAsync(String resourceGroupName)"
|
|
name: "listByResourceGroupAsync(String resourceGroupName)"
|
|
nameWithType: "ApiManagementServices.listByResourceGroupAsync(String resourceGroupName)"
|
|
summary: "List all API Management services within a resource group."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group."
|
|
name: "resourceGroupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Observable<ApiManagementServiceResource> listByResourceGroupAsync(String resourceGroupName)"
|
|
desc: "List all API Management services within a resource group."
|
|
returns:
|
|
description: "the observable for the request"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceResource?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceResource&text=ApiManagementServiceResource\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.restoreAsync(java.lang.String,java.lang.String,com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceBackupRestoreParameters)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.restoreAsync(String resourceGroupName, String serviceName, ApiManagementServiceBackupRestoreParameters parameters)"
|
|
name: "restoreAsync(String resourceGroupName, String serviceName, ApiManagementServiceBackupRestoreParameters parameters)"
|
|
nameWithType: "ApiManagementServices.restoreAsync(String resourceGroupName, String serviceName, ApiManagementServiceBackupRestoreParameters parameters)"
|
|
summary: "Restores a backup of an API Management service created using the Api<wbr>Management<wbr>Service\\_Backup operation on the current service."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group."
|
|
name: "resourceGroupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the API Management service."
|
|
name: "serviceName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Parameters supplied to the Restore API Management service from backup operation."
|
|
name: "parameters"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceBackupRestoreParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceBackupRestoreParameters&text=ApiManagementServiceBackupRestoreParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Observable<ApiManagementServiceResource> restoreAsync(String resourceGroupName, String serviceName, ApiManagementServiceBackupRestoreParameters parameters)"
|
|
desc: "Restores a backup of an API Management service created using the ApiManagementService\\_Backup operation on the current service. This is a long running operation and could take several minutes to complete."
|
|
returns:
|
|
description: "the observable for the request"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceResource?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceResource&text=ApiManagementServiceResource\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.updateAsync(java.lang.String,java.lang.String,com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServices.updateAsync(String resourceGroupName, String serviceName, ApiManagementServiceUpdateParameters parameters)"
|
|
name: "updateAsync(String resourceGroupName, String serviceName, ApiManagementServiceUpdateParameters parameters)"
|
|
nameWithType: "ApiManagementServices.updateAsync(String resourceGroupName, String serviceName, ApiManagementServiceUpdateParameters parameters)"
|
|
summary: "Updates an existing API Management service."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group."
|
|
name: "resourceGroupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the API Management service."
|
|
name: "serviceName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Parameters supplied to the CreateOrUpdate API Management service operation."
|
|
name: "parameters"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceUpdateParameters&text=ApiManagementServiceUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Observable<ApiManagementServiceResource> updateAsync(String resourceGroupName, String serviceName, ApiManagementServiceUpdateParameters parameters)"
|
|
desc: "Updates an existing API Management service."
|
|
returns:
|
|
description: "the observable for the request"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceResource?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiManagementServiceResource&text=ApiManagementServiceResource\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "interface"
|
|
desc: "Type representing ApiManagementServices."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.management.apimanagement.v2019_01_01"
|
|
artifact: com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1
|