Servizio Microsoft.ApiManagement/apis 2017-03-01
Il tipo di risorsa service/apis può essere distribuito con operazioni destinate a:
Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.
Per creare una risorsa Microsoft.ApiManagement/service/apis, aggiungere il bicep seguente al modello.
resource symbolicname 'Microsoft.ApiManagement/service/apis@2017-03-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
apiRevision: 'string'
apiVersion: 'string'
apiVersionSet: {
properties: {
description: 'string'
displayName: 'string'
versionHeaderName: 'string'
versioningScheme: 'string'
versionQueryName: 'string'
}
}
apiVersionSetId: 'string'
authenticationSettings: {
oAuth2: {
authorizationServerId: 'string'
scope: 'string'
}
}
contentFormat: 'string'
contentValue: 'string'
description: 'string'
displayName: 'string'
path: 'string'
protocols: [
'string'
]
serviceUrl: 'string'
subscriptionKeyParameterNames: {
header: 'string'
query: 'string'
}
type: 'string'
wsdlSelector: {
wsdlEndpointName: 'string'
wsdlServiceName: 'string'
}
}
}
Nome | Descrizione | Valore |
---|---|---|
apiRevision | Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1 | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 100 |
apiVersion | Indica l'identificatore della versione dell'API se l'API è con versione | corda Vincoli: Lunghezza massima = 100 |
apiVersionSet | Dettagli del contratto del set di versioni dell'API. | ApiVersionSetContract |
apiVersionSetId | Identificatore di risorsa per l'Oggetto ApiVersionSet correlato. | corda |
authenticationSettings | Raccolta di impostazioni di autenticazione incluse in questa API. | AuthenticationSettingsContract |
contentFormat | Formato del contenuto in cui viene importata l'API. | 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link' |
contentValue | Valore del contenuto durante l'importazione di un'API. | corda |
descrizione | Descrizione dell'API. Può includere tag di formattazione HTML. | corda |
displayName | Nome API. | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 300 |
sentiero | URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi di risorse all'interno dell'istanza del servizio Gestione API. Viene aggiunto all'URL di base dell'endpoint API specificato durante la creazione dell'istanza del servizio per formare un URL pubblico per questa API. | corda Vincoli: Lunghezza massima = 400 (obbligatorio) |
Protocolli | Descrive i protocolli in cui è possibile richiamare le operazioni in questa API. | Matrice di stringhe contenente uno dei seguenti elementi: 'http' 'https' |
serviceUrl | URL assoluto del servizio back-end che implementa questa API. | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 2000 |
subscriptionKeyParameterNames | Protocolli su cui è disponibile l'API. | SubscriptionKeyParameterNamesContract |
digitare | Tipo di API. | 'http' 'soap' |
wsdlSelector | Criteri per limitare l'importazione di WSDL in un subset del documento. | ApiCreateOrUpdatePropertiesWsdlSelector |
Nome | Descrizione | Valore |
---|---|---|
wsdlEndpointName | Nome dell'endpoint(porta) da importare da WSDL | corda |
wsdlServiceName | Nome del servizio da importare da WSDL | corda |
Nome | Descrizione | Valore |
---|---|---|
proprietà | Proprietà di un set di versioni dell'API. | ApiVersionSetContractProperties |
Nome | Descrizione | Valore |
---|---|---|
descrizione | Descrizione del set di versioni dell'API. | corda |
displayName | Nome del set di versioni dell'API | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 100 (obbligatorio) |
versionHeaderName | Nome del parametro di intestazione HTTP che indica la versione dell'API se versioningScheme è impostato su header . |
corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 100 |
controllo delle versioniScheme | Valore che determina dove si trova l'identificatore della versione dell'API in una richiesta HTTP. | 'Header' 'Query' 'Segment' (obbligatorio) |
versionQueryName | Nome del parametro di query che indica la versione dell'API se versioningScheme è impostato su query . |
corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 100 |
Nome | Descrizione | Valore |
---|---|---|
oAuth2 | Impostazioni di autenticazione OAuth2 | OAuth2AuthenticationSettingsContract |
Nome | Descrizione | Valore |
---|---|---|
nome | Nome della risorsa | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 256 Pattern = ^[^*#&+:<>?]+$ (obbligatorio) |
genitore | In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre. Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre. |
Nome simbolico per la risorsa di tipo: servizio |
proprietà | Creazione di entità API delle proprietà di aggiornamento. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
Nome | Descrizione | Valore |
---|---|---|
authorizationServerId | Identificatore del server di autorizzazione OAuth. | corda |
portata | ambito delle operazioni. | corda |
Nome | Descrizione | Valore |
---|---|---|
intestazione | Nome dell'intestazione della chiave di sottoscrizione. | corda |
quesito | Nome del parametro della stringa di query della chiave di sottoscrizione. | corda |
Il tipo di risorsa service/apis può essere distribuito con operazioni destinate a:
Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.
Per creare una risorsa Microsoft.ApiManagement/service/apis, aggiungere il codice JSON seguente al modello.
{
"type": "Microsoft.ApiManagement/service/apis",
"apiVersion": "2017-03-01",
"name": "string",
"properties": {
"apiRevision": "string",
"apiVersion": "string",
"apiVersionSet": {
"properties": {
"description": "string",
"displayName": "string",
"versionHeaderName": "string",
"versioningScheme": "string",
"versionQueryName": "string"
}
},
"apiVersionSetId": "string",
"authenticationSettings": {
"oAuth2": {
"authorizationServerId": "string",
"scope": "string"
}
},
"contentFormat": "string",
"contentValue": "string",
"description": "string",
"displayName": "string",
"path": "string",
"protocols": [ "string" ],
"serviceUrl": "string",
"subscriptionKeyParameterNames": {
"header": "string",
"query": "string"
},
"type": "string",
"wsdlSelector": {
"wsdlEndpointName": "string",
"wsdlServiceName": "string"
}
}
}
Nome | Descrizione | Valore |
---|---|---|
apiRevision | Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1 | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 100 |
apiVersion | Indica l'identificatore della versione dell'API se l'API è con versione | corda Vincoli: Lunghezza massima = 100 |
apiVersionSet | Dettagli del contratto del set di versioni dell'API. | ApiVersionSetContract |
apiVersionSetId | Identificatore di risorsa per l'Oggetto ApiVersionSet correlato. | corda |
authenticationSettings | Raccolta di impostazioni di autenticazione incluse in questa API. | AuthenticationSettingsContract |
contentFormat | Formato del contenuto in cui viene importata l'API. | 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link' |
contentValue | Valore del contenuto durante l'importazione di un'API. | corda |
descrizione | Descrizione dell'API. Può includere tag di formattazione HTML. | corda |
displayName | Nome API. | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 300 |
sentiero | URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi di risorse all'interno dell'istanza del servizio Gestione API. Viene aggiunto all'URL di base dell'endpoint API specificato durante la creazione dell'istanza del servizio per formare un URL pubblico per questa API. | corda Vincoli: Lunghezza massima = 400 (obbligatorio) |
Protocolli | Descrive i protocolli in cui è possibile richiamare le operazioni in questa API. | Matrice di stringhe contenente uno dei seguenti elementi: 'http' 'https' |
serviceUrl | URL assoluto del servizio back-end che implementa questa API. | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 2000 |
subscriptionKeyParameterNames | Protocolli su cui è disponibile l'API. | SubscriptionKeyParameterNamesContract |
digitare | Tipo di API. | 'http' 'soap' |
wsdlSelector | Criteri per limitare l'importazione di WSDL in un subset del documento. | ApiCreateOrUpdatePropertiesWsdlSelector |
Nome | Descrizione | Valore |
---|---|---|
wsdlEndpointName | Nome dell'endpoint(porta) da importare da WSDL | corda |
wsdlServiceName | Nome del servizio da importare da WSDL | corda |
Nome | Descrizione | Valore |
---|---|---|
proprietà | Proprietà di un set di versioni dell'API. | ApiVersionSetContractProperties |
Nome | Descrizione | Valore |
---|---|---|
descrizione | Descrizione del set di versioni dell'API. | corda |
displayName | Nome del set di versioni dell'API | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 100 (obbligatorio) |
versionHeaderName | Nome del parametro di intestazione HTTP che indica la versione dell'API se versioningScheme è impostato su header . |
corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 100 |
controllo delle versioniScheme | Valore che determina dove si trova l'identificatore della versione dell'API in una richiesta HTTP. | 'Header' 'Query' 'Segment' (obbligatorio) |
versionQueryName | Nome del parametro di query che indica la versione dell'API se versioningScheme è impostato su query . |
corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 100 |
Nome | Descrizione | Valore |
---|---|---|
oAuth2 | Impostazioni di autenticazione OAuth2 | OAuth2AuthenticationSettingsContract |
Nome | Descrizione | Valore |
---|---|---|
apiVersion | Versione dell'API | '2017-03-01' |
nome | Nome della risorsa | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 256 Pattern = ^[^*#&+:<>?]+$ (obbligatorio) |
proprietà | Creazione di entità API delle proprietà di aggiornamento. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
digitare | Tipo di risorsa | 'Microsoft.ApiManagement/service/apis' |
Nome | Descrizione | Valore |
---|---|---|
authorizationServerId | Identificatore del server di autorizzazione OAuth. | corda |
portata | ambito delle operazioni. | corda |
Nome | Descrizione | Valore |
---|---|---|
intestazione | Nome dell'intestazione della chiave di sottoscrizione. | corda |
quesito | Nome del parametro della stringa di query della chiave di sottoscrizione. | corda |
Il tipo di risorsa service/apis può essere distribuito con operazioni destinate a:
- gruppi di risorse
Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.
Per creare una risorsa Microsoft.ApiManagement/service/apis, aggiungere il codice Terraform seguente al modello.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis@2017-03-01"
name = "string"
body = jsonencode({
properties = {
apiRevision = "string"
apiVersion = "string"
apiVersionSet = {
properties = {
description = "string"
displayName = "string"
versionHeaderName = "string"
versioningScheme = "string"
versionQueryName = "string"
}
}
apiVersionSetId = "string"
authenticationSettings = {
oAuth2 = {
authorizationServerId = "string"
scope = "string"
}
}
contentFormat = "string"
contentValue = "string"
description = "string"
displayName = "string"
path = "string"
protocols = [
"string"
]
serviceUrl = "string"
subscriptionKeyParameterNames = {
header = "string"
query = "string"
}
type = "string"
wsdlSelector = {
wsdlEndpointName = "string"
wsdlServiceName = "string"
}
}
})
}
Nome | Descrizione | Valore |
---|---|---|
apiRevision | Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1 | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 100 |
apiVersion | Indica l'identificatore della versione dell'API se l'API è con versione | corda Vincoli: Lunghezza massima = 100 |
apiVersionSet | Dettagli del contratto del set di versioni dell'API. | ApiVersionSetContract |
apiVersionSetId | Identificatore di risorsa per l'Oggetto ApiVersionSet correlato. | corda |
authenticationSettings | Raccolta di impostazioni di autenticazione incluse in questa API. | AuthenticationSettingsContract |
contentFormat | Formato del contenuto in cui viene importata l'API. | 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link' |
contentValue | Valore del contenuto durante l'importazione di un'API. | corda |
descrizione | Descrizione dell'API. Può includere tag di formattazione HTML. | corda |
displayName | Nome API. | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 300 |
sentiero | URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi di risorse all'interno dell'istanza del servizio Gestione API. Viene aggiunto all'URL di base dell'endpoint API specificato durante la creazione dell'istanza del servizio per formare un URL pubblico per questa API. | corda Vincoli: Lunghezza massima = 400 (obbligatorio) |
Protocolli | Descrive i protocolli in cui è possibile richiamare le operazioni in questa API. | Matrice di stringhe contenente uno dei seguenti elementi: 'http' 'https' |
serviceUrl | URL assoluto del servizio back-end che implementa questa API. | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 2000 |
subscriptionKeyParameterNames | Protocolli su cui è disponibile l'API. | SubscriptionKeyParameterNamesContract |
digitare | Tipo di API. | 'http' 'soap' |
wsdlSelector | Criteri per limitare l'importazione di WSDL in un subset del documento. | ApiCreateOrUpdatePropertiesWsdlSelector |
Nome | Descrizione | Valore |
---|---|---|
wsdlEndpointName | Nome dell'endpoint(porta) da importare da WSDL | corda |
wsdlServiceName | Nome del servizio da importare da WSDL | corda |
Nome | Descrizione | Valore |
---|---|---|
proprietà | Proprietà di un set di versioni dell'API. | ApiVersionSetContractProperties |
Nome | Descrizione | Valore |
---|---|---|
descrizione | Descrizione del set di versioni dell'API. | corda |
displayName | Nome del set di versioni dell'API | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 100 (obbligatorio) |
versionHeaderName | Nome del parametro di intestazione HTTP che indica la versione dell'API se versioningScheme è impostato su header . |
corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 100 |
controllo delle versioniScheme | Valore che determina dove si trova l'identificatore della versione dell'API in una richiesta HTTP. | 'Header' 'Query' 'Segment' (obbligatorio) |
versionQueryName | Nome del parametro di query che indica la versione dell'API se versioningScheme è impostato su query . |
corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 100 |
Nome | Descrizione | Valore |
---|---|---|
oAuth2 | Impostazioni di autenticazione OAuth2 | OAuth2AuthenticationSettingsContract |
Nome | Descrizione | Valore |
---|---|---|
nome | Nome della risorsa | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 256 Pattern = ^[^*#&+:<>?]+$ (obbligatorio) |
parent_id | ID della risorsa padre per questa risorsa. | ID per la risorsa di tipo: servizio |
proprietà | Creazione di entità API delle proprietà di aggiornamento. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
digitare | Tipo di risorsa | "Microsoft.ApiManagement/service/apis@2017-03-01" |
Nome | Descrizione | Valore |
---|---|---|
authorizationServerId | Identificatore del server di autorizzazione OAuth. | corda |
portata | ambito delle operazioni. | corda |
Nome | Descrizione | Valore |
---|---|---|
intestazione | Nome dell'intestazione della chiave di sottoscrizione. | corda |
quesito | Nome del parametro della stringa di query della chiave di sottoscrizione. | corda |