Ottenere il servizio Gestione API eliminato soft in base al nome.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/deletedservices/{serviceName}?api-version=2022-08-01
Parametri dell'URI
Nome |
In |
Necessario |
Tipo |
Descrizione |
location
|
path |
True
|
string
|
Percorso del servizio Gestione API eliminato.
|
serviceName
|
path |
True
|
string
|
Nome del servizio di Gestione API.
Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
|
subscriptionId
|
path |
True
|
string
|
ID della sottoscrizione di destinazione.
|
api-version
|
query |
True
|
string
|
Versione dell'API da usare per questa operazione.
|
Risposte
Nome |
Tipo |
Descrizione |
200 OK
|
DeletedServiceContract
|
Servizio Gestione API eliminato temporanea.
|
Other Status Codes
|
ErrorResponse
|
Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.
|
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome |
Descrizione |
user_impersonation
|
rappresentare l'account utente
|
Esempio
ApiManagementGetDeletedServiceByName
Sample Request
GET https://management.azure.com/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3?api-version=2022-08-01
/** Samples for DeletedServices GetByName. */
public final class Main {
/*
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetDeletedServiceByName.json
*/
/**
* Sample code: ApiManagementGetDeletedServiceByName.
*
* @param manager Entry point to ApiManagementManager.
*/
public static void apiManagementGetDeletedServiceByName(
com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
manager.deletedServices().getByNameWithResponse("apimService3", "westus", com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-apimanagement
# USAGE
python api_management_get_deleted_service_by_name.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = ApiManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.deleted_services.get_by_name(
service_name="apimService3",
location="westus",
)
print(response)
# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetDeletedServiceByName.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armapimanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetDeletedServiceByName.json
func ExampleDeletedServicesClient_GetByName() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDeletedServicesClient().GetByName(ctx, "apimService3", "westus", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DeletedServiceContract = armapimanagement.DeletedServiceContract{
// Name: to.Ptr("apimService3"),
// Type: to.Ptr("Microsoft.ApiManagement/deletedservices"),
// ID: to.Ptr("/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3"),
// Location: to.Ptr("West US"),
// Properties: &armapimanagement.DeletedServiceContractProperties{
// DeletionDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-27T15:33:55.542Z"); return t}()),
// ScheduledPurgeDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-27T15:33:55.542Z"); return t}()),
// ServiceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService3"),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Get soft-deleted Api Management Service by name.
*
* @summary Get soft-deleted Api Management Service by name.
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetDeletedServiceByName.json
*/
async function apiManagementGetDeletedServiceByName() {
const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
const serviceName = "apimService3";
const location = "westus";
const credential = new DefaultAzureCredential();
const client = new ApiManagementClient(credential, subscriptionId);
const result = await client.deletedServices.getByName(serviceName, location);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"id": "/subscriptions/subid/providers/Microsoft.ApiManagement/locations/westus/deletedservices/apimService3",
"name": "apimService3",
"type": "Microsoft.ApiManagement/deletedservices",
"location": "West US",
"properties": {
"serviceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService3",
"scheduledPurgeDate": "2017-05-27T15:33:55.5426123Z",
"deletionDate": "2017-05-27T15:33:55.5426123Z"
}
}
Definizioni
DeletedServiceContract
Informazioni sul servizio Gestione API eliminate.
Nome |
Tipo |
Descrizione |
id
|
string
|
ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
location
|
string
|
Gestione API Percorso master del servizio.
|
name
|
string
|
nome della risorsa.
|
properties.deletionDate
|
string
|
Timestamp UTC quando il servizio è stato eliminato temporaneamente. La data è conforme al formato seguente: a-MM-ggTHH:mm:ssZ come specificato dallo standard ISO 8601.
|
properties.scheduledPurgeDate
|
string
|
Data e ora UTC in cui il servizio verrà eliminato automaticamente. La data è conforme al formato seguente: a-MM-ggTHH:mm:ssZ come specificato dallo standard ISO 8601.
|
properties.serviceId
|
string
|
ID risorsa servizio Gestione API completo
|
type
|
string
|
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"
|
ErrorFieldContract
Contratto campo di errore.
Nome |
Tipo |
Descrizione |
code
|
string
|
Codice di errore a livello di proprietà.
|
message
|
string
|
Rappresentazione leggibile dell'errore a livello di proprietà.
|
target
|
string
|
Nome della proprietà.
|
ErrorResponse
Risposta errore.
Nome |
Tipo |
Descrizione |
error.code
|
string
|
Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.
|
error.details
|
ErrorFieldContract[]
|
Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.
|
error.message
|
string
|
Rappresentazione leggibile dell'errore.
|