Service Microsoft.ApiManagement/apis 2017-03-01
- dernière
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Définition de ressource Bicep
Le type de ressource service/apis peut être déployé avec des opérations qui ciblent :
- groupes de ressources - Consultez commandes de déploiement de groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format de ressource
Pour créer une ressource Microsoft.ApiManagement/service/apis, ajoutez le bicep suivant à votre modèle.
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'
}
}
}
Valeurs de propriété
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Nom | Description | Valeur |
|---|---|---|
| apiRevision | Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision 1 par défaut est créée | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
| apiVersion | Indique l’identificateur de version de l’API si l’API est versionnée | corde Contraintes: Longueur maximale = |
| apiVersionSet | Détails du contrat du jeu de versions de l’API. | ApiVersionSetContract |
| apiVersionSetId | Identificateur de ressource pour l’ApiVersionSet associé. | corde |
| authenticationSettings | Collection de paramètres d’authentification inclus dans cette API. | AuthenticationSettingsContract |
| contentFormat | Format du contenu dans lequel l’API est importée. | 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link' |
| contentValue | Valeur de contenu lors de l’importation d’une API. | corde |
| description | Description de l’API. Peut inclure des balises de mise en forme HTML. | corde |
| displayName | Nom de l’API. | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
| chemin | URL relative identifiant de manière unique cette API et tous ses chemins de ressources dans l’instance du service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée pendant la création de l’instance de service pour former une URL publique pour cette API. | corde Contraintes: Longueur maximale = (obligatoire) |
| protocole | Décrit les protocoles sur lesquels les opérations de cette API peuvent être appelées. | Tableau de chaînes contenant l’un des éléments suivants : 'http' 'https' |
| serviceUrl | URL absolue du service principal implémentant cette API. | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
| subscriptionKeyParameterNames | Protocoles sur lesquels l’API est rendue disponible. | SubscriptionKeyParameterNamesContract |
| type | Type d’API. | 'http' 'soap' |
| wsdlSelector | Critères pour limiter l’importation de WSDL à un sous-ensemble du document. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Nom | Description | Valeur |
|---|---|---|
| wsdlEndpointName | Nom du point de terminaison(port) à importer à partir de WSDL | corde |
| wsdlServiceName | Nom du service à importer à partir de WSDL | corde |
ApiVersionSetContract
| Nom | Description | Valeur |
|---|---|---|
| Propriétés | Propriétés d’un jeu de versions d’API. | ApiVersionSetContractProperties |
ApiVersionSetContractProperties
| Nom | Description | Valeur |
|---|---|---|
| description | Description du jeu de versions d’API. | corde |
| displayName | Nom du jeu de versions d’API | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 (obligatoire) |
| versionHeaderName | Nom du paramètre d’en-tête HTTP qui indique la version de l’API si versioningScheme est défini sur header. |
corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
| versioningScheme | Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP. | 'Header' 'Query' 'Segment' (obligatoire) |
| versionQueryName | Nom du paramètre de requête qui indique la version de l’API si versioningScheme a la valeur query. |
corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
AuthenticationSettingsContract
| Nom | Description | Valeur |
|---|---|---|
| oAuth2 | Paramètres d’authentification OAuth2 | OAuth2AuthenticationSettingsContract |
Microsoft.ApiManagement/service/apis
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = ^[^*#&+:<>?]+$ (obligatoire) |
| parent | Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente. Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente. |
Nom symbolique de la ressource de type : service |
| Propriétés | Création d’entités d’API de propriétés de mise à jour. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
OAuth2AuthenticationSettingsContract
| Nom | Description | Valeur |
|---|---|---|
| authorizationServerId | Identificateur du serveur d’autorisation OAuth. | corde |
| portée | étendue des opérations. | corde |
SubscriptionKeyParameterNamesContract
| Nom | Description | Valeur |
|---|---|---|
| en-tête | Nom de l’en-tête de clé d’abonnement. | corde |
| requête | Nom du paramètre de chaîne de requête de clé d’abonnement. | corde |
Définition de ressource de modèle ARM
Le type de ressource service/apis peut être déployé avec des opérations qui ciblent :
- groupes de ressources - Consultez commandes de déploiement de groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format de ressource
Pour créer une ressource Microsoft.ApiManagement/service/apis, ajoutez le code JSON suivant à votre modèle.
{
"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"
}
}
}
Valeurs de propriété
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Nom | Description | Valeur |
|---|---|---|
| apiRevision | Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision 1 par défaut est créée | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
| apiVersion | Indique l’identificateur de version de l’API si l’API est versionnée | corde Contraintes: Longueur maximale = |
| apiVersionSet | Détails du contrat du jeu de versions de l’API. | ApiVersionSetContract |
| apiVersionSetId | Identificateur de ressource pour l’ApiVersionSet associé. | corde |
| authenticationSettings | Collection de paramètres d’authentification inclus dans cette API. | AuthenticationSettingsContract |
| contentFormat | Format du contenu dans lequel l’API est importée. | 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link' |
| contentValue | Valeur de contenu lors de l’importation d’une API. | corde |
| description | Description de l’API. Peut inclure des balises de mise en forme HTML. | corde |
| displayName | Nom de l’API. | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
| chemin | URL relative identifiant de manière unique cette API et tous ses chemins de ressources dans l’instance du service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée pendant la création de l’instance de service pour former une URL publique pour cette API. | corde Contraintes: Longueur maximale = (obligatoire) |
| protocole | Décrit les protocoles sur lesquels les opérations de cette API peuvent être appelées. | Tableau de chaînes contenant l’un des éléments suivants : 'http' 'https' |
| serviceUrl | URL absolue du service principal implémentant cette API. | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
| subscriptionKeyParameterNames | Protocoles sur lesquels l’API est rendue disponible. | SubscriptionKeyParameterNamesContract |
| type | Type d’API. | 'http' 'soap' |
| wsdlSelector | Critères pour limiter l’importation de WSDL à un sous-ensemble du document. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Nom | Description | Valeur |
|---|---|---|
| wsdlEndpointName | Nom du point de terminaison(port) à importer à partir de WSDL | corde |
| wsdlServiceName | Nom du service à importer à partir de WSDL | corde |
ApiVersionSetContract
| Nom | Description | Valeur |
|---|---|---|
| Propriétés | Propriétés d’un jeu de versions d’API. | ApiVersionSetContractProperties |
ApiVersionSetContractProperties
| Nom | Description | Valeur |
|---|---|---|
| description | Description du jeu de versions d’API. | corde |
| displayName | Nom du jeu de versions d’API | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 (obligatoire) |
| versionHeaderName | Nom du paramètre d’en-tête HTTP qui indique la version de l’API si versioningScheme est défini sur header. |
corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
| versioningScheme | Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP. | 'Header' 'Query' 'Segment' (obligatoire) |
| versionQueryName | Nom du paramètre de requête qui indique la version de l’API si versioningScheme a la valeur query. |
corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
AuthenticationSettingsContract
| Nom | Description | Valeur |
|---|---|---|
| oAuth2 | Paramètres d’authentification OAuth2 | OAuth2AuthenticationSettingsContract |
Microsoft.ApiManagement/service/apis
| Nom | Description | Valeur |
|---|---|---|
| apiVersion | Version de l’API | '2017-03-01' |
| nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = ^[^*#&+:<>?]+$ (obligatoire) |
| Propriétés | Création d’entités d’API de propriétés de mise à jour. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
| type | Type de ressource | 'Microsoft.ApiManagement/service/apis' |
OAuth2AuthenticationSettingsContract
| Nom | Description | Valeur |
|---|---|---|
| authorizationServerId | Identificateur du serveur d’autorisation OAuth. | corde |
| portée | étendue des opérations. | corde |
SubscriptionKeyParameterNamesContract
| Nom | Description | Valeur |
|---|---|---|
| en-tête | Nom de l’en-tête de clé d’abonnement. | corde |
| requête | Nom du paramètre de chaîne de requête de clé d’abonnement. | corde |
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource service/apis peut être déployé avec des opérations qui ciblent :
- groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format de ressource
Pour créer une ressource Microsoft.ApiManagement/service/apis, ajoutez le terraform suivant à votre modèle.
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"
}
}
})
}
Valeurs de propriété
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Nom | Description | Valeur |
|---|---|---|
| apiRevision | Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision 1 par défaut est créée | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
| apiVersion | Indique l’identificateur de version de l’API si l’API est versionnée | corde Contraintes: Longueur maximale = |
| apiVersionSet | Détails du contrat du jeu de versions de l’API. | ApiVersionSetContract |
| apiVersionSetId | Identificateur de ressource pour l’ApiVersionSet associé. | corde |
| authenticationSettings | Collection de paramètres d’authentification inclus dans cette API. | AuthenticationSettingsContract |
| contentFormat | Format du contenu dans lequel l’API est importée. | 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link' |
| contentValue | Valeur de contenu lors de l’importation d’une API. | corde |
| description | Description de l’API. Peut inclure des balises de mise en forme HTML. | corde |
| displayName | Nom de l’API. | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
| chemin | URL relative identifiant de manière unique cette API et tous ses chemins de ressources dans l’instance du service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée pendant la création de l’instance de service pour former une URL publique pour cette API. | corde Contraintes: Longueur maximale = (obligatoire) |
| protocole | Décrit les protocoles sur lesquels les opérations de cette API peuvent être appelées. | Tableau de chaînes contenant l’un des éléments suivants : 'http' 'https' |
| serviceUrl | URL absolue du service principal implémentant cette API. | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
| subscriptionKeyParameterNames | Protocoles sur lesquels l’API est rendue disponible. | SubscriptionKeyParameterNamesContract |
| type | Type d’API. | 'http' 'soap' |
| wsdlSelector | Critères pour limiter l’importation de WSDL à un sous-ensemble du document. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Nom | Description | Valeur |
|---|---|---|
| wsdlEndpointName | Nom du point de terminaison(port) à importer à partir de WSDL | corde |
| wsdlServiceName | Nom du service à importer à partir de WSDL | corde |
ApiVersionSetContract
| Nom | Description | Valeur |
|---|---|---|
| Propriétés | Propriétés d’un jeu de versions d’API. | ApiVersionSetContractProperties |
ApiVersionSetContractProperties
| Nom | Description | Valeur |
|---|---|---|
| description | Description du jeu de versions d’API. | corde |
| displayName | Nom du jeu de versions d’API | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 (obligatoire) |
| versionHeaderName | Nom du paramètre d’en-tête HTTP qui indique la version de l’API si versioningScheme est défini sur header. |
corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
| versioningScheme | Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP. | 'Header' 'Query' 'Segment' (obligatoire) |
| versionQueryName | Nom du paramètre de requête qui indique la version de l’API si versioningScheme a la valeur query. |
corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 |
AuthenticationSettingsContract
| Nom | Description | Valeur |
|---|---|---|
| oAuth2 | Paramètres d’authentification OAuth2 | OAuth2AuthenticationSettingsContract |
Microsoft.ApiManagement/service/apis
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = ^[^*#&+:<>?]+$ (obligatoire) |
| parent_id | ID de la ressource qui est le parent de cette ressource. | ID de ressource de type : de service |
| Propriétés | Création d’entités d’API de propriétés de mise à jour. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
| type | Type de ressource | « Microsoft.ApiManagement/service/apis@2017-03-01 » |
OAuth2AuthenticationSettingsContract
| Nom | Description | Valeur |
|---|---|---|
| authorizationServerId | Identificateur du serveur d’autorisation OAuth. | corde |
| portée | étendue des opérations. | corde |
SubscriptionKeyParameterNamesContract
| Nom | Description | Valeur |
|---|---|---|
| en-tête | Nom de l’en-tête de clé d’abonnement. | corde |
| requête | Nom du paramètre de chaîne de requête de clé d’abonnement. | corde |