Skip to content

[AutoPR resources/resource-manager] Minor updates to description properties to improve docs #241

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.

Sign up for GitHub

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

Merged
AutorestCI merged 1 commit into from
Jun 12, 2018
Merged

[AutoPR resources/resource-manager] Minor updates to description properties to improve docs #241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions ...-mgmt-resources/src/main/java/com/microsoft/azure/management/resources/ErrorResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
import com.fasterxml.jackson.annotation.JsonProperty;

/**
* Error reponse indicates ARM is not able to process the incoming request. The
* reason is provided in the error message.
* Error reponse indicates Azure Resource Manager is not able to process the
* incoming request. The reason is provided in the error message.
*/
public class ErrorResponse {
/**
Expand Down
2 changes: 1 addition & 1 deletion azure-mgmt-resources/src/main/java/com/microsoft/azure/management/resources/PolicySku.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import com.fasterxml.jackson.annotation.JsonProperty;

/**
* The policy sku.
* The policy sku. This property is optional, obsolete, and will be ignored.
*/
public class PolicySku {
/**
Expand Down
13 changes: 7 additions & 6 deletions ...n/java/com/microsoft/azure/management/resources/implementation/PolicyAssignmentInner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public class PolicyAssignmentInner {
private String displayName;

/**
* The ID of the policy definition.
* The ID of the policy definition or policy set definition being assigned.
*/
@JsonProperty(value = "properties.policyDefinitionId")
private String policyDefinitionId;
Expand Down Expand Up @@ -79,7 +79,8 @@ public class PolicyAssignmentInner {
private String name;

/**
* The policy sku.
* The policy sku. This property is optional, obsolete, and will be
* ignored.
*/
@JsonProperty(value = "sku")
private PolicySku sku;
Expand All @@ -105,7 +106,7 @@ public PolicyAssignmentInner withDisplayName(String displayName) {
}

/**
* Get the ID of the policy definition.
* Get the ID of the policy definition or policy set definition being assigned.
*
* @return the policyDefinitionId value
*/
Expand All @@ -114,7 +115,7 @@ public String policyDefinitionId() {
}

/**
* Set the ID of the policy definition.
* Set the ID of the policy definition or policy set definition being assigned.
*
* @param policyDefinitionId the policyDefinitionId value to set
* @return the PolicyAssignmentInner object itself.
Expand Down Expand Up @@ -252,7 +253,7 @@ public String name() {
}

/**
* Get the policy sku.
* Get the policy sku. This property is optional, obsolete, and will be ignored.
*
* @return the sku value
*/
Expand All @@ -261,7 +262,7 @@ public PolicySku sku() {
}

/**
* Set the policy sku.
* Set the policy sku. This property is optional, obsolete, and will be ignored.
*
* @param sku the sku value to set
* @return the PolicyAssignmentInner object itself.
Expand Down
30 changes: 20 additions & 10 deletions .../java/com/microsoft/azure/management/resources/implementation/PolicyDefinitionsInner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -943,7 +943,8 @@ private ServiceResponse<PageImpl<PolicyDefinitionInner>> listBuiltInDelegate(Res
}

/**
* Gets all the policy definitions in a management group.
* Retrieve policy definitions in a management group.
* This operation retrieves a list of all the policy definitions in a given management group.
*
* @param managementGroupId The ID of the management group.
* @throws IllegalArgumentException thrown if parameters fail the validation
Expand All @@ -962,7 +963,8 @@ public Page<PolicyDefinitionInner> nextPage(String nextPageLink) {
}

/**
* Gets all the policy definitions in a management group.
* Retrieve policy definitions in a management group.
* This operation retrieves a list of all the policy definitions in a given management group.
*
* @param managementGroupId The ID of the management group.
* @param serviceCallback the async ServiceCallback to handle successful and failed responses.
Expand All @@ -982,7 +984,8 @@ public Observable<ServiceResponse<Page<PolicyDefinitionInner>>> call(String next
}

/**
* Gets all the policy definitions in a management group.
* Retrieve policy definitions in a management group.
* This operation retrieves a list of all the policy definitions in a given management group.
*
* @param managementGroupId The ID of the management group.
* @throws IllegalArgumentException thrown if parameters fail the validation
Expand All @@ -999,7 +1002,8 @@ public Page<PolicyDefinitionInner> call(ServiceResponse<Page<PolicyDefinitionInn
}

/**
* Gets all the policy definitions in a management group.
* Retrieve policy definitions in a management group.
* This operation retrieves a list of all the policy definitions in a given management group.
*
* @param managementGroupId The ID of the management group.
* @throws IllegalArgumentException thrown if parameters fail the validation
Expand All @@ -1020,7 +1024,8 @@ public Observable<ServiceResponse<Page<PolicyDefinitionInner>>> call(ServiceResp
}

/**
* Gets all the policy definitions in a management group.
* Retrieve policy definitions in a management group.
* This operation retrieves a list of all the policy definitions in a given management group.
*
ServiceResponse<PageImpl<PolicyDefinitionInner>> * @param managementGroupId The ID of the management group.
* @throws IllegalArgumentException thrown if parameters fail the validation
Expand Down Expand Up @@ -1287,7 +1292,8 @@ private ServiceResponse<PageImpl<PolicyDefinitionInner>> listBuiltInNextDelegate
}

/**
* Gets all the policy definitions in a management group.
* Retrieve policy definitions in a management group.
* This operation retrieves a list of all the policy definitions in a given management group.
*
* @param nextPageLink The NextLink from the previous successful call to List operation.
* @throws IllegalArgumentException thrown if parameters fail the validation
Expand All @@ -1306,7 +1312,8 @@ public Page<PolicyDefinitionInner> nextPage(String nextPageLink) {
}

/**
* Gets all the policy definitions in a management group.
* Retrieve policy definitions in a management group.
* This operation retrieves a list of all the policy definitions in a given management group.
*
* @param nextPageLink The NextLink from the previous successful call to List operation.
* @param serviceFuture the ServiceFuture object tracking the Retrofit calls
Expand All @@ -1327,7 +1334,8 @@ public Observable<ServiceResponse<Page<PolicyDefinitionInner>>> call(String next
}

/**
* Gets all the policy definitions in a management group.
* Retrieve policy definitions in a management group.
* This operation retrieves a list of all the policy definitions in a given management group.
*
* @param nextPageLink The NextLink from the previous successful call to List operation.
* @throws IllegalArgumentException thrown if parameters fail the validation
Expand All @@ -1344,7 +1352,8 @@ public Page<PolicyDefinitionInner> call(ServiceResponse<Page<PolicyDefinitionInn
}

/**
* Gets all the policy definitions in a management group.
* Retrieve policy definitions in a management group.
* This operation retrieves a list of all the policy definitions in a given management group.
*
* @param nextPageLink The NextLink from the previous successful call to List operation.
* @throws IllegalArgumentException thrown if parameters fail the validation
Expand All @@ -1365,7 +1374,8 @@ public Observable<ServiceResponse<Page<PolicyDefinitionInner>>> call(ServiceResp
}

/**
* Gets all the policy definitions in a management group.
* Retrieve policy definitions in a management group.
* This operation retrieves a list of all the policy definitions in a given management group.
*
ServiceResponse<PageImpl<PolicyDefinitionInner>> * @param nextPageLink The NextLink from the previous successful call to List operation.
* @throws IllegalArgumentException thrown if parameters fail the validation
Expand Down