Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Microsoft.ApiManagement][2020-06-01-preview] Gateway certificate authorities #12559

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -1029,6 +1029,295 @@
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities": {
"get": {
"tags": [
"GatewayCertificateAuthority"
],
"operationId": "GatewayCertificateAuthority_ListByService",
"description": "Lists the collection of Certificate Authorities for the specified Gateway entity.",
"x-ms-examples": {
"ApiManagementListGatewaycertificateAuthorities": {
"$ref": "./examples/ApiManagementListGatewayCertificateAuthorities.json"
}
},
"parameters": [
{
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/GatewayIdParameter"
},
{
"name": "$filter",
"in": "query",
"required": false,
"type": "string",
"description": "| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | eq, ne | |</br>"
solankisamir marked this conversation as resolved.
Show resolved Hide resolved
},
{
"$ref": "./apimanagement.json#/parameters/TopQueryParameter"
},
{
"$ref": "./apimanagement.json#/parameters/SkipQueryParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
},
{
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Collection of Gateway Certificate Authoritiy entities.",
"schema": {
"$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityCollection"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-odata": "./definitions.json#/definitions/GatewayCertificateAuthorityContract"
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities/{certificateId}": {
"head": {
"tags": [
"GatewayCertificateAuthority"
],
"operationId": "GatewayCertificateAuthority_GetEntityTag",
"description": "Checks if Certificate entity is assigned to Gateway entity as Certificate Authority.",
"x-ms-examples": {
"ApiManagementHeadGatewayCertificateAuthority": {
"$ref": "./examples/ApiManagementHeadGatewayCertificateAuthority.json"
}
},
"parameters": [
{
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/GatewayIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/CertificateIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
},
{
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Specified Gateway Certificate Authority entity exists and current entity state version is present in the ETag header.",
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
}
}
}
},
"get": {
"tags": [
"GatewayCertificateAuthority"
],
"operationId": "GatewayCertificateAuthority_Get",
"description": "Get assigned Gateway Certificate Authority details.",
"x-ms-examples": {
"ApiManagementGetGatewayCertificateAuthority": {
"$ref": "./examples/ApiManagementGetGatewayCertificateAuthority.json"
}
},
"parameters": [
{
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/GatewayIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/CertificateIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
},
{
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "The response body contains the specified Gateway Certificate Authority entity.",
"schema": {
"$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityContract"
},
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
}
}
}
},
"put": {
solankisamir marked this conversation as resolved.
Show resolved Hide resolved
"tags": [
"GatewayCertificateAuthority"
],
"operationId": "GatewayCertificateAuthority_CreateOrUpdate",
"description": "Assign Certificate entity to Gateway entity as Certificate Authority.",
"x-ms-examples": {
"ApiManagementCreateGatewayCertificateAuthority": {
"$ref": "./examples/ApiManagementCreateGatewayCertificateAuthority.json"
}
},
"parameters": [
{
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/GatewayIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/CertificateIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/IfMatchOptionalParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityContract"
}
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
},
{
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"201": {
"description": "Certificate entity was successfully assigned to Gateway entity as Certificate Authority.",
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
},
"schema": {
"$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityContract"
}
},
"200": {
"description": "Gateway Certificate Authority details were successfully updated",
"headers": {
"ETag": {
"description": "Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.",
"type": "string"
}
},
"schema": {
"$ref": "./definitions.json#/definitions/GatewayCertificateAuthorityContract"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
}
}
}
},
"delete": {
"tags": [
"GatewayCertificateAuthority"
],
"operationId": "GatewayCertificateAuthority_Delete",
"description": "Unassign Certificate Authority from Gateway entity.",
"x-ms-examples": {
"ApiManagementDeleteGatewayCertificateAuthority": {
"$ref": "./examples/ApiManagementDeleteGatewayCertificateAuthority.json"
}
},
"parameters": [
{
"$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
},
{
"$ref": "./apimanagement.json#/parameters/GatewayIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/CertificateIdParameter"
},
{
"$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter"
},
{
"$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
},
{
"$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Certificate entity was successfully unassigned from Gateway entity as Certificate Authority."
},
"204": {
"description": "Certificate was successfully unassigned from Gateway entity as Certificate Authority by one of the previous requests or never assigned."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./apimanagement.json#/definitions/ErrorResponse"
}
}
}
}
}
},
"definitions": {},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5866,6 +5866,48 @@
},
"description": "Gateway hostname configuration details."
},
"GatewayCertificateAuthorityCollection": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/GatewayCertificateAuthorityContract"
},
"description": "Page values.",
"readOnly": true
},
"nextLink": {
"type": "string",
"description": "Next page link if any.",
"readOnly": true
}
},
"description": "Paged Gateway certificate authority list representation."
},
"GatewayCertificateAuthorityContract": {
"properties": {
"properties": {
"x-ms-client-flatten": true,
solankisamir marked this conversation as resolved.
Show resolved Hide resolved
"$ref": "#/definitions/GatewayCertificateAuthorityContractProperties",
"description": "Gateway certificate authority details."
}
},
"allOf": [
{
"$ref": "./apimanagement.json#/definitions/Resource"
}
],
"description": "Gateway certificate authority details."
},
"GatewayCertificateAuthorityContractProperties": {
"properties": {
"isTrusted": {
"type": "boolean",
"description": "Determines whether certificate authority is trusted."
}
},
"description": "Gateway certificate authority details."
},
"AssociationContract": {
"properties": {
"properties": {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
{
"parameters": {
"serviceName": "apimService1",
"resourceGroupName": "rg1",
"api-version": "2020-06-01-preview",
"subscriptionId": "subid",
"gatewayId": "gw1",
"certificateId": "cert1",
"parameters": {
"properties": {
"isTrusted": false
}
}
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1",
"type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities",
"name": "cert1",
"properties": {
"isTrusted": false
}
}
},
"200": {
"body": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/certificateAuthorities/cert1",
"type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities",
"name": "cert1",
"properties": {
"isTrusted": false
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"parameters": {
"serviceName": "apimService1",
"resourceGroupName": "rg1",
"api-version": "2020-06-01-preview",
"subscriptionId": "subid",
"gatewayId": "gw1",
"certificateId": "default",
"If-Match": "*"
},
"responses": {
"200": {},
"204": {}
}
}
Loading